@backstage/cli 0.28.1 → 0.29.0-next.1

package/CHANGELOG.md

@@ -1,10 +1,75 @@
 # @backstage/cli
 
-## 0.28.1
+## 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
+
+- bc71665: **BREAKING**: The `LEGACY_BACKEND_START` flag has been removed, along with support for `src/run.ts` as the development entry point.
 
 ### Patch Changes
 
-- c5276b6: 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.
+- 28b60ad: The check for `react-dom/client` in the Jest configuration will now properly always run from the target directory.
+- e30b65d: Added `--alwaysPack` as a replacement for the now hidden `--alwaysYarnPack` flag for the `build-workspace` command.
+- a7f97e4: Added a new `"rejectFrontendNetworkRequests"` configuration flag that can be set in the `"jest"` field in the root `package.json`:
+
+  ```json
+  {
+    "jest": {
+      "rejectFrontendNetworkRequests": true
+    }
+  }
+  ```
+
+  This flag causes rejection of any form of network requests that are attempted to be made in frontend or common package tests. This flag can only be set in the root `package.json` and can not be overridden in individual package configurations.
+
+- 04297a0: The `--successCache` option for the `repo test` and `repo lint` commands now use an additive store that keeps old entries around for a week before they are cleaned up automatically.
+- b4627f2: Fixed an issue where the `raw-loader` for loading HTML templates was not resolved from the context of the CLI package.
+- 17850a5: Update upgrade-helper link in `versions:bump` command to include `yarnPlugin` parameter when the yarn plugin is installed
+- b084f5a: Bump the Webpack dependency range to `^5.94.0`, as our current configuration is not compatible with some older versions.
+- 946fa34: Added a new `--link <workspace-path>` option for frontend builds that allow you to override module resolution to link in an external workspace at runtime.
+
+  As part of this change the Webpack linked workspace resolution plugin for frontend builds has been removed. It was in place to support the old workspace linking where it was done by Yarn, which is no longer a working option.
+
+- Updated dependencies
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/cli-node@0.2.9
+  - @backstage/config@1.2.0
+  - @backstage/config-loader@1.9.1
+  - @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.28.0
 

package/config/jest.js

@@ -23,12 +23,22 @@ const paths = require('@backstage/cli-common').findPaths(process.cwd());
 
 const SRC_EXTS = ['ts', 'js', 'tsx', 'jsx', 'mts', 'cts', 'mjs', 'cjs'];
 
+const FRONTEND_ROLES = [
+  'frontend',
+  'web-library',
+  'common-library',
+  'frontend-plugin',
+  'frontend-plugin-module',
+];
+
 const envOptions = {
   oldTests: Boolean(process.env.BACKSTAGE_OLD_TESTS),
 };
 
 try {
-  require.resolve('react-dom/client');
+  require.resolve('react-dom/client', {
+    paths: [paths.targetRoot],
+  });
   process.env.HAS_REACT_DOM_CLIENT = true;
 } catch {
   /* ignored */
@@ -121,24 +131,13 @@ const transformIgnorePattern = [
 
 // Provides additional config that's based on the role of the target package
 function getRoleConfig(role) {
-  switch (role) {
-    case 'frontend':
-    case 'web-library':
-    case 'common-library':
-    case 'frontend-plugin':
-    case 'frontend-plugin-module':
-      return { testEnvironment: require.resolve('jest-environment-jsdom') };
-    case 'cli':
-    case 'backend':
-    case 'node-library':
-    case 'backend-plugin':
-    case 'backend-plugin-module':
-    default:
-      return { testEnvironment: require.resolve('jest-environment-node') };
+  if (FRONTEND_ROLES.includes(role)) {
+    return { testEnvironment: require.resolve('jest-environment-jsdom') };
   }
+  return { testEnvironment: require.resolve('jest-environment-node') };
 }
 
-async function getProjectConfig(targetPath, extraConfig) {
+async function getProjectConfig(targetPath, extraConfig, extraOptions) {
   const configJsPath = path.resolve(targetPath, 'jest.config.js');
   const configTsPath = path.resolve(targetPath, 'jest.config.ts');
   // If the package has it's own jest config, we use that instead.
@@ -232,6 +231,17 @@ async function getProjectConfig(targetPath, extraConfig) {
 
   options.setupFilesAfterEnv = options.setupFilesAfterEnv || [];
 
+  if (
+    extraOptions.rejectFrontendNetworkRequests &&
+    FRONTEND_ROLES.includes(pkgJson.backstage?.role)
+  ) {
+    // By adding this first we ensure that it's possible to for example override
+    // fetch with a mock in a custom setup file
+    options.setupFilesAfterEnv.unshift(
+      require.resolve('./jestRejectNetworkRequests.js'),
+    );
+  }
+
   if (options.testEnvironment === require.resolve('jest-environment-jsdom')) {
     // FIXME https://github.com/jsdom/jsdom/issues/1724
     options.setupFilesAfterEnv.unshift(require.resolve('cross-fetch/polyfill'));
@@ -254,7 +264,7 @@ async function getProjectConfig(targetPath, extraConfig) {
       .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}`;
   }
@@ -276,21 +286,31 @@ async function getRootConfig() {
     collectCoverageFrom: ['**/*.{js,jsx,ts,tsx,mjs,cjs}', '!**/*.d.ts'],
   };
 
+  const { rejectFrontendNetworkRequests, ...rootOptions } =
+    rootPkgJson.jest ?? {};
+  const extraRootOptions = {
+    rejectFrontendNetworkRequests,
+  };
+
   const workspacePatterns =
     rootPkgJson.workspaces && rootPkgJson.workspaces.packages;
 
   // Check if we're running within a specific monorepo package. In that case just get the single project config.
   if (!workspacePatterns || paths.targetRoot !== paths.targetDir) {
-    return getProjectConfig(paths.targetDir, {
-      ...baseCoverageConfig,
-      ...(rootPkgJson.jest ?? {}),
-    });
+    return getProjectConfig(
+      paths.targetDir,
+      {
+        ...baseCoverageConfig,
+        ...rootOptions,
+      },
+      extraRootOptions,
+    );
   }
 
   const globalRootConfig = { ...baseCoverageConfig };
   const globalProjectConfig = {};
 
-  for (const [key, value] of Object.entries(rootPkgJson.jest ?? {})) {
+  for (const [key, value] of Object.entries(rootOptions)) {
     if (projectConfigKeys.includes(key)) {
       globalProjectConfig[key] = value;
     } else {
@@ -306,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))) {
@@ -321,10 +341,14 @@ async function getRootConfig() {
         testScript?.includes('backstage-cli test') ||
         testScript?.includes('backstage-cli package test');
       if (testScript && isSupportedTestScript) {
-        return await getProjectConfig(projectPath, {
-          ...globalProjectConfig,
-          displayName: packageData.name,
-        });
+        return await getProjectConfig(
+          projectPath,
+          {
+            ...globalProjectConfig,
+            displayName: packageData.name,
+          },
+          extraRootOptions,
+        );
       }
 
       return undefined;
@@ -333,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/config/jestRejectNetworkRequests.js

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const http = require('http');
+const https = require('https');
+
+const errorMessage = 'Network requests are not allowed in tests';
+
+const origHttpAgent = http.globalAgent;
+const origHttpsAgent = https.globalAgent;
+const origFetch = global.fetch;
+const origXMLHttpRequest = global.fetch;
+
+http.globalAgent = new http.Agent({
+  lookup() {
+    throw new Error(errorMessage);
+  },
+});
+
+https.globalAgent = new https.Agent({
+  lookup() {
+    throw new Error(errorMessage);
+  },
+});
+
+if (global.fetch) {
+  global.fetch = async () => {
+    throw new Error(errorMessage);
+  };
+}
+
+if (global.XMLHttpRequest) {
+  global.XMLHttpRequest = class {
+    constructor() {
+      throw new Error(errorMessage);
+    }
+  };
+}
+
+// Reset overrides after each suite to make sure we don't pollute the test environment
+afterAll(() => {
+  http.globalAgent = origHttpAgent;
+  https.globalAgent = origHttpsAgent;
+  global.fetch = origFetch;
+  global.XMLHttpRequest = origXMLHttpRequest;
+});

package/config/nodeTransform.cjs

@@ -16,6 +16,39 @@
 
 const { transformSync } = require('@swc/core');
 const { addHook } = require('pirates');
+const { Module } = require('module');
+
+// This hooks into module resolution and overrides imports of packages that
+// exist in the linked workspace to instead be resolved from the linked workspace.
+if (process.env.BACKSTAGE_CLI_LINKED_WORKSPACE) {
+  const { join: joinPath } = require('path');
+  const { getPackagesSync } = require('@manypkg/get-packages');
+  const { packages: linkedPackages, root: linkedRoot } = getPackagesSync(
+    process.env.BACKSTAGE_CLI_LINKED_WORKSPACE,
+  );
+
+  // Matches all packages in the linked workspaces, as well as sub-path exports from them
+  const replacementRegex = new RegExp(
+    `^(?:${linkedPackages
+      .map(pkg => pkg.packageJson.name)
+      .join('|')})(?:/.*)?$`,
+  );
+
+  const origLoad = Module._load;
+  Module._load = function requireHook(request, parent) {
+    if (!replacementRegex.test(request)) {
+      return origLoad.call(this, request, parent);
+    }
+
+    // The package import that we're overriding will always existing in the root
+    // node_modules of the linked workspace, so it's enough to override the the
+    // parent paths with that single entry
+    return origLoad.call(this, request, {
+      ...parent,
+      paths: [joinPath(linkedRoot.dir, 'node_modules')],
+    });
+  };
+}
 
 addHook(
   (code, filename) => {

package/dist/commands/build/buildFrontend.cjs.js

@@ -2,30 +2,27 @@
 
 var fs = require('fs-extra');
 var path = require('path');
-require('webpack');
+var bundle = require('../../lib/bundler/bundle.cjs.js');
+var moduleFederation = require('../../lib/bundler/moduleFederation.cjs.js');
 require('chalk');
+require('react-dev-utils/openBrowser');
+require('webpack');
+require('webpack-dev-server');
+require('../../lib/paths.cjs.js');
+var config = require('../../lib/config.cjs.js');
 require('eslint-webpack-plugin');
 require('fork-ts-checker-webpack-plugin');
 require('html-webpack-plugin');
 require('@module-federation/enhanced/webpack');
-require('@backstage/cli-common');
 require('react-dev-utils/ModuleScopePlugin');
-require('run-script-webpack-plugin');
 require('@pmmmwh/react-refresh-webpack-plugin');
-require('../../lib/paths.cjs.js');
-require('@manypkg/get-packages');
-require('webpack-node-externals');
 require('../../lib/bundler/optimization.cjs.js');
 require('lodash/pickBy');
 require('../../lib/run.cjs.js');
 require('mini-css-extract-plugin');
 require('../../lib/version.cjs.js');
 require('yn');
-var bundle = require('../../lib/bundler/bundle.cjs.js');
-var moduleFederation = require('../../lib/bundler/moduleFederation.cjs.js');
-require('react-dev-utils/openBrowser');
-require('webpack-dev-server');
-var config = require('../../lib/config.cjs.js');
+require('@manypkg/get-packages');
 require('../../lib/bundler/packageDetection.cjs.js');
 var parallel = require('../../lib/parallel.cjs.js');
 

package/dist/commands/buildWorkspace.cjs.js

@@ -15,7 +15,7 @@ var buildWorkspace = async (dir, packages, options) => {
   }
   await createDistWorkspace.createDistWorkspace(packages, {
     targetDir: dir,
-    alwaysYarnPack: options.alwaysYarnPack,
+    alwaysPack: options.alwaysPack,
     enableFeatureDetection: true
   });
 };

package/dist/commands/index.cjs.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var commander = require('commander');
 var errors = require('@backstage/errors');
 var errors$1 = require('../lib/errors.cjs.js');
 
@@ -67,7 +68,7 @@ function registerScriptCommand(program) {
   command.command("start").description("Start a package for local development").option(...configOption).option("--role <name>", "Run the command with an explicit package role").option("--check", "Enable type checking and linting if available").option("--inspect [host]", "Enable debugger in Node.js environments").option(
     "--inspect-brk [host]",
     "Enable debugger in Node.js environments, breaking before code starts"
-  ).option("--require <path>", "Add a --require argument to the node process").action(lazy(() => Promise.resolve().then(function () { return require('./start/index.cjs.js'); }).then((m) => m.command)));
+  ).option("--require <path>", "Add a --require argument to the node process").option("--link <path>", "Link an external workspace for module resolution").action(lazy(() => Promise.resolve().then(function () { return require('./start/index.cjs.js'); }).then((m) => m.command)));
   command.command("build").description("Build a package for production deployment or publishing").option("--role <name>", "Run the command with an explicit package role").option(
     "--minify",
     "Minify the generated code. Does not apply to app package (app is minified by default)."
@@ -184,8 +185,13 @@ function registerCommands(program) {
   ).description(
     "Migrate any plugins that have been moved to the @backstage-community namespace automatically"
   ).action(lazy(() => Promise.resolve().then(function () { return require('./versions/migrate.cjs.js'); }).then((m) => m.default)));
-  program.command("build-workspace <workspace-dir> [packages...]").option(
-    "--alwaysYarnPack",
+  program.command("build-workspace <workspace-dir> [packages...]").addOption(
+    new commander.Option(
+      "--alwaysYarnPack",
+      "Alias for --alwaysPack for backwards compatibility."
+    ).implies({ alwaysPack: true }).hideHelp(true)
+  ).option(
+    "--alwaysPack",
     "Force workspace output to be a result of running `yarn pack` on each package (warning: very slow)"
   ).description("Builds a temporary dist workspace from the provided packages").action(lazy(() => Promise.resolve().then(function () { return require('./buildWorkspace.cjs.js'); }).then((m) => m.default)));
   program.command("create-github-app <github-org>").description("Create new GitHub App in your organization.").action(lazy(() => Promise.resolve().then(function () { return require('./create-github-app/index.cjs.js'); }).then((m) => m.default)));

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

@@ -1,50 +1,28 @@
 'use strict';
 
 var chalk = require('chalk');
-var fs = require('fs-extra');
 var crypto = require('crypto');
 var path = require('path');
 var cliNode = require('@backstage/cli-node');
 var paths = require('../../lib/paths.cjs.js');
 var parallel = require('../../lib/parallel.cjs.js');
 var optionsParser = require('./optionsParser.cjs.js');
+var SuccessCache = require('../../lib/cache/SuccessCache.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
 function depCount(pkg) {
   const deps = pkg.dependencies ? Object.keys(pkg.dependencies).length : 0;
   const devDeps = pkg.devDependencies ? Object.keys(pkg.devDependencies).length : 0;
   return deps + devDeps;
 }
-const CACHE_FILE_NAME = "lint-cache.json";
-async function readCache(dir) {
-  try {
-    const data = await fs__default.default.readJson(path.resolve(dir, CACHE_FILE_NAME));
-    if (!Array.isArray(data)) {
-      return void 0;
-    }
-    if (data.some((x) => typeof x !== "string")) {
-      return void 0;
-    }
-    return data;
-  } catch {
-    return void 0;
-  }
-}
-async function writeCache(dir, cache) {
-  await fs__default.default.mkdirp(dir);
-  await fs__default.default.writeJson(path.resolve(dir, CACHE_FILE_NAME), cache, { spaces: 2 });
-}
 async function command(opts, cmd) {
   let packages = await cliNode.PackageGraph.listTargetPackages();
-  const cacheDir = path.resolve(
-    opts.successCacheDir ?? "node_modules/.cache/backstage-cli"
-  );
+  const cache = new SuccessCache.SuccessCache("lint", opts.successCacheDir);
   const cacheContext = opts.successCache ? {
-    cache: await readCache(cacheDir),
+    entries: await cache.read(),
     lockfile: await cliNode.Lockfile.load(paths.paths.resolveTargetRoot("yarn.lock"))
   } : void 0;
   if (opts.since) {
@@ -97,7 +75,7 @@ async function command(opts, cmd) {
       fix: Boolean(opts.fix),
       format: opts.format,
       shouldCache: Boolean(cacheContext),
-      successCache: cacheContext?.cache,
+      successCache: cacheContext?.entries,
       rootDir: paths.paths.targetRoot
     },
     workerFactory: async ({
@@ -111,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,
@@ -136,20 +114,24 @@ 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");
           }
           sha = await hash.digest("hex");
-          if (successCache?.includes(sha)) {
+          if (successCache?.has(sha)) {
             console.log(`Skipped ${relativeDir} due to cache hit`);
             return { relativeDir, sha, failed: false };
           }
@@ -194,7 +176,7 @@ async function command(opts, cmd) {
     }
   }
   if (cacheContext) {
-    await writeCache(cacheDir, outputSuccessCache);
+    await cache.write(outputSuccessCache);
   }
   if (failed) {
     process.exit(1);