[ddc] Adding extraDdcOptions forwarder to frontend server.

Markzipan · Commit Queue · commit 40bf581c79e0 · 2025-06-12T14:43:52.000-07:00
Change-Id: Ie2ee13b6089f4f24957e9865d6c2fd7296ed7c30 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/433261 Reviewed-by: Johnni Winther <johnniwinther@google.com> Commit-Queue: Mark Zhou <markzipan@google.com> Reviewed-by: Nicholas Shahan <nshahan@google.com>
diff --git a/pkg/dev_compiler/lib/src/command/command.dart b/pkg/dev_compiler/lib/src/command/command.dart
@@ -96,57 +96,7 @@ Future<CompilerResult> _compile(
   bool useIncrementalCompiler = false,
   Map<Uri, List<int>>? inputDigests,
 }) async {
-  // TODO(jmesserly): refactor options to share code with dartdevc CLI.
-  var argParser = ArgParser(allowTrailingOptions: true)
-    ..addFlag(
-      'help',
-      abbr: 'h',
-      help: 'Display this message.',
-      negatable: false,
-    )
-    ..addOption('packages', help: 'The package spec file to use.')
-    // TODO(jmesserly): is this still useful for us, or can we remove it now?
-    ..addFlag(
-      'summarize-text',
-      help: 'Emit API summary and AST in .js.txt and .ast.xml files.',
-      defaultsTo: false,
-      hide: true,
-    )
-    ..addFlag(
-      'track-widget-creation',
-      help: 'Enable inspecting of Flutter widgets.',
-      defaultsTo: false,
-      hide: true,
-    )
-    // TODO(jmesserly): add verbose help to show hidden options
-    ..addOption(
-      'dart-sdk-summary',
-      help: 'The path to the Dart SDK summary file.',
-      hide: true,
-    )
-    ..addMultiOption(
-      'multi-root',
-      help:
-          'The directories to search when encountering uris with the '
-          'specified multi-root scheme.',
-      defaultsTo: [Uri.base.path],
-    )
-    ..addFlag(
-      'compile-sdk',
-      help: 'Build an SDK module.',
-      defaultsTo: false,
-      hide: true,
-    )
-    ..addOption(
-      'libraries-file',
-      help: 'The path to the libraries.json file for the sdk.',
-    )
-    ..addOption(
-      'used-inputs-file',
-      help: 'If set, the file to record inputs used.',
-      hide: true,
-    );
-  Options.addArguments(argParser);
+  var argParser = Options.nonSdkArgParser();
   var declaredVariables = parseAndRemoveDeclaredVariables(args);
   ArgResults argResults;
   try {
diff --git a/pkg/dev_compiler/lib/src/command/options.dart b/pkg/dev_compiler/lib/src/command/options.dart
@@ -153,6 +153,9 @@ class Options {
         summaryModules: _parseCustomSummaryModules(
           args['summary'] as List<String>,
         ),
+        nonHotReloadablePackages: Set.from(
+          args['non-hot-reloadable-package'] as List<String>,
+        ),
         moduleFormats: parseModuleFormatOption(args),
         moduleName: _getModuleName(args),
         multiRootScheme: args['multi-root-scheme'] as String,
@@ -194,6 +197,14 @@ class Options {
             'API summary file(s) of imported libraries, optionally\n'
             'with module import path: -s path.dill=js/import/path',
       )
+      ..addMultiOption(
+        'non-hot-reloadable-package',
+        help:
+            'Specifies that a package should not be hot reloaded.\n'
+            'Hot reload will be rejected when any such package is modified. '
+            'This allows the compiler to emit these packages with better '
+            'performance.',
+      )
       ..addFlag(
         'summarize',
         help: 'Emit an API summary file.',
@@ -227,8 +238,8 @@ class Options {
         defaultsTo: false,
         hide: hide,
       )
-      // TODO(41852) Define a process for breaking changes before graduating
-      // from experimental.
+      // TODO(41852) Define a process for breaking changes before graduating from
+      // experimental.
       ..addFlag(
         'experimental-emit-debug-metadata',
         help:
@@ -368,6 +379,63 @@ class Options {
     // that build systems do not depend on passing windows-style paths here.
     return p.toUri(moduleName).toString();
   }
+
+  /// Returns an `ArgParser` for arguments compatible with non-SDK DDC
+  /// compilations.
+  static ArgParser nonSdkArgParser() {
+    // TODO(jmesserly): refactor options to share code with dartdevc CLI.
+    var argParser = ArgParser(allowTrailingOptions: true)
+      ..addFlag(
+        'help',
+        abbr: 'h',
+        help: 'Display this message.',
+        negatable: false,
+      )
+      ..addOption('packages', help: 'The package spec file to use.')
+      // TODO(jmesserly): is this still useful for us, or can we remove it now?
+      ..addFlag(
+        'summarize-text',
+        help: 'Emit API summary and AST in .js.txt and .ast.xml files.',
+        defaultsTo: false,
+        hide: true,
+      )
+      ..addFlag(
+        'track-widget-creation',
+        help: 'Enable inspecting of Flutter widgets.',
+        defaultsTo: false,
+        hide: true,
+      )
+      // TODO(jmesserly): add verbose help to show hidden options
+      ..addOption(
+        'dart-sdk-summary',
+        help: 'The path to the Dart SDK summary file.',
+        hide: true,
+      )
+      ..addMultiOption(
+        'multi-root',
+        help:
+            'The directories to search when encountering uris with the '
+            'specified multi-root scheme.',
+        defaultsTo: [Uri.base.path],
+      )
+      ..addFlag(
+        'compile-sdk',
+        help: 'Build an SDK module.',
+        defaultsTo: false,
+        hide: true,
+      )
+      ..addOption(
+        'libraries-file',
+        help: 'The path to the libraries.json file for the sdk.',
+      )
+      ..addOption(
+        'used-inputs-file',
+        help: 'If set, the file to record inputs used.',
+        hide: true,
+      );
+    Options.addArguments(argParser);
+    return argParser;
+  }
 }
 
 /// Finds explicit module names of the form `path=name` in [summaryPaths],
diff --git a/pkg/dev_compiler/lib/src/compiler/module_builder.dart b/pkg/dev_compiler/lib/src/compiler/module_builder.dart
@@ -13,20 +13,25 @@ import 'js_names.dart';
 /// The module format to emit.
 enum ModuleFormat {
   /// ECMAScript 6 module using import and export.
-  es6,
+  es6('es6'),
 
   /// CommonJS module (used in Node.js)
-  common,
+  common('common'),
 
   /// Asynchronous Module Definition (AMD, used in browsers).
-  amd,
+  amd('amd'),
 
   /// Dart Dev Compiler's own format.
-  ddc,
+  ddc('ddc'),
 
   // New version of ddc module system that will support hot reload.
   // TODO(nshahan) Eventually replace the existing `ddc` with this format.
-  ddcLibraryBundle,
+  ddcLibraryBundle('ddc');
+
+  const ModuleFormat(this.flagName);
+
+  /// The name of the module format passed to DDC's `--modules` flag.
+  final String flagName;
 }
 
 /// Parses a string into a [ModuleFormat].
diff --git a/pkg/frontend_server/lib/frontend_server.dart b/pkg/frontend_server/lib/frontend_server.dart
@@ -195,6 +195,14 @@ ArgParser argParser = new ArgParser(allowTrailingOptions: true)
   ..addMultiOption('enable-experiment',
       help: 'Comma separated list of experimental features, e.g. set-literals.',
       hide: true)
+  ..addMultiOption(
+    'extra-ddc-options',
+    help:
+        'A comma-separated list of additional command line arguments that will'
+        'be passed directly to DDC. Example: '
+        '"--extra-ddc-options=--canary".',
+    hide: true,
+  )
   ..addFlag('split-output-by-packages',
       help:
           'Split resulting kernel file into multiple files (one per package).',
@@ -694,9 +702,14 @@ class FrontendCompiler implements CompilerInterface {
       transformer?.transform(results.component!);
 
       if (_compilerOptions.target!.name == 'dartdevc') {
+        List<String>? extraDdcOptions = options.wasParsed('extra-ddc-options')
+            ? options.multiOption('extra-ddc-options')
+            : null;
         await writeJavaScriptBundle(results, _kernelBinaryFilename,
             options['filesystem-scheme'], options['dartdevc-module-format'],
-            fullComponent: true, recompileRestart: false);
+            fullComponent: true,
+            recompileRestart: false,
+            extraDdcOptions: extraDdcOptions);
       }
       await writeDillFile(
         results,
@@ -838,7 +851,9 @@ class FrontendCompiler implements CompilerInterface {
   /// `recompile-restart` request.
   Future<void> writeJavaScriptBundle(KernelCompilationResults results,
       String filename, String fileSystemScheme, String moduleFormat,
-      {required bool fullComponent, required bool recompileRestart}) async {
+      {required bool fullComponent,
+      required bool recompileRestart,
+      List<String>? extraDdcOptions}) async {
     PackageConfig packageConfig = await loadPackageConfigUri(
         _compilerOptions.packagesFileUri ??
             new File('.dart_tool/package_config.json').absolute.uri);
@@ -853,6 +868,7 @@ class FrontendCompiler implements CompilerInterface {
       emitDebugMetadata: emitDebugMetadata,
       moduleFormat: moduleFormat,
       canaryFeatures: canaryFeatures,
+      extraDdcOptions: extraDdcOptions ?? [],
     );
     if (fullComponent) {
       await bundler.initialize(component, _mainSource, packageConfig);
@@ -1048,9 +1064,14 @@ class FrontendCompiler implements CompilerInterface {
 
     if (_compilerOptions.target!.name == 'dartdevc') {
       try {
+        List<String>? extraDdcOptions = _options.wasParsed('extra-ddc-options')
+            ? _options.multiOption('extra-ddc-options')
+            : null;
         await writeJavaScriptBundle(results, _kernelBinaryFilename,
             _options['filesystem-scheme'], _options['dartdevc-module-format'],
-            fullComponent: false, recompileRestart: recompileRestart);
+            fullComponent: false,
+            recompileRestart: recompileRestart,
+            extraDdcOptions: extraDdcOptions);
       } catch (e) {
         _outputStream.writeln('$e');
         errors.add(e.toString());
diff --git a/pkg/frontend_server/lib/src/javascript_bundle.dart b/pkg/frontend_server/lib/src/javascript_bundle.dart
@@ -8,6 +8,7 @@ import 'dart:convert';
 import 'dart:io';
 import 'dart:typed_data';
 
+import 'package:args/args.dart';
 import 'package:dev_compiler/dev_compiler.dart';
 import 'package:dev_compiler/src/command/command.dart';
 import 'package:dev_compiler/src/kernel/hot_reload_delta_inspector.dart';
@@ -42,12 +43,14 @@ class IncrementalJavaScriptBundler {
     this.emitDebugSymbols = false,
     this.canaryFeatures = false,
     String? moduleFormat,
+    this.extraDdcOptions = const [],
   }) : _moduleFormat = parseModuleFormat(moduleFormat ?? 'amd');
 
   final bool useDebuggerModuleNames;
   final bool emitDebugMetadata;
   final bool emitDebugSymbols;
   final ModuleFormat _moduleFormat;
+  final List<String> extraDdcOptions;
   final bool canaryFeatures;
   final FileSystem? _fileSystem;
   final Set<Library> _loadedLibraries;
@@ -185,6 +188,20 @@ class IncrementalJavaScriptBundler {
     }
   }
 
+  /// Reports if [option] in [extraDdcOptions] was overridden or extended
+  /// to [newValue] before being passed to DDC.
+  void _checkOverriddenExtraDdcOption(
+      ArgResults extraDdcOptionsResults, String option, dynamic newValue) {
+    if (extraDdcOptionsResults.wasParsed(option)) {
+      if (newValue is List) {
+        if (listEquals(extraDdcOptionsResults[option], newValue)) return;
+      } else if (newValue == extraDdcOptionsResults[option]) {
+        return;
+      }
+      print("Warning: DDC option '$option' was overridden to '$newValue'.");
+    }
+  }
+
   /// Compile each component into a single JavaScript library bundle.
   Future<Map<String, Compiler>> compile(
     ClassHierarchy classHierarchy,
@@ -221,18 +238,42 @@ class IncrementalJavaScriptBundler {
 
       final String componentUrl =
           urlForComponentUri(libraryBundleImport, packageConfig);
-      // library bundle name to use in trackLibraries
-      // use full path for tracking if library bundle uri is not a package uri.
+      // Library bundle name to use in trackLibraries. Use the full path for
+      // tracking if library bundle uri is not a package uri.
       final String libraryBundleName = makeLibraryBundleName(componentUrl);
-      final Options ddcOptions = new Options(
-        sourceMap: true,
-        summarizeApi: false,
-        emitDebugMetadata: emitDebugMetadata,
-        emitDebugSymbols: emitDebugSymbols,
-        moduleName: libraryBundleName,
-        canaryFeatures: canaryFeatures,
-        moduleFormats: [_moduleFormat],
-      );
+      // Issue a warning when provided [extraDdcOptions] were overridden.
+      final ArgResults extraDdcOptionsResults =
+          Options.nonSdkArgParser().parse(extraDdcOptions);
+      _checkOverriddenExtraDdcOption(
+          extraDdcOptionsResults, 'source-map', true);
+      _checkOverriddenExtraDdcOption(
+          extraDdcOptionsResults, 'summarize', false);
+      _checkOverriddenExtraDdcOption(extraDdcOptionsResults,
+          'experimental-emit-debug-metadata', emitDebugMetadata);
+      _checkOverriddenExtraDdcOption(
+          extraDdcOptionsResults, 'emit-debug-symbols', emitDebugSymbols);
+      _checkOverriddenExtraDdcOption(
+          extraDdcOptionsResults, 'canary', canaryFeatures);
+      _checkOverriddenExtraDdcOption(
+          extraDdcOptionsResults, 'module-name', libraryBundleName);
+      _checkOverriddenExtraDdcOption(
+          extraDdcOptionsResults, 'modules', [libraryBundleName]);
+      // Apply existing Frontend Server flags over options selected in
+      // [extraDdcOptions].
+      final List<String> ddcArgs = [
+        ...extraDdcOptions,
+        '--source-map',
+        '--no-summarize',
+        emitDebugMetadata
+            ? '--experimental-emit-debug-metadata'
+            : '--no-experimental-emit-debug-metadata',
+        emitDebugSymbols ? '--emit-debug-symbols' : '--no-emit-debug-symbols',
+        canaryFeatures ? '--canary' : '--no-canary',
+        '--module-name=$libraryBundleName',
+        '--modules=${_moduleFormat.flagName}',
+      ];
+      final Options ddcOptions =
+          new Options.fromArguments(Options.nonSdkArgParser().parse(ddcArgs));
       Compiler compiler;
       if (ddcOptions.emitLibraryBundle) {
         compiler = new LibraryBundleCompiler(
