@backstage/cli 0.36.0-next.1 → 0.36.0

package/config/jestCachingModuleLoader.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Backstage Authors
+ * Copyright 2023 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.
@@ -14,22 +14,14 @@
  * limitations under the License.
  */
 
-// 'jest-runtime' is included with jest and should be kept in sync with the installed jest version
-// eslint-disable-next-line @backstage/no-undeclared-imports
-const { default: JestRuntime } = require('jest-runtime');
-
-module.exports = class CachingJestRuntime extends JestRuntime {
-  constructor(config, ...restArgs) {
-    super(config, ...restArgs);
-    this.allowLoadAsEsm = config.extensionsToTreatAsEsm.includes('.mts');
-  }
-
-  // Unfortunately we need to use this unstable API to make sure that .js files
-  // are only loaded as modules where ESM is supported, i.e. Node.js packages.
-  unstable_shouldLoadAsEsm(path, ...restArgs) {
-    if (!this.allowLoadAsEsm) {
-      return false;
-    }
-    return super.unstable_shouldLoadAsEsm(path, ...restArgs);
+try {
+  module.exports = require('@backstage/cli-module-test-jest/config/jestCachingModuleLoader');
+} catch (e) {
+  if (e.code === 'MODULE_NOT_FOUND') {
+    throw new Error(
+      '@backstage/cli-module-test-jest is required to use the jest caching module loader. ' +
+        'Please install it as a dependency.',
+    );
   }
-};
+  throw e;
+}

package/config/jestFileTransform.js

@@ -14,31 +14,14 @@
  * limitations under the License.
  */
 
-const path = require('node:path');
-
-module.exports = {
-  process(src, filename) {
-    const assetFilename = JSON.stringify(path.basename(filename));
-
-    if (filename.match(/\.icon\.svg$/)) {
-      return {
-        code: `const React = require('react');
-      const SvgIcon = require('@material-ui/core/SvgIcon').default;
-      module.exports = {
-        __esModule: true,
-        default: props => React.createElement(SvgIcon, props, {
-          $$typeof: Symbol.for('react.element'),
-          type: 'svg',
-          ref: ref,
-          key: null,
-          props: Object.assign({}, props, {
-            children: ${assetFilename}
-          })
-        })
-      };`,
-      };
-    }
-
-    return { code: `module.exports = ${assetFilename};` };
-  },
-};
+try {
+  module.exports = require('@backstage/cli-module-test-jest/config/jestFileTransform');
+} catch (e) {
+  if (e.code === 'MODULE_NOT_FOUND') {
+    throw new Error(
+      '@backstage/cli-module-test-jest is required to use the jest file transform. ' +
+        'Please install it as a dependency.',
+    );
+  }
+  throw e;
+}

package/config/jestRejectNetworkRequests.js

@@ -14,57 +14,14 @@
  * limitations under the License.
  */
 
-const http = require('node:http');
-const https = require('node: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.XMLHttpRequest;
-
-http.globalAgent = new http.Agent({
-  lookup() {
-    throw new Error(errorMessage);
-  },
-});
-
-https.globalAgent = new https.Agent({
-  lookup() {
-    throw new Error(errorMessage);
-  },
-});
-
-const BLOCKING_FETCH_SYMBOL = Symbol.for(
-  'backstage.jestRejectNetworkRequests.blockingFetch',
-);
-
-if (global.fetch) {
-  const blockingFetch = async (input, init) => {
-    // If global.fetch still has our marker, block the request
-    if (global.fetch[BLOCKING_FETCH_SYMBOL]) {
-      throw new Error(errorMessage);
-    }
-    // MSW (or something else) wrapped us - pass through
-    return origFetch(input, init);
-  };
-  blockingFetch[BLOCKING_FETCH_SYMBOL] = true;
-  global.fetch = blockingFetch;
-}
-
-if (global.XMLHttpRequest) {
-  global.XMLHttpRequest = class {
-    constructor() {
-      throw new Error(errorMessage);
-    }
-  };
+try {
+  module.exports = require('@backstage/cli-module-test-jest/config/jestRejectNetworkRequests');
+} catch (e) {
+  if (e.code === 'MODULE_NOT_FOUND') {
+    throw new Error(
+      '@backstage/cli-module-test-jest is required to use the jest network request rejection. ' +
+        'Please install it as a dependency.',
+    );
+  }
+  throw e;
 }
-
-// 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/jestSucraseTransform.js

@@ -14,74 +14,14 @@
  * limitations under the License.
  */
 
-const { createHash } = require('node:crypto');
-const { transform } = require('sucrase');
-const sucrasePkg = require('sucrase/package.json');
-
-const ESM_REGEX = /\b(?:import|export)\b/;
-
-function createTransformer(config) {
-  const process = (source, filePath) => {
-    let transforms;
-
-    if (filePath.endsWith('.esm.js')) {
-      transforms = ['imports'];
-    } else if (filePath.endsWith('.js')) {
-      // This is a very rough filter to avoid transforming things that we quickly
-      // can be sure are definitely not ESM modules.
-      if (ESM_REGEX.test(source)) {
-        transforms = ['imports', 'jsx']; // JSX within .js is currently allowed
-      }
-    } else if (filePath.endsWith('.jsx')) {
-      transforms = ['jsx', 'imports'];
-    } else if (filePath.endsWith('.ts')) {
-      transforms = ['typescript', 'imports'];
-    } else if (filePath.endsWith('.tsx')) {
-      transforms = ['typescript', 'jsx', 'imports'];
-    }
-
-    // Only apply the jest transform to the test files themselves
-    if (transforms && filePath.includes('.test.')) {
-      transforms.push('jest');
-    }
-
-    if (transforms) {
-      const { code, sourceMap: map } = transform(source, {
-        transforms,
-        filePath,
-        disableESTransforms: true,
-        sourceMapOptions: {
-          compiledFilename: filePath,
-        },
-      });
-      if (config.enableSourceMaps) {
-        const b64 = Buffer.from(JSON.stringify(map), 'utf8').toString('base64');
-        const suffix = `//# sourceMappingURL=data:application/json;charset=utf-8;base64,${b64}`;
-        // Include both inline and object source maps, as inline source maps are
-        // needed for support of some editor integrations.
-        return { code: `${code}\n${suffix}`, map };
-      }
-      // We only return the `map` result if source maps are enabled, as they
-      // have a negative impact on the coverage accuracy.
-      return { code };
-    }
-
-    return { code: source };
-  };
-
-  const getCacheKey = sourceText => {
-    return createHash('sha256')
-      .update(sourceText)
-      .update(Buffer.alloc(1))
-      .update(sucrasePkg.version)
-      .update(Buffer.alloc(1))
-      .update(JSON.stringify(config))
-      .update(Buffer.alloc(1))
-      .update('1') // increment whenever the transform logic in this file changes
-      .digest('hex');
-  };
-
-  return { process, getCacheKey };
+try {
+  module.exports = require('@backstage/cli-module-test-jest/config/jestSucraseTransform');
+} catch (e) {
+  if (e.code === 'MODULE_NOT_FOUND') {
+    throw new Error(
+      '@backstage/cli-module-test-jest is required to use the jest Sucrase transform. ' +
+        'Please install it as a dependency.',
+    );
+  }
+  throw e;
 }
-
-module.exports = { createTransformer };

package/config/jestSwcTransform.js

@@ -13,32 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const { createTransformer: createSwcTransformer } = require('@swc/jest');
 
-const ESM_REGEX = /\b(?:import|export)\b/;
-
-function createTransformer(config) {
-  const swcTransformer = createSwcTransformer({
-    inputSourceMap: false,
-    ...config,
-  });
-  const process = (source, filePath, jestOptions) => {
-    // Skip transformation of .js files without ESM syntax, we never transform from CJS to ESM
-    if (filePath.endsWith('.js') && !ESM_REGEX.test(source)) {
-      return { code: source };
-    }
-
-    // Skip transformation of .mjs files, they should only be used if ESM support is available
-    if (jestOptions.supportsStaticESM && filePath.endsWith('.mjs')) {
-      return { code: source };
-    }
-
-    return swcTransformer.process(source, filePath, jestOptions);
-  };
-
-  const getCacheKey = swcTransformer.getCacheKey;
-
-  return { process, getCacheKey };
+try {
+  module.exports = require('@backstage/cli-module-test-jest/config/jestSwcTransform');
+} catch (e) {
+  if (e.code === 'MODULE_NOT_FOUND') {
+    throw new Error(
+      '@backstage/cli-module-test-jest is required to use the jest SWC transform. ' +
+        'Please install it as a dependency.',
+    );
+  }
+  throw e;
 }
-
-module.exports = { createTransformer };

package/config/jestYamlTransform.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 The Backstage Authors
+ * Copyright 2020 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.
@@ -14,27 +14,14 @@
  * limitations under the License.
  */
 
-const yaml = require('yaml');
-const crypto = require('node:crypto');
-
-function createTransformer(config) {
-  const process = source => {
-    const json = JSON.stringify(yaml.parse(source), null, 2);
-    return { code: `module.exports = ${json}`, map: null };
-  };
-
-  const getCacheKey = sourceText => {
-    return crypto
-      .createHash('sha256')
-      .update(sourceText)
-      .update(Buffer.alloc(1))
-      .update(JSON.stringify(config))
-      .update(Buffer.alloc(1))
-      .update('1') // increment whenever the transform logic in this file changes
-      .digest('hex');
-  };
-
-  return { process, getCacheKey };
+try {
+  module.exports = require('@backstage/cli-module-test-jest/config/jestYamlTransform');
+} catch (e) {
+  if (e.code === 'MODULE_NOT_FOUND') {
+    throw new Error(
+      '@backstage/cli-module-test-jest is required to use the jest YAML transform. ' +
+        'Please install it as a dependency.',
+    );
+  }
+  throw e;
 }
-
-module.exports = { createTransformer };

package/config/nodeTransform.cjs

@@ -14,74 +14,14 @@
  * limitations under the License.
  */
 
-const { pathToFileURL } = require('node:url');
-const { transformSync } = require('@swc/core');
-const { addHook } = require('pirates');
-const { Module } = require('node: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('node: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
-    // parent paths with that single entry
-    return origLoad.call(this, request, {
-      ...parent,
-      paths: [joinPath(linkedRoot.dir, 'node_modules')],
-    });
-  };
+try {
+  require('@backstage/cli-node/config/nodeTransform.cjs');
+} catch (e) {
+  if (e.code === 'MODULE_NOT_FOUND') {
+    throw new Error(
+      '@backstage/cli-node is required to use the node transform. ' +
+        'Please install it as a dependency.',
+    );
+  }
+  throw e;
 }
-
-addHook(
-  (code, filename) => {
-    const transformed = transformSync(code, {
-      filename,
-      sourceMaps: 'inline',
-      module: {
-        type: 'commonjs',
-        ignoreDynamic: true,
-      },
-      jsc: {
-        target: 'es2023',
-        parser: {
-          syntax: 'typescript',
-        },
-      },
-    });
-    process.send?.({ type: 'watch', path: filename });
-    return transformed.code;
-  },
-  { extensions: ['.ts', '.cts'], ignoreNodeModules: true },
-);
-
-addHook(
-  (code, filename) => {
-    process.send?.({ type: 'watch', path: filename });
-    return code;
-  },
-  { extensions: ['.js', '.cjs'], ignoreNodeModules: true },
-);
-
-// Register module hooks, used by "type": "module" in package.json, .mjs and
-// .mts files, as well as dynamic import(...)s, although dynamic imports will be
-// handled be the CommonJS hooks in this file if what it points to is CommonJS.
-Module.register('./nodeTransformHooks.mjs', pathToFileURL(__filename));