Don't implicitly run "pub get".

lib/src/entrypoint.dart

 // Copyright (c) 2012, 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.
 
 library pub.entrypoint;
 
 import 'dart:async';
+import 'dart:io';
 
 import 'package:path/path.dart' as path;
 import 'package:barback/barback.dart';
 
 import 'barback/asset_environment.dart';
 import 'io.dart';
 import 'lock_file.dart';
 import 'log.dart' as log;
 import 'package.dart';
 import 'package_graph.dart';
@@ skipping 25 matching lines @@
   final Package root;
 
   /// The system-wide cache which caches packages that need to be fetched over
   /// the network.
   final SystemCache cache;
 
   /// Whether to create and symlink a "packages" directory containing links to
   /// the installed packages.
   final bool _packageSymlinks;
 
+  /// Whether this entrypoing is in memory only, as opposed to representing a

[Bob Nystrom, 2015/08/10 21:54:28]

"entrypoint"

[nweiz, 2015/08/10 22:32:47]

Done.

+  /// real directory on disk.
+  final bool _inMemory;
+
   /// The lockfile for the entrypoint.
   ///
-  /// If not provided to the entrypoint, it will be laoded lazily from disc.
-  LockFile _lockFile;
-
-  /// The graph of all packages reachable from the entrypoint.
-  PackageGraph _packageGraph;
-
-  /// Loads the entrypoint from a package at [rootDir].
-  ///
-  /// If [packageSymlinks] is `true`, this will create a "packages" directory
-  /// with symlinks to the installed packages. This directory will be symlinked
-  /// into any directory that might contain an entrypoint.
-  Entrypoint(String rootDir, SystemCache cache, {bool packageSymlinks: true})
-      : root = new Package.load(null, rootDir, cache.sources),
-        cache = cache,
-        _packageSymlinks = packageSymlinks;
-
-  /// Creates an entrypoint given package and lockfile objects.
-  Entrypoint.inMemory(this.root, this._lockFile, this.cache)
-      : _packageSymlinks = false;
-
-  /// The path to the entrypoint's "packages" directory.
-  String get packagesDir => root.path('packages');
-
-  /// The path to the entrypoint's ".packages" file.
-  String get packagesFile => root.path('.packages');
-
-  /// `true` if the entrypoint package currently has a lock file.
-  bool get lockFileExists => _lockFile != null || entryExists(lockFilePath);
-
+  /// If not provided to the entrypoint, it will be loaded lazily from disk.
   LockFile get lockFile {
     if (_lockFile != null) return _lockFile;
 
-    if (!lockFileExists) {
+    if (!entryExists(lockFilePath)) {

[Bob Nystrom, 2015/08/10 21:54:28]

fileExists()? I suppose it could be a link, but a directory would be bad.

[nweiz, 2015/08/10 22:32:47]

Done.

       _lockFile = new LockFile.empty(cache.sources);
     } else {
       _lockFile = new LockFile.load(lockFilePath, cache.sources);
     }
 
     return _lockFile;
   }
+  LockFile _lockFile;
+
+  /// The package graph for the application and all of its transitive
+  /// dependencies.
+  ///
+  /// Throws a [DataError] if the `.packages` file isn't up-to-date relative to
+  /// the pubspec and the lockfile.
+  PackageGraph get packageGraph {
+    if (_packageGraph != null) return _packageGraph;
+
+    assertUpToDate();
+    var packages = new Map.fromIterable(lockFile.packages.values,
+        key: (id) => id.name,
+        value: (id) {
+      var dir = cache.sources[id.source].getDirectory(id);
+      return new Package.load(id.name, dir, cache.sources);
+    });
+    packages[root.name] = root;
+
+    _packageGraph = new PackageGraph(this, lockFile, packages);
+    return _packageGraph;
+  }
+  PackageGraph _packageGraph;
+
+  /// The path to the entrypoint's "packages" directory.
+  String get packagesDir => root.path('packages');
+
+  /// The path to the entrypoint's ".packages" file.
+  String get packagesFile => root.path('.packages');
 
   /// The path to the entrypoint package's pubspec.
   String get pubspecPath => root.path('pubspec.yaml');
 
   /// The path to the entrypoint package's lockfile.
   String get lockFilePath => root.path('pubspec.lock');
 
+  /// Loads the entrypoint from a package at [rootDir].
+  ///
+  /// If [packageSymlinks] is `true`, this will create a "packages" directory
+  /// with symlinks to the installed packages. This directory will be symlinked
+  /// into any directory that might contain an entrypoint.
+  Entrypoint(String rootDir, SystemCache cache, {bool packageSymlinks: true})
+      : root = new Package.load(null, rootDir, cache.sources),
+        cache = cache,
+        _packageSymlinks = packageSymlinks,
+        _inMemory = false;
+
+  /// Creates an entrypoint given package and lockfile objects.
+  Entrypoint.inMemory(this.root, this._lockFile, this.cache)
+      : _packageSymlinks = false,
+        _inMemory = true;
+
+  /// Creates an entrypoint given a package and a [solveResult], from which the
+  /// package graph and lockfile will be computed.
+  Entrypoint.fromSolveResult(this.root, this.cache, SolveResult solveResult)
+      : _packageSymlinks = false,
+        _inMemory = true {
+    _packageGraph = new PackageGraph.fromSolveResult(this, solveResult);
+    _lockFile = _packageGraph.lockFile;
+  }
+
   /// Gets all dependencies of the [root] package.
   ///
   /// Performs version resolution according to [SolveType].
   ///
   /// [useLatest], if provided, defines a list of packages that will be
   /// unlocked and forced to their latest versions. If [upgradeAll] is
   /// true, the previous lockfile is ignored and all packages are re-resolved
   /// from scratch. Otherwise, it will attempt to preserve the versions of all
   /// previously locked packages.
   ///
   /// Shows a report of the changes made relative to the previous lockfile. If
   /// this is an upgrade or downgrade, all transitive dependencies are shown in
   /// the report. Otherwise, only dependencies that were changed are shown. If
   /// [dryRun] is `true`, no physical changes are made.
+  ///
+  /// Updates [lockFile] and [packageRoot] accordingly.
   Future acquireDependencies(SolveType type, {List<String> useLatest,
       bool dryRun: false}) async {
     var result = await resolveVersions(type, cache.sources, root,
         lockFile: lockFile, useLatest: useLatest);
     if (!result.succeeded) throw result.error;
 
     result.showReport(type);
 
     if (dryRun) {
       result.summarizeChanges(type, dryRun: dryRun);
@@ skipping 10 matching lines @@
     var ids = await Future.wait(result.packages.map(_get));
     _saveLockFile(ids);
 
     if (_packageSymlinks) _linkSelf();
     _linkOrDeleteSecondaryPackageDirs();
 
     result.summarizeChanges(type, dryRun: dryRun);
 
     /// Build a package graph from the version solver results so we don't
     /// have to reload and reparse all the pubspecs.
-    var packageGraph = await loadPackageGraph(result);
+    _packageGraph = new PackageGraph.fromSolveResult(this, result);
     packageGraph.loadTransformerCache().clearIfOutdated(result.changedPackages);
 
     try {
       await precompileDependencies(changed: result.changedPackages);
       await precompileExecutables(changed: result.changedPackages);
     } catch (error, stackTrace) {
       // Just log exceptions here. Since the method is just about acquiring
       // dependencies, it shouldn't fail unless that fails.
       log.exception(error, stackTrace);
     }
 
     writeTextFile(packagesFile, lockFile.packagesFile(root.name));
   }
 
   /// Precompile any transformed dependencies of the entrypoint.
   ///
   /// If [changed] is passed, only dependencies whose contents might be changed
   /// if one of the given packages changes will be recompiled.
   Future precompileDependencies({Iterable<String> changed}) async {
     if (changed != null) changed = changed.toSet();
 
-    var graph = await loadPackageGraph();
-
     // Just precompile the debug version of a package. We're mostly interested
     // in improving speed for development iteration loops, which usually use
     // debug mode.
     var depsDir = path.join('.pub', 'deps', 'debug');
 
-    var dependenciesToPrecompile = graph.packages.values.where((package) {
+    var dependenciesToPrecompile = packageGraph.packages.values
+        .where((package) {
       if (package.pubspec.transformers.isEmpty) return false;
-      if (graph.isPackageMutable(package.name)) return false;
+      if (packageGraph.isPackageMutable(package.name)) return false;
       if (!dirExists(path.join(depsDir, package.name))) return true;
       if (changed == null) return true;
 
       /// Only recompile [package] if any of its transitive dependencies have
       /// changed. We check all transitive dependencies because it's possible
       /// that a transformer makes decisions based on their contents.
       return overlaps(
-          graph.transitiveDependencies(package.name)
+          packageGraph.transitiveDependencies(package.name)
             .map((package) => package.name).toSet(),
           changed);
     }).map((package) => package.name).toSet();
 
     if (dirExists(depsDir)) {
       // Delete any cached dependencies that are going to be recached.
       for (var package in dependenciesToPrecompile) {
         deleteEntry(path.join(depsDir, package));
       }
 
       // Also delete any cached dependencies that should no longer be cached.
       for (var subdir in listDir(depsDir)) {
-        var package = graph.packages[path.basename(subdir)];
+        var package = packageGraph.packages[path.basename(subdir)];
         if (package == null || package.pubspec.transformers.isEmpty ||
-            graph.isPackageMutable(package.name)) {
+            packageGraph.isPackageMutable(package.name)) {
           deleteEntry(subdir);
         }
       }
     }
 
     if (dependenciesToPrecompile.isEmpty) return;
 
     try {
       await log.progress("Precompiling dependencies", () async {
         var packagesToLoad =
-            unionAll(dependenciesToPrecompile.map(graph.transitiveDependencies))
+            unionAll(dependenciesToPrecompile.map(
+                packageGraph.transitiveDependencies))
             .map((package) => package.name).toSet();
 
         var environment = await AssetEnvironment.create(this, BarbackMode.DEBUG,
             packages: packagesToLoad, useDart2JS: false);
 
         /// Ignore barback errors since they'll be emitted via [getAllAssets]
         /// below.
         environment.barback.errors.listen((_) {});
 
         // TODO(nweiz): only get assets from [dependenciesToPrecompile] so as
@@ skipping 30 matching lines @@
     var binDir = path.join('.pub', 'bin');
     var sdkVersionPath = path.join(binDir, 'sdk-version');
 
     // If the existing executable was compiled with a different SDK, we need to
     // recompile regardless of what changed.
     // TODO(nweiz): Use the VM to check this when issue 20802 is fixed.
     var sdkMatches = fileExists(sdkVersionPath) &&
         readTextFile(sdkVersionPath) == "${sdk.version}\n";
     if (!sdkMatches) changed = null;
 
-    var graph = await loadPackageGraph();
-
     // Clean out any outdated snapshots.
     if (dirExists(binDir)) {
       for (var entry in listDir(binDir)) {
         if (!dirExists(entry)) continue;
 
         var package = path.basename(entry);
-        if (!graph.packages.containsKey(package) ||
-            graph.isPackageMutable(package)) {
+        if (!packageGraph.packages.containsKey(package) ||
+            packageGraph.isPackageMutable(package)) {
           deleteEntry(entry);
         }
       }
     }
 
     var executables = new Map.fromIterable(root.immediateDependencies,
         key: (dep) => dep.name,
-        value: (dep) => _executablesForPackage(graph, dep.name, changed));
+        value: (dep) => _executablesForPackage(dep.name, changed));
 
     for (var package in executables.keys.toList()) {
       if (executables[package].isEmpty) executables.remove(package);
     }
 
     if (!sdkMatches) deleteEntry(binDir);
     if (executables.isEmpty) return;
 
     await log.progress("Precompiling executables", () async {
       ensureDir(binDir);
 
       // Make sure there's a trailing newline so our version file matches the
       // SDK's.
       writeTextFile(sdkVersionPath, "${sdk.version}\n");
 
       var packagesToLoad =
-          unionAll(executables.keys.map(graph.transitiveDependencies))
+          unionAll(executables.keys.map(packageGraph.transitiveDependencies))
           .map((package) => package.name).toSet();
       var executableIds = unionAll(
           executables.values.map((ids) => ids.toSet()));
       var environment = await AssetEnvironment.create(this, BarbackMode.RELEASE,
           packages: packagesToLoad,
           entrypoints: executableIds,
           useDart2JS: false);
       environment.barback.errors.listen((error) {
         log.error(log.red("Build error:\n$error"));
       });
 
       await waitAndPrintErrors(executables.keys.map((package) async {
         var dir = path.join(binDir, package);
         cleanDir(dir);
         await environment.precompileExecutables(package, dir,
             executableIds: executables[package]);
       }));
     });
   }
 
   /// Returns the list of all executable assets for [packageName] that should be
   /// precompiled.
   ///
   /// If [changed] isn't `null`, executables for [packageName] will only be
   /// compiled if they might depend on a package in [changed].
-  List<AssetId> _executablesForPackage(PackageGraph graph, String packageName,
+  List<AssetId> _executablesForPackage(String packageName,
       Set<String> changed) {

[Bob Nystrom, 2015/08/10 21:54:28]

Does this fit on the previous line now?

-    var package = graph.packages[packageName];
+    var package = packageGraph.packages[packageName];
     var binDir = package.path('bin');
     if (!dirExists(binDir)) return [];
-    if (graph.isPackageMutable(packageName)) return [];
+    if (packageGraph.isPackageMutable(packageName)) return [];
 
     var executables = package.executableIds;
 
     // If we don't know which packages were changed, always precompile the
     // executables.
     if (changed == null) return executables;
 
     // If any of the package's dependencies changed, recompile the executables.
-    if (graph.transitiveDependencies(packageName)
+    if (packageGraph.transitiveDependencies(packageName)
         .any((package) => changed.contains(package.name))) {
       return executables;
     }
 
     // If any executables don't exist, precompile them regardless of what
     // changed. Since we delete the bin directory before recompiling, we need to
     // recompile all executables.
     var executablesExist = executables.every((executable) =>
         fileExists(path.join('.pub', 'bin', packageName,
             "${path.url.basename(executable.path)}.snapshot")));
@@ skipping 17 matching lines @@
         if (source is! CachedSource) return null;
         return source.downloadToSystemCache(id);
       }
 
       var packageDir = path.join(packagesDir, id.name);
       if (entryExists(packageDir)) deleteEntry(packageDir);
       return source.get(id, packageDir);
     }).then((_) => source.resolveId(id));
   }
 
-  /// Determines whether or not the lockfile is out of date with respect to the
-  /// pubspec.
-  ///
-  /// This will be `false` if there is no lockfile at all, or if the pubspec
-  /// contains dependencies that are not in the lockfile or that don't match
-  /// what's in there.
-  bool _isLockFileUpToDate(LockFile lockFile) {
-    /// If this is an entrypoint for an in-memory package, trust the in-memory
-    /// lockfile provided for it.
-    if (root.dir == null) return true;
+  /// Throws a [DataError] if the `.packages` file doesn't exist or if it's
+  /// out-of-date relative to the lockfile or the pubspec.
+  void assertUpToDate() {
+    if (_inMemory) return;
 
-    return root.immediateDependencies.every((package) {
-      var locked = lockFile.packages[package.name];
-      if (locked == null) return false;
-
-      if (package.source != locked.source) return false;
-      if (!package.constraint.allows(locked.version)) return false;
-
-      var source = cache.sources[package.source];
-      if (source == null) return false;
-
-      return source.descriptionsEqual(package.description, locked.description);
-    });
-  }
-
-  /// Determines whether all of the packages in the lockfile are already
-  /// installed and available.
-  ///
-  /// Note: this assumes [isLockFileUpToDate] has already been called and
-  /// returned `true`.
-  bool _arePackagesAvailable(LockFile lockFile) {
-    return lockFile.packages.values.every((package) {
-      var source = cache.sources[package.source];
-
-      // This should only be called after [_isLockFileUpToDate] has returned
-      // `true`, which ensures all of the sources in the lock file are valid.
-      assert(source != null);
-
-      // We only care about cached sources. Uncached sources aren't "installed".
-      // If one of those is missing, we want to show the user the file not
-      // found error later since installing won't accomplish anything.
-      if (source is! CachedSource) return true;
-
-      // Get the directory.
-      var dir = source.getDirectory(package);
-      // See if the directory is there and looks like a package.
-      return dirExists(dir) || fileExists(path.join(dir, "pubspec.yaml"));
-    });
-  }
-
-  /// Gets dependencies if the lockfile is out of date with respect to the
-  /// pubspec.
-  Future ensureLockFileIsUpToDate() async {
-    if (!lockFileExists) {
-      log.message(
-          "You don't have a lockfile, so we need to generate that:");
-    } else if (_isLockFileUpToDate(lockFile)) {
-      // If we do have a lock file, we still need to make sure the packages are
-      // actually installed. The user may have just gotten a package that
-      // includes a lockfile.
-      if (_arePackagesAvailable(lockFile)) return;
-
-      // If we don't have a current lock file, we definitely need to install.
-      log.message(
-          "You are missing some dependencies, so we need to install them "
-          "first:");
-    } else {
-      log.message(
-          "Your pubspec has changed, so we need to update your lockfile:");
+    if (!entryExists(lockFilePath)) {
+      dataError('No pubspec.lock file found, please run "pub get" first.');
     }
 
-    await acquireDependencies(SolveType.GET);
-  }
+    if (!entryExists(packagesFile)) {
+      dataError('No .packages file found, please run "pub get" first.');

[Bob Nystrom, 2015/08/10 21:54:28]

We should definitely figure out how this should be announced with 1.12.

[nweiz, 2015/08/10 22:32:46]

I was planning to send out an email on dart-announce.

+    }
 
-  /// Loads the package graph for the application and all of its transitive
-  /// dependencies.
-  ///
-  /// If [result] is passed, this loads the graph from it without re-parsing the
-  /// lockfile or any pubspecs. Otherwise, before loading, this makes sure the
-  /// lockfile and dependencies are installed and up to date.
-  Future<PackageGraph> loadPackageGraph([SolveResult result]) async {
-    if (_packageGraph != null) return _packageGraph;
+    var packagesMtime = new File(packagesFile).lastModifiedSync();

[Bob Nystrom, 2015/08/10 21:54:28]

"Mtime" is a bit weird (it should at least be "MTime"). How about "Modified"?

[nweiz, 2015/08/10 22:32:47]

Done.

+    var pubspecMtime = new File(pubspecPath).lastModifiedSync();
+    if (packagesMtime.isBefore(pubspecMtime)) {
+      dataError('The pubspec.yaml file has changed since the .packages file '
+          'was generated, please run "pub get" again.');
+    }
 
-    var graph = await log.progress("Loading package graph", () async {
-      if (result != null) {
-        var packages = new Map.fromIterable(result.packages,
-            key: (id) => id.name,
-            value: (id) {
-          if (id.name == root.name) return root;
-
-          return new Package(result.pubspecs[id.name],
-              cache.sources[id.source].getDirectory(id));
-        });
-
-        return new PackageGraph(
-            this,
-            new LockFile(result.packages, cache.sources),
-            packages);
-      }
-
-      await ensureLockFileIsUpToDate();
-      var packages = new Map.fromIterable(lockFile.packages.values,
-          key: (id) => id.name,
-          value: (id) {
-        var dir = cache.sources[id.source].getDirectory(id);
-        return new Package.load(id.name, dir, cache.sources);
-      });
-      packages[root.name] = root;
-      return new PackageGraph(this, lockFile, packages);
-    }, fine: true);
-
-    _packageGraph = graph;
-    return graph;
+    var lockFileMtime = new File(lockFilePath).lastModifiedSync();
+    if (packagesMtime.isBefore(lockFileMtime)) {
+      dataError('The pubspec.lock file has changed since the .packages file '
+          'was generated, please run "pub get" again.');
+    }
   }
 
   /// Saves a list of concrete package versions to the `pubspec.lock` file.
   void _saveLockFile(List<PackageId> packageIds) {
     _lockFile = new LockFile(packageIds, cache.sources);
     var lockFilePath = root.path('pubspec.lock');
     writeTextFile(lockFilePath, _lockFile.serialize(root.dir));
   }
 
   /// Creates a self-referential symlink in the `packages` directory that allows
@@ skipping 53 matching lines @@
   /// If [packageSymlinks] is true, creates a symlink to the "packages"
   /// directory in [dir].
   ///
   /// Otherwise, deletes a "packages" directories in [dir] if one exists.
   void _linkOrDeleteSecondaryPackageDir(String dir) {
     var symlink = path.join(dir, 'packages');
     if (entryExists(symlink)) deleteEntry(symlink);
     if (_packageSymlinks) createSymlink(packagesDir, symlink, relative: true);
   }
 }