From 117e05ea88189140d0c0e4a7c754890f2737a87c Mon Sep 17 00:00:00 2001 From: "Lasse R.H. Nielsen" Date: Thu, 6 Mar 2025 16:08:14 +0100 Subject: [PATCH 1/2] Remove uspport for `.packages` files. Simplify (braking) API which no longer needs to support two files. Since this is breaking anyway, add `final` to classes, and make comparison operators on `LanguageVersion` instance methods. Add tool to query package configuration for a file or directory: `bin/package_config_of.dart`. --- pkgs/package_config/CHANGELOG.md | 24 +- pkgs/package_config/README.md | 5 +- pkgs/package_config/lib/package_config.dart | 62 +- .../lib/package_config_types.dart | 1 - pkgs/package_config/lib/src/discovery.dart | 34 +- .../lib/src/package_config.dart | 700 ++++++++++++++++-- .../lib/src/package_config_impl.dart | 568 -------------- .../lib/src/package_config_io.dart | 91 +-- .../lib/src/package_config_json.dart | 24 +- .../package_config/lib/src/packages_file.dart | 193 ----- pkgs/package_config/pubspec.yaml | 4 +- pkgs/package_config/test/discovery_test.dart | 133 +--- .../test/discovery_uri_test.dart | 113 +-- pkgs/package_config/test/parse_test.dart | 64 -- 14 files changed, 749 insertions(+), 1267 deletions(-) delete mode 100644 pkgs/package_config/lib/src/package_config_impl.dart delete mode 100644 pkgs/package_config/lib/src/packages_file.dart diff --git a/pkgs/package_config/CHANGELOG.md b/pkgs/package_config/CHANGELOG.md index ac3be0449..db5070783 100644 --- a/pkgs/package_config/CHANGELOG.md +++ b/pkgs/package_config/CHANGELOG.md @@ -1,10 +1,24 @@ -## 2.2.0-wip +## 3.0.0 -- Add relational operators to `LanguageVersion` with extension methods - exported under `LanguageVersionRelationalOperators`. +- Removes support for the `.packages` file. + The Dart SDK no longer supports that file, and no new `.packages` files + will be generated. -- Include correct parameter names in errors when validating - the `major` and `minor` versions in the `LanguageVersion.new` constructor. +- **Breaking change** + Simplifies API that no longer needs to support two separate files. + - Renamed `readAnyConfigFile` to `readConfigFile`, and removed + the `preferNewest` parameter. + - Same for `readAnyConfigFileUri` which becomes `readConfigFileUri`. + + Also makes `PackageConfig`, `Package` and `LanguageVersion` final classes. + +- Adds `PackageConfig.minVersion` to complement `.maxVersion`. + Currently both are `2`. + +- Adds relational operators to `LanguageVersion`. + +- Includes correct parameter names in errors when validating + the `major` and `minor` versions in the `LanguageVersion()` constructor. ## 2.1.1 diff --git a/pkgs/package_config/README.md b/pkgs/package_config/README.md index 76fd3cbed..4e3f0b0c7 100644 --- a/pkgs/package_config/README.md +++ b/pkgs/package_config/README.md @@ -21,6 +21,5 @@ The primary libraries of this package are Just the `PackageConfig` class and other types needed to use package configurations. This library does not depend on `dart:io`. -The package includes deprecated backwards compatible functionality to -work with the `.packages` file. This functionality will not be maintained, -and will be removed in a future version of this package. +The package no longer contains backwards compatible functionality to +work with `.packages` files. diff --git a/pkgs/package_config/lib/package_config.dart b/pkgs/package_config/lib/package_config.dart index 074c97707..0c01d6d24 100644 --- a/pkgs/package_config/lib/package_config.dart +++ b/pkgs/package_config/lib/package_config.dart @@ -21,20 +21,7 @@ export 'package_config_types.dart'; /// Reads a specific package configuration file. /// -/// The file must exist and be readable. -/// It must be either a valid `package_config.json` file -/// or a valid `.packages` file. -/// It is considered a `package_config.json` file if its first character -/// is a `{`. -/// -/// If the file is a `.packages` file (the file name is `.packages`) -/// and [preferNewest] is true, the default, also checks if there is -/// a `.dart_tool/package_config.json` file next -/// to the original file, and if so, loads that instead. -/// If [preferNewest] is set to false, a directly specified `.packages` file -/// is loaded even if there is an available `package_config.json` file. -/// The caller can determine this from the [PackageConfig.version] -/// being 1 and look for a `package_config.json` file themselves. +/// The file must exist, be readable and be a valid `package_config.json` file. /// /// If [onError] is provided, the configuration file parsing will report errors /// by calling that function, and then try to recover. @@ -42,26 +29,19 @@ export 'package_config_types.dart'; /// a valid configuration from the invalid configuration file. /// If no [onError] is provided, errors are thrown immediately. Future loadPackageConfig(File file, + {void Function(Object error)? onError}) => + readConfigFile(file, onError ?? throwError); + +/// @nodoc +@Deprecated('use loadPackageConfig instead') +Future loadAnyPackageConfig(File file, {bool preferNewest = true, void Function(Object error)? onError}) => - readAnyConfigFile(file, preferNewest, onError ?? throwError); + loadPackageConfig(file, onError: onError); /// Reads a specific package configuration URI. /// -/// The file of the URI must exist and be readable. -/// It must be either a valid `package_config.json` file -/// or a valid `.packages` file. -/// It is considered a `package_config.json` file if its first -/// non-whitespace character is a `{`. -/// -/// If [preferNewest] is true, the default, and the file is a `.packages` file, -/// as determined by its file name being `.packages`, -/// first checks if there is a `.dart_tool/package_config.json` file -/// next to the original file, and if so, loads that instead. -/// The [file] *must not* be a `package:` URI. -/// If [preferNewest] is set to false, a directly specified `.packages` file -/// is loaded even if there is an available `package_config.json` file. -/// The caller can determine this from the [PackageConfig.version] -/// being 1 and look for a `package_config.json` file themselves. +/// The file of the URI must exist, be readable, +/// and be a valid `package_config.json` file. /// /// If [loader] is provided, URIs are loaded using that function. /// The future returned by the loader must complete with a [Uint8List] @@ -88,15 +68,19 @@ Future loadPackageConfig(File file, /// If no [onError] is provided, errors are thrown immediately. Future loadPackageConfigUri(Uri file, {Future Function(Uri uri)? loader, - bool preferNewest = true, void Function(Object error)? onError}) => - readAnyConfigFileUri(file, loader, onError ?? throwError, preferNewest); + readConfigFileUri(file, loader, onError ?? throwError); + +/// @nodoc +@Deprecated('use loadPackageConfigUri instead') +Future loadAnyPackageConfigUri(Uri uri, + {bool preferNewest = true, void Function(Object error)? onError}) => + loadPackageConfigUri(uri, onError: onError); /// Finds a package configuration relative to [directory]. /// -/// If [directory] contains a package configuration, -/// either a `.dart_tool/package_config.json` file or, -/// if not, a `.packages`, then that file is loaded. +/// If [directory] contains a `.dart_tool/package_config.json` file, +/// then that file is loaded. /// /// If no file is found in the current directory, /// then the parent directories are checked recursively, @@ -129,9 +113,8 @@ Future findPackageConfig(Directory directory, /// Finds a package configuration relative to [location]. /// -/// If [location] contains a package configuration, -/// either a `.dart_tool/package_config.json` file or, -/// if not, a `.packages`, then that file is loaded. +/// If [location] contains a `.dart_tool/package_config.json` +/// package configuration file or, then that file is loaded. /// The [location] URI *must not* be a `package:` URI. /// It should be a hierarchical URI which is supported /// by [loader]. @@ -189,9 +172,6 @@ Future findPackageConfigUri(Uri location, /// If the `.dart_tool/` directory does not exist, it is created. /// If it cannot be created, this operation fails. /// -/// Also writes a `.packages` file in [directory]. -/// This will stop happening eventually as the `.packages` file becomes -/// discontinued. /// A comment is generated if `[PackageConfig.extraData]` contains a /// `"generator"` entry. Future savePackageConfig( diff --git a/pkgs/package_config/lib/package_config_types.dart b/pkgs/package_config/lib/package_config_types.dart index 5c2c3413c..913f744f6 100644 --- a/pkgs/package_config/lib/package_config_types.dart +++ b/pkgs/package_config/lib/package_config_types.dart @@ -17,6 +17,5 @@ export 'src/package_config.dart' show InvalidLanguageVersion, LanguageVersion, - LanguageVersionRelationalOperators, Package, PackageConfig; diff --git a/pkgs/package_config/lib/src/discovery.dart b/pkgs/package_config/lib/src/discovery.dart index b67841099..e02ce1ec0 100644 --- a/pkgs/package_config/lib/src/discovery.dart +++ b/pkgs/package_config/lib/src/discovery.dart @@ -6,14 +6,12 @@ import 'dart:io'; import 'dart:typed_data'; import 'errors.dart'; -import 'package_config_impl.dart'; +import 'package_config.dart'; import 'package_config_io.dart'; import 'package_config_json.dart'; -import 'packages_file.dart' as packages_file; import 'util_io.dart' show defaultLoader, pathJoin; final Uri packageConfigJsonPath = Uri(path: '.dart_tool/package_config.json'); -final Uri dotPackagesPath = Uri(path: '.packages'); final Uri currentPath = Uri(path: '.'); final Uri parentPath = Uri(path: '..'); @@ -24,16 +22,13 @@ final Uri parentPath = Uri(path: '..'); /// and stopping when something is found. /// /// * Check if a `.dart_tool/package_config.json` file exists in the directory. -/// * Check if a `.packages` file exists in the directory -/// (if `minVersion <= 1`). -/// * Repeat these checks for the parent directories until reaching the +/// * Repeat this check for the parent directories until reaching the /// root directory if [recursive] is true. /// -/// If any of these tests succeed, a `PackageConfig` class is returned. +/// If any such a test succeeds, a `PackageConfig` class is returned. /// Returns `null` if no configuration was found. If a configuration /// is needed, then the caller can supply [PackageConfig.empty]. /// -/// If [minVersion] is greater than 1, `.packages` files are ignored. /// If [minVersion] is greater than the version read from the /// `package_config.json` file, it too is ignored. Future findPackageConfig(Directory baseDirectory, @@ -44,7 +39,6 @@ Future findPackageConfig(Directory baseDirectory, return null; } do { - // Check for $cwd/.packages var packageConfig = await findPackageConfigInDirectory(directory, minVersion, onError); if (packageConfig != null) return packageConfig; @@ -87,13 +81,6 @@ Future findPackageConfigUri( var config = parsePackageConfigBytes(bytes, file, onError); if (config.version >= minVersion) return config; } - if (minVersion <= 1) { - file = location.resolveUri(dotPackagesPath); - bytes = await loader(file); - if (bytes != null) { - return packages_file.parse(bytes, file, onError); - } - } if (!recursive) break; var parent = location.resolveUri(parentPath); if (parent == location) break; @@ -102,7 +89,7 @@ Future findPackageConfigUri( return null; } -/// Finds a `.packages` or `.dart_tool/package_config.json` file in [directory]. +/// Finds a `.dart_tool/package_config.json` file in [directory]. /// /// Loads the file, if it is there, and returns the resulting [PackageConfig]. /// Returns `null` if the file isn't there. @@ -113,7 +100,6 @@ Future findPackageConfigUri( /// a best-effort attempt is made to return a package configuration. /// This may be the empty package configuration. /// -/// If [minVersion] is greater than 1, `.packages` files are ignored. /// If [minVersion] is greater than the version read from the /// `package_config.json` file, it too is ignored. Future findPackageConfigInDirectory(Directory directory, @@ -124,12 +110,6 @@ Future findPackageConfigInDirectory(Directory directory, if (config.version < minVersion) return null; return config; } - if (minVersion <= 1) { - packageConfigFile = await checkForDotPackagesFile(directory); - if (packageConfigFile != null) { - return await readDotPackagesFile(packageConfigFile, onError); - } - } return null; } @@ -140,9 +120,3 @@ Future checkForPackageConfigJsonFile(Directory directory) async { if (await file.exists()) return file; return null; } - -Future checkForDotPackagesFile(Directory directory) async { - var file = File(pathJoin(directory.path, '.packages')); - if (await file.exists()) return file; - return null; -} diff --git a/pkgs/package_config/lib/src/package_config.dart b/pkgs/package_config/lib/src/package_config.dart index 707e85703..7ef3637ea 100644 --- a/pkgs/package_config/lib/src/package_config.dart +++ b/pkgs/package_config/lib/src/package_config.dart @@ -5,8 +5,8 @@ import 'dart:typed_data'; import 'errors.dart'; -import 'package_config_impl.dart'; import 'package_config_json.dart'; +import 'util.dart'; /// A package configuration. /// @@ -15,8 +15,11 @@ import 'package_config_json.dart'; /// More members may be added to this class in the future, /// so classes outside of this package must not implement [PackageConfig] /// or any subclass of it. -abstract class PackageConfig { - /// The largest configuration version currently recognized. +abstract final class PackageConfig { + /// The lowest configuration version currently supported. + static const int minVersion = 2; + + /// The highest configuration version currently supported. static const int maxVersion = 2; /// An empty package configuration. @@ -142,8 +145,8 @@ abstract class PackageConfig { /// The configuration version number. /// - /// Currently this is 1 or 2, where - /// * Version one is the `.packages` file format and + /// So far these have been 1 or 2, where + /// * Version one is the `.packages` file format, and is no longer supported. /// * Version two is the first `package_config.json` format. /// /// Instances of this class supports both, and the version @@ -210,7 +213,7 @@ abstract class PackageConfig { } /// Configuration data for a single package. -abstract class Package { +abstract final class Package { /// Creates a package with the provided properties. /// /// The [name] must be a valid package name. @@ -298,7 +301,7 @@ abstract class Package { /// If errors during parsing are handled using an `onError` handler, /// then an *invalid* language version may be represented by an /// [InvalidLanguageVersion] object. -abstract class LanguageVersion implements Comparable { +abstract final class LanguageVersion implements Comparable { /// The maximal value allowed by [major] and [minor] values; static const int maxValue = 0x7FFFFFFF; @@ -352,16 +355,53 @@ abstract class LanguageVersion implements Comparable { /// Compares language versions. /// - /// Two language versions are considered equal if they have the - /// same major and minor version numbers. + /// Two language versions are equal if they have the same + /// major and minor version numbers. /// /// A language version is greater than another if the former's major version /// is greater than the latter's major version, or if they have /// the same major version and the former's minor version is greater than /// the latter's. + /// + /// Invalid language versions are ordered before all valid versions, + /// and are all ordered together. @override int compareTo(LanguageVersion other); + /// Whether this language version is less than [other]. + /// + /// If either version being compared is an [InvalidLanguageVersion], + /// a [StateError] is thrown. Verify versions are valid before comparing them. + /// + /// For details on how valid language versions are compared, + /// check out [LanguageVersion.compareTo]. + bool operator <(LanguageVersion other); + + /// Whether this language version is less than or equal to [other]. + /// + /// If either version being compared is an [InvalidLanguageVersion], + /// a [StateError] is thrown. Verify versions are valid before comparing them. + /// + /// For details on how valid language versions are compared, + /// check out [LanguageVersion.compareTo]. + bool operator <=(LanguageVersion other); + + /// Whether this language version is greater than [other]. + /// + /// Neither version being compared must be an [InvalidLanguageVersion]. + /// + /// For details on how valid language versions are compared, + /// check out [LanguageVersion.compareTo]. + bool operator >(LanguageVersion other); + + /// Whether this language version is greater than or equal to [other]. + /// + /// Neither version being compared must be an [InvalidLanguageVersion]. + /// + /// For details on how valid language versions are compared, + /// check out [LanguageVersion.compareTo]. + bool operator >=(LanguageVersion other); + /// Valid language versions with the same [major] and [minor] values are /// equal. /// @@ -386,7 +426,9 @@ abstract class LanguageVersion implements Comparable { /// Stored in a [Package] when the original language version string /// was invalid and a `onError` handler was passed to the parser /// which did not throw on an error. -abstract class InvalidLanguageVersion implements LanguageVersion { +/// The caller which provided the `onError` handler which was called +/// should be prepared to encounter invalid values. +abstract final class InvalidLanguageVersion implements LanguageVersion { /// The value -1 for an invalid language version. @override int get major; @@ -407,63 +449,399 @@ abstract class InvalidLanguageVersion implements LanguageVersion { String toString(); } -/// Relational operators for [LanguageVersion] that -/// compare valid versions with [LanguageVersion.compareTo]. +// -------------------------------------------------------------------- +// Implementation of interfaces. + +const bool _disallowPackagesInsidePackageUriRoot = false; + +// Implementations of the main data types exposed by the API of this package. + +final class SimplePackageConfig implements PackageConfig { + @override + final int version; + final Map _packages; + final PackageTree _packageTree; + @override + final Object? extraData; + + factory SimplePackageConfig(int version, Iterable packages, + [Object? extraData, void Function(Object error)? onError]) { + onError ??= throwError; + var validVersion = _validateVersion(version, onError); + var sortedPackages = [...packages]..sort(_compareRoot); + var packageTree = _validatePackages(packages, sortedPackages, onError); + return SimplePackageConfig._(validVersion, packageTree, + {for (var p in packageTree.allPackages) p.name: p}, extraData); + } + + SimplePackageConfig._( + this.version, this._packageTree, this._packages, this.extraData); + + /// Creates empty configuration. + /// + /// The empty configuration can be used in cases where no configuration is + /// found, but code expects a non-null configuration. + /// + /// The version number is [PackageConfig.maxVersion] to avoid + /// minimum-version filters discarding the configuration. + const SimplePackageConfig.empty() + : version = PackageConfig.maxVersion, + _packageTree = const EmptyPackageTree(), + _packages = const {}, + extraData = null; + + static int _validateVersion( + int version, void Function(Object error) onError) { + if (version < 0 || version > PackageConfig.maxVersion) { + onError(PackageConfigArgumentError(version, 'version', + 'Must be in the range 1 to ${PackageConfig.maxVersion}')); + return 2; // The minimal version supporting a SimplePackageConfig. + } + return version; + } + + static PackageTree _validatePackages(Iterable originalPackages, + List packages, void Function(Object error) onError) { + var packageNames = {}; + var tree = TriePackageTree(); + for (var originalPackage in packages) { + SimplePackage? newPackage; + if (originalPackage is! SimplePackage) { + // SimplePackage validates these properties. + newPackage = SimplePackage.validate( + originalPackage.name, + originalPackage.root, + originalPackage.packageUriRoot, + originalPackage.languageVersion, + originalPackage.extraData, + originalPackage.relativeRoot, (error) { + if (error is PackageConfigArgumentError) { + onError(PackageConfigArgumentError(packages, 'packages', + 'Package ${newPackage!.name}: ${error.message}')); + } else { + onError(error); + } + }); + if (newPackage == null) continue; + } else { + newPackage = originalPackage; + } + var name = newPackage.name; + if (packageNames.contains(name)) { + onError(PackageConfigArgumentError( + name, 'packages', "Duplicate package name '$name'")); + continue; + } + packageNames.add(name); + tree.add(newPackage, (error) { + if (error is ConflictException) { + // There is a conflict with an existing package. + var existingPackage = error.existingPackage; + switch (error.conflictType) { + case ConflictType.sameRoots: + onError(PackageConfigArgumentError( + originalPackages, + 'packages', + 'Packages ${newPackage!.name} and ${existingPackage.name} ' + 'have the same root directory: ${newPackage.root}.\n')); + break; + case ConflictType.interleaving: + // The new package is inside the package URI root of the existing + // package. + onError(PackageConfigArgumentError( + originalPackages, + 'packages', + 'Package ${newPackage!.name} is inside the root of ' + 'package ${existingPackage.name}, and the package root ' + 'of ${existingPackage.name} is inside the root of ' + '${newPackage.name}.\n' + '${existingPackage.name} package root: ' + '${existingPackage.packageUriRoot}\n' + '${newPackage.name} root: ${newPackage.root}\n')); + break; + case ConflictType.insidePackageRoot: + onError(PackageConfigArgumentError( + originalPackages, + 'packages', + 'Package ${newPackage!.name} is inside the package root of ' + 'package ${existingPackage.name}.\n' + '${existingPackage.name} package root: ' + '${existingPackage.packageUriRoot}\n' + '${newPackage.name} root: ${newPackage.root}\n')); + break; + } + } else { + // Any other error. + onError(error); + } + }); + } + return tree; + } + + @override + Iterable get packages => _packages.values; + + @override + Package? operator [](String packageName) => _packages[packageName]; + + @override + Package? packageOf(Uri file) => _packageTree.packageOf(file); + + @override + Uri? resolve(Uri packageUri) { + var packageName = checkValidPackageUri(packageUri, 'packageUri'); + return _packages[packageName]?.packageUriRoot.resolveUri( + Uri(path: packageUri.path.substring(packageName.length + 1))); + } + + @override + Uri? toPackageUri(Uri nonPackageUri) { + if (nonPackageUri.isScheme('package')) { + throw PackageConfigArgumentError( + nonPackageUri, 'nonPackageUri', 'Must not be a package URI'); + } + if (nonPackageUri.hasQuery || nonPackageUri.hasFragment) { + throw PackageConfigArgumentError(nonPackageUri, 'nonPackageUri', + 'Must not have query or fragment part'); + } + // Find package that file belongs to. + var package = _packageTree.packageOf(nonPackageUri); + if (package == null) return null; + // Check if it is inside the package URI root. + var path = nonPackageUri.toString(); + var root = package.packageUriRoot.toString(); + if (_beginsWith(package.root.toString().length, root, path)) { + var rest = path.substring(root.length); + return Uri(scheme: 'package', path: '${package.name}/$rest'); + } + return null; + } +} + +/// Configuration data for a single package. +final class SimplePackage implements Package { + @override + final String name; + @override + final Uri root; + @override + final Uri packageUriRoot; + @override + final LanguageVersion? languageVersion; + @override + final Object? extraData; + @override + final bool relativeRoot; + + SimplePackage._(this.name, this.root, this.packageUriRoot, + this.languageVersion, this.extraData, this.relativeRoot); + + /// Creates a [SimplePackage] with the provided content. + /// + /// The provided arguments must be valid. + /// + /// If the arguments are invalid then the error is reported by + /// calling [onError], then the erroneous entry is ignored. + /// + /// If [onError] is provided, the user is expected to be able to handle + /// errors themselves. An invalid [languageVersion] string + /// will be replaced with the string `"invalid"`. This allows + /// users to detect the difference between an absent version and + /// an invalid one. + /// + /// Returns `null` if the input is invalid and an approximately valid package + /// cannot be salvaged from the input. + static SimplePackage? validate( + String name, + Uri root, + Uri? packageUriRoot, + LanguageVersion? languageVersion, + Object? extraData, + bool relativeRoot, + void Function(Object error) onError) { + var fatalError = false; + var invalidIndex = checkPackageName(name); + if (invalidIndex >= 0) { + onError(PackageConfigFormatException( + 'Not a valid package name', name, invalidIndex)); + fatalError = true; + } + if (root.isScheme('package')) { + onError(PackageConfigArgumentError( + '$root', 'root', 'Must not be a package URI')); + fatalError = true; + } else if (!isAbsoluteDirectoryUri(root)) { + onError(PackageConfigArgumentError( + '$root', + 'root', + 'In package $name: Not an absolute URI with no query or fragment ' + 'with a path ending in /')); + // Try to recover. If the URI has a scheme, + // then ensure that the path ends with `/`. + if (!root.hasScheme) { + fatalError = true; + } else if (!root.path.endsWith('/')) { + root = root.replace(path: '${root.path}/'); + } + } + if (packageUriRoot == null) { + packageUriRoot = root; + } else if (!fatalError) { + packageUriRoot = root.resolveUri(packageUriRoot); + if (!isAbsoluteDirectoryUri(packageUriRoot)) { + onError(PackageConfigArgumentError( + packageUriRoot, + 'packageUriRoot', + 'In package $name: Not an absolute URI with no query or fragment ' + 'with a path ending in /')); + packageUriRoot = root; + } else if (!isUriPrefix(root, packageUriRoot)) { + onError(PackageConfigArgumentError(packageUriRoot, 'packageUriRoot', + 'The package URI root is not below the package root')); + packageUriRoot = root; + } + } + if (fatalError) return null; + return SimplePackage._( + name, root, packageUriRoot, languageVersion, extraData, relativeRoot); + } +} + +/// Checks whether [source] is a valid Dart language version string. +/// +/// The format is (as RegExp) `^(0|[1-9]\d+)\.(0|[1-9]\d+)$`. /// -/// If either operand is an [InvalidLanguageVersion], a [StateError] is thrown. -/// Versions should be verified as valid after parsing and before using them. -extension LanguageVersionRelationalOperators on LanguageVersion { +/// Reports a format exception on [onError] if not, or if the numbers +/// are too large (at most 32-bit signed integers). +LanguageVersion parseLanguageVersion( + String? source, void Function(Object error) onError) { + var index = 0; + // Reads a positive decimal numeral. Returns the value of the numeral, + // or a negative number in case of an error. + // Starts at [index] and increments the index to the position after + // the numeral. + // It is an error if the numeral value is greater than 0x7FFFFFFFF. + // It is a recoverable error if the numeral starts with leading zeros. + int readNumeral() { + const maxValue = 0x7FFFFFFF; + if (index == source!.length) { + onError(PackageConfigFormatException('Missing number', source, index)); + return -1; + } + var start = index; + + var char = source.codeUnitAt(index); + var digit = char ^ 0x30; + if (digit > 9) { + onError(PackageConfigFormatException('Missing number', source, index)); + return -1; + } + var firstDigit = digit; + var value = 0; + do { + value = value * 10 + digit; + if (value > maxValue) { + onError( + PackageConfigFormatException('Number too large', source, start)); + return -1; + } + index++; + if (index == source.length) break; + char = source.codeUnitAt(index); + digit = char ^ 0x30; + } while (digit <= 9); + if (firstDigit == 0 && index > start + 1) { + onError(PackageConfigFormatException( + 'Leading zero not allowed', source, start)); + } + return value; + } + + var major = readNumeral(); + if (major < 0) { + return SimpleInvalidLanguageVersion(source); + } + if (index == source!.length || source.codeUnitAt(index) != $dot) { + onError(PackageConfigFormatException("Missing '.'", source, index)); + return SimpleInvalidLanguageVersion(source); + } + index++; + var minor = readNumeral(); + if (minor < 0) { + return SimpleInvalidLanguageVersion(source); + } + if (index != source.length) { + onError(PackageConfigFormatException( + 'Unexpected trailing character', source, index)); + return SimpleInvalidLanguageVersion(source); + } + return SimpleLanguageVersion(major, minor, source); +} + +abstract final class _SimpleLanguageVersionBase implements LanguageVersion { + @override + int compareTo(LanguageVersion other) { + var result = major - other.major; + if (result != 0) return result; + return minor - other.minor; + } +} + +final class SimpleLanguageVersion extends _SimpleLanguageVersionBase { + @override + final int major; + @override + final int minor; + String? _source; + SimpleLanguageVersion(this.major, this.minor, this._source); + + @override + bool operator ==(Object other) => + other is LanguageVersion && major == other.major && minor == other.minor; + + @override + int get hashCode => (major * 17 ^ minor * 37) & 0x3FFFFFFF; + + @override + String toString() => _source ??= '$major.$minor'; + /// Whether this language version is less than [other]. /// - /// If either version being compared is an [InvalidLanguageVersion], - /// a [StateError] is thrown. Verify versions are valid before comparing them. + /// Neither version being compared must be an [InvalidLanguageVersion]. /// /// For details on how valid language versions are compared, /// check out [LanguageVersion.compareTo]. + @override bool operator <(LanguageVersion other) { - // Throw an error if comparing as or with an invalid language version. - if (this is InvalidLanguageVersion) { - _throwThisInvalid(); - } else if (other is InvalidLanguageVersion) { - _throwOtherInvalid(); - } + // Throw an error if comparing with an invalid language version. + if (other is InvalidLanguageVersion) _throwOtherInvalid(); return compareTo(other) < 0; } /// Whether this language version is less than or equal to [other]. /// - /// If either version being compared is an [InvalidLanguageVersion], - /// a [StateError] is thrown. Verify versions are valid before comparing them. + /// Neither version being compared must be an [InvalidLanguageVersion]. /// /// For details on how valid language versions are compared, /// check out [LanguageVersion.compareTo]. + @override bool operator <=(LanguageVersion other) { - // Throw an error if comparing as or with an invalid language version. - if (this is InvalidLanguageVersion) { - _throwThisInvalid(); - } else if (other is InvalidLanguageVersion) { - _throwOtherInvalid(); - } - + // Throw an error if comparing with an invalid language version. + if (other is InvalidLanguageVersion) _throwOtherInvalid(); return compareTo(other) <= 0; } /// Whether this language version is greater than [other]. /// - /// If either version being compared is an [InvalidLanguageVersion], - /// a [StateError] is thrown. Verify versions are valid before comparing them. + /// Neither version being compared must be an [InvalidLanguageVersion]. /// /// For details on how valid language versions are compared, /// check out [LanguageVersion.compareTo]. + @override bool operator >(LanguageVersion other) { - // Throw an error if comparing as or with an invalid language version. - if (this is InvalidLanguageVersion) { - _throwThisInvalid(); - } else if (other is InvalidLanguageVersion) { - _throwOtherInvalid(); - } - + if (other is InvalidLanguageVersion) _throwOtherInvalid(); return compareTo(other) > 0; } @@ -474,22 +852,242 @@ extension LanguageVersionRelationalOperators on LanguageVersion { /// /// For details on how valid language versions are compared, /// check out [LanguageVersion.compareTo]. + @override bool operator >=(LanguageVersion other) { - // Throw an error if comparing as or with an invalid language version. - if (this is InvalidLanguageVersion) { - _throwThisInvalid(); - } else if (other is InvalidLanguageVersion) { - _throwOtherInvalid(); - } - + // Throw an error if comparing with an invalid language version. + if (other is InvalidLanguageVersion) _throwOtherInvalid(); return compareTo(other) >= 0; } + static Never _throwOtherInvalid() => throw StateError( + 'Can\'t compare a language version to an invalid language version. ' + 'Verify language versions are valid after parsing.'); +} + +final class SimpleInvalidLanguageVersion extends _SimpleLanguageVersionBase + implements InvalidLanguageVersion { + final String? _source; + SimpleInvalidLanguageVersion(this._source); + @override + int get major => -1; + @override + int get minor => -1; + + @override + bool operator <(LanguageVersion other) { + _throwThisInvalid(); + } + + @override + bool operator <=(LanguageVersion other) { + _throwThisInvalid(); + } + + @override + bool operator >(LanguageVersion other) { + _throwThisInvalid(); + } + + @override + bool operator >=(LanguageVersion other) { + _throwThisInvalid(); + } + + @override + String toString() => _source!; + static Never _throwThisInvalid() => throw StateError( 'Can\'t compare an invalid language version to another language version. ' 'Verify language versions are valid after parsing.'); +} - static Never _throwOtherInvalid() => throw StateError( - 'Can\'t compare a language version to an invalid language version. ' - 'Verify language versions are valid after parsing.'); +abstract class PackageTree { + Iterable get allPackages; + SimplePackage? packageOf(Uri file); +} + +class _PackageTrieNode { + SimplePackage? package; + + /// Indexed by path segment. + Map map = {}; } + +/// Packages of a package configuration ordered by root path. +/// +/// A package has a root path and a package root path, where the latter +/// contains the files exposed by `package:` URIs. +/// +/// A package is said to be inside another package if the root path URI of +/// the latter is a prefix of the root path URI of the former. +/// +/// No two packages of a package may have the same root path. +/// The package root path of a package must not be inside another package's +/// root path. +/// Entire other packages are allowed inside a package's root. +class TriePackageTree implements PackageTree { + /// Indexed by URI scheme. + final Map _map = {}; + + /// A list of all packages. + final List _packages = []; + + @override + Iterable get allPackages sync* { + for (var package in _packages) { + yield package; + } + } + + bool _checkConflict(_PackageTrieNode node, SimplePackage newPackage, + void Function(Object error) onError) { + var existingPackage = node.package; + if (existingPackage != null) { + // Trying to add package that is inside the existing package. + // 1) If it's an exact match it's not allowed (i.e. the roots can't be + // the same). + if (newPackage.root.path.length == existingPackage.root.path.length) { + onError(ConflictException( + newPackage, existingPackage, ConflictType.sameRoots)); + return true; + } + // 2) The existing package has a packageUriRoot thats inside the + // root of the new package. + if (_beginsWith(0, newPackage.root.toString(), + existingPackage.packageUriRoot.toString())) { + onError(ConflictException( + newPackage, existingPackage, ConflictType.interleaving)); + return true; + } + + // For internal reasons we allow this (for now). One should still never do + // it though. + // 3) The new package is inside the packageUriRoot of existing package. + if (_disallowPackagesInsidePackageUriRoot) { + if (_beginsWith(0, existingPackage.packageUriRoot.toString(), + newPackage.root.toString())) { + onError(ConflictException( + newPackage, existingPackage, ConflictType.insidePackageRoot)); + return true; + } + } + } + return false; + } + + /// Tries to add `newPackage` to the tree. + /// + /// Reports a [ConflictException] if the added package conflicts with an + /// existing package. + /// It conflicts if its root or package root is the same as an existing + /// package's root or package root, is between the two, or if it's inside the + /// package root of an existing package. + /// + /// If a conflict is detected between [newPackage] and a previous package, + /// then [onError] is called with a [ConflictException] object + /// and the [newPackage] is not added to the tree. + /// + /// The packages are added in order of their root path. + void add(SimplePackage newPackage, void Function(Object error) onError) { + var root = newPackage.root; + var node = _map[root.scheme] ??= _PackageTrieNode(); + if (_checkConflict(node, newPackage, onError)) return; + var segments = root.pathSegments; + // Notice that we're skipping the last segment as it's always the empty + // string because roots are directories. + for (var i = 0; i < segments.length - 1; i++) { + var path = segments[i]; + node = node.map[path] ??= _PackageTrieNode(); + if (_checkConflict(node, newPackage, onError)) return; + } + node.package = newPackage; + _packages.add(newPackage); + } + + bool _isMatch( + String path, _PackageTrieNode node, List potential) { + var currentPackage = node.package; + if (currentPackage != null) { + var currentPackageRootLength = currentPackage.root.toString().length; + if (path.length == currentPackageRootLength) return true; + var currentPackageUriRoot = currentPackage.packageUriRoot.toString(); + // Is [file] inside the package root of [currentPackage]? + if (currentPackageUriRoot.length == currentPackageRootLength || + _beginsWith(currentPackageRootLength, currentPackageUriRoot, path)) { + return true; + } + potential.add(currentPackage); + } + return false; + } + + @override + SimplePackage? packageOf(Uri file) { + var currentTrieNode = _map[file.scheme]; + if (currentTrieNode == null) return null; + var path = file.toString(); + var potential = []; + if (_isMatch(path, currentTrieNode, potential)) { + return currentTrieNode.package; + } + var segments = file.pathSegments; + + for (var i = 0; i < segments.length - 1; i++) { + var segment = segments[i]; + currentTrieNode = currentTrieNode!.map[segment]; + if (currentTrieNode == null) break; + if (_isMatch(path, currentTrieNode, potential)) { + return currentTrieNode.package; + } + } + if (potential.isEmpty) return null; + return potential.last; + } +} + +class EmptyPackageTree implements PackageTree { + const EmptyPackageTree(); + + @override + Iterable get allPackages => const Iterable.empty(); + + @override + SimplePackage? packageOf(Uri file) => null; +} + +/// Checks whether [longerPath] begins with [parentPath]. +/// +/// Skips checking the [start] first characters which are assumed to +/// already have been matched. +bool _beginsWith(int start, String parentPath, String longerPath) { + if (longerPath.length < parentPath.length) return false; + for (var i = start; i < parentPath.length; i++) { + if (longerPath.codeUnitAt(i) != parentPath.codeUnitAt(i)) return false; + } + return true; +} + +enum ConflictType { sameRoots, interleaving, insidePackageRoot } + +/// Conflict between packages added to the same configuration. +/// +/// The [package] conflicts with [existingPackage] if it has +/// the same root path or the package URI root path +/// of [existingPackage] is inside the root path of [package]. +class ConflictException { + /// The existing package that [package] conflicts with. + final SimplePackage existingPackage; + + /// The package that could not be added without a conflict. + final SimplePackage package; + + /// Whether the conflict is with the package URI root of [existingPackage]. + final ConflictType conflictType; + + /// Creates a root conflict between [package] and [existingPackage]. + ConflictException(this.package, this.existingPackage, this.conflictType); +} + +/// Used for sorting packages by root path. +int _compareRoot(Package p1, Package p2) => + p1.root.toString().compareTo(p2.root.toString()); diff --git a/pkgs/package_config/lib/src/package_config_impl.dart b/pkgs/package_config/lib/src/package_config_impl.dart deleted file mode 100644 index 865e99a8e..000000000 --- a/pkgs/package_config/lib/src/package_config_impl.dart +++ /dev/null @@ -1,568 +0,0 @@ -// Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file -// for details. All rights reserved. Use of this source code is governed by a -// BSD-style license that can be found in the LICENSE file. - -import 'errors.dart'; -import 'package_config.dart'; -import 'util.dart'; - -export 'package_config.dart'; - -const bool _disallowPackagesInsidePackageUriRoot = false; - -// Implementations of the main data types exposed by the API of this package. - -class SimplePackageConfig implements PackageConfig { - @override - final int version; - final Map _packages; - final PackageTree _packageTree; - @override - final Object? extraData; - - factory SimplePackageConfig(int version, Iterable packages, - [Object? extraData, void Function(Object error)? onError]) { - onError ??= throwError; - var validVersion = _validateVersion(version, onError); - var sortedPackages = [...packages]..sort(_compareRoot); - var packageTree = _validatePackages(packages, sortedPackages, onError); - return SimplePackageConfig._(validVersion, packageTree, - {for (var p in packageTree.allPackages) p.name: p}, extraData); - } - - SimplePackageConfig._( - this.version, this._packageTree, this._packages, this.extraData); - - /// Creates empty configuration. - /// - /// The empty configuration can be used in cases where no configuration is - /// found, but code expects a non-null configuration. - /// - /// The version number is [PackageConfig.maxVersion] to avoid - /// minimum-version filters discarding the configuration. - const SimplePackageConfig.empty() - : version = PackageConfig.maxVersion, - _packageTree = const EmptyPackageTree(), - _packages = const {}, - extraData = null; - - static int _validateVersion( - int version, void Function(Object error) onError) { - if (version < 0 || version > PackageConfig.maxVersion) { - onError(PackageConfigArgumentError(version, 'version', - 'Must be in the range 1 to ${PackageConfig.maxVersion}')); - return 2; // The minimal version supporting a SimplePackageConfig. - } - return version; - } - - static PackageTree _validatePackages(Iterable originalPackages, - List packages, void Function(Object error) onError) { - var packageNames = {}; - var tree = TriePackageTree(); - for (var originalPackage in packages) { - SimplePackage? newPackage; - if (originalPackage is! SimplePackage) { - // SimplePackage validates these properties. - newPackage = SimplePackage.validate( - originalPackage.name, - originalPackage.root, - originalPackage.packageUriRoot, - originalPackage.languageVersion, - originalPackage.extraData, - originalPackage.relativeRoot, (error) { - if (error is PackageConfigArgumentError) { - onError(PackageConfigArgumentError(packages, 'packages', - 'Package ${newPackage!.name}: ${error.message}')); - } else { - onError(error); - } - }); - if (newPackage == null) continue; - } else { - newPackage = originalPackage; - } - var name = newPackage.name; - if (packageNames.contains(name)) { - onError(PackageConfigArgumentError( - name, 'packages', "Duplicate package name '$name'")); - continue; - } - packageNames.add(name); - tree.add(newPackage, (error) { - if (error is ConflictException) { - // There is a conflict with an existing package. - var existingPackage = error.existingPackage; - switch (error.conflictType) { - case ConflictType.sameRoots: - onError(PackageConfigArgumentError( - originalPackages, - 'packages', - 'Packages ${newPackage!.name} and ${existingPackage.name} ' - 'have the same root directory: ${newPackage.root}.\n')); - break; - case ConflictType.interleaving: - // The new package is inside the package URI root of the existing - // package. - onError(PackageConfigArgumentError( - originalPackages, - 'packages', - 'Package ${newPackage!.name} is inside the root of ' - 'package ${existingPackage.name}, and the package root ' - 'of ${existingPackage.name} is inside the root of ' - '${newPackage.name}.\n' - '${existingPackage.name} package root: ' - '${existingPackage.packageUriRoot}\n' - '${newPackage.name} root: ${newPackage.root}\n')); - break; - case ConflictType.insidePackageRoot: - onError(PackageConfigArgumentError( - originalPackages, - 'packages', - 'Package ${newPackage!.name} is inside the package root of ' - 'package ${existingPackage.name}.\n' - '${existingPackage.name} package root: ' - '${existingPackage.packageUriRoot}\n' - '${newPackage.name} root: ${newPackage.root}\n')); - break; - } - } else { - // Any other error. - onError(error); - } - }); - } - return tree; - } - - @override - Iterable get packages => _packages.values; - - @override - Package? operator [](String packageName) => _packages[packageName]; - - @override - Package? packageOf(Uri file) => _packageTree.packageOf(file); - - @override - Uri? resolve(Uri packageUri) { - var packageName = checkValidPackageUri(packageUri, 'packageUri'); - return _packages[packageName]?.packageUriRoot.resolveUri( - Uri(path: packageUri.path.substring(packageName.length + 1))); - } - - @override - Uri? toPackageUri(Uri nonPackageUri) { - if (nonPackageUri.isScheme('package')) { - throw PackageConfigArgumentError( - nonPackageUri, 'nonPackageUri', 'Must not be a package URI'); - } - if (nonPackageUri.hasQuery || nonPackageUri.hasFragment) { - throw PackageConfigArgumentError(nonPackageUri, 'nonPackageUri', - 'Must not have query or fragment part'); - } - // Find package that file belongs to. - var package = _packageTree.packageOf(nonPackageUri); - if (package == null) return null; - // Check if it is inside the package URI root. - var path = nonPackageUri.toString(); - var root = package.packageUriRoot.toString(); - if (_beginsWith(package.root.toString().length, root, path)) { - var rest = path.substring(root.length); - return Uri(scheme: 'package', path: '${package.name}/$rest'); - } - return null; - } -} - -/// Configuration data for a single package. -class SimplePackage implements Package { - @override - final String name; - @override - final Uri root; - @override - final Uri packageUriRoot; - @override - final LanguageVersion? languageVersion; - @override - final Object? extraData; - @override - final bool relativeRoot; - - SimplePackage._(this.name, this.root, this.packageUriRoot, - this.languageVersion, this.extraData, this.relativeRoot); - - /// Creates a [SimplePackage] with the provided content. - /// - /// The provided arguments must be valid. - /// - /// If the arguments are invalid then the error is reported by - /// calling [onError], then the erroneous entry is ignored. - /// - /// If [onError] is provided, the user is expected to be able to handle - /// errors themselves. An invalid [languageVersion] string - /// will be replaced with the string `"invalid"`. This allows - /// users to detect the difference between an absent version and - /// an invalid one. - /// - /// Returns `null` if the input is invalid and an approximately valid package - /// cannot be salvaged from the input. - static SimplePackage? validate( - String name, - Uri root, - Uri? packageUriRoot, - LanguageVersion? languageVersion, - Object? extraData, - bool relativeRoot, - void Function(Object error) onError) { - var fatalError = false; - var invalidIndex = checkPackageName(name); - if (invalidIndex >= 0) { - onError(PackageConfigFormatException( - 'Not a valid package name', name, invalidIndex)); - fatalError = true; - } - if (root.isScheme('package')) { - onError(PackageConfigArgumentError( - '$root', 'root', 'Must not be a package URI')); - fatalError = true; - } else if (!isAbsoluteDirectoryUri(root)) { - onError(PackageConfigArgumentError( - '$root', - 'root', - 'In package $name: Not an absolute URI with no query or fragment ' - 'with a path ending in /')); - // Try to recover. If the URI has a scheme, - // then ensure that the path ends with `/`. - if (!root.hasScheme) { - fatalError = true; - } else if (!root.path.endsWith('/')) { - root = root.replace(path: '${root.path}/'); - } - } - if (packageUriRoot == null) { - packageUriRoot = root; - } else if (!fatalError) { - packageUriRoot = root.resolveUri(packageUriRoot); - if (!isAbsoluteDirectoryUri(packageUriRoot)) { - onError(PackageConfigArgumentError( - packageUriRoot, - 'packageUriRoot', - 'In package $name: Not an absolute URI with no query or fragment ' - 'with a path ending in /')); - packageUriRoot = root; - } else if (!isUriPrefix(root, packageUriRoot)) { - onError(PackageConfigArgumentError(packageUriRoot, 'packageUriRoot', - 'The package URI root is not below the package root')); - packageUriRoot = root; - } - } - if (fatalError) return null; - return SimplePackage._( - name, root, packageUriRoot, languageVersion, extraData, relativeRoot); - } -} - -/// Checks whether [source] is a valid Dart language version string. -/// -/// The format is (as RegExp) `^(0|[1-9]\d+)\.(0|[1-9]\d+)$`. -/// -/// Reports a format exception on [onError] if not, or if the numbers -/// are too large (at most 32-bit signed integers). -LanguageVersion parseLanguageVersion( - String? source, void Function(Object error) onError) { - var index = 0; - // Reads a positive decimal numeral. Returns the value of the numeral, - // or a negative number in case of an error. - // Starts at [index] and increments the index to the position after - // the numeral. - // It is an error if the numeral value is greater than 0x7FFFFFFFF. - // It is a recoverable error if the numeral starts with leading zeros. - int readNumeral() { - const maxValue = 0x7FFFFFFF; - if (index == source!.length) { - onError(PackageConfigFormatException('Missing number', source, index)); - return -1; - } - var start = index; - - var char = source.codeUnitAt(index); - var digit = char ^ 0x30; - if (digit > 9) { - onError(PackageConfigFormatException('Missing number', source, index)); - return -1; - } - var firstDigit = digit; - var value = 0; - do { - value = value * 10 + digit; - if (value > maxValue) { - onError( - PackageConfigFormatException('Number too large', source, start)); - return -1; - } - index++; - if (index == source.length) break; - char = source.codeUnitAt(index); - digit = char ^ 0x30; - } while (digit <= 9); - if (firstDigit == 0 && index > start + 1) { - onError(PackageConfigFormatException( - 'Leading zero not allowed', source, start)); - } - return value; - } - - var major = readNumeral(); - if (major < 0) { - return SimpleInvalidLanguageVersion(source); - } - if (index == source!.length || source.codeUnitAt(index) != $dot) { - onError(PackageConfigFormatException("Missing '.'", source, index)); - return SimpleInvalidLanguageVersion(source); - } - index++; - var minor = readNumeral(); - if (minor < 0) { - return SimpleInvalidLanguageVersion(source); - } - if (index != source.length) { - onError(PackageConfigFormatException( - 'Unexpected trailing character', source, index)); - return SimpleInvalidLanguageVersion(source); - } - return SimpleLanguageVersion(major, minor, source); -} - -abstract class _SimpleLanguageVersionBase implements LanguageVersion { - @override - int compareTo(LanguageVersion other) { - var result = major.compareTo(other.major); - if (result != 0) return result; - return minor.compareTo(other.minor); - } -} - -class SimpleLanguageVersion extends _SimpleLanguageVersionBase { - @override - final int major; - @override - final int minor; - String? _source; - SimpleLanguageVersion(this.major, this.minor, this._source); - - @override - bool operator ==(Object other) => - other is LanguageVersion && major == other.major && minor == other.minor; - - @override - int get hashCode => (major * 17 ^ minor * 37) & 0x3FFFFFFF; - - @override - String toString() => _source ??= '$major.$minor'; -} - -class SimpleInvalidLanguageVersion extends _SimpleLanguageVersionBase - implements InvalidLanguageVersion { - final String? _source; - SimpleInvalidLanguageVersion(this._source); - @override - int get major => -1; - @override - int get minor => -1; - - @override - String toString() => _source!; -} - -abstract class PackageTree { - Iterable get allPackages; - SimplePackage? packageOf(Uri file); -} - -class _PackageTrieNode { - SimplePackage? package; - - /// Indexed by path segment. - Map map = {}; -} - -/// Packages of a package configuration ordered by root path. -/// -/// A package has a root path and a package root path, where the latter -/// contains the files exposed by `package:` URIs. -/// -/// A package is said to be inside another package if the root path URI of -/// the latter is a prefix of the root path URI of the former. -/// -/// No two packages of a package may have the same root path. -/// The package root path of a package must not be inside another package's -/// root path. -/// Entire other packages are allowed inside a package's root. -class TriePackageTree implements PackageTree { - /// Indexed by URI scheme. - final Map _map = {}; - - /// A list of all packages. - final List _packages = []; - - @override - Iterable get allPackages sync* { - for (var package in _packages) { - yield package; - } - } - - bool _checkConflict(_PackageTrieNode node, SimplePackage newPackage, - void Function(Object error) onError) { - var existingPackage = node.package; - if (existingPackage != null) { - // Trying to add package that is inside the existing package. - // 1) If it's an exact match it's not allowed (i.e. the roots can't be - // the same). - if (newPackage.root.path.length == existingPackage.root.path.length) { - onError(ConflictException( - newPackage, existingPackage, ConflictType.sameRoots)); - return true; - } - // 2) The existing package has a packageUriRoot thats inside the - // root of the new package. - if (_beginsWith(0, newPackage.root.toString(), - existingPackage.packageUriRoot.toString())) { - onError(ConflictException( - newPackage, existingPackage, ConflictType.interleaving)); - return true; - } - - // For internal reasons we allow this (for now). One should still never do - // it though. - // 3) The new package is inside the packageUriRoot of existing package. - if (_disallowPackagesInsidePackageUriRoot) { - if (_beginsWith(0, existingPackage.packageUriRoot.toString(), - newPackage.root.toString())) { - onError(ConflictException( - newPackage, existingPackage, ConflictType.insidePackageRoot)); - return true; - } - } - } - return false; - } - - /// Tries to add `newPackage` to the tree. - /// - /// Reports a [ConflictException] if the added package conflicts with an - /// existing package. - /// It conflicts if its root or package root is the same as an existing - /// package's root or package root, is between the two, or if it's inside the - /// package root of an existing package. - /// - /// If a conflict is detected between [newPackage] and a previous package, - /// then [onError] is called with a [ConflictException] object - /// and the [newPackage] is not added to the tree. - /// - /// The packages are added in order of their root path. - void add(SimplePackage newPackage, void Function(Object error) onError) { - var root = newPackage.root; - var node = _map[root.scheme] ??= _PackageTrieNode(); - if (_checkConflict(node, newPackage, onError)) return; - var segments = root.pathSegments; - // Notice that we're skipping the last segment as it's always the empty - // string because roots are directories. - for (var i = 0; i < segments.length - 1; i++) { - var path = segments[i]; - node = node.map[path] ??= _PackageTrieNode(); - if (_checkConflict(node, newPackage, onError)) return; - } - node.package = newPackage; - _packages.add(newPackage); - } - - bool _isMatch( - String path, _PackageTrieNode node, List potential) { - var currentPackage = node.package; - if (currentPackage != null) { - var currentPackageRootLength = currentPackage.root.toString().length; - if (path.length == currentPackageRootLength) return true; - var currentPackageUriRoot = currentPackage.packageUriRoot.toString(); - // Is [file] inside the package root of [currentPackage]? - if (currentPackageUriRoot.length == currentPackageRootLength || - _beginsWith(currentPackageRootLength, currentPackageUriRoot, path)) { - return true; - } - potential.add(currentPackage); - } - return false; - } - - @override - SimplePackage? packageOf(Uri file) { - var currentTrieNode = _map[file.scheme]; - if (currentTrieNode == null) return null; - var path = file.toString(); - var potential = []; - if (_isMatch(path, currentTrieNode, potential)) { - return currentTrieNode.package; - } - var segments = file.pathSegments; - - for (var i = 0; i < segments.length - 1; i++) { - var segment = segments[i]; - currentTrieNode = currentTrieNode!.map[segment]; - if (currentTrieNode == null) break; - if (_isMatch(path, currentTrieNode, potential)) { - return currentTrieNode.package; - } - } - if (potential.isEmpty) return null; - return potential.last; - } -} - -class EmptyPackageTree implements PackageTree { - const EmptyPackageTree(); - - @override - Iterable get allPackages => const Iterable.empty(); - - @override - SimplePackage? packageOf(Uri file) => null; -} - -/// Checks whether [longerPath] begins with [parentPath]. -/// -/// Skips checking the [start] first characters which are assumed to -/// already have been matched. -bool _beginsWith(int start, String parentPath, String longerPath) { - if (longerPath.length < parentPath.length) return false; - for (var i = start; i < parentPath.length; i++) { - if (longerPath.codeUnitAt(i) != parentPath.codeUnitAt(i)) return false; - } - return true; -} - -enum ConflictType { sameRoots, interleaving, insidePackageRoot } - -/// Conflict between packages added to the same configuration. -/// -/// The [package] conflicts with [existingPackage] if it has -/// the same root path or the package URI root path -/// of [existingPackage] is inside the root path of [package]. -class ConflictException { - /// The existing package that [package] conflicts with. - final SimplePackage existingPackage; - - /// The package that could not be added without a conflict. - final SimplePackage package; - - /// Whether the conflict is with the package URI root of [existingPackage]. - final ConflictType conflictType; - - /// Creates a root conflict between [package] and [existingPackage]. - ConflictException(this.package, this.existingPackage, this.conflictType); -} - -/// Used for sorting packages by root path. -int _compareRoot(Package p1, Package p2) => - p1.root.toString().compareTo(p2.root.toString()); diff --git a/pkgs/package_config/lib/src/package_config_io.dart b/pkgs/package_config/lib/src/package_config_io.dart index 8c5773b2b..19cae38c3 100644 --- a/pkgs/package_config/lib/src/package_config_io.dart +++ b/pkgs/package_config/lib/src/package_config_io.dart @@ -9,10 +9,8 @@ import 'dart:io'; import 'dart:typed_data'; import 'errors.dart'; -import 'package_config_impl.dart'; +import 'package_config.dart'; import 'package_config_json.dart'; -import 'packages_file.dart' as packages_file; -import 'util.dart'; import 'util_io.dart'; /// Name of directory where Dart tools store their configuration. @@ -25,32 +23,11 @@ const dartToolDirName = '.dart_tool'; /// File is stored in the dart tool directory. const packageConfigFileName = 'package_config.json'; -/// Name of file containing legacy package configuration data. -/// -/// File is stored in the package root directory. -const packagesFileName = '.packages'; - /// Reads a package configuration file. /// -/// Detects whether the [file] is a version one `.packages` file or -/// a version two `package_config.json` file. -/// -/// If the [file] is a `.packages` file and [preferNewest] is true, -/// first checks whether there is an adjacent `.dart_tool/package_config.json` -/// file, and if so, reads that instead. -/// If [preferNewest] is false, the specified file is loaded even if it is -/// a `.packages` file and there is an available `package_config.json` file. -/// /// The file must exist and be a normal file. -Future readAnyConfigFile( - File file, bool preferNewest, void Function(Object error) onError) async { - if (preferNewest && fileName(file.path) == packagesFileName) { - var alternateFile = File( - pathJoin(dirName(file.path), dartToolDirName, packageConfigFileName)); - if (alternateFile.existsSync()) { - return await readPackageConfigJsonFile(alternateFile, onError); - } - } +Future readConfigFile( + File file, void Function(Object error) onError) async { Uint8List bytes; try { bytes = await file.readAsBytes(); @@ -58,38 +35,25 @@ Future readAnyConfigFile( onError(e); return const SimplePackageConfig.empty(); } - return parseAnyConfigFile(bytes, file.uri, onError); + return parsePackageConfigBytes(bytes, file.uri, onError); } -/// Like [readAnyConfigFile] but uses a URI and an optional loader. -Future readAnyConfigFileUri( +/// Like [readConfigFile] but uses a URI and an optional loader. +Future readConfigFileUri( Uri file, Future Function(Uri uri)? loader, - void Function(Object error) onError, - bool preferNewest) async { + void Function(Object error) onError) async { if (file.isScheme('package')) { throw PackageConfigArgumentError( file, 'file', 'Must not be a package: URI'); } if (loader == null) { if (file.isScheme('file')) { - return await readAnyConfigFile(File.fromUri(file), preferNewest, onError); + return await readConfigFile(File.fromUri(file), onError); } loader = defaultLoader; } - if (preferNewest && file.pathSegments.last == packagesFileName) { - var alternateFile = file.resolve('$dartToolDirName/$packageConfigFileName'); - Uint8List? bytes; - try { - bytes = await loader(alternateFile); - } catch (e) { - onError(e); - return const SimplePackageConfig.empty(); - } - if (bytes != null) { - return parsePackageConfigBytes(bytes, alternateFile, onError); - } - } + Uint8List? bytes; try { bytes = await loader(file); @@ -102,20 +66,6 @@ Future readAnyConfigFileUri( file.toString(), 'file', 'File cannot be read')); return const SimplePackageConfig.empty(); } - return parseAnyConfigFile(bytes, file, onError); -} - -/// Parses a `.packages` or `package_config.json` file's contents. -/// -/// Assumes it's a JSON file if the first non-whitespace character -/// is `{`, otherwise assumes it's a `.packages` file. -PackageConfig parseAnyConfigFile( - Uint8List bytes, Uri file, void Function(Object error) onError) { - var firstChar = firstNonWhitespaceChar(bytes); - if (firstChar != $lbrace) { - // Definitely not a JSON object, probably a .packages. - return packages_file.parse(bytes, file, onError); - } return parsePackageConfigBytes(bytes, file, onError); } @@ -131,18 +81,6 @@ Future readPackageConfigJsonFile( return parsePackageConfigBytes(bytes, file.uri, onError); } -Future readDotPackagesFile( - File file, void Function(Object error) onError) async { - Uint8List bytes; - try { - bytes = await file.readAsBytes(); - } catch (error) { - onError(error); - return const SimplePackageConfig.empty(); - } - return packages_file.parse(bytes, file.uri, onError); -} - Future writePackageConfigJsonFile( PackageConfig config, Directory targetDirectory) async { // Write .dart_tool/package_config.json first. @@ -153,14 +91,5 @@ Future writePackageConfigJsonFile( var sink = file.openWrite(encoding: utf8); writePackageConfigJsonUtf8(config, baseUri, sink); - var doneJson = sink.close(); - - // Write .packages too. - file = File(pathJoin(targetDirectory.path, packagesFileName)); - baseUri = file.uri; - sink = file.openWrite(encoding: utf8); - writeDotPackages(config, baseUri, sink); - var donePackages = sink.close(); - - await Future.wait([doneJson, donePackages]); + await sink.close(); } diff --git a/pkgs/package_config/lib/src/package_config_json.dart b/pkgs/package_config/lib/src/package_config_json.dart index 65560a0f0..afc18cb4e 100644 --- a/pkgs/package_config/lib/src/package_config_json.dart +++ b/pkgs/package_config/lib/src/package_config_json.dart @@ -8,8 +8,7 @@ import 'dart:convert'; import 'dart:typed_data'; import 'errors.dart'; -import 'package_config_impl.dart'; -import 'packages_file.dart' as packages_file; +import 'package_config.dart'; import 'util.dart'; const String _configVersionKey = 'configVersion'; @@ -26,10 +25,6 @@ const List _packageNames = [ _languageVersionKey ]; -const String _generatedKey = 'generated'; -const String _generatorKey = 'generator'; -const String _generatorVersionKey = 'generatorVersion'; - final _jsonUtf8Decoder = json.fuse(utf8).decoder; PackageConfig parsePackageConfigBytes( @@ -264,23 +259,6 @@ Map packageConfigToJson(PackageConfig config, Uri? baseUri) => ], }; -void writeDotPackages(PackageConfig config, Uri baseUri, StringSink output) { - var extraData = config.extraData; - // Write .packages too. - String? comment; - if (extraData is Map) { - var generator = extraData[_generatorKey]; - if (generator is String) { - var generated = extraData[_generatedKey]; - var generatorVersion = extraData[_generatorVersionKey]; - comment = 'Generated by $generator' - "${generatorVersion is String ? " $generatorVersion" : ""}" - "${generated is String ? " on $generated" : ""}."; - } - } - packages_file.write(output, config, baseUri: baseUri, comment: comment); -} - /// If "extraData" is a JSON map, then return it, otherwise return null. /// /// If the value contains any of the [reservedNames] for the current context, diff --git a/pkgs/package_config/lib/src/packages_file.dart b/pkgs/package_config/lib/src/packages_file.dart deleted file mode 100644 index bf68f2c88..000000000 --- a/pkgs/package_config/lib/src/packages_file.dart +++ /dev/null @@ -1,193 +0,0 @@ -// Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file -// for details. All rights reserved. Use of this source code is governed by a -// BSD-style license that can be found in the LICENSE file. - -import 'errors.dart'; -import 'package_config_impl.dart'; -import 'util.dart'; - -/// The language version prior to the release of language versioning. -/// -/// This is the default language version used by all packages from a -/// `.packages` file. -final LanguageVersion _languageVersion = LanguageVersion(2, 7); - -/// Parses a `.packages` file into a [PackageConfig]. -/// -/// The [source] is the byte content of a `.packages` file, assumed to be -/// UTF-8 encoded. In practice, all significant parts of the file must be ASCII, -/// so Latin-1 or Windows-1252 encoding will also work fine. -/// -/// If the file content is available as a string, its [String.codeUnits] can -/// be used as the `source` argument of this function. -/// -/// The [baseLocation] is used as a base URI to resolve all relative -/// URI references against. -/// If the content was read from a file, `baseLocation` should be the -/// location of that file. -/// -/// Returns a simple package configuration where each package's -/// [Package.packageUriRoot] is the same as its [Package.root] -/// and it has no [Package.languageVersion]. -PackageConfig parse( - List source, Uri baseLocation, void Function(Object error) onError) { - if (baseLocation.isScheme('package')) { - onError(PackageConfigArgumentError( - baseLocation, 'baseLocation', 'Must not be a package: URI')); - return PackageConfig.empty; - } - var index = 0; - var packages = []; - var packageNames = {}; - while (index < source.length) { - var ignoreLine = false; - var start = index; - var separatorIndex = -1; - var end = source.length; - var char = source[index++]; - if (char == $cr || char == $lf) { - continue; - } - if (char == $colon) { - onError(PackageConfigFormatException( - 'Missing package name', source, index - 1)); - ignoreLine = true; // Ignore if package name is invalid. - } else { - ignoreLine = char == $hash; // Ignore if comment. - } - var queryStart = -1; - var fragmentStart = -1; - while (index < source.length) { - char = source[index++]; - if (char == $colon && separatorIndex < 0) { - separatorIndex = index - 1; - } else if (char == $cr || char == $lf) { - end = index - 1; - break; - } else if (char == $question && queryStart < 0 && fragmentStart < 0) { - queryStart = index - 1; - } else if (char == $hash && fragmentStart < 0) { - fragmentStart = index - 1; - } - } - if (ignoreLine) continue; - if (separatorIndex < 0) { - onError( - PackageConfigFormatException("No ':' on line", source, index - 1)); - continue; - } - var packageName = String.fromCharCodes(source, start, separatorIndex); - var invalidIndex = checkPackageName(packageName); - if (invalidIndex >= 0) { - onError(PackageConfigFormatException( - 'Not a valid package name', source, start + invalidIndex)); - continue; - } - if (queryStart >= 0) { - onError(PackageConfigFormatException( - 'Location URI must not have query', source, queryStart)); - end = queryStart; - } else if (fragmentStart >= 0) { - onError(PackageConfigFormatException( - 'Location URI must not have fragment', source, fragmentStart)); - end = fragmentStart; - } - var packageValue = String.fromCharCodes(source, separatorIndex + 1, end); - Uri packageLocation; - try { - packageLocation = Uri.parse(packageValue); - } on FormatException catch (e) { - onError(PackageConfigFormatException.from(e)); - continue; - } - var relativeRoot = !hasAbsolutePath(packageLocation); - packageLocation = baseLocation.resolveUri(packageLocation); - if (packageLocation.isScheme('package')) { - onError(PackageConfigFormatException( - 'Package URI as location for package', source, separatorIndex + 1)); - continue; - } - var path = packageLocation.path; - if (!path.endsWith('/')) { - path += '/'; - packageLocation = packageLocation.replace(path: path); - } - if (packageNames.contains(packageName)) { - onError(PackageConfigFormatException( - 'Same package name occurred more than once', source, start)); - continue; - } - var rootUri = packageLocation; - if (path.endsWith('/lib/')) { - // Assume default Pub package layout. Include package itself in root. - rootUri = - packageLocation.replace(path: path.substring(0, path.length - 4)); - } - var package = SimplePackage.validate(packageName, rootUri, packageLocation, - _languageVersion, null, relativeRoot, (error) { - if (error is ArgumentError) { - onError(PackageConfigFormatException(error.message.toString(), source)); - } else { - onError(error); - } - }); - if (package != null) { - packages.add(package); - packageNames.add(packageName); - } - } - return SimplePackageConfig(1, packages, null, onError); -} - -/// Writes the configuration to a [StringSink]. -/// -/// If [comment] is provided, the output will contain this comment -/// with `# ` in front of each line. -/// Lines are defined as ending in line feed (`'\n'`). If the final -/// line of the comment doesn't end in a line feed, one will be added. -/// -/// If [baseUri] is provided, package locations will be made relative -/// to the base URI, if possible, before writing. -void write(StringSink output, PackageConfig config, - {Uri? baseUri, String? comment}) { - if (baseUri != null && !baseUri.isAbsolute) { - throw PackageConfigArgumentError(baseUri, 'baseUri', 'Must be absolute'); - } - - if (comment != null) { - var lines = comment.split('\n'); - if (lines.last.isEmpty) lines.removeLast(); - for (var commentLine in lines) { - output.write('# '); - output.writeln(commentLine); - } - } else { - output.write('# generated by package:package_config at '); - output.write(DateTime.now()); - output.writeln(); - } - for (var package in config.packages) { - var packageName = package.name; - var uri = package.packageUriRoot; - // Validate packageName. - if (!isValidPackageName(packageName)) { - throw PackageConfigArgumentError( - config, 'config', '"$packageName" is not a valid package name'); - } - if (uri.scheme == 'package') { - throw PackageConfigArgumentError( - config, 'config', 'Package location must not be a package URI: $uri'); - } - output.write(packageName); - output.write(':'); - // If baseUri is provided, make the URI relative to baseUri. - if (baseUri != null) { - uri = relativizeUri(uri, baseUri)!; - } - if (!uri.path.endsWith('/')) { - uri = uri.replace(path: '${uri.path}/'); - } - output.write(uri); - output.writeln(); - } -} diff --git a/pkgs/package_config/pubspec.yaml b/pkgs/package_config/pubspec.yaml index d3a1c7d38..c0a081ae6 100644 --- a/pkgs/package_config/pubspec.yaml +++ b/pkgs/package_config/pubspec.yaml @@ -1,5 +1,5 @@ name: package_config -version: 2.2.0-wip +version: 3.0.0-wip description: Support for reading and writing Dart Package Configuration files. repository: https://github.com/dart-lang/tools/tree/main/pkgs/package_config issue_tracker: https://github.com/dart-lang/tools/labels/package%3Apackage_config @@ -11,5 +11,5 @@ dependencies: path: ^1.8.0 dev_dependencies: - dart_flutter_team_lints: ^3.0.0 + dart_flutter_team_lints: ^3.1.0 test: ^1.16.0 diff --git a/pkgs/package_config/test/discovery_test.dart b/pkgs/package_config/test/discovery_test.dart index 6d1b65529..dbe691efc 100644 --- a/pkgs/package_config/test/discovery_test.dart +++ b/pkgs/package_config/test/discovery_test.dart @@ -69,15 +69,14 @@ void main() { validatePackagesFile(config, directory); }); - // Finds .packages if no package_config.json. + // Does not find .packages if no package_config.json. fileTest('.packages', { '.packages': packagesFile, 'script.dart': 'main(){}', 'packages': {'shouldNotBeFound': {}} }, (Directory directory) async { - var config = (await findPackageConfig(directory))!; - expect(config.version, 1); // Found .packages file. - validatePackagesFile(config, directory); + var config = await findPackageConfig(directory); + expect(config, null); }); // Finds package_config.json in super-directory. @@ -87,6 +86,7 @@ void main() { 'package_config.json': packageConfigFile, }, 'subdir': { + '.packages': packagesFile, 'script.dart': 'main(){}', } }, (Directory directory) async { @@ -95,16 +95,6 @@ void main() { validatePackagesFile(config, directory); }); - // Finds .packages in super-directory. - fileTest('.packages recursive', { - '.packages': packagesFile, - 'subdir': {'script.dart': 'main(){}'} - }, (Directory directory) async { - var config = (await findPackageConfig(subdir(directory, 'subdir/')))!; - expect(config.version, 1); - validatePackagesFile(config, directory); - }); - // Does not find a packages/ directory, and returns null if nothing found. fileTest('package directory packages not supported', { 'packages': { @@ -116,19 +106,7 @@ void main() { }); group('throws', () { - fileTest('invalid .packages', { - '.packages': 'not a .packages file', - }, (Directory directory) { - expect(findPackageConfig(directory), throwsA(isA())); - }); - - fileTest('invalid .packages as JSON', { - '.packages': packageConfigFile, - }, (Directory directory) { - expect(findPackageConfig(directory), throwsA(isA())); - }); - - fileTest('invalid .packages', { + fileTest('invalid package config not JSON', { '.dart_tool': { 'package_config.json': 'not a JSON file', } @@ -136,41 +114,29 @@ void main() { expect(findPackageConfig(directory), throwsA(isA())); }); - fileTest('invalid .packages as INI', { + fileTest('invalid package config as INI', { '.dart_tool': { 'package_config.json': packagesFile, } }, (Directory directory) { expect(findPackageConfig(directory), throwsA(isA())); }); - }); - - group('handles error', () { - fileTest('invalid .packages', { - '.packages': 'not a .packages file', - }, (Directory directory) async { - var hadError = false; - await findPackageConfig(directory, - onError: expectAsync1((error) { - hadError = true; - expect(error, isA()); - }, max: -1)); - expect(hadError, true); - }); - fileTest('invalid .packages as JSON', { - '.packages': packageConfigFile, + fileTest('indirectly through .packages', { + '.packages': packagesFile, + '.dart_tool': { + 'package_config.json': packageConfigFile, + }, }, (Directory directory) async { - var hadError = false; - await findPackageConfig(directory, - onError: expectAsync1((error) { - hadError = true; - expect(error, isA()); - }, max: -1)); - expect(hadError, true); + // A .packages file in the directory of a .dart_tool/package_config.json + // used to automatically redirect to the package_config.json. + var file = dirFile(directory, '.packages'); + expect(loadPackageConfig(file), throwsA(isA())); }); + }); - fileTest('invalid package_config not JSON', { + group('handles error', () { + fileTest('invalid package config not JSON', { '.dart_tool': { 'package_config.json': 'not a JSON file', } @@ -208,8 +174,8 @@ void main() { expect(config, null); }); - // Finds package_config.json in super-directory, with .packages in - // subdir and minVersion > 1. + // Finds package_config.json in super-directory. + // (Even with `.packages` in search directory.) fileTest('package_config.json recursive .packages ignored', { '.dart_tool': { 'package_config.json': packageConfigFile, @@ -242,19 +208,6 @@ void main() { expect(config.version, 2); validatePackagesFile(config, directory); }); - fileTest('indirectly through .packages', files, - (Directory directory) async { - var file = dirFile(directory, '.packages'); - var config = await loadPackageConfig(file); - expect(config.version, 2); - validatePackagesFile(config, directory); - }); - fileTest('prefer .packages', files, (Directory directory) async { - var file = dirFile(directory, '.packages'); - var config = await loadPackageConfig(file, preferNewest: false); - expect(config.version, 1); - validatePackagesFile(config, directory); - }); }); fileTest('package_config.json non-default name', { @@ -280,32 +233,21 @@ void main() { validatePackagesFile(config, directory); }); - fileTest('.packages', { + fileTest('.packages cannot be loaded', { '.packages': packagesFile, }, (Directory directory) async { var file = dirFile(directory, '.packages'); - var config = await loadPackageConfig(file); - expect(config.version, 1); - validatePackagesFile(config, directory); + expect(loadPackageConfig(file), throwsFormatException); }); - fileTest('.packages non-default name', { - 'pheldagriff': packagesFile, - }, (Directory directory) async { - var file = dirFile(directory, 'pheldagriff'); - var config = await loadPackageConfig(file); - expect(config.version, 1); - validatePackagesFile(config, directory); - }); - - fileTest('no config found', {}, (Directory directory) { - var file = dirFile(directory, 'anyname'); + fileTest('no config file found', {}, (Directory directory) { + var file = dirFile(directory, 'any_name'); expect( () => loadPackageConfig(file), throwsA(isA())); }); fileTest('no config found, handled', {}, (Directory directory) async { - var file = dirFile(directory, 'anyname'); + var file = dirFile(directory, 'any_name'); var hadError = false; await loadPackageConfig(file, onError: expectAsync1((error) { @@ -316,30 +258,9 @@ void main() { }); fileTest('specified file syntax error', { - 'anyname': 'syntax error', - }, (Directory directory) { - var file = dirFile(directory, 'anyname'); - expect(() => loadPackageConfig(file), throwsFormatException); - }); - - // Find package_config.json in subdir even if initial file syntax error. - fileTest('specified file syntax onError', { - '.packages': 'syntax error', - '.dart_tool': { - 'package_config.json': packageConfigFile, - }, - }, (Directory directory) async { - var file = dirFile(directory, '.packages'); - var config = await loadPackageConfig(file); - expect(config.version, 2); - validatePackagesFile(config, directory); - }); - - // A file starting with `{` is a package_config.json file. - fileTest('file syntax error with {', { - '.packages': '{syntax error', + 'any_name': 'syntax error', }, (Directory directory) { - var file = dirFile(directory, '.packages'); + var file = dirFile(directory, 'any_name'); expect(() => loadPackageConfig(file), throwsFormatException); }); }); diff --git a/pkgs/package_config/test/discovery_uri_test.dart b/pkgs/package_config/test/discovery_uri_test.dart index 542bf0a65..f436a295a 100644 --- a/pkgs/package_config/test/discovery_uri_test.dart +++ b/pkgs/package_config/test/discovery_uri_test.dart @@ -66,17 +66,6 @@ void main() { validatePackagesFile(config, directory); }); - // Finds .packages if no package_config.json. - loaderTest('.packages', { - '.packages': packagesFile, - 'script.dart': 'main(){}', - 'packages': {'shouldNotBeFound': {}} - }, (directory, loader) async { - var config = (await findPackageConfigUri(directory, loader: loader))!; - expect(config.version, 1); // Found .packages file. - validatePackagesFile(config, directory); - }); - // Finds package_config.json in super-directory. loaderTest('package_config.json recursive', { '.packages': packagesFile, @@ -93,15 +82,15 @@ void main() { validatePackagesFile(config, directory); }); - // Finds .packages in super-directory. - loaderTest('.packages recursive', { + // Does not find a .packages file. + loaderTest('Not .packages', { '.packages': packagesFile, - 'subdir': {'script.dart': 'main(){}'} + 'script.dart': 'main(){}', + 'packages': {'shouldNotBeFound': {}} }, (directory, loader) async { - var config = (await findPackageConfigUri(directory.resolve('subdir/'), - loader: loader))!; - expect(config.version, 1); - validatePackagesFile(config, directory); + var config = + await findPackageConfigUri(recurse: false, directory, loader: loader); + expect(config, null); }); // Does not find a packages/ directory, and returns null if nothing found. @@ -113,65 +102,6 @@ void main() { var config = await findPackageConfigUri(directory, loader: loader); expect(config, null); }); - - loaderTest('invalid .packages', { - '.packages': 'not a .packages file', - }, (Uri directory, loader) { - expect(() => findPackageConfigUri(directory, loader: loader), - throwsA(isA())); - }); - - loaderTest('invalid .packages as JSON', { - '.packages': packageConfigFile, - }, (Uri directory, loader) { - expect(() => findPackageConfigUri(directory, loader: loader), - throwsA(isA())); - }); - - loaderTest('invalid .packages', { - '.dart_tool': { - 'package_config.json': 'not a JSON file', - } - }, (Uri directory, loader) { - expect(() => findPackageConfigUri(directory, loader: loader), - throwsA(isA())); - }); - - loaderTest('invalid .packages as INI', { - '.dart_tool': { - 'package_config.json': packagesFile, - } - }, (Uri directory, loader) { - expect(() => findPackageConfigUri(directory, loader: loader), - throwsA(isA())); - }); - - // Does not find .packages if no package_config.json and minVersion > 1. - loaderTest('.packages ignored', { - '.packages': packagesFile, - 'script.dart': 'main(){}' - }, (directory, loader) async { - var config = - await findPackageConfigUri(directory, minVersion: 2, loader: loader); - expect(config, null); - }); - - // Finds package_config.json in super-directory, with .packages in - // subdir and minVersion > 1. - loaderTest('package_config.json recursive ignores .packages', { - '.dart_tool': { - 'package_config.json': packageConfigFile, - }, - 'subdir': { - '.packages': packagesFile, - 'script.dart': 'main(){}', - } - }, (directory, loader) async { - var config = (await findPackageConfigUri(directory.resolve('subdir/'), - minVersion: 2, loader: loader))!; - expect(config.version, 2); - validatePackagesFile(config, directory); - }); }); group('loadPackageConfig', () { @@ -191,10 +121,13 @@ void main() { }); loaderTest('indirectly through .packages', files, (Uri directory, loader) async { + // Is no longer supported. var file = directory.resolve('.packages'); - var config = await loadPackageConfigUri(file, loader: loader); - expect(config.version, 2); - validatePackagesFile(config, directory); + var hadError = false; + await loadPackageConfigUri(file, loader: loader, onError: (_) { + hadError = true; + }); + expect(hadError, true); }); }); @@ -221,24 +154,6 @@ void main() { validatePackagesFile(config, directory); }); - loaderTest('.packages', { - '.packages': packagesFile, - }, (Uri directory, loader) async { - var file = directory.resolve('.packages'); - var config = await loadPackageConfigUri(file, loader: loader); - expect(config.version, 1); - validatePackagesFile(config, directory); - }); - - loaderTest('.packages non-default name', { - 'pheldagriff': packagesFile, - }, (Uri directory, loader) async { - var file = directory.resolve('pheldagriff'); - var config = await loadPackageConfigUri(file, loader: loader); - expect(config.version, 1); - validatePackagesFile(config, directory); - }); - loaderTest('no config found', {}, (Uri directory, loader) { var file = directory.resolve('anyname'); expect(() => loadPackageConfigUri(file, loader: loader), @@ -280,7 +195,7 @@ void main() { expect(hadError, true); }); - // Don't look for package_config.json if original file not named .packages. + // Don't look for package_config.json if original name or file are bad. loaderTest('specified file syntax error with alternative', { 'anyname': 'syntax error', '.dart_tool': { diff --git a/pkgs/package_config/test/parse_test.dart b/pkgs/package_config/test/parse_test.dart index a92b9bfcc..8555b086c 100644 --- a/pkgs/package_config/test/parse_test.dart +++ b/pkgs/package_config/test/parse_test.dart @@ -8,75 +8,11 @@ import 'dart:typed_data'; import 'package:package_config/package_config_types.dart'; import 'package:package_config/src/errors.dart'; import 'package:package_config/src/package_config_json.dart'; -import 'package:package_config/src/packages_file.dart' as packages; import 'package:test/test.dart'; import 'src/util.dart'; void main() { - group('.packages', () { - test('valid', () { - var packagesFile = '# Generated by pub yadda yadda\n' - 'foo:file:///foo/lib/\n' - 'bar:/bar/lib/\n' - 'baz:lib/\n'; - var result = packages.parse(utf8.encode(packagesFile), - Uri.parse('file:///tmp/file.dart'), throwError); - expect(result.version, 1); - expect({for (var p in result.packages) p.name}, {'foo', 'bar', 'baz'}); - expect(result.resolve(pkg('foo', 'foo.dart')), - Uri.parse('file:///foo/lib/foo.dart')); - expect(result.resolve(pkg('bar', 'bar.dart')), - Uri.parse('file:///bar/lib/bar.dart')); - expect(result.resolve(pkg('baz', 'baz.dart')), - Uri.parse('file:///tmp/lib/baz.dart')); - - var foo = result['foo']!; - expect(foo, isNotNull); - expect(foo.root, Uri.parse('file:///foo/')); - expect(foo.packageUriRoot, Uri.parse('file:///foo/lib/')); - expect(foo.languageVersion, LanguageVersion(2, 7)); - expect(foo.relativeRoot, false); - }); - - test('valid empty', () { - var packagesFile = '# Generated by pub yadda yadda\n'; - var result = packages.parse( - utf8.encode(packagesFile), Uri.file('/tmp/file.dart'), throwError); - expect(result.version, 1); - expect({for (var p in result.packages) p.name}, {}); - }); - - group('invalid', () { - var baseFile = Uri.file('/tmp/file.dart'); - void testThrows(String name, String content) { - test(name, () { - expect( - () => packages.parse(utf8.encode(content), baseFile, throwError), - throwsA(isA())); - }); - test('$name, handle error', () { - var hadError = false; - packages.parse(utf8.encode(content), baseFile, (error) { - hadError = true; - expect(error, isA()); - }); - expect(hadError, true); - }); - } - - testThrows('repeated package name', 'foo:lib/\nfoo:lib\n'); - testThrows('no colon', 'foo\n'); - testThrows('empty package name', ':lib/\n'); - testThrows('dot only package name', '.:lib/\n'); - testThrows('dot only package name', '..:lib/\n'); - testThrows('invalid package name character', 'f\\o:lib/\n'); - testThrows('package URI', 'foo:package:bar/lib/'); - testThrows('location with query', 'f\\o:lib/?\n'); - testThrows('location with fragment', 'f\\o:lib/#\n'); - }); - }); - group('package_config.json', () { test('valid', () { var packageConfigFile = ''' From d921e01121d98daf78c9188d8efba6cc4f38f34e Mon Sep 17 00:00:00 2001 From: "Lasse R.H. Nielsen" Date: Thu, 6 Mar 2025 16:23:24 +0100 Subject: [PATCH 2/2] Remember -wip on changelog version. --- pkgs/package_config/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkgs/package_config/CHANGELOG.md b/pkgs/package_config/CHANGELOG.md index db5070783..775b6699b 100644 --- a/pkgs/package_config/CHANGELOG.md +++ b/pkgs/package_config/CHANGELOG.md @@ -1,4 +1,4 @@ -## 3.0.0 +## 3.0.0-wip - Removes support for the `.packages` file. The Dart SDK no longer supports that file, and no new `.packages` files