@backstage/cli 0.29.0-next.0 → 0.29.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @backstage/cli
 
+## 0.29.0-next.1
+
+### Minor Changes
+
+- 6819f8c: Added a new optimization to the `repo test` command that will filter out unused packages in watch mode if all provide filters are paths that point from the repo root. This significantly speeds up running individual tests from the repo root in a large workspace, for example:
+
+  ```sh
+  yarn test packages/app/src/App.test.tsx
+  ```
+
+### Patch Changes
+
+- 4046d53: Fixed an issue where the `--successCache` option for the `repo test` and `repo lint` commands would be include the workspace path in generated cache keys. This previously broke caching in environments where the workspace path varies across builds.
+- 6b2888c: Fixed an issue with the `--successCache` flag for `repo test` where the tree hash for the wrong package directory would sometimes be used to generate the cache key.
+- 6266ed3: Updated dependency `del` to `^8.0.0`.
+- 4046d53: Fixed an issue with the `repo lint` command where the cache key for the `--successCache` option would not properly ignore files that should be ignored according to `.eslintignore`s.
+- 702f41d: Bumped dev dependencies `@types/node`
+- Updated dependencies
+  - @backstage/cli-common@0.1.15-next.0
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-node@0.2.10-next.0
+  - @backstage/config@1.2.0
+  - @backstage/config-loader@1.9.2-next.0
+  - @backstage/errors@1.2.4
+  - @backstage/eslint-plugin@0.1.10
+  - @backstage/integration@1.15.1
+  - @backstage/release-manifests@0.0.11
+  - @backstage/types@1.1.1
+
 ## 0.29.0-next.0
 
 ### Minor Changes

package/config/jest.js

@@ -264,7 +264,7 @@ async function getProjectConfig(targetPath, extraConfig, extraOptions) {
       .createHash('sha256')
       .update(version)
       .update(Buffer.alloc(1))
-      .update(JSON.stringify(config.transform))
+      .update(JSON.stringify(config.transform).replaceAll(paths.targetRoot, ''))
       .digest('hex');
     config.id = `backstage_cli_${configHash}`;
   }
@@ -326,7 +326,7 @@ async function getRootConfig() {
     ),
   ).then(_ => _.flat());
 
-  let configs = await Promise.all(
+  let projects = await Promise.all(
     projectPaths.flat().map(async projectPath => {
       const packagePath = path.resolve(projectPath, 'package.json');
       if (!(await fs.pathExists(packagePath))) {
@@ -357,12 +357,16 @@ async function getRootConfig() {
 
   const cache = global.__backstageCli_jestSuccessCache;
   if (cache) {
-    configs = await cache.filterConfigs(configs, globalRootConfig);
+    projects = await cache.filterConfigs(projects, globalRootConfig);
+  }
+  const watchProjectFilter = global.__backstageCli_watchProjectFilter;
+  if (watchProjectFilter) {
+    projects = await watchProjectFilter.filter(projects);
   }
 
   return {
     rootDir: paths.targetRoot,
-    projects: configs,
+    projects,
     testResultsProcessor: cache
       ? require.resolve('./jestCacheResultProcessor.cjs')
       : undefined,

package/dist/commands/repo/lint.cjs.js

@@ -89,7 +89,7 @@ async function command(opts, cmd) {
       const crypto = require("crypto");
       const globby = require("globby");
       const { readFile } = require("fs/promises");
-      const { relative: workerRelativePath } = require("path");
+      const workerPath = require("path");
       return async ({
         fullDir,
         relativeDir,
@@ -114,15 +114,19 @@ async function command(opts, cmd) {
           hash.update(parentHash);
           hash.update("\0");
           for (const path of result.sort()) {
-            if (await eslint.isPathIgnored(path)) {
+            const absPath = workerPath.resolve(rootDir, path);
+            const pathInPackage = workerPath.relative(fullDir, absPath);
+            if (await eslint.isPathIgnored(pathInPackage)) {
               continue;
             }
-            hash.update(workerRelativePath(fullDir, path));
+            hash.update(pathInPackage);
             hash.update("\0");
-            hash.update(await readFile(path));
+            hash.update(await readFile(absPath));
             hash.update("\0");
             hash.update(
-              JSON.stringify(await eslint.calculateConfigForFile(path))
+              JSON.stringify(
+                await eslint.calculateConfigForFile(pathInPackage)
+              ).replaceAll(rootDir, "")
             );
             hash.update("\0");
           }

package/dist/commands/repo/test.cjs.js

@@ -3,6 +3,7 @@
 var os = require('os');
 var crypto = require('node:crypto');
 var yargs = require('yargs');
+var jestCli = require('jest-cli');
 var path = require('path');
 var cliNode = require('@backstage/cli-node');
 var paths = require('../../lib/paths.cjs.js');
@@ -17,23 +18,30 @@ var crypto__default = /*#__PURE__*/_interopDefaultCompat(crypto);
 var yargs__default = /*#__PURE__*/_interopDefaultCompat(yargs);
 
 async function readPackageTreeHashes(graph) {
-  const pkgs = Array.from(graph.values());
+  const pkgs = Array.from(graph.values()).map((pkg) => ({
+    ...pkg,
+    path: path.relative(paths.paths.targetRoot, pkg.dir)
+  }));
   const output = await run.runPlain(
     "git",
     "ls-tree",
-    "--object-only",
+    '--format="%(objectname)=%(path)"',
     "HEAD",
     "--",
-    ...pkgs.map((pkg) => path.relative(paths.paths.targetRoot, pkg.dir))
+    ...pkgs.map((pkg) => pkg.path)
   );
-  const treeShaList = output.trim().split(/\r?\n/);
-  if (treeShaList.length !== pkgs.length) {
-    throw new Error(
-      `Error listing project git tree hashes, output length does not equal input length`
-    );
-  }
   const map = new Map(
-    pkgs.map((pkg, i) => [pkg.packageJson.name, treeShaList[i]])
+    output.trim().split(/\r?\n/).map((line) => {
+      const [itemSha, ...itemPathParts] = line.split("=");
+      const itemPath = itemPathParts.join("=");
+      const pkg = pkgs.find((p) => p.path === itemPath);
+      if (!pkg) {
+        throw new Error(
+          `Unexpectedly missing tree sha entry for path ${itemPath}`
+        );
+      }
+      return [pkg.packageJson.name, itemSha];
+    })
   );
   return (pkgName) => {
     const sha = map.get(pkgName);
@@ -83,6 +91,7 @@ function removeOptionArg(args, option, size = 2) {
   } while (changed);
 }
 async function command(opts, cmd) {
+  const testGlobal = global;
   let parent = cmd;
   while (parent.parent) {
     parent = parent.parent;
@@ -90,21 +99,44 @@ async function command(opts, cmd) {
   const allArgs = parent.args;
   const args = allArgs.slice(allArgs.indexOf("test") + 1);
   const hasFlags = createFlagFinder(args);
+  const { _: parsedArgs } = await yargs__default.default(args).options(jestCli.yargsOptions).argv;
   if (!hasFlags("-c", "--config")) {
     args.push("--config", paths.paths.resolveOwn("config/jest.js"));
   }
   if (!hasFlags("--passWithNoTests")) {
     args.push("--passWithNoTests");
   }
+  let isSingleWatchMode = args.includes("--watch");
   if (!opts.since && !process.env.CI && !hasFlags("--coverage", "--watch", "--watchAll")) {
     const isGitRepo = () => run.runCheck("git", "rev-parse", "--is-inside-work-tree");
     const isMercurialRepo = () => run.runCheck("hg", "--cwd", ".", "root");
     if (await isGitRepo() || await isMercurialRepo()) {
+      isSingleWatchMode = true;
       args.push("--watch");
     } else {
       args.push("--watchAll");
     }
   }
+  if (isSingleWatchMode && parsedArgs.length > 0) {
+    testGlobal.__backstageCli_watchProjectFilter = {
+      async filter(projectConfigs) {
+        const selectedProjects2 = [];
+        const usedArgs = /* @__PURE__ */ new Set();
+        for (const project of projectConfigs) {
+          for (const arg of parsedArgs) {
+            if (cliCommon.isChildPath(project.rootDir, String(arg))) {
+              selectedProjects2.push(project);
+              usedArgs.add(arg);
+            }
+          }
+        }
+        if (usedArgs.size !== parsedArgs.length) {
+          return projectConfigs;
+        }
+        return selectedProjects2;
+      }
+    };
+  }
   if (!hasFlags("--workerIdleMemoryLimit")) {
     args.push("--workerIdleMemoryLimit=1000M");
   }
@@ -153,11 +185,9 @@ async function command(opts, cmd) {
     args.push("--help");
     process.stdout._handle.setBlocking(true);
   }
-  const jestCli = require("jest-cli");
   if (opts.successCache) {
     removeOptionArg(args, "--successCache", 1);
     removeOptionArg(args, "--successCacheDir");
-    const { _: parsedArgs } = await yargs__default.default(args).options(jestCli.yargsOptions).argv;
     if (parsedArgs.length > 0) {
       throw new Error(
         `The --successCache flag can not be combined with the following arguments: ${parsedArgs.join(
@@ -174,8 +204,7 @@ async function command(opts, cmd) {
     const graph = await getPackageGraph();
     const projectHashes = /* @__PURE__ */ new Map();
     const outputSuccessCache = new Array();
-    const globalWithCache = global;
-    globalWithCache.__backstageCli_jestSuccessCache = {
+    testGlobal.__backstageCli_jestSuccessCache = {
       // This is called by `config/jest.js` after the project configs have been gathered
       async filterConfigs(projectConfigs, globalRootConfig) {
         const cacheEntries = await cache.read();
@@ -188,7 +217,9 @@ async function command(opts, cmd) {
         baseHash.update("\0");
         baseHash.update(process.version);
         baseHash.update("\0");
-        baseHash.update(JSON.stringify(globalRootConfig));
+        baseHash.update(
+          SuccessCache.SuccessCache.trimPaths(JSON.stringify(globalRootConfig))
+        );
         const baseSha = baseHash.digest("hex");
         return projectConfigs.filter((project) => {
           const packageName = project.displayName;
@@ -206,7 +237,7 @@ async function command(opts, cmd) {
             const depHash = getPackageTreeHash(depPkg.name);
             hash.update(`${depName}:${depHash}`);
           }
-          hash.update(JSON.stringify(project));
+          hash.update(SuccessCache.SuccessCache.trimPaths(JSON.stringify(project)));
           hash.update(lockfile.getDependencyTreeHash(packageName));
           const sha = hash.digest("hex");
           projectHashes.set(packageName, sha);

package/dist/lib/cache/SuccessCache.cjs.js

@@ -2,6 +2,7 @@
 
 var fs = require('fs-extra');
 var node_path = require('node:path');
+var paths = require('../paths.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -11,6 +12,14 @@ const DEFAULT_CACHE_BASE_PATH = "node_modules/.cache/backstage-cli";
 const CACHE_MAX_AGE_MS = 7 * 24 * 36e5;
 class SuccessCache {
   #path;
+  /**
+   * Trim any occurrences of the workspace root path from the input string. This
+   * is useful to ensure stable hashes that don't vary based on the workspace
+   * location.
+   */
+  static trimPaths(input) {
+    return input.replaceAll(paths.paths.targetRoot, "");
+  }
   constructor(name, basePath) {
     this.#path = node_path.resolve(basePath ?? DEFAULT_CACHE_BASE_PATH, name);
   }

package/dist/packages/backend-defaults/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.5.3-next.0";
+var version = "0.5.3-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/backend-plugin-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.0.2-next.0";
+var version = "1.0.2-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/backend-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.0.3-next.0";
+var version = "1.0.3-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/cli/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.29.0-next.0";
+var version = "0.29.0-next.1";
 var dependencies = {
 	"@backstage/catalog-model": "workspace:^",
 	"@backstage/cli-common": "workspace:^",
@@ -144,7 +144,7 @@ var devDependencies = {
 	"@types/fs-extra": "^11.0.0",
 	"@types/http-proxy": "^1.17.4",
 	"@types/inquirer": "^8.1.3",
-	"@types/node": "^18.17.8",
+	"@types/node": "^20.16.0",
 	"@types/npm-packlist": "^3.0.0",
 	"@types/recursive-readdir": "^2.2.0",
 	"@types/rollup-plugin-peer-deps-external": "^2.2.0",
@@ -155,7 +155,7 @@ var devDependencies = {
 	"@types/webpack-sources": "^3.2.3",
 	"@types/yarnpkg__lockfile": "^1.1.4",
 	"@vitejs/plugin-react": "^4.3.1",
-	del: "^7.0.0",
+	del: "^8.0.0",
 	msw: "^1.0.0",
 	nodemon: "^3.0.1",
 	vite: "^5.0.0",

package/dist/packages/core-components/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.16.0-next.0";
+var version = "0.16.0-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/dev-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.1.3-next.0";
+var version = "1.1.3-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.7.0";
+var version = "1.7.1-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/theme/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.6.0";
+var version = "0.6.1-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/auth-backend/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.24.0-next.0";
+var version = "0.24.0-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/auth-backend-module-guest-provider/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.2.2-next.0";
+var version = "0.2.2-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/catalog-node/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.14.0-next.0";
+var version = "1.14.0-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/scaffolder-node/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.5.1-next.0";
+var version = "0.5.1-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/scaffolder-node-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.1.15-next.0";
+var version = "0.1.15-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/cli",
-  "version": "0.29.0-next.0",
+  "version": "0.29.0-next.1",
   "description": "CLI for developing Backstage plugins and apps",
   "backstage": {
     "role": "cli"
@@ -43,10 +43,10 @@
   },
   "dependencies": {
     "@backstage/catalog-model": "1.7.0",
-    "@backstage/cli-common": "0.1.14",
-    "@backstage/cli-node": "0.2.9",
+    "@backstage/cli-common": "0.1.15-next.0",
+    "@backstage/cli-node": "0.2.10-next.0",
     "@backstage/config": "1.2.0",
-    "@backstage/config-loader": "1.9.1",
+    "@backstage/config-loader": "1.9.2-next.0",
     "@backstage/errors": "1.2.4",
     "@backstage/eslint-plugin": "0.1.10",
     "@backstage/integration": "1.15.1",
@@ -159,22 +159,22 @@
   },
   "devDependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-plugin-api": "1.0.2-next.0",
-    "@backstage/backend-test-utils": "1.0.3-next.0",
+    "@backstage/backend-plugin-api": "1.0.2-next.1",
+    "@backstage/backend-test-utils": "1.0.3-next.1",
     "@backstage/catalog-client": "1.8.0-next.0",
     "@backstage/config": "1.2.0",
     "@backstage/core-app-api": "1.15.1",
-    "@backstage/core-components": "0.16.0-next.0",
+    "@backstage/core-components": "0.16.0-next.1",
     "@backstage/core-plugin-api": "1.10.0",
-    "@backstage/dev-utils": "1.1.3-next.0",
+    "@backstage/dev-utils": "1.1.3-next.1",
     "@backstage/errors": "1.2.4",
-    "@backstage/plugin-auth-backend": "0.24.0-next.0",
-    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.2-next.0",
-    "@backstage/plugin-catalog-node": "1.14.0-next.0",
-    "@backstage/plugin-scaffolder-node": "0.5.1-next.0",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.1.15-next.0",
-    "@backstage/test-utils": "1.7.0",
-    "@backstage/theme": "0.6.0",
+    "@backstage/plugin-auth-backend": "0.24.0-next.1",
+    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.2-next.1",
+    "@backstage/plugin-catalog-node": "1.14.0-next.1",
+    "@backstage/plugin-scaffolder-node": "0.5.1-next.1",
+    "@backstage/plugin-scaffolder-node-test-utils": "0.1.15-next.1",
+    "@backstage/test-utils": "1.7.1-next.0",
+    "@backstage/theme": "0.6.1-next.0",
     "@rspack/core": "^1.0.10",
     "@rspack/dev-server": "^1.0.9",
     "@rspack/plugin-react-refresh": "^1.0.0",
@@ -184,7 +184,7 @@
     "@types/fs-extra": "^11.0.0",
     "@types/http-proxy": "^1.17.4",
     "@types/inquirer": "^8.1.3",
-    "@types/node": "^18.17.8",
+    "@types/node": "^20.16.0",
     "@types/npm-packlist": "^3.0.0",
     "@types/recursive-readdir": "^2.2.0",
     "@types/rollup-plugin-peer-deps-external": "^2.2.0",
@@ -195,7 +195,7 @@
     "@types/webpack-sources": "^3.2.3",
     "@types/yarnpkg__lockfile": "^1.1.4",
     "@vitejs/plugin-react": "^4.3.1",
-    "del": "^7.0.0",
+    "del": "^8.0.0",
     "msw": "^1.0.0",
     "nodemon": "^3.0.1",
     "vite": "^5.0.0",