Add --immutable arg

bin/cluster.js

@@ -49,7 +49,7 @@ async function runMaster() {
       await install({
         root,
         cwd: `${root}/${data[0].dir}`,
-        frozenLockfile: true,
+        immutable: true,
         conservative: true,
       });
 

commands/add.js

@@ -110,7 +110,13 @@ const add /*: Add */ = async ({root, cwd, args, dev = false}) => {
       dirs: projects.map(dir => `${root}/${dir}`),
       target: resolve(root, cwd),
     });
-    await generateBazelBuildRules({root, deps, projects, dependencySyncRule});
+    await generateBazelBuildRules({
+      root,
+      deps,
+      projects,
+      dependencySyncRule,
+      immutable: false,
+    });
   }
 };
 

commands/ci.js

@@ -9,7 +9,7 @@ export type CiArgs = {
 export type Ci = (CiArgs) => Promise<void>
 */
 const ci /*: Ci */ = async ({root, cwd}) => {
-  await install({root, cwd, frozenLockfile: true, conservative: true});
+  await install({root, cwd, immutable: true, conservative: true});
 };
 
 module.exports = {ci};

commands/focus.js

@@ -88,12 +88,13 @@ const focus /*: Focus */ = async ({
   await validateVersionPolicy({dirs: deps.map(dep => dep.dir), versionPolicy});
 
   if (workspace === 'sandbox') {
-    await generateBazelignore({root});
+    await generateBazelignore({root, immutable: false});
     await generateBazelBuildRules({
       root,
       deps,
       projects,
       dependencySyncRule,
+      immutable: false,
     });
   }
 

commands/install.js

@@ -21,7 +21,7 @@ const {node, yarn} = require('../utils/binary-paths.js');
 export type InstallArgs = {
   root: string,
   cwd: string,
-  frozenLockfile?: boolean,
+  immutable?: boolean,
   conservative?: boolean,
   skipPreinstall?: boolean,
   skipPostinstall?: boolean,
@@ -33,7 +33,7 @@ export type Install = (InstallArgs) => Promise<void>
 const install /*: Install */ = async ({
   root,
   cwd,
-  frozenLockfile = false,
+  immutable = false,
   conservative = true,
   skipPreinstall = false,
   skipPostinstall = false,
@@ -71,14 +71,27 @@ const install /*: Install */ = async ({
   validateDeps({deps});
   await validateVersionPolicy({dirs: deps.map(dep => dep.dir), versionPolicy});
 
-  if (workspace === 'sandbox' && frozenLockfile === false) {
-    await generateBazelignore({root});
-    await generateBazelBuildRules({
-      root,
-      deps: all,
-      projects,
-      dependencySyncRule,
-    });
+  if (workspace === 'sandbox') {
+    const changedGeneratedFiles = [
+      ...(await generateBazelignore({
+        root,
+        immutable,
+      })),
+      ...(await generateBazelBuildRules({
+        root,
+        deps: all,
+        projects,
+        dependencySyncRule,
+        immutable,
+      })),
+    ];
+
+    if (immutable && changedGeneratedFiles.length > 0) {
+      throw new ImmutableInstallError(
+        `Generated files would have changed, but 'immutable' arg was passed`,
+        changedGeneratedFiles
+      );
+    }
   }
 
   if (hooks.bool_shouldinstall) {
@@ -97,7 +110,7 @@ const install /*: Install */ = async ({
   const env = process.env;
   const path = dirname(node) + ':' + String(process.env.PATH);
   const spawnArgs = [yarn, 'install'];
-  if (frozenLockfile) {
+  if (immutable) {
     spawnArgs.push('--immutable');
   }
 
@@ -131,6 +144,19 @@ const install /*: Install */ = async ({
   }
 };
 
+/**
+ * An error that's thrown when the `immutable` flag is
+ * `true` and generated files would have changed.
+ */
+class ImmutableInstallError extends Error {
+  /*:: changedFiles: Array<string>; */
+
+  constructor(message /*: string */, changedFiles /*: Array<string> */) {
+    super(message);
+    this.changedFiles = changedFiles;
+  }
+}
+
 const validateRegistration = ({root, cwd, projects}) => {
   if (!projects.find(dir => resolve(`${root}/${dir}`) === cwd)) {
     const registrationError = `Your cwd ${cwd} is not listed in manifest.json or package.json. If you are at the wrong directory, cd into your desired directory or use the --cwd flag. If you are in the desired directory, make sure it is listed in the projects field in manifest.json or workspaces field in package.json`;
@@ -173,4 +199,4 @@ const validateVersionPolicy = async ({dirs, versionPolicy}) => {
   if (!result.valid) throw new Error(getErrorMessage(result, false));
 };
 
-module.exports = {install};
+module.exports = {install, ImmutableInstallError};

commands/remove.js

@@ -41,7 +41,13 @@ const remove /*: Remove */ = async ({root, cwd, args}) => {
       dirs: projects.map(dir => `${root}/${dir}`),
       target: resolve(root, cwd),
     });
-    await generateBazelBuildRules({root, deps, projects, dependencySyncRule});
+    await generateBazelBuildRules({
+      root,
+      deps,
+      projects,
+      dependencySyncRule,
+      immutable: false,
+    });
   }
 };
 

index.js

@@ -1,11 +1,11 @@
 // @flow
 const {getRootDir} = require('./utils/get-root-dir.js');
 const {parse, normalize} = require('./utils/parse-argv.js');
-const {cli} = require('./utils/cli.js');
+const {cli, CliError} = require('./utils/cli.js');
 const {version} = require('./commands/version.js');
 const {init} = require('./commands/init.js');
 const {scaffold} = require('./commands/scaffold.js');
-const {install} = require('./commands/install.js');
+const {install, ImmutableInstallError} = require('./commands/install.js');
 const {ci} = require('./commands/ci.js');
 const {focus} = require('./commands/focus.js');
 const {add} = require('./commands/add.js');
@@ -86,26 +86,46 @@ const runCLI /*: RunCLI */ = async argv => {
         --skipPreinstall           Skip the preinstall hook
         --skipPostinstall          Skip the postinstall hook
         --mode                     If set to skip-build, skips build scripts. If set to update-lockfile, skips link step
+        --immutable                Fail if generated files need to be modified
         --verbose`,
-        async ({cwd, skipPreinstall, skipPostinstall, mode, verbose}) =>
-          install({
-            root: await rootOf(args),
-            cwd,
-            skipPreinstall: Boolean(skipPreinstall),
-            skipPostinstall: Boolean(skipPostinstall),
-            mode,
-            verbose: Boolean(verbose),
-          }),
+        async ({
+          cwd,
+          skipPreinstall,
+          skipPostinstall,
+          mode,
+          immutable,
+          verbose,
+        }) => {
+          try {
+            await install({
+              root: await rootOf(args),
+              cwd,
+              skipPreinstall: Boolean(skipPreinstall),
+              skipPostinstall: Boolean(skipPostinstall),
+              mode,
+              immutable: Boolean(immutable),
+              verbose: Boolean(verbose),
+            });
+          } catch (error) {
+            handleInstallError(error);
+          }
+        },
       ],
       ci: [
-        `Install all dependencies for all project without modifying source files
+        `Install all dependencies for all projects, failing if any generated files need to be modified
 
         --cwd [cwd]                Project directory to use`,
-        async ({cwd}) => ci({root: await rootOf(args), cwd}),
+        async ({cwd}) => {
+          try {
+            await ci({root: await rootOf(args), cwd});
+          } catch (error) {
+            handleInstallError(error);
+          }
+        },
       ],
       focus: [
         `Install all dependencies for one or more projects without installing the rest
-        
+
         --cwd [cwd]                Project directory to use
         --all                      Install all dependencies, like regular yarn install
         --production               Install only production dependencies, not devDependencies
@@ -366,6 +386,32 @@ const runCLI /*: RunCLI */ = async argv => {
   );
 };
 
+const ansiRed = '\x1b[91m';
+const ansiReset = '\x1b[0m';
+/**
+ * Checks whether the provided error is a `ImmutableInstallError`,
+ * and if it is, throws a `CliError` with a formatted message.
+ */
+function handleInstallError(error /*: Error | ImmutableInstallError */) {
+  if (error instanceof ImmutableInstallError) {
+    const shouldUseColors = process.stdout.isTTY || process.env.FORCE_COLOR;
+    const errorMessage =
+      (shouldUseColors ? ansiRed : '') +
+      'ERROR: ' +
+      error.message +
+      '\n' +
+      error.changedFiles
+        .sort((a, b) => a.localeCompare(b))
+        .map(l => '  - ' + l)
+        .join('\n') +
+      (shouldUseColors ? ansiReset : '');
+
+    throw new CliError(errorMessage, 1);
+  } else {
+    throw error;
+  }
+}
+
 async function rootOf(args) {
   return getRootDir({dir: args.cwd});
 }

tests/fixtures/immutable-install/a/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "a",
+  "version": "0.0.0"
+}

tests/fixtures/immutable-install/b/BUILD.bazel

@@ -0,0 +1,9 @@
+package(default_visibility = ["//visibility:public"])
+load("@jazelle//:build-rules.bzl", "web_library")
+
+web_library(
+  name = "b",
+  deps = [
+  ],
+  dist = ["dist"],
+)

tests/fixtures/immutable-install/b/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "b",
+  "version": "0.0.0",
+  "dependencies": {
+    "a": "0.0.0"
+  }
+}

tests/fixtures/immutable-install/manifest.json

@@ -0,0 +1,3 @@
+{
+  "workspace": "sandbox"
+}

tests/fixtures/immutable-install/package.json

@@ -0,0 +1,4 @@
+{
+  "private": true,
+  "workspaces": ["a", "b"]
+}

tests/fixtures/immutable-install/third_party/jazelle/BUILD.bazel

@@ -0,0 +1,8 @@
+load("@jazelle//:build-rules.bzl", "web_library")
+
+package(default_visibility = ["//visibility:public"])
+
+web_library(
+  name = "node_modules",
+  srcs = glob(["**/*"]),
+)

tests/fixtures/immutable-install/third_party/jazelle/scripts/build-file-template.js

@@ -0,0 +1,8 @@
+// @flow
+module.exports.template = ({name, path, label, dependencies}) => `
+#
+# name: ${name}
+# path: ${path}
+# label: ${label}
+# dependencies: ${dependencies.join('|')}
+#`;