packages/devtools_app/lib/main.dart

// Copyright 2018 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.

import 'dart:async';
import 'package:html_shim/html.dart';

import 'package:devtools_app/src/framework/framework_core.dart';
import 'package:devtools_app/src/main.dart';
import 'package:devtools_app/src/ui/analytics.dart' as ga;
import 'package:devtools_app/src/ui/analytics_platform.dart' as ga_platform;
import 'package:platform_detect/platform_detect.dart';

void main() {
  // Run in a zone in order to catch all Dart exceptions.
  runZoned(
    () {
      // Initialize the core framework.
      FrameworkCore.init(window.location.toString());

      // Load the web app framework.
      final HtmlPerfToolFramework framework = HtmlPerfToolFramework();

      // Show the opt-in dialog for collection analytics?
      try {
        if (ga.isGtagsEnabled() &
            (!window.localStorage.containsKey(ga_platform.devToolsProperty()) ||
                window.localStorage[ga_platform.devToolsProperty()].isEmpty)) {
          framework.showAnalyticsDialog();
        }
      } catch (e) {
        // If there are errors setting up analytics, write them to the console
        // but do not prevent DevTools from loading.
        window.console.error(e);
      }

      if (!browser.isChrome) {
        final browserName =
            // Edge shows up as IE, so we replace it's name to avoid confusion.
            browser.isInternetExplorer || browser == Browser.UnknownBrowser
                ? 'an unsupported browser'
                : browser.name;
        framework.disableAppWithError(
          'ERROR: You are running DevTools on $browserName, '
              'but DevTools only runs on Chrome.',
          'Reopen this url in a Chrome browser to use DevTools.',
        );
        return;
      }

      // Show the Q3 DevTools survey.
      // TODO(kenz): do not show this survey again if a) an action has been
      // taken (survey link clicked or toast dismissed), b) we have shown it
      // 5 times without action, or c) the date is after ~ Oct 30th 2019. Data
      // required for a) and b) needs to be added to devtools_server.
      // ignore: dead_code
      if (false) {
        framework.surveyToast(_generateSurveyUrl());
      }

      FrameworkCore.initVmService(
        window.location.toString(),
        errorReporter: (String title, dynamic error) {
          framework.showError(title, error);
        },
      ).then((bool connected) {
        if (!connected) {
          framework.showConnectionDialog();
          framework.showSnapshotMessage();
          // Clear the main element so it stops displaying "Loading..."
          // TODO(jacobr): display a message explaining how to launch a Flutter
          // application from the command line and connect to it with DevTools.
          framework.mainElement.clear();
        }
      });

      framework.loadScreenFromLocation();
    },
    zoneSpecification: const ZoneSpecification(
      handleUncaughtError: _handleUncaughtError,
    ),
  );
}

String _generateSurveyUrl() {
  const clientIdKey = 'ClientId';
  const ideKey = 'IDE';
  const fromKey = 'From';
  const internalKey = 'Internal';

  final uri = Uri.parse(window.location.toString());

  // TODO(kenz): get client id once functionality is available.
  const clientId = '';

  String ideValue = uri.queryParameters[ga.ideLaunchedQuery] ?? '';
  ideValue = ideValue == '' ? 'CLI' : ideValue;

  final fromValue = uri.fragment ?? '';

  // TODO(djshuckerow): override this value for internal users.
  const internalValue = false;

  final surveyUri = Uri(
    scheme: 'https',
    host: 'google.qualtrics.com',
    path: 'jfe/form/SV_dcfOyXRTiB1qowl',
    queryParameters: {
      clientIdKey: clientId,
      ideKey: ideValue,
      fromKey: fromValue,
      internalKey: internalValue,
    },
  );
  return surveyUri.toString();
}

void _handleUncaughtError(
  Zone self,
  ZoneDelegate parent,
  Zone zone,
  Object error,
  StackTrace stackTrace,
) {
  // TODO(devoncarew): `stackTrace` always seems to be null.

  // Report exceptions with DevTools to GA; user's Flutter app exceptions are
  // not collected.
  ga.error('$error\n${stackTrace ?? ''}'.trim(), true);

  final Console console = window.console;

  // Also write them to the console to aid debugging.
  final errorLines = error.toString().split('\n');
  console.groupCollapsed(
      'DevTools exception: [${error.runtimeType}] ${errorLines.first}');
  console.log(errorLines.skip(1).join('\n'));

  if (stackTrace != null) {
    if (errorLines.length > 1) {
      console.log('\n');
    }
    console.log(stackTrace.toString().trim());
  }

  console.groupEnd();
}