packages/flutter_tools/lib/src/reporting/github_template.dart - master - magnusroot/flutter

packages/flutter_tools/lib/src/reporting/github_template.dart
224 строки7 KB
Moritz
Remove some refs to package:intl (#188504)
29 июн 2026, 10:50
29 июн 2026, 10:5053f3cb3
// Copyright 2014 The Flutter 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:file/file.dart';

import '../base/file_system.dart';
import '../base/io.dart';
import '../base/logger.dart';
import '../base/process.dart';
import '../build_system/exceptions.dart';
import '../convert.dart';
import '../devfs.dart';
import '../flutter_manifest.dart';
import '../flutter_project_metadata.dart';
import '../project.dart';
import '../version.dart';

/// Provide suggested GitHub issue templates to user when Flutter encounters an error.
class GitHubTemplateCreator {
  GitHubTemplateCreator({
    required FileSystem fileSystem,
    required Logger logger,
    required FlutterProjectFactory flutterProjectFactory,
  }) : _fileSystem = fileSystem,
       _logger = logger,
       _flutterProjectFactory = flutterProjectFactory;

  final FileSystem _fileSystem;
  final Logger _logger;
  final FlutterProjectFactory _flutterProjectFactory;

  static String toolCrashSimilarIssuesURL(String errorString) {
    return 'https://github.com/flutter/flutter/issues?q=is%3Aissue+${Uri.encodeQueryComponent(errorString)}';
  }

  /// Restricts exception object strings to contain only information about tool internals.
  static String sanitizedCrashException(Object error) {
    if (error is ProcessException) {
      // Suppress args.
      return 'ProcessException: ${error.message} Command: ${error.executable}, OS error code: ${error.errorCode}';
    } else if (error is FileSystemException) {
      // Suppress path.
      return 'FileSystemException: ${error.message}, ${error.osError}';
    } else if (error is SocketException) {
      // Suppress address and port.
      return 'SocketException: ${error.message}, ${error.osError}';
    } else if (error is DevFSException) {
      // Suppress underlying error.
      return 'DevFSException: ${error.message}';
    } else if (error is NoSuchMethodError ||
        error is ArgumentError ||
        error is VersionCheckError ||
        error is MissingDefineException ||
        error is UnsupportedError ||
        error is UnimplementedError ||
        error is StateError ||
        error is ProcessExit ||
        error is OSError) {
      // These exception objects only reference tool internals, print the whole error.
      return '${error.runtimeType}: $error';
    } else if (error is Error) {
      return '${error.runtimeType}: ${LineSplitter.split(error.stackTrace.toString()).take(1)}';
    } else if (error is String) {
      // Force comma separator to standardize.
      final String buffer = _asCommaSeparatedNumber(error.length);

      return 'String: <$buffer characters>';
    }
    // Tool crash issue templates benefit from the concrete Dart error type.
    // The tool is not obfuscated, and collapsing unknown types loses useful signal.
    // ignore: avoid_type_to_string
    return error.runtimeType.toString();
  }

  /// Insert a comma every three digits in a number.
  static String _asCommaSeparatedNumber(int number) {
    assert(number >= 0);
    final numberStr = number.toString();
    final buffer = StringBuffer();
    final int length = numberStr.length;
    buffer.write(numberStr[0]);

    for (var i = 1; i < length; i++) {
      if ((length - i) % 3 == 0) {
        buffer.write(',');
      }
      buffer.write(numberStr[i]);
    }
    return buffer.toString();
  }

  /// GitHub URL to present to the user containing encoded suggested template.
  ///
  /// Shorten the URL, if possible.
  Future<String> toolCrashIssueTemplateGitHubURL(
    String command,
    Object error,
    StackTrace stackTrace,
    String doctorText,
  ) async {
    final String errorString = sanitizedCrashException(error);
    final title = '[tool_crash] $errorString';
    final body =
        '''
## Command
```sh
$command
```

## Steps to Reproduce
1. ...
2. ...
3. ...

## Logs
$errorString
```console
${LineSplitter.split(stackTrace.toString()).take(25).join('\n')}
```
```console
$doctorText
```

## Flutter Application Metadata
${_projectMetadataInformation()}
''';

    return 'https://github.com/flutter/flutter/issues'
        '/new' // We split this here to appease our lint that looks for bad "new bug" links.
        '?title=${Uri.encodeQueryComponent(title)}'
        '&body=${Uri.encodeQueryComponent(body)}'
        '&labels=${Uri.encodeQueryComponent('tool,severe: crash')}';
  }

  /// Provide information about the Flutter project in the working directory, if present.
  String _projectMetadataInformation() {
    FlutterProject project;
    try {
      project = _flutterProjectFactory.fromDirectory(_fileSystem.currentDirectory);
    } on Exception catch (exception) {
      // pubspec may be malformed.
      return exception.toString();
    }
    try {
      final FlutterManifest manifest = project.manifest;
      if (manifest.isEmpty) {
        return 'No pubspec in working directory.';
      }
      final metadata = FlutterProjectMetadata(project.metadataFile, _logger);
      final FlutterTemplateType? projectType = metadata.projectType;
      final description = StringBuffer()
        ..writeln('**Type**: ${projectType == null ? 'malformed' : projectType.cliName}')
        ..writeln('**Version**: ${manifest.appVersion}')
        ..writeln('**Material**: ${manifest.usesMaterialDesign}')
        ..writeln('**Android X**: ${manifest.usesAndroidX}')
        ..writeln('**Module**: ${manifest.isModule}')
        ..writeln('**Plugin**: ${manifest.isPlugin}')
        ..writeln('**Android package**: ${manifest.androidPackage}')
        ..writeln('**iOS bundle identifier**: ${manifest.iosBundleIdentifier}')
        ..writeln('**Creation channel**: ${metadata.versionChannel}')
        ..writeln('**Creation framework version**: ${metadata.versionRevision}');

      final File file = project.flutterPluginsDependenciesFile;
      if (file.existsSync()) {
        _writePlugins(description, file);
      }
      return description.toString();
    } on Exception catch (exception) {
      return exception.toString();
    }
  }

  void _writePlugins(StringBuffer description, File file) {
    description.writeln('### Plugins');
    // Format is:
    // {
    //   "plugins": {
    //     "ios": [
    //       {
    //         "path": "/path/to/.pub-cache/hosted/pub.dartlang.org/camera-0.5.7+2/",
    //       }
    //     ]
    //   }
    // }
    final Object? json = jsonDecode(file.readAsStringSync());
    if (json is! Map<String, Object?>) {
      return;
    }
    final Object? plugins = json['plugins'];
    if (plugins is! Map<String, Object?>) {
      return;
    }
    final pluginPaths = <String>{};
    for (final Object? pluginList in plugins.values) {
      if (pluginList is! List<Object?>) {
        continue;
      }
      for (final Object? plugin in pluginList) {
        if (plugin is! Map<String, Object?>) {
          continue;
        }
        final path = plugin['path'] as String?;
        if (path != null) {
          pluginPaths.add(path);
        }
      }
    }
    if (pluginPaths.isEmpty) {
      return;
    }
    for (final path in pluginPaths) {
      // Write the last part of the path, which includes the plugin name and version.
      // Example: camera-0.5.7+2
      final List<String> pathParts = _fileSystem.path.split(path);
      if (pathParts.isEmpty) {
        continue;
      }
      description.writeln(pathParts.last);
    }
  }
}