Support optional packageUri (#148)

* Support optional packageUri * Fix changelog and pubspec.yaml version
dart-lang · Aug 22, 2023 · e5ce42a · e5ce42a
1 parent 1c46390
commit e5ce42a
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 15 deletions.
diff --git a/pkgs/extension_discovery/CHANGELOG.md b/pkgs/extension_discovery/CHANGELOG.md
@@ -1,8 +1,7 @@
-## 1.0.2-wip
-- Improve error messaging for `package_config.json` parsing.
-
 ## 1.0.1-wip
 
+- Support optional `packageUri`.
+- Improve error messaging for `package_config.json` parsing.
 - Update the package description.
 
 ## 1.0.0

diff --git a/pkgs/extension_discovery/lib/src/expect_json.dart b/pkgs/extension_discovery/lib/src/expect_json.dart
@@ -34,6 +34,13 @@ extension ExpectJson on Map<String, Object?> {
     }
   }
 
+  Uri? optionalUri(String key) {
+    if (containsKey(key)) {
+      return expectUri(key);
+    }
+    return null;
+  }
+
   List<Object?> expectList(String key) {
     if (this[key] case List<Object?> v) return v;
     throw FormatException('The value at "$key" must be a list:\n$toString()');

diff --git a/pkgs/extension_discovery/lib/src/package_config.dart b/pkgs/extension_discovery/lib/src/package_config.dart
@@ -18,14 +18,14 @@ Future<PackageConfig> loadPackageConfig(
     if (packageConfig.expectNumber('configVersion') != 2) {
       throw FormatException('"configVersion" must be 2');
     }
-    return packageConfig
-        .expectListObjects('packages')
-        .map((p) => (
-              name: p.expectString('name'),
-              rootUri: p.expectUri('rootUri').asDirectory(),
-              packageUri: p.expectUri('packageUri').asDirectory(),
-            ))
-        .toList();
+    return packageConfig.expectListObjects('packages').map((p) {
+      final rootUri = p.expectUri('rootUri').asDirectory();
+      return (
+        name: p.expectString('name'),
+        rootUri: rootUri,
+        packageUri: p.optionalUri('packageUri')?.asDirectory() ?? rootUri,
+      );
+    }).toList();
   } on IOException catch (e) {
     if (!packageConfigFile.existsSync()) {
       throw packageConfigNotFound(packageConfigFile.uri);

diff --git a/pkgs/extension_discovery/pubspec.yaml b/pkgs/extension_discovery/pubspec.yaml
@@ -1,7 +1,7 @@
 name: extension_discovery
 description: >-
   A convention and utilities for package extension discovery.
-version: 1.0.2-wip
+version: 1.0.1-wip
 repository: https://github.com/dart-lang/tools/tree/main/pkgs/extension_discovery
 
 dev_dependencies:

diff --git a/pkgs/extension_discovery/test/package_config_test.dart b/pkgs/extension_discovery/test/package_config_test.dart
@@ -105,9 +105,53 @@ void main() {
 
     // ################################## Cannot read version 99
 
-    final pkgcfg = jsonDecode(packageConfigFile.readAsStringSync()) as Map;
-    pkgcfg['configVersion'] = 99;
-    packageConfigFile.writeAsStringSync(jsonEncode(pkgcfg));
+    {
+      final pkgcfg = jsonDecode(packageConfigFile.readAsStringSync()) as Map;
+      pkgcfg['configVersion'] = 99;
+      packageConfigFile.writeAsStringSync(jsonEncode(pkgcfg));
+    }
+
+    // Loading before `dart pub get` throws PackageConfigException
+    expect(
+      loadPackageConfig(packageConfigFile),
+      throwsA(isA<PackageConfigException>()),
+    );
+
+    // ################################## packageUri is optional
+
+    // Get dependencies
+    await d.dartPubGet(d.path('myapp'));
+
+    {
+      final pkgcfg = jsonDecode(packageConfigFile.readAsStringSync()) as Map;
+      for (final p in pkgcfg['packages'] as List) {
+        (p as Map).remove('packageUri');
+      }
+      packageConfigFile.writeAsStringSync(jsonEncode(pkgcfg));
+    }
+
+    // Parse package_config
+    {
+      final packages = await loadPackageConfig(packageConfigFile);
+      expect(packages, isNotEmpty);
+      expect(packages.any((p) => p.name == 'myapp'), isTrue);
+      expect(packages.any((p) => p.name == 'foo'), isTrue);
+      expect(packages.any((p) => p.name == 'bar'), isTrue);
+      expect(packages.every((p) => p.rootUri == p.packageUri), isTrue);
+    }
+
+    // ################################## packageUri is optional
+
+    // Get dependencies
+    await d.dartPubGet(d.path('myapp'));
+
+    {
+      final pkgcfg = jsonDecode(packageConfigFile.readAsStringSync()) as Map;
+      for (final p in pkgcfg['packages'] as List) {
+        (p as Map).remove('rootUri');
+      }
+      packageConfigFile.writeAsStringSync(jsonEncode(pkgcfg));
+    }
 
     // Loading before `dart pub get` throws PackageConfigException
     expect(