_analytics_web.dart

// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// ignore_for_file: non_constant_identifier_names

@JS()
library;

import 'dart:async';
import 'dart:js_interop';

import 'package:devtools_app_shared/ui.dart';
import 'package:flutter/foundation.dart';
import 'package:logging/logging.dart';
import 'package:unified_analytics/unified_analytics.dart' as ua;
import 'package:web/web.dart';

import '../dtd_manager_extensions.dart';
import '../globals.dart';
import '../query_parameters.dart';
import '../server/server.dart' as server;
import '../utils.dart';
import 'analytics_common.dart';
import 'constants.dart' as gac;
import 'gtags.dart';
import 'metrics.dart';

// Dimensions1 AppType values:
const appTypeFlutter = 'flutter';
const appTypeWeb = 'web';
const appTypeFlutterWeb = 'flutter_web';
const appTypeDartCLI = 'dart_cli';
// Dimensions2 BuildType values:
const buildTypeDebug = 'debug';
const buildTypeProfile = 'profile';
// Start with Android_n.n.n
const devToolsPlatformTypeAndroid = 'Android_';
// Dimension5 devToolsChrome starts with
const devToolsChromeName = 'Chrome/'; // starts with and ends with n.n.n
const devToolsChromeIos = 'Crios/'; // starts with and ends with n.n.n
const devToolsChromeOS = 'CrOS'; // Chrome OS
// Dimension6 devToolsVersion

// Dimension7 ideLaunched
const ideLaunchedCLI = 'CLI'; // Command Line Interface

final _log = Logger('_analytics_web');

@JS('initializeGA')
external void initializeGA();

extension type GtagEventDevTools._(JSObject _) implements GtagEvent {
  // TODO(kenz): try to make this accept a JSON map of extra parameters rather
  // than a fixed list of fields. See
  // https://github.com/flutter/devtools/pull/3281#discussion_r692376353.
  external factory GtagEventDevTools({
    String? event_category,
    String? event_label, // Event e.g., gaScreenViewEvent, gaSelectEvent, etc.
    String? send_to, // UA ID of target GA property to receive event data.

    int value,
    bool non_interaction,
    JSObject? custom_map,

    // NOTE: Do not reorder any of these. Order here must match the order in the
    // Google Analytics console.

    String? user_app, // dimension1 (flutter or web)
    String? user_build, // dimension2 (debug or profile)
    String? user_platform, // dimension3 (android/ios/fuchsia/linux/mac/windows)
    String? devtools_platform, // dimension4 linux/android/mac/windows
    String? devtools_chrome, // dimension5 Chrome version #
    String? devtools_version, // dimension6 DevTools version #
    String? ide_launched, // dimension7 Devtools launched (CLI, VSCode, Android)
    String?
        flutter_client_id, // dimension8 Flutter tool client_id (~/.flutter).
    String? is_external_build, // dimension9 External build or google3
    String? is_embedded, // dimension10 Whether devtools is embedded
    String? g3_username, // dimension11 g3 username (null for external users)

    // dimension12 IDE feature that launched Devtools
    // The following is a non-exhaustive list of possible values for this dimension:
    // "command" - VS Code command palette
    // "sidebarContent" - the content of the sidebar (e.g. the DevTools dropdown for a debug session)
    // "sidebarTitle" - the DevTools action in the sidebar title
    // "touchbar" - MacOS touchbar button
    // "launchConfiguration" - configured explicitly in launch configuration
    // "onDebugAutomatic" - configured to always run on debug session start
    // "onDebugPrompt" - user responded to prompt when running a debug session
    // "languageStatus" - launched from the language status popout
    String? ide_launched_feature,
    String? is_wasm, // dimension13 whether DevTools is running with WASM.

    // Performance screen metrics. See [PerformanceScreenMetrics].
    int? ui_duration_micros, // metric1
    int? raster_duration_micros, // metric2
    int? shader_compilation_duration_micros, // metric3
    // Profiler screen metrics. See [ProfilerScreenMetrics].
    int? cpu_sample_count, // metric4
    int? cpu_stack_depth, // metric5
    // Performance screen metric. See [PerformanceScreenMetrics].
    int? trace_event_count, // metric6
    // Memory screen metric. See [MemoryScreenMetrics].
    int? heap_diff_objects_before, // metric7
    int? heap_diff_objects_after, // metric8
    int? heap_objects_total, // metric9
    // Inspector screen metrics. See [InspectorScreenMetrics].
    int? root_set_count, // metric10
    int? row_count, // metric11
    int? inspector_tree_controller_id, // metric12
  });

  // Custom dimensions:
  external String? get user_app;
  external String? get user_build;
  external String? get user_platform;
  external String? get devtools_platform;
  external String? get devtools_chrome;
  external String? get devtools_version;
  external String? get ide_launched;
  external String? get flutter_client_id;
  external String? get is_external_build;
  external String? get is_embedded;
  external String? get g3_username;
  external String? get ide_launched_feature;
  external String? get is_wasm;

  // Custom metrics:
  external int? get ui_duration_micros;
  external int? get raster_duration_micros;
  external int? get shader_compilation_duration_micros;
  external int? get cpu_sample_count;
  external int? get cpu_stack_depth;
  external int? get trace_event_count;
  external int? get heap_diff_objects_before;
  external int? get heap_diff_objects_after;
  external int? get heap_objects_total;
  external int? get root_set_count;
  external int? get row_count;
  external int? get inspector_tree_controller_id;
}

extension type GtagExceptionDevTools._(JSObject _) implements GtagException {
  external factory GtagExceptionDevTools({
    String? description,
    bool fatal,

    // NOTE: Do not reorder any of these. Order here must match the order in the
    // Google Analytics console.

    String? user_app, // dimension1 (flutter or web)
    String? user_build, // dimension2 (debug or profile)
    String? user_platform, // dimension3 (android or ios)
    String? devtools_platform, // dimension4 linux/android/mac/windows
    String? devtools_chrome, // dimension5 Chrome version #
    String? devtools_version, // dimension6 DevTools version #
    String? ide_launched, // dimension7 IDE launched DevTools
    String? flutter_client_id, // dimension8 Flutter tool clientId
    String? is_external_build, // dimension9 External build or google3
    String? is_embedded, // dimension10 Whether devtools is embedded
    String? g3_username, // dimension11 g3 username (null for external users)

    // dimension12 IDE feature that launched Devtools
    // The following is a non-exhaustive list of possible values for this dimension:
    // "command" - VS Code command palette
    // "sidebarContent" - the content of the sidebar (e.g. the DevTools dropdown for a debug session)
    // "sidebarTitle" - the DevTools action in the sidebar title
    // "touchbar" - MacOS touchbar button
    // "launchConfiguration" - configured explicitly in launch configuration
    // "onDebugAutomatic" - configured to always run on debug session start
    // "onDebugPrompt" - user responded to prompt when running a debug session
    // "languageStatus" - launched from the language status popout
    String? ide_launched_feature,
    String? is_wasm, // dimension13 whether DevTools is running with WASM.

    // Performance screen metrics. See [PerformanceScreenMetrics].
    int? ui_duration_micros, // metric1
    int? raster_duration_micros, // metric2
    int? shader_compilation_duration_micros, // metric3
    // Profiler screen metrics. See [ProfilerScreenMetrics].
    int? cpu_sample_count, // metric4
    int? cpu_stack_depth, // metric5
    // Performance screen metric. See [PerformanceScreenMetrics].
    int? trace_event_count, // metric6
    // Memory screen metric. See [MemoryScreenMetrics].
    int? heap_diff_objects_before, // metric7
    int? heap_diff_objects_after, // metric8
    int? heap_objects_total, // metric9
    // Inspector screen metrics. See [InspectorScreenMetrics].
    int? root_set_count, // metric10
    int? row_count, // metric11
    int? inspector_tree_controller_id, // metric12
  });

  // Custom dimensions:
  external String? get user_app;
  external String? get user_build;
  external String? get user_platform;
  external String? get devtools_platform;
  external String? get devtools_chrome;
  external String? get devtools_version;
  external String? get ide_launched;
  external String? get flutter_client_id;
  external String? get is_external_build;
  external String? get is_embedded;
  external String? get g3_username;
  external String? get ide_launched_feature;
  external String? get is_wasm;

  // Custom metrics:
  external int? get ui_duration_micros;
  external int? get raster_duration_micros;
  external int? get shader_compilation_duration_micros;
  external int? get cpu_sample_count;
  external int? get cpu_stack_depth;
  external int? get trace_event_count;
  external int? get heap_diff_objects_before;
  external int? get heap_diff_objects_after;
  external int? get heap_objects_total;
  external int? get root_set_count;
  external int? get row_count;
  external int? get inspector_tree_controller_id;
}

// This cannot be a factory constructor in the [GtagEventDevTools] class due to
// https://github.com/dart-lang/sdk/issues/46967.
GtagEventDevTools _gtagEvent({
  required String event_category,
  required String event_label,
  String? send_to,
  bool non_interaction = false,
  int value = 0,
  ScreenAnalyticsMetrics? screenMetrics,
}) {
  return GtagEventDevTools(
    event_category: event_category,
    event_label: event_label,
    send_to: send_to,
    non_interaction: non_interaction,
    value: value,
    user_app: userAppType,
    user_build: userBuildType,
    user_platform: userPlatformType,
    devtools_platform: devtoolsPlatformType,
    devtools_chrome: devtoolsChrome,
    devtools_version: devtoolsVersion,
    ide_launched: ideLaunched,
    flutter_client_id: flutterClientId,
    is_external_build: isExternalBuild.toString(),
    is_embedded: isEmbedded().toString(),
    g3_username: devToolsEnvironmentParameters.username(),
    ide_launched_feature: ideLaunchedFeature,
    is_wasm: kIsWasm.toString(),
    // [PerformanceScreenMetrics]
    ui_duration_micros: screenMetrics is PerformanceScreenMetrics
        ? screenMetrics.uiDuration?.inMicroseconds
        : null,
    raster_duration_micros: screenMetrics is PerformanceScreenMetrics
        ? screenMetrics.rasterDuration?.inMicroseconds
        : null,
    shader_compilation_duration_micros:
        screenMetrics is PerformanceScreenMetrics
            ? screenMetrics.shaderCompilationDuration?.inMicroseconds
            : null,
    trace_event_count: screenMetrics is PerformanceScreenMetrics
        ? screenMetrics.traceEventCount
        : null,
    // [ProfilerScreenMetrics]
    cpu_sample_count: screenMetrics is ProfilerScreenMetrics
        ? screenMetrics.cpuSampleCount
        : null,
    cpu_stack_depth: screenMetrics is ProfilerScreenMetrics
        ? screenMetrics.cpuStackDepth
        : null,
    // [MemoryScreenMetrics]
    heap_diff_objects_before: screenMetrics is MemoryScreenMetrics
        ? screenMetrics.heapDiffObjectsBefore
        : null,
    heap_diff_objects_after: screenMetrics is MemoryScreenMetrics
        ? screenMetrics.heapDiffObjectsAfter
        : null,
    heap_objects_total: screenMetrics is MemoryScreenMetrics
        ? screenMetrics.heapObjectsTotal
        : null,
    // [InspectorScreenMetrics]
    root_set_count: screenMetrics is InspectorScreenMetrics
        ? screenMetrics.rootSetCount
        : null,
    row_count:
        screenMetrics is InspectorScreenMetrics ? screenMetrics.rowCount : null,
    inspector_tree_controller_id: screenMetrics is InspectorScreenMetrics
        ? screenMetrics.inspectorTreeControllerId
        : null,
  );
}

// This cannot be a factory constructor in the [GtagExceptionDevTools] class due to
// https://github.com/dart-lang/sdk/issues/46967.
GtagExceptionDevTools _gtagException(
  String errorMessage, {
  bool fatal = false,
  ScreenAnalyticsMetrics? screenMetrics,
}) {
  return GtagExceptionDevTools(
    description: errorMessage,
    fatal: fatal,
    user_app: userAppType,
    user_build: userBuildType,
    user_platform: userPlatformType,
    devtools_platform: devtoolsPlatformType,
    devtools_chrome: devtoolsChrome,
    devtools_version: devtoolsVersion,
    ide_launched: _ideLaunched,
    flutter_client_id: flutterClientId,
    is_external_build: isExternalBuild.toString(),
    is_embedded: isEmbedded().toString(),
    g3_username: devToolsEnvironmentParameters.username(),
    ide_launched_feature: ideLaunchedFeature,
    is_wasm: kIsWasm.toString(),
    // [PerformanceScreenMetrics]
    ui_duration_micros: screenMetrics is PerformanceScreenMetrics
        ? screenMetrics.uiDuration?.inMicroseconds
        : null,
    raster_duration_micros: screenMetrics is PerformanceScreenMetrics
        ? screenMetrics.rasterDuration?.inMicroseconds
        : null,
    trace_event_count: screenMetrics is PerformanceScreenMetrics
        ? screenMetrics.traceEventCount
        : null,
    shader_compilation_duration_micros:
        screenMetrics is PerformanceScreenMetrics
            ? screenMetrics.shaderCompilationDuration?.inMicroseconds
            : null,
    // [ProfilerScreenMetrics]
    cpu_sample_count: screenMetrics is ProfilerScreenMetrics
        ? screenMetrics.cpuSampleCount
        : null,
    cpu_stack_depth: screenMetrics is ProfilerScreenMetrics
        ? screenMetrics.cpuStackDepth
        : null,
    // [MemoryScreenMetrics]
    heap_diff_objects_before: screenMetrics is MemoryScreenMetrics
        ? screenMetrics.heapDiffObjectsBefore
        : null,
    heap_diff_objects_after: screenMetrics is MemoryScreenMetrics
        ? screenMetrics.heapDiffObjectsAfter
        : null,
    heap_objects_total: screenMetrics is MemoryScreenMetrics
        ? screenMetrics.heapObjectsTotal
        : null,
    // [InspectorScreenMetrics]
    root_set_count: screenMetrics is InspectorScreenMetrics
        ? screenMetrics.rootSetCount
        : null,
    row_count:
        screenMetrics is InspectorScreenMetrics ? screenMetrics.rowCount : null,
    inspector_tree_controller_id: screenMetrics is InspectorScreenMetrics
        ? screenMetrics.inspectorTreeControllerId
        : null,
  );
}

/// Whether google analytics are enabled.
Future<bool> isAnalyticsEnabled() async {
  bool enabled = false;
  if (kReleaseMode) {
    enabled = await dtdManager.analyticsTelemetryEnabled();
  }

  // TODO(https://github.com/flutter/devtools/issues/7083): remove this block
  // when the legacy analytics are fully removed. For now, check that both
  // unified analytics are enabled and the legacy analytics are enabled.
  if (enabled) {
    enabled = await server.isAnalyticsEnabled();
  }

  return enabled;
}

/// Whether the google analytics consent message should be shown.
Future<bool> shouldShowAnalyticsConsentMessage() async {
  bool shouldShow = false;
  if (kReleaseMode) {
    // When asked if the consent message should be shown,
    // package:unified_analytics will return true if this the user's first run
    // of DevTools with package:unified_analytics support or when the consent
    // message version has been updated.
    shouldShow = await dtdManager.shouldShowAnalyticsConsentMessage();
  }

  // TODO(https://github.com/flutter/devtools/issues/7083): remove this block
  // when the legacy analytics are fully removed.
  if (!shouldShow) {
    shouldShow = await server.isFirstRun();
  }

  return shouldShow;
}

void screen(
  String screenName, [
  int value = 0,
]) {
  _log.fine('Event: Screen(screenName:$screenName, value:$value)');
  final gtagEvent = _gtagEvent(
    event_category: gac.screenViewEvent,
    event_label: gac.init,
    value: value,
    send_to: gaDevToolsPropertyId(),
  );
  _sendEventForScreen(screenName, gtagEvent);
}

String _operationKey(String screenName, String timedOperation) {
  return '$screenName-$timedOperation';
}

final _timedOperationsInProgress = <String, DateTime>{};

// Use this method coupled with `timeEnd` when an operation cannot be timed in
// a callback, but rather needs to be timed instead at two disjoint start and
// end marks.
void timeStart(String screenName, String timedOperation) {
  final startTime = DateTime.now();
  final operationKey = _operationKey(
    screenName,
    timedOperation,
  );
  _timedOperationsInProgress[operationKey] = startTime;
}

// Use this method coupled with `timeStart` when an operation cannot be timed in
// a callback, but rather needs to be timed instead at two disjoint start and
// end marks.
void timeEnd(
  String screenName,
  String timedOperation, {
  ScreenAnalyticsMetrics Function()? screenMetricsProvider,
}) {
  final endTime = DateTime.now();
  final operationKey = _operationKey(
    screenName,
    timedOperation,
  );
  final startTime = _timedOperationsInProgress.remove(operationKey);
  assert(startTime != null);
  if (startTime == null) {
    _log.warning(
      'Could not time operation "$timedOperation" because a) `timeEnd` was '
      'called before `timeStart` or b) the `screenName` and `timedOperation`'
      'parameters for the `timeStart` and `timeEnd` calls do not match.',
    );
    return;
  }
  final durationMicros =
      endTime.microsecondsSinceEpoch - startTime.microsecondsSinceEpoch;
  _timing(
    screenName,
    timedOperation,
    durationMicros: durationMicros,
    screenMetrics:
        screenMetricsProvider != null ? screenMetricsProvider() : null,
  );
}

void cancelTimingOperation(String screenName, String timedOperation) {
  final operationKey = _operationKey(
    screenName,
    timedOperation,
  );
  final operation = _timedOperationsInProgress.remove(operationKey);
  assert(
    operation != null,
    'The operation cannot be cancelled because it does not exist.',
  );
}

// Use this when a synchronous operation can be timed in a callback.
void timeSync(
  String screenName,
  String timedOperation, {
  required void Function() syncOperation,
  ScreenAnalyticsMetrics Function()? screenMetricsProvider,
}) {
  final startTime = DateTime.now();
  try {
    syncOperation();
  } catch (e, st) {
    // Do not send the timing analytic to GA if the operation failed.
    _log.warning(
      'Could not time sync operation "$timedOperation" '
      'because an exception was thrown:\n$e\n$st',
    );
    rethrow;
  }
  final endTime = DateTime.now();
  final durationMicros =
      endTime.microsecondsSinceEpoch - startTime.microsecondsSinceEpoch;
  _timing(
    screenName,
    timedOperation,
    durationMicros: durationMicros,
    screenMetrics:
        screenMetricsProvider != null ? screenMetricsProvider() : null,
  );
}

// Use this when an asynchronous operation can be timed in a callback.
Future<void> timeAsync(
  String screenName,
  String timedOperation, {
  required Future<void> Function() asyncOperation,
  ScreenAnalyticsMetrics Function()? screenMetricsProvider,
}) async {
  final startTime = DateTime.now();
  try {
    await asyncOperation();
  } catch (e, st) {
    // Do not send the timing analytic to GA if the operation failed.
    _log.warning(
      'Could not time async operation "$timedOperation" '
      'because an exception was thrown:\n$e\n$st',
    );
    rethrow;
  }
  final endTime = DateTime.now();
  final durationMicros =
      endTime.microsecondsSinceEpoch - startTime.microsecondsSinceEpoch;
  _timing(
    screenName,
    timedOperation,
    durationMicros: durationMicros,
    screenMetrics:
        screenMetricsProvider != null ? screenMetricsProvider() : null,
  );
}

void _timing(
  String screenName,
  String timedOperation, {
  required int durationMicros,
  ScreenAnalyticsMetrics? screenMetrics,
}) {
  _log.fine(
    'Event: _timing('
    'screenName:$screenName, '
    'timedOperation:$timedOperation, '
    'durationMicros:$durationMicros)',
  );
  final gtagEvent = _gtagEvent(
    event_category: gac.timingEvent,
    event_label: timedOperation,
    value: durationMicros,
    send_to: gaDevToolsPropertyId(),
    screenMetrics: screenMetrics,
  );
  _sendEventForScreen(screenName, gtagEvent);
}

/// Sends an analytics event to signal that something in DevTools was selected.
void select(
  String screenName,
  String selectedItem, {
  int value = 0,
  bool nonInteraction = false,
  ScreenAnalyticsMetrics Function()? screenMetricsProvider,
}) {
  _log.fine(
    'Event: select('
    'screenName:$screenName, '
    'selectedItem:$selectedItem, '
    'value:$value, '
    'nonInteraction:$nonInteraction)',
  );
  final gtagEvent = _gtagEvent(
    event_category: gac.selectEvent,
    event_label: selectedItem,
    value: value,
    non_interaction: nonInteraction,
    send_to: gaDevToolsPropertyId(),
    screenMetrics:
        screenMetricsProvider != null ? screenMetricsProvider() : null,
  );
  _sendEventForScreen(screenName, gtagEvent);
}

/// Sends an analytics event to signal that something in DevTools was viewed.
///
/// Impression events should not signal user interaction like [select].
void impression(
  String screenName,
  String item, {
  ScreenAnalyticsMetrics Function()? screenMetricsProvider,
}) {
  _log.fine(
    'Event: impression('
    'screenName:$screenName, '
    'item:$item)',
  );
  final gtagEvent = _gtagEvent(
    event_category: gac.impressionEvent,
    event_label: item,
    non_interaction: true,
    send_to: gaDevToolsPropertyId(),
    screenMetrics:
        screenMetricsProvider != null ? screenMetricsProvider() : null,
  );
  _sendEventForScreen(screenName, gtagEvent);
}

String? _lastGaError;

void reportError(
  String errorMessage, {
  bool fatal = false,
}) {
  // Don't keep recording same last error.
  if (_lastGaError == errorMessage) return;
  _lastGaError = errorMessage;

  final gTagException = _gtagException(
    errorMessage,
    fatal: fatal,
  );
  GTag.exception(gaExceptionProvider: () => gTagException);

  final uaEvent = _uaEventFromGtagException(gTagException);
  unawaited(dtdManager.sendAnalyticsEvent(uaEvent));
}

////////////////////////////////////////////////////////////////////////////////
// Utilities to collect all platform and DevTools state for Analytics.
////////////////////////////////////////////////////////////////////////////////

// GA dimensions:
String _userAppType = ''; // dimension1
String _userBuildType = ''; // dimension2
String _userPlatformType = ''; // dimension3

String _devtoolsPlatformType =
    ''; // dimension4 MacIntel/Linux/Windows/Android_n
String _devtoolsChrome = ''; // dimension5 Chrome/n.n.n  or Crios/n.n.n

final devtoolsVersion = devToolsVersion; //dimension6 n.n.n

String _ideLaunched = ''; // dimension7 IDE launched DevTools (VSCode, CLI, ...)

// dimension12 IDE feature that launched DevTools
String _ideLaunchedFeature = '';

String _flutterClientId = ''; // dimension8 Flutter tool clientId.

String get userAppType => _userAppType;

set userAppType(String newUserAppType) {
  _userAppType = newUserAppType;
}

String get userBuildType => _userBuildType;

set userBuildType(String newUserBuildType) {
  _userBuildType = newUserBuildType;
}

String get userPlatformType => _userPlatformType;

set userPlatformType(String newUserPlatformType) {
  _userPlatformType = newUserPlatformType;
}

String get devtoolsPlatformType => _devtoolsPlatformType;

set devtoolsPlatformType(String newDevtoolsPlatformType) {
  _devtoolsPlatformType = newDevtoolsPlatformType;
}

String get devtoolsChrome => _devtoolsChrome;

set devtoolsChrome(String newDevtoolsChrome) {
  _devtoolsChrome = newDevtoolsChrome;
}

/// The IDE that DevTools was launched from.
///
/// Defaults to [ideLaunchedCLI] if DevTools was not launched from the IDE.
String get ideLaunched => _ideLaunched;

String get ideLaunchedFeature => _ideLaunchedFeature;

set ideLaunchedFeature(String newIdeLaunchedFeature) {
  _ideLaunchedFeature = newIdeLaunchedFeature;
}

String get flutterClientId => _flutterClientId;

set flutterClientId(String newFlutterClientId) {
  _flutterClientId = newFlutterClientId;
}

bool _computingDimensions = false;
bool _analyticsComputed = false;

bool _computingUserApplicationDimensions = false;
bool _userApplicationDimensionsComputed = false;

// Computes the running application.
void _computeUserApplicationCustomGTagData() {
  if (_userApplicationDimensionsComputed) return;

  final connectedApp = serviceConnection.serviceManager.connectedApp!;
  assert(connectedApp.isFlutterAppNow != null);
  assert(connectedApp.isDartWebAppNow != null);
  assert(connectedApp.isProfileBuildNow != null);

  const unknownOS = 'unknown';
  if (connectedApp.isFlutterAppNow!) {
    userPlatformType =
        serviceConnection.serviceManager.vm?.operatingSystem ?? unknownOS;
  }
  if (connectedApp.isFlutterWebAppNow) {
    userAppType = appTypeFlutterWeb;
  } else if (connectedApp.isFlutterAppNow!) {
    userAppType = appTypeFlutter;
  } else if (connectedApp.isDartWebAppNow!) {
    userAppType = appTypeWeb;
  } else {
    userAppType = appTypeDartCLI;
  }

  userBuildType =
      connectedApp.isProfileBuildNow! ? buildTypeProfile : buildTypeDebug;

  _analyticsComputed = true;
}

@JS('getDevToolsPropertyID')
external String gaDevToolsPropertyId();

@JS('hookupListenerForGA')
external void jsHookupListenerForGA();

/// Computes the DevTools application. Fills in the devtoolsPlatformType and
/// devtoolsChrome.
void computeDevToolsCustomGTagsData() {
  // Platform
  final platform = window.navigator.platform;
  platform.replaceAll(' ', '_');
  devtoolsPlatformType = platform;

  final appVersion = window.navigator.appVersion;
  final splits = appVersion.split(' ');
  final len = splits.length;
  for (int index = 0; index < len; index++) {
    final value = splits[index];
    // Chrome or Chrome iOS
    if (value.startsWith(devToolsChromeName) ||
        value.startsWith(devToolsChromeIos)) {
      devtoolsChrome = value;
    } else if (value.startsWith('Android')) {
      // appVersion for Android is 'Android n.n.n'
      devtoolsPlatformType = '$devToolsPlatformTypeAndroid${splits[index + 1]}';
    } else if (value == devToolsChromeOS) {
      // Chrome OS will return a platform e.g., CrOS_Linux_x86_64
      devtoolsPlatformType = '${devToolsChromeOS}_$platform';
    }
  }
}

// Look at the query parameters '&ide=' and record in GA.
void computeDevToolsQueryParams() {
  _ideLaunched = ideLaunchedCLI; // Default is Command Line launch.

  final queryParams = DevToolsQueryParams.load();
  final ide = queryParams.ide;
  if (ide != null) {
    _ideLaunched = ide;
  }

  final ideFeature = queryParams.ideFeature;
  if (ideFeature != null) {
    ideLaunchedFeature = ideFeature;
  }
}

Future<void> computeFlutterClientId() async {
  flutterClientId = await server.flutterGAClientID();
}

int _stillWaiting = 0;

void waitForDimensionsComputed(String screenName) {
  Timer(const Duration(milliseconds: 100), () {
    if (_analyticsComputed) {
      screen(screenName);
    } else {
      if (_stillWaiting++ < 50) {
        waitForDimensionsComputed(screenName);
      } else {
        _log.warning('Cancel waiting for dimensions.');
      }
    }
  });
}

Future<void> setupDimensions() async {
  if (!_analyticsComputed && !_computingDimensions) {
    _computingDimensions = true;
    computeDevToolsCustomGTagsData();
    computeDevToolsQueryParams();
    await computeFlutterClientId();
    _analyticsComputed = true;
  }
}

void setupUserApplicationDimensions() {
  if (serviceConnection.serviceManager.connectedApp != null &&
      !_userApplicationDimensionsComputed &&
      !_computingUserApplicationDimensions) {
    _computingUserApplicationDimensions = true;
    _computeUserApplicationCustomGTagData();
    _userApplicationDimensionsComputed = true;
  }
}

Map<String, Object?> generateSurveyQueryParameters() {
  const ideKey = 'IDE';
  const versionKey = 'Version';
  const internalKey = 'Internal';
  return {
    ideKey: _ideLaunched,
    versionKey: devtoolsVersion,
    internalKey: (!isExternalBuild).toString(),
  };
}

FutureOr<void> legacyOnEnableAnalytics() async {
  await server.setAnalyticsEnabled();
}

FutureOr<void> legacyOnDisableAnalytics() async {
  await server.setAnalyticsEnabled(false);
}

void legacyOnSetupAnalytics() {
  initializeGA();
  jsHookupListenerForGA();
}

void _sendEventForScreen(String screenName, GtagEventDevTools gtagEvent) {
  GTag.event(
    screenName,
    gaEventProvider: () => gtagEvent,
  );
  final uaEvent = _uaEventFromGtagEvent(gtagEvent);
  unawaited(dtdManager.sendAnalyticsEvent(uaEvent));
}

ua.Event _uaEventFromGtagEvent(GtagEventDevTools gtagEvent) {
  return ua.Event.devtoolsEvent(
    eventCategory: gtagEvent.event_category!,
    label: gtagEvent.event_label!,
    value: gtagEvent.value,
    userInitiatedInteraction: !gtagEvent.non_interaction,
    userApp: gtagEvent.user_app,
    userBuild: gtagEvent.user_build,
    userPlatform: gtagEvent.user_platform,
    devtoolsPlatform: gtagEvent.devtools_platform,
    devtoolsChrome: gtagEvent.devtools_chrome,
    devtoolsVersion: gtagEvent.devtools_version,
    ideLaunched: gtagEvent.ide_launched,
    isExternalBuild: gtagEvent.is_external_build,
    isEmbedded: gtagEvent.is_embedded,
    ideLaunchedFeature: gtagEvent.ide_launched_feature,
    isWasm: gtagEvent.is_wasm,
    g3Username: gtagEvent.g3_username,
    uiDurationMicros: gtagEvent.ui_duration_micros,
    rasterDurationMicros: gtagEvent.raster_duration_micros,
    shaderCompilationDurationMicros:
        gtagEvent.shader_compilation_duration_micros,
    traceEventCount: gtagEvent.trace_event_count,
    cpuSampleCount: gtagEvent.cpu_sample_count,
    cpuStackDepth: gtagEvent.cpu_stack_depth,
    heapDiffObjectsBefore: gtagEvent.heap_diff_objects_before,
    heapDiffObjectsAfter: gtagEvent.heap_diff_objects_after,
    heapObjectsTotal: gtagEvent.heap_objects_total,
    rootSetCount: gtagEvent.root_set_count,
    rowCount: gtagEvent.row_count,
    inspectorTreeControllerId: gtagEvent.inspector_tree_controller_id,
  );
}

ua.Event _uaEventFromGtagException(GtagExceptionDevTools gtagException) {
  return ua.Event.exception(
    exception: gtagException.description ?? 'unknown exception',
    data: {
      'fatal': gtagException.fatal,
      'userApp': gtagException.user_app,
      'userBuild': gtagException.user_build,
      'userPlatform': gtagException.user_platform,
      'devtoolsPlatform': gtagException.devtools_platform,
      'devtoolsChrome': gtagException.devtools_chrome,
      'devtoolsVersion': gtagException.devtools_version,
      'ideLaunched': gtagException.ide_launched,
      'isExternalBuild': gtagException.is_external_build,
      'isEmbedded': gtagException.is_embedded,
      'ideLaunchedFeature': gtagException.ide_launched_feature,
      'isWasm': gtagException.is_wasm,
      'g3Username': gtagException.g3_username,
      'uiDurationMicros': gtagException.ui_duration_micros,
      'rasterDurationMicros': gtagException.raster_duration_micros,
      'shaderCompilationDurationMicros':
          gtagException.shader_compilation_duration_micros,
      'traceEventCount': gtagException.trace_event_count,
      'cpuSampleCount': gtagException.cpu_sample_count,
      'cpuStackDepth': gtagException.cpu_stack_depth,
      'heapDiffObjectsBefore': gtagException.heap_diff_objects_before,
      'heapDiffObjectsAfter': gtagException.heap_diff_objects_after,
      'heapObjectsTotal': gtagException.heap_objects_total,
      'rootSetCount': gtagException.root_set_count,
      'rowCount': gtagException.row_count,
      'inspectorTreeControllerId': gtagException.inspector_tree_controller_id,
    },
  );
}