Keep only changes related to SDK paths update

Author: Anna Gringauze

dwds/CHANGELOG.md

@@ -24,12 +24,6 @@
 - Include an optional param to `Dwds.start` to indicate whether it a Flutter
   app or not.
 - Remove deprecated `ChromeProxyService.setExceptionPauseMode()`.
-- Refactor `SdkConfiguration`:
-  - Constructor now takes `SdkLayout` as a parameter.
-  - Rename `SdkConfiguration.unsoundSdkSummaryPath` with
-    `SdkConfiguration.weakSummaryPath`.
-  - Rename `SdkConfiguration.soundSdkSummaryPath` with
-    `SdkConfiguration.soundSummaryPath`.
 - Support dart 3.0-alpha breaking changes:
   - Generate missing SDK assets for tests.
   - Enable frontend server null safe tests.

dwds/debug_extension/pubspec.yaml

@@ -6,7 +6,7 @@ description: >-
   A chrome extension for Dart debugging.
 
 environment:
-  sdk: '>=2.12.0 <3.0.0'
+  sdk: '>=3.0.0-134.0.dev <3.0.0'
 
 dependencies:
   async: ^2.3.0

dwds/debug_extension_mv3/pubspec.yaml

@@ -6,7 +6,7 @@ description: >-
   A Chrome extension for Dart debugging.
 
 environment:
-  sdk: '>=2.18.0 <3.0.0'
+  sdk: '>=3.0.0-134.0.dev <3.0.0'
 
 dependencies:
   built_value: ^8.3.0

dwds/lib/dwds.dart

@@ -29,5 +29,4 @@ export 'src/services/expression_compiler.dart'
 export 'src/services/expression_compiler_service.dart'
     show ExpressionCompilerService;
 export 'src/utilities/sdk_configuration.dart'
-    show SdkConfiguration, SdkConfigurationProvider;
-export 'src/utilities/sdk_layout.dart' show SdkLayout;
+    show SdkLayout, SdkConfiguration, SdkConfigurationProvider;

dwds/lib/sdk_configuration.dart

@@ -76,8 +76,8 @@ class _Compiler {
     final librariesUri = sdkConfiguration.librariesUri!;
     final workerUri = sdkConfiguration.compilerWorkerUri!;
     final sdkSummaryUri = soundNullSafety
-        ? sdkConfiguration.soundSummaryUri!
-        : sdkConfiguration.weakSummaryUri!;
+        ? sdkConfiguration.soundSdkSummaryUri!
+        : sdkConfiguration.weakSdkSummaryUri!;
 
     final args = [
       '--experimental-expression-compiler',

dwds/lib/src/injected/client.js

@@ -3,13 +3,12 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'dart:async';
+import 'dart:io';
 
 import 'package:file/file.dart';
 import 'package:file/local.dart';
 import 'package:path/path.dart' as p;
 
-import 'sdk_layout.dart';
-
 class InvalidSdkConfigurationException implements Exception {
   final String? message;
 
@@ -33,36 +32,164 @@ abstract class SdkConfigurationProvider {
   Future<SdkConfiguration> get configuration;
 }
 
-/// SDK configuration.
+/// Sdk layout.
+///
+/// Contains definition of the default SDK layout.
+/// We keep all the path constants in one place for ease of update.
+class SdkLayout {
+  static final sdkDir = p.dirname(p.dirname(Platform.resolvedExecutable));
+  static final defaultSdkLayout = createDefault(sdkDir);
+
+  static SdkLayout createDefault(String sdkDirectory) {
+    final sdkJsWeakFileName = 'dart_sdk.js';
+    final sdkJsMapWeakFileName = 'dart_sdk.js.map';
+    final sdkJsSoundFileName = 'dart_sdk_sound.js';
+    final sdkJsMapSoundFileName = 'dart_sdk_sound.js.map';
+    final sdkSummarySoundFileName = 'ddc_outline.dill';
+    final sdkSummaryWeakFileName = 'ddc_outline_unsound.dill';
+    final sdkFullDillSoundFileName = 'ddc_platform.dill';
+    final sdkFullDillWeakFileName = 'ddc_platform_unsound.dill';
+
+    final sdkSummaryDirectory = p.join(sdkDirectory, 'lib', '_internal');
+    final sdkJsDirectory =
+        p.join(sdkDirectory, 'lib', 'dev_compiler', 'kernel', 'amd');
+
+    final soundSummaryPath =
+        p.join(sdkSummaryDirectory, sdkSummarySoundFileName);
+    final soundFullDillPath =
+        p.join(sdkSummaryDirectory, sdkFullDillSoundFileName);
+    final soundJsPath = p.join(sdkJsDirectory, sdkJsSoundFileName);
+    final soundJsMapPath = p.join(sdkJsDirectory, sdkJsMapSoundFileName);
+
+    final weakSummaryPath = p.join(sdkSummaryDirectory, sdkSummaryWeakFileName);
+    final weakFullDillPath =
+        p.join(sdkSummaryDirectory, sdkFullDillWeakFileName);
+    final weakJsPath = p.join(sdkJsDirectory, sdkJsWeakFileName);
+    final weakJsMapPath = p.join(sdkJsDirectory, sdkJsMapWeakFileName);
+
+    final librariesPath = p.join(sdkDirectory, 'lib', 'libraries.json');
+    final dartdevcSnapshotPath =
+        p.join(sdkDirectory, 'bin', 'snapshots', 'dartdevc.dart.snapshot');
+    final kernelWorkerSnapshotPath =
+        p.join(sdkDirectory, 'bin', 'snapshots', 'kernel_worker.dart.snapshot');
+
+    return SdkLayout(
+      sdkJsWeakFileName: sdkJsWeakFileName,
+      sdkJsMapWeakFileName: sdkJsMapWeakFileName,
+      sdkJsSoundFileName: sdkJsSoundFileName,
+      sdkJsMapSoundFileName: sdkJsMapSoundFileName,
+      sdkSummarySoundFileName: sdkSummarySoundFileName,
+      sdkSummaryWeakFileName: sdkSummaryWeakFileName,
+      sdkFullDillSoundFileName: sdkFullDillSoundFileName,
+      sdkFullDillWeakFileName: sdkFullDillWeakFileName,
+      sdkDirectory: sdkDirectory,
+      soundSummaryPath: soundSummaryPath,
+      soundFullDillPath: soundFullDillPath,
+      soundJsPath: soundJsPath,
+      soundJsMapPath: soundJsMapPath,
+      weakSummaryPath: weakSummaryPath,
+      weakFullDillPath: weakFullDillPath,
+      weakJsPath: weakJsPath,
+      weakJsMapPath: weakJsMapPath,
+      librariesPath: librariesPath,
+      dartdevcSnapshotPath: dartdevcSnapshotPath,
+      kernelWorkerSnapshotPath: kernelWorkerSnapshotPath,
+    );
+  }
+
+  final String sdkJsWeakFileName;
+  final String sdkJsMapWeakFileName;
+  final String sdkJsSoundFileName;
+  final String sdkJsMapSoundFileName;
+  final String sdkSummarySoundFileName;
+  final String sdkSummaryWeakFileName;
+  final String sdkFullDillSoundFileName;
+  final String sdkFullDillWeakFileName;
+
+  final String sdkDirectory;
+
+  final String soundSummaryPath;
+  final String soundFullDillPath;
+  final String soundJsPath;
+  final String soundJsMapPath;
+
+  final String weakSummaryPath;
+  final String weakFullDillPath;
+  final String weakJsPath;
+  final String weakJsMapPath;
+
+  final String librariesPath;
+
+  final String dartdevcSnapshotPath;
+  final String kernelWorkerSnapshotPath;
+
+  SdkLayout({
+    required this.sdkJsWeakFileName,
+    required this.sdkJsMapWeakFileName,
+    required this.sdkJsSoundFileName,
+    required this.sdkJsMapSoundFileName,
+    required this.sdkSummarySoundFileName,
+    required this.sdkSummaryWeakFileName,
+    required this.sdkFullDillSoundFileName,
+    required this.sdkFullDillWeakFileName,
+    required this.sdkDirectory,
+    required this.soundSummaryPath,
+    required this.soundFullDillPath,
+    required this.soundJsPath,
+    required this.soundJsMapPath,
+    required this.weakSummaryPath,
+    required this.weakFullDillPath,
+    required this.weakJsPath,
+    required this.weakJsMapPath,
+    required this.librariesPath,
+    required this.dartdevcSnapshotPath,
+    required this.kernelWorkerSnapshotPath,
+  });
+}
+
+/// Data class describing the SDK layout.
 ///
 /// Provides helpers to convert paths to uris that work on all platforms.
 ///
 /// Call [validate] method to make sure the files in the configuration
 /// layout exist before reading the files.
 class SdkConfiguration {
   static final defaultSdkLayout = SdkLayout.defaultSdkLayout;
-  static final defaultConfiguration = SdkConfiguration(defaultSdkLayout);
+  static final defaultConfiguration =
+      SdkConfiguration.fromSdkLayout(defaultSdkLayout);
 
-  SdkLayout? sdkLayout;
+  String? sdkDirectory;
+  String? weakSdkSummaryPath;
+  String? soundSdkSummaryPath;
+  String? librariesPath;
+  String? compilerWorkerPath;
 
-  SdkConfiguration(this.sdkLayout);
+  SdkConfiguration({
+    this.sdkDirectory,
+    this.weakSdkSummaryPath,
+    this.soundSdkSummaryPath,
+    this.librariesPath,
+    this.compilerWorkerPath,
+  });
 
-  SdkConfiguration.empty() : this(null);
+  SdkConfiguration.empty() : this();
+
+  SdkConfiguration.fromSdkLayout(SdkLayout sdkLayout)
+      : this(
+          sdkDirectory: sdkLayout.sdkDirectory,
+          weakSdkSummaryPath: sdkLayout.weakSummaryPath,
+          soundSdkSummaryPath: sdkLayout.soundSummaryPath,
+          librariesPath: sdkLayout.librariesPath,
+          compilerWorkerPath: sdkLayout.dartdevcSnapshotPath,
+        );
 
   static Uri? _toUri(String? path) => path == null ? null : p.toUri(path);
   static Uri? _toAbsoluteUri(String? path) =>
       path == null ? null : p.toUri(p.absolute(path));
 
-  String get dartPath => sdkLayout!.dartPath;
-  String? get sdkDirectory => sdkLayout?.sdkDirectory;
-  String? get soundSummaryPath => sdkLayout?.soundSummaryPath;
-  String? get weakSummaryPath => sdkLayout?.weakSummaryPath;
-  String? get librariesPath => sdkLayout?.librariesPath;
-  String? get compilerWorkerPath => sdkLayout?.dartdevcSnapshotPath;
-
   Uri? get sdkDirectoryUri => _toUri(sdkDirectory);
-  Uri? get soundSummaryUri => _toUri(soundSummaryPath);
-  Uri? get weakSummaryUri => _toUri(weakSummaryPath);
+  Uri? get soundSdkSummaryUri => _toUri(soundSdkSummaryPath);
+  Uri? get weakSdkSummaryUri => _toUri(weakSdkSummaryPath);
   Uri? get librariesUri => _toUri(librariesPath);
 
   /// Note: has to be ///file: Uri to run in an isolate.
@@ -72,7 +199,6 @@ class SdkConfiguration {
   /// exist on disk.
   void validate({FileSystem fileSystem = const LocalFileSystem()}) {
     validateSdkDir(fileSystem: fileSystem);
-    validateDartExecutable(fileSystem: fileSystem);
     validateSummaries(fileSystem: fileSystem);
     validateLibrariesSpec(fileSystem: fileSystem);
     validateCompilerWorker(fileSystem: fileSystem);
@@ -88,36 +214,26 @@ class SdkConfiguration {
     }
   }
 
-  /// Throws [InvalidSdkConfigurationException] if SDK root does not
-  /// exist on the disk.
-  void validateDartExecutable(
-      {FileSystem fileSystem = const LocalFileSystem()}) {
-    if (!fileSystem.file(dartPath).existsSync()) {
-      throw InvalidSdkConfigurationException(
-          'Dart executable $dartPath does not exist');
-    }
-  }
-
   void validateSummaries({FileSystem fileSystem = const LocalFileSystem()}) {
     validateSoundSummaries(fileSystem: fileSystem);
     validateWeakSummaries(fileSystem: fileSystem);
   }
 
   void validateWeakSummaries(
       {FileSystem fileSystem = const LocalFileSystem()}) {
-    if (weakSummaryPath == null ||
-        !fileSystem.file(weakSummaryPath).existsSync()) {
+    if (weakSdkSummaryPath == null ||
+        !fileSystem.file(weakSdkSummaryPath).existsSync()) {
       throw InvalidSdkConfigurationException(
-          'Sdk summary $weakSummaryPath does not exist');
+          'Sdk summary $weakSdkSummaryPath does not exist');
     }
   }
 
   void validateSoundSummaries(
       {FileSystem fileSystem = const LocalFileSystem()}) {
-    if ((soundSummaryPath == null ||
-        !fileSystem.file(soundSummaryPath).existsSync())) {
+    if ((soundSdkSummaryPath == null ||
+        !fileSystem.file(soundSdkSummaryPath).existsSync())) {
       throw InvalidSdkConfigurationException(
-          'Sdk summary $soundSummaryPath does not exist');
+          'Sdk summary $soundSdkSummaryPath does not exist');
     }
   }