paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 43 Packages Projects Releases Wiki Activity

Merge pull request #28308 from backstage/rugvip/modules

Browse Source 
cli: add support for native ESM in Node.js packages
This commit is contained in:
Patrik Oldsberg
2025-01-16 14:07:54 +01:00
committed by GitHub
parent c0a8a92136 c09845bb4e
commit e57fd0c63d
96 changed files with 1810 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/afraid-experts-explain.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli-node': patch
---
Added `type` field to `BackstagePackageJson` type.
.changeset/beige-dingos-destroy.md
+18
View File
@@ -0,0 +1,18 @@
---
'@backstage/cli': minor
---
**BREAKING**: Add support for native ESM in Node.js code. This changes the behavior of dynamic import expressions in Node.js code. Typically this can be fixed by replacing `import(...)` with `require(...)`, with an `as typeof import(...)` cast if needed for types. This is because dynamic imports will no longer be transformed to `require(...)` calls, but instead be left as-is. This in turn allows you to load ESM modules from CommonJS code using `import(...)`.
This change adds support for the following in Node.js packages, across type checking, package builds, runtime transforms and Jest tests:
- Dynamic imports that load ESM modules from CommonJS code.
- Both `.mjs` and `.mts` files as explicit ESM files, as well as `.cjs` and `.cts` as explicit CommonJS files.
- Support for the `"type": "module"` field in `package.json` to indicate that the package is an ESM package.
There are a few caveats to be aware of:
- To enable support for native ESM in tests, you need to run the tests with the `--experimental-vm-modules` flag enabled, typically via `NODE_OPTIONS='--experimental-vm-modules'`.
- Declaring a package as `"type": "module"` in `package.json` is supported, but in tests it will cause all local transitive dependencies to also be treated as ESM, regardless of whether they declare `"type": "module"` or not.
- Node.js has an [ESM interoperability layer with CommonJS](https://nodejs.org/docs/latest-v22.x/api/esm.html#interoperability-with-commonjs) that allows for imports from ESM to identify named exports in CommonJS packages. This interoperability layer is **only** enabled when importing packages with a `.cts` or `.cjs` extension. This is because the interoperability layer is not fully compatible with the NPM ecosystem, and would break package if it was enabled for `.js` files.
- Dynamic imports of CommonJS packages will vary in shape depending on the runtime, i.e. test vs local development, etc. It is therefore recommended to avoid dynamic imports of CommonJS packages and instead use `require`, or to use the explicit CommonJS extensions as mentioned above. If you do need to dynamically import CommonJS packages, avoid using `default` exports, as the shape of them vary across different environments and you would otherwise need to manually unwrap the import based on the shape of the module object.
.changeset/curly-humans-prove.md
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/backend-test-utils': patch
'@backstage/backend-defaults': patch
'@backstage/config-loader': patch
---
Internal refactor to use explicit `require` for lazy-loading dependency.
.changeset/dry-horses-report.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-test-utils': patch
---
Sync feature installation compatibility logic with `@backstage/backend-app-api`.
.changeset/quiet-phones-sell.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/repo-tools': patch
---
Internal refactor to support native ESM.
.changeset/twelve-eyes-stare.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-dynamic-feature-service': patch
---
Make sure changes are successfully tracked before starting up scanner.
.github/workflows/ci.yml
+1 -1
View File
@@ -202,7 +202,7 @@ jobs:
env:
CI: true
NODE_OPTIONS: --max-old-space-size=8192 --no-node-snapshot
NODE_OPTIONS: --max-old-space-size=8192 --no-node-snapshot --experimental-vm-modules
INTEGRATION_TEST_GITHUB_TOKEN: ${{ secrets.INTEGRATION_TEST_GITHUB_TOKEN }}
INTEGRATION_TEST_GITLAB_TOKEN: ${{ secrets.INTEGRATION_TEST_GITLAB_TOKEN }}
INTEGRATION_TEST_BITBUCKET_TOKEN: ${{ secrets.INTEGRATION_TEST_BITBUCKET_TOKEN }}
.github/workflows/verify_windows.yml
+1 -1
View File
@@ -21,7 +21,7 @@ jobs:
env:
CI: true
NODE_OPTIONS: --max-old-space-size=8192 --no-node-snapshot
NODE_OPTIONS: --max-old-space-size=8192 --no-node-snapshot --experimental-vm-modules
INTEGRATION_TEST_GITHUB_TOKEN: ${{ secrets.INTEGRATION_TEST_GITHUB_TOKEN }}
INTEGRATION_TEST_GITLAB_TOKEN: ${{ secrets.INTEGRATION_TEST_GITLAB_TOKEN }}
INTEGRATION_TEST_BITBUCKET_TOKEN: ${{ secrets.INTEGRATION_TEST_BITBUCKET_TOKEN }}
docs/tooling/cli/02-build-system.md
+34 -23
View File
@@ -483,29 +483,40 @@ of the build system, including the bundling, tests, builds, and type checking.
Loaders are always selected based on the file extension. The following is a list
of all supported file extensions:
| Extension | Exports | Purpose |
| --------- | ------------- | ------------------ |
| `.ts` | Script Module | TypeScript |
| `.tsx` | Script Module | TypeScript and XML |
| `.js` | Script Module | JavaScript |
| `.jsx` | Script Module | JavaScript and XML |
| `.mjs` | Script Module | ECMAScript Module |
| `.cjs` | Script Module | CommonJS Module |
| `.json` | JSON Data | JSON Data |
| `.yml` | JSON Data | YAML Data |
| `.yaml` | JSON Data | YAML Data |
| `.css` | classes | Style sheet |
| `.eot` | URL Path | Font |
| `.ttf` | URL Path | Font |
| `.woff2` | URL Path | Font |
| `.woff` | URL Path | Font |
| `.bmp` | URL Path | Image |
| `.gif` | URL Path | Image |
| `.jpeg` | URL Path | Image |
| `.jpg` | URL Path | Image |
| `.png` | URL Path | Image |
| `.svg` | URL Path | Image |
| `.md` | URL Path | Markdown File |
| Extension | Exports | Purpose |
| --------- | ------------- | ---------------------------- |
| `.ts` | Script Module | TypeScript |
| `.tsx` | Script Module | TypeScript and XML |
| `.mts` | Script Module | ECMAScript Module TypeScript |
| `.cts` | Script Module | CommonJS TypeScript |
| `.js` | Script Module | JavaScript |
| `.jsx` | Script Module | JavaScript and XML |
| `.mjs` | Script Module | ECMAScript Module |
| `.cjs` | Script Module | CommonJS Module |
| `.json` | JSON Data | JSON Data |
| `.yml` | JSON Data | YAML Data |
| `.yaml` | JSON Data | YAML Data |
| `.css` | classes | Style sheet |
| `.eot` | URL Path | Font |
| `.ttf` | URL Path | Font |
| `.woff2` | URL Path | Font |
| `.woff` | URL Path | Font |
| `.bmp` | URL Path | Image |
| `.gif` | URL Path | Image |
| `.jpeg` | URL Path | Image |
| `.jpg` | URL Path | Image |
| `.png` | URL Path | Image |
| `.svg` | URL Path | Image |
| `.md` | URL Path | Markdown File |
## ECMAScript Modules
The Backstage tooling supports [ECMAScript modules (ESM)](https://nodejs.org/docs/latest-v22.x/api/esm.html) in Node.js packages. This includes support for all the script module file extensions listed above during local development, in built packages, in tests, and during type checking. [Dynamic imports](https://nodejs.org/docs/latest-v22.x/api/esm.html#import-expressions) can be used to load ESM-only packages from CommonJS and vice versa. There are however a couple of limitations to be aware of:
- To enable support for native ESM in tests, you need to run the tests with the `--experimental-vm-modules` flag enabled, typically via `NODE_OPTIONS='--experimental-vm-modules'`.
- Declaring a package as `"type": "module"` in `package.json` is supported, but in tests it will cause all local transitive dependencies to also be treated as ESM, regardless of whether they declare `"type": "module"` or not.
- Node.js has an [ESM interoperability layer with CommonJS](https://nodejs.org/docs/latest-v22.x/api/esm.html#interoperability-with-commonjs) that allows for imports from ESM to identify named exports in CommonJS packages. This interoperability layer is **only** enabled when importing packages with a `.cts` or `.cjs` extension. This is because the interoperability layer is not fully compatible with the NPM ecosystem, and would break package if it was enabled for `.js` files.
- Dynamic imports of CommonJS packages will vary in shape depending on the runtime, i.e. test vs local development, etc. It is therefore recommended to avoid dynamic imports of CommonJS packages and instead use `require`, or to use the explicit CommonJS extensions as mentioned above. If you do need to dynamically import CommonJS packages, avoid using `default` exports, as the shape of them vary across different environments and you would otherwise need to manually unwrap the import based on the shape of the module object.
## Jest Configuration
package.json
+2 -2
View File
@@ -49,8 +49,8 @@
"storybook": "yarn ./storybook run storybook",
"techdocs-cli": "node scripts/techdocs-cli.js",
"techdocs-cli:dev": "cross-env TECHDOCS_CLI_DEV_MODE=true node scripts/techdocs-cli.js",
"test": "NODE_OPTIONS=--no-node-snapshot backstage-cli repo test",
"test:all": "NODE_OPTIONS=--no-node-snapshot backstage-cli repo test --coverage",
"test": "NODE_OPTIONS='--no-node-snapshot --experimental-vm-modules' backstage-cli repo test",
"test:all": "NODE_OPTIONS='--no-node-snapshot --experimental-vm-modules' backstage-cli repo test --coverage",
"test:e2e": "NODE_OPTIONS=--no-node-snapshot playwright test",
"tsc": "tsc",
"tsc:full": "backstage-cli repo clean && tsc --skipLibCheck false --incremental false"
packages/backend-defaults/src/entrypoints/database/connectors/postgres.ts
+1 -1
View File
@@ -103,7 +103,7 @@ export async function buildPgDatabaseConfig(
Connector: CloudSqlConnector,
IpAddressTypes,
AuthTypes,
} = await import('@google-cloud/cloud-sql-connector');
} = require('@google-cloud/cloud-sql-connector') as typeof import('@google-cloud/cloud-sql-connector');
const connector = new CloudSqlConnector();
const clientOpts = await connector.getOptions({
instanceConnectionName: config.connection.instance,
packages/backend-dynamic-feature-service/src/manager/plugin-manager.ts
+1 -1
View File
@@ -68,7 +68,7 @@ export class DynamicPluginManager implements DynamicPluginProvider {
preferAlpha: options.preferAlpha,
});
const scannedPlugins = (await scanner.scanRoot()).packages;
scanner.trackChanges();
await scanner.trackChanges();
const moduleLoader =
options.moduleLoader ||
new CommonJSModuleLoader({ logger: options.logger });
packages/backend-test-utils/src/cache/memcache.ts
Vendored
+2 -1
View File
@@ -59,7 +59,8 @@ export async function startMemcachedContainer(
image: string,
): Promise<Instance> {
// Lazy-load to avoid side-effect of importing testcontainers
const { GenericContainer } = await import('testcontainers');
const { GenericContainer } =
require('testcontainers') as typeof import('testcontainers');
const container = await new GenericContainer(image)
.withExposedPorts(11211)
packages/backend-test-utils/src/cache/redis.ts
Vendored
+2 -1
View File
@@ -57,7 +57,8 @@ export async function connectToExternalRedis(
export async function startRedisContainer(image: string): Promise<Instance> {
// Lazy-load to avoid side-effect of importing testcontainers
const { GenericContainer } = await import('testcontainers');
const { GenericContainer } =
require('testcontainers') as typeof import('testcontainers');
const container = await new GenericContainer(image)
.withExposedPorts(6379)
packages/backend-test-utils/src/database/mysql.ts
+2 -1
View File
@@ -72,7 +72,8 @@ export async function startMysqlContainer(image: string): Promise<{
const password = uuid();
// Lazy-load to avoid side-effect of importing testcontainers
const { GenericContainer } = await import('testcontainers');
const { GenericContainer } =
require('testcontainers') as typeof import('testcontainers');
const container = await new GenericContainer(image)
.withExposedPorts(3306)
packages/backend-test-utils/src/database/postgres.ts
+2 -1
View File
@@ -72,7 +72,8 @@ export async function startPostgresContainer(image: string): Promise<{
const password = uuid();
// Lazy-load to avoid side-effect of importing testcontainers
const { GenericContainer } = await import('testcontainers');
const { GenericContainer } =
require('testcontainers') as typeof import('testcontainers');
const container = await new GenericContainer(image)
.withExposedPorts(5432)
packages/backend-test-utils/src/next/wiring/TestBackend.ts
+11 -2
View File
@@ -210,10 +210,19 @@ function isPromise<T>(value: unknown | Promise<T>): value is Promise<T> {
);
}
// Same as in the backend-app-api, handles double defaults from dynamic imports
function unwrapFeature(
feature: BackendFeature | (() => BackendFeature),
feature: BackendFeature | { default: BackendFeature },
): BackendFeature {
return typeof feature === 'function' ? feature() : feature;
if ('$$type' in feature) {
return feature;
}
if ('default' in feature) {
return feature.default;
}
return feature;
}
const backendInstancesToCleanUp = new Array<Backend>();
packages/cli-node/report.api.md
+2
View File
@@ -72,6 +72,8 @@ export interface BackstagePackageJson {
[key: string]: string;
};
// (undocumented)
type?: 'module' | 'commonjs';
// (undocumented)
types?: string;
// (undocumented)
typesVersions?: Record<string, Record<string, string[]>>;
packages/cli-node/src/monorepo/PackageGraph.ts
+2
View File
@@ -43,6 +43,8 @@ export interface BackstagePackageJson {
// that the package bundles all of its dependencies in its build output.
bundled?: boolean;
type?: 'module' | 'commonjs';
backstage?: {
role?: PackageRole;
moved?: string;
packages/cli/config/jest.js
+98 -62
View File
@@ -31,6 +31,14 @@ const FRONTEND_ROLES = [
'frontend-plugin-module',
];
const NODE_ROLES = [
'backend',
'cli',
'node-library',
'backend-plugin',
'backend-plugin-module',
];
const envOptions = {
oldTests: Boolean(process.env.BACKSTAGE_OLD_TESTS),
};
@@ -130,11 +138,97 @@ const transformIgnorePattern = [
].join('|');
// Provides additional config that's based on the role of the target package
function getRoleConfig(role) {
function getRoleConfig(role, pkgJson) {
// Only Node.js package roles support native ESM modules, frontend and common
// packages are always transpiled to CommonJS.
const moduleOpts = NODE_ROLES.includes(role)
? {
module: {
ignoreDynamic: true,
exportInteropAnnotation: true,
},
}
: undefined;
const transform = {
'\\.(mjs|cjs|js)$': [
require.resolve('./jestSwcTransform'),
{
...moduleOpts,
jsc: {
parser: {
syntax: 'ecmascript',
},
},
},
],
'\\.jsx$': [
require.resolve('./jestSwcTransform'),
{
jsc: {
parser: {
syntax: 'ecmascript',
jsx: true,
},
transform: {
react: {
runtime: 'automatic',
},
},
},
},
],
'\\.(mts|cts|ts)$': [
require.resolve('./jestSwcTransform'),
{
...moduleOpts,
jsc: {
parser: {
syntax: 'typescript',
},
},
},
],
'\\.tsx$': [
require.resolve('./jestSwcTransform'),
{
jsc: {
parser: {
syntax: 'typescript',
tsx: true,
},
transform: {
react: {
runtime: 'automatic',
},
},
},
},
],
'\\.(bmp|gif|jpg|jpeg|png|ico|webp|frag|xml|svg|eot|woff|woff2|ttf)$':
require.resolve('./jestFileTransform.js'),
'\\.(yaml)$': require.resolve('./jestYamlTransform'),
};
if (FRONTEND_ROLES.includes(role)) {
return { testEnvironment: require.resolve('jest-environment-jsdom') };
return {
testEnvironment: require.resolve('jest-environment-jsdom'),
transform,
};
}
return { testEnvironment: require.resolve('jest-environment-node') };
return {
testEnvironment: require.resolve('jest-environment-node'),
moduleFileExtensions: [...SRC_EXTS, 'json', 'node'],
// Jest doesn't let us dynamically detect type=module per transformed file,
// so we have to assume that if the entry point is ESM, all TS files are
// ESM.
//
// This means you can't switch a package to type=module until all of its
// monorepo dependencies are also type=module or does not contain any .ts
// files.
extensionsToTreatAsEsm:
pkgJson.type === 'module' ? ['.ts', '.mts'] : ['.mts'],
transform,
};
}
async function getProjectConfig(targetPath, extraConfig, extraOptions) {
@@ -160,64 +254,6 @@ async function getProjectConfig(targetPath, extraConfig, extraOptions) {
'\\.(css|less|scss|sss|styl)$': require.resolve('jest-css-modules'),
},
transform: {
'\\.(mjs|cjs|js)$': [
require.resolve('./jestSwcTransform'),
{
jsc: {
parser: {
syntax: 'ecmascript',
},
},
},
],
'\\.jsx$': [
require.resolve('./jestSwcTransform'),
{
jsc: {
parser: {
syntax: 'ecmascript',
jsx: true,
},
transform: {
react: {
runtime: 'automatic',
},
},
},
},
],
'\\.ts$': [
require.resolve('./jestSwcTransform'),
{
jsc: {
parser: {
syntax: 'typescript',
},
},
},
],
'\\.tsx$': [
require.resolve('./jestSwcTransform'),
{
jsc: {
parser: {
syntax: 'typescript',
tsx: true,
},
transform: {
react: {
runtime: 'automatic',
},
},
},
},
],
'\\.(bmp|gif|jpg|jpeg|png|ico|webp|frag|xml|svg|eot|woff|woff2|ttf)$':
require.resolve('./jestFileTransform.js'),
'\\.(yaml)$': require.resolve('./jestYamlTransform'),
},
// A bit more opinionated
testMatch: [`**/*.test.{${SRC_EXTS.join(',')}}`],
@@ -226,7 +262,7 @@ async function getProjectConfig(targetPath, extraConfig, extraOptions) {
: require.resolve('./jestCachingModuleLoader'),
transformIgnorePatterns: [`/node_modules/(?:${transformIgnorePattern})/`],
...getRoleConfig(pkgJson.backstage?.role),
...getRoleConfig(pkgJson.backstage?.role, pkgJson),
};
options.setupFilesAfterEnv = options.setupFilesAfterEnv || [];
packages/cli/config/jestCachingModuleLoader.js
+14
View File
@@ -19,6 +19,11 @@ const { default: JestRuntime } = require('jest-runtime');
const scriptTransformCache = new Map();
module.exports = class CachingJestRuntime extends JestRuntime {
constructor(config, ...restAgs) {
super(config, ...restAgs);
this.allowLoadAsEsm = config.extensionsToTreatAsEsm.includes('.mts');
}
// This may or may not be a good idea. Theoretically I don't know why this would impact
// test correctness and flakiness, but it seems like it may introduce flakiness and strange failures.
// It does seem to speed up test execution by a fair amount though.
@@ -33,4 +38,13 @@ module.exports = class CachingJestRuntime extends JestRuntime {
}
return script;
}
// 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);
}
};
packages/cli/config/jestSwcTransform.js
+6
View File
@@ -23,10 +23,16 @@ function createTransformer(config) {
...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 (filePath.endsWith('.mjs')) {
return { code: source };
}
return swcTransformer.process(source, filePath, jestOptions);
};
packages/cli/config/nodeTransform.cjs
+10 -1
View File
@@ -14,6 +14,7 @@
* limitations under the License.
*/
const { pathToFileURL } = require('url');
const { transformSync } = require('@swc/core');
const { addHook } = require('pirates');
const { Module } = require('module');
@@ -55,7 +56,10 @@ addHook(
const transformed = transformSync(code, {
filename,
sourceMaps: 'inline',
module: { type: 'commonjs' },
module: {
type: 'commonjs',
ignoreDynamic: true,
},
jsc: {
target: 'es2022',
parser: {
@@ -76,3 +80,8 @@ addHook(
},
{ 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));
packages/cli/config/nodeTransformHooks.mjs
+282
View File
@@ -0,0 +1,282 @@
/*
* 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.
*/
import { dirname, extname, resolve as resolvePath } from 'path';
import { fileURLToPath } from 'url';
import { transformFile } from '@swc/core';
import { isBuiltin } from 'node:module';
import { readFile } from 'fs/promises';
import { existsSync } from 'fs';
// @ts-check
// No explicit file extension, no type in package.json
const DEFAULT_MODULE_FORMAT = 'commonjs';
// Source file extensions to look for when using bundle resolution strategy
const SRC_EXTS = ['.ts', '.js'];
const TS_EXTS = ['.ts', '.mts', '.cts'];
const moduleTypeTable = {
'.mjs': 'module',
'.mts': 'module',
'.cjs': 'commonjs',
'.cts': 'commonjs',
'.ts': undefined,
'.js': undefined,
};
/** @type {import('module').ResolveHook} */
export async function resolve(specifier, context, nextResolve) {
// Built-in modules are handled by the default resolver
if (isBuiltin(specifier)) {
return nextResolve(specifier, context);
}
const ext = extname(specifier);
// Unless there's an explicit import attribute, JSON files are loaded with our custom loader that's defined below.
if (ext === '.json' && !context.importAttributes?.type) {
const jsonResult = await nextResolve(specifier, context);
return {
...jsonResult,
format: 'commonjs',
importAttributes: { type: 'json' },
};
}
// Anything else with an explicit extension is handled by the default
// resolver, except that we help determine the module type where needed.
if (ext !== '') {
return withDetectedModuleType(await nextResolve(specifier, context));
}
// Other external modules are handled by the default resolver, but again we
// help determine the module type where needed.
if (!specifier.startsWith('.')) {
return withDetectedModuleType(await nextResolve(specifier, context));
}
// The rest of this function handles the case of resolving imports that do not
// specify any extension and might point to a directory with an `index.*`
// file. We resolve those using the same logic as most JS bundlers would, with
// the addition of checking if there's an explicit module format listed in the
// closest `package.json` file.
//
// We use a bundle resolution strategy in order to keep code consistent across
// Backstage codebases that contains code both for Web and Node.js, and to
// support packages with common code that can be used in both environments.
try {
// This is expected to throw, but in the event that this module specifier is
// supported we prefer to use the default resolver.
return await nextResolve(specifier, context);
} catch (error) {
if (error.code === 'ERR_UNSUPPORTED_DIR_IMPORT') {
const spec = `${specifier}${specifier.endsWith('/') ? '' : '/'}index`;
const resolved = await resolveWithoutExt(spec, context, nextResolve);
if (resolved) {
return withDetectedModuleType(resolved);
}
} else if (error.code === 'ERR_MODULE_NOT_FOUND') {
const resolved = await resolveWithoutExt(specifier, context, nextResolve);
if (resolved) {
return withDetectedModuleType(resolved);
}
}
// Unexpected error or no resolution found
throw error;
}
}
/**
* Populates the `format` field in the resolved object based on the closest `package.json` file.
*
* @param {import('module').ResolveFnOutput} resolved
* @returns {Promise<import('module').ResolveFnOutput>}
*/
async function withDetectedModuleType(resolved) {
// Already has an explicit format
if (resolved.format) {
return resolved;
}
// Happens in Node.js v22 when there's a package.json without an explicit "type" field. Use the default.
if (resolved.format === null) {
return { ...resolved, format: DEFAULT_MODULE_FORMAT };
}
const ext = extname(resolved.url);
const explicitFormat = moduleTypeTable[ext];
if (explicitFormat) {
return {
...resolved,
format: explicitFormat,
};
}
// TODO(Rugvip): Afaik this should never happen and we can remove this check, but want it here for a little while to verify.
if (ext === '.js') {
throw new Error('Unexpected .js file without explicit format');
}
// TODO(Rugvip): Does this need caching? kept it simple for now but worth exploring
const packageJsonPath = await findPackageJSON(fileURLToPath(resolved.url));
if (!packageJsonPath) {
return resolved;
}
const packageJson = JSON.parse(await readFile(packageJsonPath, 'utf8'));
return {
...resolved,
format: packageJson.type ?? DEFAULT_MODULE_FORMAT,
};
}
/**
* Find the closest package.json file from the given path.
*
* TODO(Rugvip): This can be replaced with the Node.js built-in with the same name once it is stable.
* @param {string} startPath
* @returns {Promise<string | undefined>}
*/
async function findPackageJSON(startPath) {
let path = startPath;
// Some confidence check to avoid infinite loop
for (let i = 0; i < 1000; i++) {
const packagePath = resolvePath(path, 'package.json');
if (existsSync(packagePath)) {
return packagePath;
}
const newPath = dirname(path);
if (newPath === path) {
return undefined;
}
path = newPath;
}
throw new Error(
`Iteration limit reached when searching for package.json at ${startPath}`,
);
}
/** @type {import('module').ResolveHook} */
async function resolveWithoutExt(specifier, context, nextResolve) {
for (const tryExt of SRC_EXTS) {
try {
const resolved = await nextResolve(specifier + tryExt, {
...context,
format: 'commonjs',
});
return {
...resolved,
format: moduleTypeTable[tryExt] ?? resolved.format,
};
} catch {
/* ignore */
}
}
return undefined;
}
/** @type {import('module').LoadHook} */
export async function load(url, context, nextLoad) {
// Non-file URLs are handled by the default loader
if (!url.startsWith('file://')) {
return nextLoad(url, context);
}
// JSON files loaded as CommonJS are handled by this custom loader, because
// the default one doesn't work. For JSON loading to work we'd need the
// synchronous hooks that aren't supported yet, or avoid using the CommonJS
// compatibility.
if (
context.format === 'commonjs' &&
context.importAttributes?.type === 'json'
) {
try {
// TODO(Rugvip): Make sure this is valid JSON
const content = await readFile(fileURLToPath(url), 'utf8');
return {
source: `module.exports = (${content})`,
format: 'commonjs',
shortCircuit: true,
};
} catch {
// Let the default loader generate the error
return nextLoad(url, context);
}
}
const ext = extname(url);
// Non-TS files are handled by the default loader
if (!TS_EXTS.includes(ext)) {
return nextLoad(url, context);
}
const format = context.format ?? DEFAULT_MODULE_FORMAT;
// We have two choices at this point, we can either transform CommonJS files
// and return the transformed source code, or let the default loader handle
// them. If we transform them ourselves we will enter CommonJS compatibility
// mode in the new module system in Node.js, this effectively means all
// CommonJS loaded via `require` calls from this point will all be treated as
// if it was loaded via `import` calls from modules.
//
// The CommonJS compatibility layer will try to identify named exports and
// make them available directly, which is convenient as it avoids things like
// `import(...).then(m => m.default.foo)`, allowing you to instead write
// `import(...).then(m => m.foo)`. The compatibility layer doesn't always work
// all that well though, and can lead to module loading issues in many cases,
// especially for older code.
// This `if` block opts-out of using CommonJS compatibility mode by default,
// and instead leaves it to our existing loader to transform CommonJS. We do
// however use compatibility mode for the more explicit .cts file extension,
// allows for a way to opt-in to the new behavior.
//
// TODO(Rugvip): Once the synchronous hooks API is available for us to use, we might be able to adopt that instead
if (format === 'commonjs' && ext !== '.cts') {
return nextLoad(url, { ...context, format });
}
const transformed = await transformFile(fileURLToPath(url), {
sourceMaps: 'inline',
module: {
type: format === 'module' ? 'es6' : 'commonjs',
ignoreDynamic: true,
// This helps the Node.js CommonJS compat layer identify named exports.
exportInteropAnnotation: true,
},
jsc: {
target: 'es2022',
parser: {
syntax: 'typescript',
},
},
});
return {
...context,
shortCircuit: true,
source: transformed.code,
format,
responseURL: url,
};
}
packages/cli/config/tsconfig.json
+1
View File
@@ -1,5 +1,6 @@
{
"compilerOptions": {
"allowImportingTsExtensions": true,
"allowJs": true,
"declaration": true,
"declarationMap": false,
packages/cli/src/alpha.ts
+1 -1
View File
@@ -24,6 +24,6 @@ import chalk from 'chalk';
),
);
const initializer = new CliInitializer();
initializer.add(import('./modules/config/alpha').then(m => m.default));
initializer.add(import('./modules/config/alpha'));
await initializer.run();
})();
packages/cli/src/commands/index.ts
+24 -34
View File
@@ -43,7 +43,7 @@ export function registerRepoCommand(program: Command) {
'--minify',
'Minify the generated code. Does not apply to app package (app is minified by default).',
)
.action(lazy(() => import('./repo/build').then(m => m.command)));
.action(lazy(() => import('./repo/build'), 'command'));
command
.command('lint')
@@ -70,7 +70,7 @@ export function registerRepoCommand(program: Command) {
'Set the success cache location, (default: node_modules/.cache/backstage-cli)',
)
.option('--fix', 'Attempt to automatically fix violations')
.action(lazy(() => import('./repo/lint').then(m => m.command)));
.action(lazy(() => import('./repo/lint'), 'command'));
command
.command('fix')
@@ -83,20 +83,18 @@ export function registerRepoCommand(program: Command) {
'--check',
'Fail if any packages would have been changed by the command',
)
.action(lazy(() => import('./repo/fix').then(m => m.command)));
.action(lazy(() => import('./repo/fix'), 'command'));
command
.command('clean')
.description('Delete cache and output directories')
.action(lazy(() => import('./repo/clean').then(m => m.command)));
.action(lazy(() => import('./repo/clean'), 'command'));
command
.command('list-deprecations')
.description('List deprecations')
.option('--json', 'Output as JSON')
.action(
lazy(() => import('./repo/list-deprecations').then(m => m.command)),
);
.action(lazy(() => import('./repo/list-deprecations'), 'command'));
command
.command('test')
@@ -118,7 +116,7 @@ export function registerRepoCommand(program: Command) {
'Show help for Jest CLI options, which are passed through',
)
.description('Run tests, forwarding args to Jest, defaulting to watch mode')
.action(lazy(() => import('./repo/test').then(m => m.command)));
.action(lazy(() => import('./repo/test'), 'command'));
}
export function registerScriptCommand(program: Command) {
@@ -139,7 +137,7 @@ export function registerScriptCommand(program: Command) {
)
.option('--require <path>', 'Add a --require argument to the node process')
.option('--link <path>', 'Link an external workspace for module resolution')
.action(lazy(() => import('./start').then(m => m.command)));
.action(lazy(() => import('./start'), 'command'));
command
.command('build')
@@ -163,7 +161,7 @@ export function registerScriptCommand(program: Command) {
(opt: string, opts: string[]) => (opts ? [...opts, opt] : [opt]),
Array<string>(),
)
.action(lazy(() => import('./build').then(m => m.command)));
.action(lazy(() => import('./build'), 'command'));
command
.command('lint [directories...]')
@@ -182,29 +180,29 @@ export function registerScriptCommand(program: Command) {
'Fail if more than this number of warnings. -1 allows warnings. (default: 0)',
)
.description('Lint a package')
.action(lazy(() => import('./lint').then(m => m.default)));
.action(lazy(() => import('./lint'), 'default'));
command
.command('test')
.allowUnknownOption(true) // Allows the command to run, but we still need to parse raw args
.helpOption(', --backstage-cli-help') // Let Jest handle help
.description('Run tests, forwarding args to Jest, defaulting to watch mode')
.action(lazy(() => import('./test').then(m => m.default)));
.action(lazy(() => import('./test'), 'default'));
command
.command('clean')
.description('Delete cache directories')
.action(lazy(() => import('./clean/clean').then(m => m.default)));
.action(lazy(() => import('./clean/clean'), 'default'));
command
.command('prepack')
.description('Prepares a package for packaging before publishing')
.action(lazy(() => import('./pack').then(m => m.pre)));
.action(lazy(() => import('./pack'), 'pre'));
command
.command('postpack')
.description('Restores the changes made by the prepack command')
.action(lazy(() => import('./pack').then(m => m.post)));
.action(lazy(() => import('./pack'), 'post'));
}
export function registerMigrateCommand(program: Command) {
@@ -215,39 +213,31 @@ export function registerMigrateCommand(program: Command) {
command
.command('package-roles')
.description(`Add package role field to packages that don't have it`)
.action(lazy(() => import('./migrate/packageRole').then(m => m.default)));
.action(lazy(() => import('./migrate/packageRole'), 'default'));
command
.command('package-scripts')
.description('Set package scripts according to each package role')
.action(
lazy(() => import('./migrate/packageScripts').then(m => m.command)),
);
.action(lazy(() => import('./migrate/packageScripts'), 'command'));
command
.command('package-exports')
.description('Synchronize package subpath export definitions')
.action(
lazy(() => import('./migrate/packageExports').then(m => m.command)),
);
.action(lazy(() => import('./migrate/packageExports'), 'command'));
command
.command('package-lint-configs')
.description(
'Migrates all packages to use @backstage/cli/config/eslint-factory',
)
.action(
lazy(() => import('./migrate/packageLintConfigs').then(m => m.command)),
);
.action(lazy(() => import('./migrate/packageLintConfigs'), 'command'));
command
.command('react-router-deps')
.description(
'Migrates the react-router dependencies for all packages to be peer dependencies',
)
.action(
lazy(() => import('./migrate/reactRouterDeps').then(m => m.command)),
);
.action(lazy(() => import('./migrate/reactRouterDeps'), 'command'));
}
export function registerCommands(program: Command) {
@@ -281,7 +271,7 @@ export function registerCommands(program: Command) {
'The license to use for any new packages (default: Apache-2.0)',
)
.option('--no-private', 'Do not mark new packages as private')
.action(lazy(() => import('./new/new').then(m => m.default)));
.action(lazy(() => import('./new/new'), 'default'));
registerConfigCommands(program);
registerRepoCommand(program);
@@ -302,7 +292,7 @@ export function registerCommands(program: Command) {
.option('--skip-install', 'Skips yarn install step')
.option('--skip-migrate', 'Skips migration of any moved packages')
.description('Bump Backstage packages to the latest versions')
.action(lazy(() => import('./versions/bump').then(m => m.default)));
.action(lazy(() => import('./versions/bump'), 'default'));
program
.command('versions:migrate')
@@ -317,7 +307,7 @@ export function registerCommands(program: Command) {
.description(
'Migrate any plugins that have been moved to the @backstage-community namespace automatically',
)
.action(lazy(() => import('./versions/migrate').then(m => m.default)));
.action(lazy(() => import('./versions/migrate'), 'default'));
program
.command('build-workspace <workspace-dir> [packages...]')
@@ -334,17 +324,17 @@ export function registerCommands(program: Command) {
'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(() => import('./buildWorkspace').then(m => m.default)));
.action(lazy(() => import('./buildWorkspace'), 'default'));
program
.command('create-github-app <github-org>')
.description('Create new GitHub App in your organization.')
.action(lazy(() => import('./create-github-app').then(m => m.default)));
.action(lazy(() => import('./create-github-app'), 'default'));
program
.command('info')
.description('Show helpful information for debugging and reporting bugs')
.action(lazy(() => import('./info').then(m => m.default)));
.action(lazy(() => import('./info'), 'default'));
// Notifications for removed commands
program
packages/cli/src/lib/builder/config.ts
+84 -8
View File
@@ -16,7 +16,11 @@
import chalk from 'chalk';
import fs from 'fs-extra';
import { relative as relativePath, resolve as resolvePath } from 'path';
import {
extname,
relative as relativePath,
resolve as resolvePath,
} from 'path';
import commonjs from '@rollup/plugin-commonjs';
import resolve from '@rollup/plugin-node-resolve';
import postcss from 'rollup-plugin-postcss';
@@ -29,6 +33,7 @@ import {
RollupOptions,
OutputOptions,
WarningHandlerWithDefault,
OutputPlugin,
} from 'rollup';
import { forwardFileImports } from './plugins';
@@ -40,6 +45,12 @@ import { readEntryPoints } from '../entryPoints';
const SCRIPT_EXTS = ['.js', '.jsx', '.ts', '.tsx'];
const MODULE_EXTS = ['.mjs', '.mts'];
const COMMONJS_EXTS = ['.cjs', '.cts'];
const MOD_EXT = '.mjs';
const CJS_EXT = '.cjs';
const CJS_JS_EXT = '.cjs.js';
function isFileImport(source: string) {
if (source.startsWith('.')) {
return true;
@@ -68,6 +79,39 @@ function buildInternalImportPattern(options: BuildOptions) {
return new RegExp(`^(?:${names.join('|')})(?:$|/)`);
}
// This Rollup output plugin enables support for mixed CommonJS and ESM output.
// It does it be filtering out the unwanted output files that don't match the
// input file format, allowing the rollup configuration to have overlapping
// output configurations for different formats.
function multiOutputFormat(): OutputPlugin {
return {
name: 'backstage-multi-output-format',
generateBundle(opts, bundle) {
const filter: (name: string) => boolean =
opts.format === 'cjs'
? s => s.endsWith(MOD_EXT)
: s => !s.endsWith(MOD_EXT);
// Delete any files that don't match the current output format
for (const name in bundle) {
if (filter(name)) {
delete bundle[name];
delete bundle[`${name}.map`];
}
}
},
renderDynamicImport(opts) {
if (opts.format === 'cjs') {
return {
left: 'import(',
right: ')',
};
}
return undefined;
},
};
}
export async function makeRollupConfigs(
options: BuildOptions,
): Promise<RollupOptions[]> {
@@ -120,18 +164,47 @@ export async function makeRollupConfigs(
const rewriteNodeModules = (name: string) =>
name.replaceAll('node_modules', 'node_modules_dist');
// For CommonJS we build both CommonJS and ESM output. Each of these outputs
// can output both .cjs and .mjs files. The files from each of these outputs
// will overlap, but we trim away files where the format doesn't match the
// file extensions. That way we are left with a combination of .cjs and .mjs
// files where the module format in the file matches the file extension.
if (options.outputs.has(Output.cjs)) {
output.push({
const defaultExt = targetPkg.type === 'module' ? MOD_EXT : CJS_JS_EXT;
const outputOpts: OutputOptions = {
dir: distDir,
entryFileNames: chunkInfo =>
`${rewriteNodeModules(chunkInfo.name)}.cjs.js`,
chunkFileNames: `cjs/[name]-[hash].cjs.js`,
format: 'commonjs',
interop: 'compat',
entryFileNames(chunkInfo) {
const cleanName = rewriteNodeModules(chunkInfo.name);
const inputId = chunkInfo.facadeModuleId;
if (!inputId) {
return cleanName + defaultExt;
}
const inputExt = extname(inputId);
if (MODULE_EXTS.includes(inputExt)) {
return cleanName + MOD_EXT;
}
if (COMMONJS_EXTS.includes(inputExt)) {
return cleanName + CJS_EXT;
}
return cleanName + defaultExt;
},
sourcemap: true,
preserveModules: true,
preserveModulesRoot: `${targetDir}/src`,
interop: 'compat',
exports: 'named',
plugins: [multiOutputFormat()],
};
output.push({
...outputOpts,
format: 'cjs',
});
output.push({
...outputOpts,
format: 'module',
});
}
if (options.outputs.has(Output.esm)) {
@@ -160,7 +233,10 @@ export async function makeRollupConfigs(
// All module imports are always marked as external
external,
plugins: [
resolve({ mainFields }),
resolve({
mainFields,
extensions: SCRIPT_EXTS,
}),
commonjs({
include: /node_modules/,
exclude: [/\/[^/]+\.(?:stories|test)\.[^/]+$/],
packages/cli/src/lib/builder/packager.ts
+1 -1
View File
@@ -107,7 +107,7 @@ export const buildPackage = async (options: BuildOptions) => {
const rollupConfigs = await makeRollupConfigs(options);
await fs.remove(paths.resolveTarget('dist'));
await fs.remove(resolvePath(options.targetDir ?? paths.targetDir, 'dist'));
const buildTasks = rollupConfigs.map(rollupBuild);
packages/cli/src/lib/lazy.ts
+15 -3
View File
@@ -17,13 +17,25 @@
import { assertError } from '@backstage/errors';
import { exitWithError } from '../lib/errors';
type ActionFunc = (...args: any[]) => Promise<void>;
type ActionExports<TModule extends object> = {
[KName in keyof TModule as TModule[KName] extends ActionFunc
? KName
: never]: TModule[KName];
};
// Wraps an action function so that it always exits and handles errors
export function lazy(
getActionFunc: () => Promise<(...args: any[]) => Promise<void>>,
export function lazy<TModule extends object>(
moduleLoader: () => Promise<TModule>,
exportName: keyof ActionExports<TModule>,
): (...args: any[]) => Promise<never> {
return async (...args: any[]) => {
try {
const actionFunc = await getActionFunc();
const mod = await moduleLoader();
const actualModule = (
mod as unknown as { default: ActionExports<TModule> }
).default;
const actionFunc = actualModule[exportName] as ActionFunc;
await actionFunc(...args);
process.exit(0);
packages/cli/src/modules/config/alpha.ts
+1 -1
View File
@@ -32,7 +32,7 @@ export default createCliPlugin({
'Only include the schema that applies to the given package',
)
.description('Browse the configuration reference documentation')
.action(lazy(() => import('./commands/docs').then(m => m.default)));
.action(lazy(() => import('./commands/docs'), 'default'));
await defaultCommand.parseAsync(args, { from: 'user' });
},
packages/cli/src/modules/config/index.ts
+4 -4
View File
@@ -32,7 +32,7 @@ export function registerCommands(program: Command) {
'Only include the schema that applies to the given package',
)
.description('Browse the configuration reference documentation')
.action(lazy(() => import('./commands/docs').then(m => m.default)));
.action(lazy(() => import('./commands/docs'), 'default'));
program
.command('config:print')
@@ -49,7 +49,7 @@ export function registerCommands(program: Command) {
)
.option(...configOption)
.description('Print the app configuration for the current package')
.action(lazy(() => import('./commands/print').then(m => m.default)));
.action(lazy(() => import('./commands/print'), 'default'));
program
.command('config:check')
@@ -68,7 +68,7 @@ export function registerCommands(program: Command) {
.description(
'Validate that the given configuration loads and matches schema',
)
.action(lazy(() => import('./commands/validate').then(m => m.default)));
.action(lazy(() => import('./commands/validate'), 'default'));
program
.command('config:schema')
@@ -83,5 +83,5 @@ export function registerCommands(program: Command) {
.option('--merge', 'Print the config schemas merged', true)
.option('--no-merge', 'Print the config schemas not merged')
.description('Print configuration schema')
.action(lazy(() => import('./commands/schema').then(m => m.default)));
.action(lazy(() => import('./commands/schema'), 'default'));
}
packages/cli/src/tests/transforms/__fixtures__/.gitignore
+2
View File
@@ -0,0 +1,2 @@
!node_modules
dist
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-commonjs/a-default.js
Generated Vendored
+1
View File
@@ -0,0 +1 @@
module.exports = 'a'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-commonjs/a-named.js
Generated Vendored
+1
View File
@@ -0,0 +1 @@
exports.value = 'a'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-commonjs/b-default.mjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
export default 'b'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-commonjs/b-named.mjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
export const value = 'b'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-commonjs/c-default.cjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
module.exports = 'c'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-commonjs/c-named.cjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
exports.value = 'c'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-commonjs/main.d.ts
Generated Vendored
+15
View File
@@ -0,0 +1,15 @@
export const namedA: string
export const namedB: string
export const namedC: string
export const defaultA: string
export const defaultB: string
export const defaultC: string
export namespace dyn {
export const namedA: Promise<string>
export const namedB: Promise<string>
export const namedC: Promise<string>
export const defaultA: Promise<string>
export const defaultB: Promise<string>
export const defaultC: Promise<string>
}
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-commonjs/main.js
Generated Vendored
+14
View File
@@ -0,0 +1,14 @@
exports.namedA = require('./a-named').value;
// exports.namedB = require('./b-named.mjs').value;
exports.namedC = require('./c-named.cjs').value;
exports.defaultA = require('./a-default');
// exports.defaultB = require('./b-default.mjs').default;
exports.defaultC = require('./c-default.cjs');
exports.dyn = {
namedA: import('./a-named').then(m => m.value),
namedB: import('./b-named.mjs').then(m => m.value),
namedC: import('./c-named.cjs').then(m => m.value),
defaultA: import('./a-default').then(m => m.default),
defaultB: import('./b-default.mjs').then(m => m.default),
defaultC: import('./c-default.cjs').then(m => m.default),
}
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-commonjs/package.json
Generated Vendored
+12
View File
@@ -0,0 +1,12 @@
{
"name": "dep-commonjs",
"type": "commonjs",
"exports": {
".": "./main.js"
},
"typesVersions": {
"*": {
"*": [ "main.d.ts" ]
}
}
}
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-default/a-default.js
Generated Vendored
+1
View File
@@ -0,0 +1 @@
module.exports = 'a'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-default/a-named.js
Generated Vendored
+1
View File
@@ -0,0 +1 @@
exports.value = 'a'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-default/b-default.mjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
export default 'b'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-default/b-named.mjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
export const value = 'b'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-default/c-default.cjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
module.exports = 'c'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-default/c-named.cjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
exports.value = 'c'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-default/main.d.ts
Generated Vendored
+15
View File
@@ -0,0 +1,15 @@
export const namedA: string
export const namedB: string
export const namedC: string
export const defaultA: string
export const defaultB: string
export const defaultC: string
export namespace dyn {
export const namedA: Promise<string>
export const namedB: Promise<string>
export const namedC: Promise<string>
export const defaultA: Promise<string>
export const defaultB: Promise<string>
export const defaultC: Promise<string>
}
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-default/main.js
Generated Vendored
+14
View File
@@ -0,0 +1,14 @@
exports.namedA = require('./a-named').value;
// exports.namedB = require('./b-named.mjs').value;
exports.namedC = require('./c-named.cjs').value;
exports.defaultA = require('./a-default');
// exports.defaultB = require('./b-default.mjs').default;
exports.defaultC = require('./c-default.cjs');
exports.dyn = {
namedA: import('./a-named').then(m => m.value),
namedB: import('./b-named.mjs').then(m => m.value),
namedC: import('./c-named.cjs').then(m => m.value),
defaultA: import('./a-default').then(m => m.default),
defaultB: import('./b-default.mjs').then(m => m.default),
defaultC: import('./c-default.cjs').then(m => m.default),
}
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-default/package.json
Generated Vendored
+11
View File
@@ -0,0 +1,11 @@
{
"name": "dep-default",
"exports": {
".": "./main.js"
},
"typesVersions": {
"*": {
"*": [ "main.d.ts" ]
}
}
}
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-module/a-default.js
Generated Vendored
+1
View File
@@ -0,0 +1 @@
export default 'a'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-module/a-named.js
Generated Vendored
+1
View File
@@ -0,0 +1 @@
export const value = 'a'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-module/b-default.mjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
export default 'b'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-module/b-named.mjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
export const value = 'b'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-module/c-default.cjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
module.exports = 'c'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-module/c-named.cjs
Generated Vendored
+1
View File
@@ -0,0 +1 @@
exports.value = 'c'
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-module/main.d.ts
Generated Vendored
+15
View File
@@ -0,0 +1,15 @@
export const namedA: string
export const namedB: string
export const namedC: string
export const defaultA: string
export const defaultB: string
export const defaultC: string
export namespace dyn {
export const namedA: Promise<string>
export const namedB: Promise<string>
export const namedC: Promise<string>
export const defaultA: Promise<string>
export const defaultB: Promise<string>
export const defaultC: Promise<string>
}
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-module/main.js
Generated Vendored
+14
View File
@@ -0,0 +1,14 @@
export { value as namedA } from './a-named'
export { value as namedB } from './b-named.mjs'
export { value as namedC } from './c-named.cjs'
export { default as defaultA } from './a-default'
export { default as defaultB } from './b-default.mjs'
export { default as defaultC } from './c-default.cjs'
export const dyn = {
namedA: import('./a-named').then(m => m.value),
namedB: import('./b-named.mjs').then(m => m.value),
namedC: import('./c-named.cjs').then(m => m.value),
defaultA: import('./a-default').then(m => m.default),
defaultB: import('./b-default.mjs').then(m => m.default),
defaultC: import('./c-default.cjs').then(m => m.default),
}
packages/cli/src/tests/transforms/__fixtures__/node_modules/dep-module/package.json
Generated Vendored
+12
View File
@@ -0,0 +1,12 @@
{
"name": "dep-module",
"type": "module",
"exports": {
".": "./main.js"
},
"typesVersions": {
"*": {
"*": [ "main.d.ts" ]
}
}
}
packages/cli/src/tests/transforms/__fixtures__/pkg-commonjs/a-default.ts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'a';
packages/cli/src/tests/transforms/__fixtures__/pkg-commonjs/a-named.ts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'a';
packages/cli/src/tests/transforms/__fixtures__/pkg-commonjs/b-default.mts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'b';
packages/cli/src/tests/transforms/__fixtures__/pkg-commonjs/b-named.mts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'b';
packages/cli/src/tests/transforms/__fixtures__/pkg-commonjs/c-default.cts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'c';
packages/cli/src/tests/transforms/__fixtures__/pkg-commonjs/c-named.cts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'c';
packages/cli/src/tests/transforms/__fixtures__/pkg-commonjs/main.ts
+71
View File
@@ -0,0 +1,71 @@
/*
* 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.
*/
import * as depCommonJs from 'dep-commonjs';
// import * as depModule from 'dep-module';
import * as depDefault from 'dep-default';
import { value as namedA } from './a-named';
// import { value as namedB } from './b-named.mts';
import { value as namedC } from './c-named.cts';
import { default as defaultA } from './a-default';
// import { default as defaultB } from './b-default.mts';
import { default as defaultC } from './c-default.cts';
async function resolveAll(obj: object): Promise<unknown> {
const val = await obj;
if (typeof val !== 'object' || val === null) {
return val;
}
if (Array.isArray(val)) {
return await Promise.all(val.map(resolveAll));
}
return Object.fromEntries(
await Promise.all(
Object.entries(obj).map(async ([key, value]) => [
key,
await resolveAll(await value),
]),
),
);
}
export const values = resolveAll({
depCommonJs,
// depModule,
depDefault,
dynCommonJs: import('dep-commonjs'),
dynModule: import('dep-module'),
dynDefault: import('dep-default'),
dep: {
namedA,
// namedB,
namedC,
defaultA,
// defaultB,
defaultC,
},
dyn: {
// @ts-expect-error Default exports from CommonJS are not well supported
namedA: import('./a-named').then(m => m.default.value),
namedB: import('./b-named.mts').then(m => m.value),
namedC: import('./c-named.cts').then(m => m.value),
// @ts-expect-error Default exports from CommonJS are not well supported
defaultA: import('./a-default').then(m => m.default.default),
defaultB: import('./b-default.mts').then(m => m.default),
// @ts-expect-error Default exports from CommonJS are not well supported
defaultC: import('./c-default.cts').then(m => m.default.default),
},
});
packages/cli/src/tests/transforms/__fixtures__/pkg-commonjs/package.json
+8
View File
@@ -0,0 +1,8 @@
{
"name": "pkg-commonjs",
"type": "commonjs",
"exports": {
".": "./main.ts",
"./print": "./print.ts"
}
}
packages/cli/src/tests/transforms/__fixtures__/pkg-commonjs/print.ts
+19
View File
@@ -0,0 +1,19 @@
/*
* 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.
*/
import { values } from './main';
values.then(obj => console.log(JSON.stringify(obj, null, 2)));
packages/cli/src/tests/transforms/__fixtures__/pkg-default/a-default.ts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'a';
packages/cli/src/tests/transforms/__fixtures__/pkg-default/a-named.ts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'a';
packages/cli/src/tests/transforms/__fixtures__/pkg-default/b-default.mts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'b';
packages/cli/src/tests/transforms/__fixtures__/pkg-default/b-named.mts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'b';
packages/cli/src/tests/transforms/__fixtures__/pkg-default/c-default.cts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'c';
packages/cli/src/tests/transforms/__fixtures__/pkg-default/c-named.cts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'c';
packages/cli/src/tests/transforms/__fixtures__/pkg-default/main.ts
+71
View File
@@ -0,0 +1,71 @@
/*
* 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.
*/
import * as depCommonJs from 'dep-commonjs';
// import * as depModule from 'dep-module';
import * as depDefault from 'dep-default';
import { value as namedA } from './a-named';
// import { value as namedB } from './b-named.mts';
import { value as namedC } from './c-named.cts';
import { default as defaultA } from './a-default';
// import { default as defaultB } from './b-default.mts';
import { default as defaultC } from './c-default.cts';
async function resolveAll(obj: object): Promise<unknown> {
const val = await obj;
if (typeof val !== 'object' || val === null) {
return val;
}
if (Array.isArray(val)) {
return await Promise.all(val.map(resolveAll));
}
return Object.fromEntries(
await Promise.all(
Object.entries(obj).map(async ([key, value]) => [
key,
await resolveAll(await value),
]),
),
);
}
export const values = resolveAll({
depCommonJs,
// depModule,
depDefault,
dynCommonJs: import('dep-commonjs'),
dynModule: import('dep-module'),
dynDefault: import('dep-default'),
dep: {
namedA,
// namedB,
namedC,
defaultA,
// defaultB,
defaultC,
},
dyn: {
// @ts-expect-error Default exports from CommonJS are not well supported
namedA: import('./a-named').then(m => m.default.value),
namedB: import('./b-named.mts').then(m => m.value),
namedC: import('./c-named.cts').then(m => m.value),
// @ts-expect-error Default exports from CommonJS are not well supported
defaultA: import('./a-default').then(m => m.default.default),
defaultB: import('./b-default.mts').then(m => m.default),
// @ts-expect-error Default exports from CommonJS are not well supported
defaultC: import('./c-default.cts').then(m => m.default.default),
},
});
packages/cli/src/tests/transforms/__fixtures__/pkg-default/package.json
+7
View File
@@ -0,0 +1,7 @@
{
"name": "pkg-default",
"exports": {
".": "./main.ts",
"./print": "./print.ts"
}
}
packages/cli/src/tests/transforms/__fixtures__/pkg-default/print.ts
+19
View File
@@ -0,0 +1,19 @@
/*
* 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.
*/
import { values } from './main';
values.then(obj => console.log(JSON.stringify(obj, null, 2)));
packages/cli/src/tests/transforms/__fixtures__/pkg-module/a-default-explicit.mts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'a';
packages/cli/src/tests/transforms/__fixtures__/pkg-module/a-default.ts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'a';
packages/cli/src/tests/transforms/__fixtures__/pkg-module/a-named-explicit.mts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'a';
packages/cli/src/tests/transforms/__fixtures__/pkg-module/a-named.ts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'a';
packages/cli/src/tests/transforms/__fixtures__/pkg-module/b-default.mts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'b';
packages/cli/src/tests/transforms/__fixtures__/pkg-module/b-named.mts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'b';
packages/cli/src/tests/transforms/__fixtures__/pkg-module/c-default.cts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export default 'c';
packages/cli/src/tests/transforms/__fixtures__/pkg-module/c-named.cts
+16
View File
@@ -0,0 +1,16 @@
/*
* 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.
*/
export const value = 'c';
packages/cli/src/tests/transforms/__fixtures__/pkg-module/main-explicit.mts
+73
View File
@@ -0,0 +1,73 @@
/*
* 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.
*/
// @ts-nocheck
import * as depCommonJs from 'dep-commonjs';
import * as depModule from 'dep-module';
import * as depDefault from 'dep-default';
import { value as namedA } from './a-named-explicit';
import { value as namedB } from './b-named';
import cNamed from './c-named';
import defaultA from './a-default-explicit';
import defaultB from './b-default';
import cDefault from './c-default';
const { default: defaultC } = cDefault;
const { value: namedC } = cNamed;
async function resolveAll(obj): Promise<unknown> {
const val = await obj;
if (typeof val !== 'object' || val === null) {
return val;
}
if (Array.isArray(val)) {
return await Promise.all(val.map(resolveAll));
}
return Object.fromEntries(
await Promise.all(
Object.entries(obj).map(async ([key, value]) => [
key,
await resolveAll(await value),
]),
),
);
}
export const values = resolveAll({
depCommonJs,
depModule,
depDefault,
dynCommonJs: import('dep-commonjs'),
dynModule: import('dep-module'),
dynDefault: import('dep-default'),
dep: {
namedA,
namedB,
namedC,
defaultA,
defaultB,
defaultC,
},
dyn: {
namedA: import('./a-named-explicit').then(m => m.value),
namedB: import('./b-named').then(m => m.value),
namedC: import('./c-named').then(m => m.default.value),
defaultA: import('./a-default-explicit').then(m => m.default),
defaultB: import('./b-default').then(m => m.default),
defaultC: import('./c-default').then(m => m.default.default),
},
});
packages/cli/src/tests/transforms/__fixtures__/pkg-module/main.ts
+72
View File
@@ -0,0 +1,72 @@
/*
* 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.
*/
import * as depCommonJs from 'dep-commonjs';
import * as depModule from 'dep-module';
import * as depDefault from 'dep-default';
import { value as namedA } from './a-named';
import { value as namedB } from './b-named.mts';
import { value as namedC } from './c-named.cts';
import defaultA from './a-default';
import defaultB from './b-default.mts';
import cDefault from './c-default.cts';
// @ts-expect-error Default exports from CommonJS are not well supported
const { default: defaultC } = cDefault;
async function resolveAll(obj: object): Promise<unknown> {
const val = await obj;
if (typeof val !== 'object' || val === null) {
return val;
}
if (Array.isArray(val)) {
return await Promise.all(val.map(resolveAll));
}
return Object.fromEntries(
await Promise.all(
Object.entries(obj).map(async ([key, value]) => [
key,
await resolveAll(await value),
]),
),
);
}
export const values = resolveAll({
depCommonJs,
depModule,
depDefault,
dynCommonJs: import('dep-commonjs'),
dynModule: import('dep-module'),
dynDefault: import('dep-default'),
dep: {
namedA,
namedB,
namedC,
defaultA,
defaultB,
defaultC,
},
dyn: {
namedA: import('./a-named').then(m => m.value),
namedB: import('./b-named.mts').then(m => m.value),
namedC: import('./c-named.cts').then(m => m.value),
defaultA: import('./a-default').then(m => m.default),
defaultB: import('./b-default.mts').then(m => m.default),
// @ts-expect-error Default exports from CommonJS are not well supported
defaultC: import('./c-default.cts').then(m => m.default.default),
},
});
packages/cli/src/tests/transforms/__fixtures__/pkg-module/package.json
+8
View File
@@ -0,0 +1,8 @@
{
"name": "pkg-module",
"type": "module",
"exports": {
".": "./main.ts",
"./print": "./print.ts"
}
}
packages/cli/src/tests/transforms/__fixtures__/pkg-module/print.ts
+19
View File
@@ -0,0 +1,19 @@
/*
* 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.
*/
import { values } from './main';
values.then(obj => console.log(JSON.stringify(obj, null, 2)));
packages/cli/src/tests/transforms/transforms.test.ts
+259
View File
@@ -0,0 +1,259 @@
/*
* 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.
*/
import { execFileSync } from 'child_process';
import { resolve as resolvePath } from 'path';
import { Output, buildPackage } from '../../lib/builder';
const exportValues = {
all: {
namedA: 'a',
namedB: 'b',
namedC: 'c',
defaultA: 'a',
defaultB: 'b',
defaultC: 'c',
},
commonJs: {
namedA: 'a',
namedC: 'c',
defaultA: 'a',
defaultC: 'c',
},
};
const expectedExports = {
commonJs: {
...exportValues.commonJs,
dyn: exportValues.all,
default: {
...exportValues.commonJs,
dyn: exportValues.all,
},
},
module: {
...exportValues.all,
dyn: exportValues.all,
},
};
function loadFixture(fixture: string) {
const output = execFileSync(
'node',
[
'--import',
'@backstage/cli/config/nodeTransform.cjs',
resolvePath(__dirname, `__fixtures__/${fixture}`),
],
{ encoding: 'utf8' },
);
return JSON.parse(output);
}
describe('node runtime module transforms', () => {
it('should load from commonjs format', async () => {
expect(loadFixture('pkg-commonjs/print.ts')).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.commonJs,
dyn: exportValues.all,
});
});
it('should load from default format', async () => {
expect(loadFixture('pkg-default/print.ts')).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.commonJs,
dyn: exportValues.all,
});
});
it('should load from module format', async () => {
expect(loadFixture('pkg-module/print.ts')).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
depModule: expectedExports.module,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.all,
dyn: exportValues.all,
});
});
});
describe('Jest runtime module transforms', () => {
it('should load from commonjs format', async () => {
const values = await import('./__fixtures__/pkg-commonjs/main').then(
m => m.values,
);
expect(values).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.commonJs,
dyn: exportValues.all,
});
});
it('should load from default format', async () => {
const values = await import('./__fixtures__/pkg-default/main').then(
m => m.values,
);
expect(values).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.commonJs,
dyn: exportValues.all,
});
});
it('should load from module format', async () => {
// This uses a separate entry point with an explicit .mts extension. This is
// because we can't cleanly switch the Jest behavior based on type=module in
// package.json for .ts files in Jest. If a module type is detected we
// instead need to switch the transforms for the entire Jest project, which
// we can't do for this test. We instead use the explicit .mts extension to
// verify the transform behavior.
// @ts-expect-error Cannot find module './__fixtures__/pkg-module/main-explicit' or its corresponding type declarations.
const values = await import('./__fixtures__/pkg-module/main-explicit').then(
m => m.values,
);
expect(values).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
depModule: expectedExports.module,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.all,
dyn: exportValues.all,
});
});
});
describe('package build transforms', () => {
it('should build and load from commonjs format', async () => {
const pkgPath = resolvePath(__dirname, '__fixtures__/pkg-commonjs');
await buildPackage({
targetDir: pkgPath,
outputs: new Set([Output.cjs]),
workspacePackages: [],
});
const values = await import(resolvePath(pkgPath, 'dist/index.cjs.js')).then(
m => m.values,
);
expect(values).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.commonJs,
dyn: exportValues.all,
});
expect(loadFixture('pkg-commonjs/dist/print.cjs.js')).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.commonJs,
dyn: exportValues.all,
});
});
it('should build and load from default format', async () => {
const pkgPath = resolvePath(__dirname, '__fixtures__/pkg-default');
await buildPackage({
targetDir: pkgPath,
outputs: new Set([Output.cjs]),
workspacePackages: [],
});
const values = await import(resolvePath(pkgPath, 'dist/index.cjs.js')).then(
m => m.values,
);
expect(values).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.commonJs,
dyn: exportValues.all,
});
expect(loadFixture('pkg-default/dist/print.cjs.js')).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.commonJs,
dyn: exportValues.all,
});
});
it('should build and load from module format', async () => {
const pkgPath = resolvePath(__dirname, '__fixtures__/pkg-module');
await buildPackage({
targetDir: pkgPath,
outputs: new Set([Output.cjs]),
workspacePackages: [],
});
const values = await import(resolvePath(pkgPath, 'dist/index.mjs')).then(
m => m.values,
);
expect(values).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
depModule: expectedExports.module,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.all,
dyn: exportValues.all,
});
expect(loadFixture('pkg-module/dist/print.mjs')).toEqual({
depCommonJs: expectedExports.commonJs,
depDefault: expectedExports.commonJs,
depModule: expectedExports.module,
dynCommonJs: expectedExports.commonJs,
dynDefault: expectedExports.commonJs,
dynModule: expectedExports.module,
dep: exportValues.all,
dyn: exportValues.all,
});
});
});
packages/cli/src/wiring/CliInitializer.ts
+29 -3
View File
@@ -22,16 +22,23 @@ import { version } from '../lib/version';
import chalk from 'chalk';
import { exitWithError } from '../lib/errors';
import { assertError } from '@backstage/errors';
import { isPromise } from 'util/types';
type UninitializedFeature = CliFeature | Promise<CliFeature>;
type UninitializedFeature = CliFeature | Promise<{ default: CliFeature }>;
export class CliInitializer {
private graph = new CommandGraph();
private commandRegistry = new CommandRegistry(this.graph);
#uninitiazedFeatures: Promise<CliFeature>[] = [];
add(module: UninitializedFeature) {
this.#uninitiazedFeatures.push(Promise.resolve(module));
add(feature: UninitializedFeature) {
if (isPromise(feature)) {
this.#uninitiazedFeatures.push(
feature.then(f => unwrapFeature(f.default)),
);
} else {
this.#uninitiazedFeatures.push(Promise.resolve(feature));
}
}
async #register(feature: CliFeature) {
@@ -136,3 +143,22 @@ function isCliPlugin(feature: CliFeature): feature is InternalCliPlugin {
// Backwards compatibility for v1 registrations that use duck typing
return 'plugin' in internal;
}
/** @internal */
export function unwrapFeature(
feature: CliFeature | { default: CliFeature },
): CliFeature {
if ('$$type' in feature) {
return feature;
}
// This is a workaround where default exports get transpiled to `exports['default'] = ...`
// in CommonJS modules, which in turn results in a double `{ default: { default: ... } }` nesting
// when importing using a dynamic import.
// TODO: This is a broader issue than just this piece of code, and should move away from CommonJS.
if ('default' in feature) {
return feature.default;
}
return feature;
}
packages/config-loader/src/schema/collect.ts
+2 -3
View File
@@ -183,9 +183,8 @@ async function compileTsSchemas(
// Lazy loaded, because this brings up all of TypeScript and we don't
// want that eagerly loaded in tests
const { getProgramFromFiles, buildGenerator } = await import(
'typescript-json-schema'
);
const { getProgramFromFiles, buildGenerator } =
require('typescript-json-schema') as typeof import('typescript-json-schema');
const program = getProgramFromFiles(
entries.map(({ path }) => path),
packages/repo-tools/src/commands/index.ts
+36 -57
View File
@@ -39,9 +39,7 @@ function registerPackageCommand(program: Command) {
'Initialize any required files to use the OpenAPI tooling for this package.',
)
.action(
lazy(() =>
import('./package/schema/openapi/init').then(m => m.singleCommand),
),
lazy(() => import('./package/schema/openapi/init'), 'singleCommand'),
);
openApiCommand
@@ -60,11 +58,7 @@ function registerPackageCommand(program: Command) {
)
.option('--watch')
.description('Watch the OpenAPI spec for changes and regenerate on save.')
.action(
lazy(() =>
import('./package/schema/openapi/generate').then(m => m.command),
),
);
.action(lazy(() => import('./package/schema/openapi/generate'), 'command'));
openApiCommand
.command('fuzz')
@@ -81,18 +75,14 @@ function registerPackageCommand(program: Command) {
'--exclude-checks <excludeChecks>',
'Exclude checks from schemathesis run',
)
.action(
lazy(() => import('./package/schema/openapi/fuzz').then(m => m.command)),
);
.action(lazy(() => import('./package/schema/openapi/fuzz'), 'command'));
openApiCommand
.command('diff')
.option('--ignore', 'Ignore linting failures and only log the results.')
.option('--json', 'Output the results as JSON')
.option('--since <ref>', 'Diff the API against a specific ref')
.action(
lazy(() => import('./package/schema/openapi/diff').then(m => m.command)),
);
.action(lazy(() => import('./package/schema/openapi/diff'), 'command'));
}
function registerRepoCommand(program: Command) {
@@ -113,11 +103,7 @@ function registerRepoCommand(program: Command) {
.description(
'Verify that all OpenAPI schemas are valid and set up correctly.',
)
.action(
lazy(() =>
import('./repo/schema/openapi/verify').then(m => m.bulkCommand),
),
);
.action(lazy(() => import('./repo/schema/openapi/verify'), 'bulkCommand'));
openApiCommand
.command('lint [paths...]')
@@ -126,17 +112,13 @@ function registerRepoCommand(program: Command) {
'--strict',
'Fail on any linting severity messages, not just errors.',
)
.action(
lazy(() => import('./repo/schema/openapi/lint').then(m => m.bulkCommand)),
);
.action(lazy(() => import('./repo/schema/openapi/lint'), 'bulkCommand'));
openApiCommand
.command('test [paths...]')
.description('Test OpenAPI schemas against written tests')
.option('--update', 'Update the spec on failure.')
.action(
lazy(() => import('./repo/schema/openapi/test').then(m => m.bulkCommand)),
);
.action(lazy(() => import('./repo/schema/openapi/test'), 'bulkCommand'));
openApiCommand
.command('fuzz')
@@ -145,9 +127,7 @@ function registerRepoCommand(program: Command) {
'--since <ref>',
'Only fuzz packages that have changed since the given ref',
)
.action(
lazy(() => import('./repo/schema/openapi/fuzz').then(m => m.command)),
);
.action(lazy(() => import('./repo/schema/openapi/fuzz'), 'command'));
openApiCommand
.command('diff')
@@ -159,9 +139,7 @@ function registerRepoCommand(program: Command) {
'Diff the API against a specific ref',
'origin/master',
)
.action(
lazy(() => import('./repo/schema/openapi/diff').then(m => m.command)),
);
.action(lazy(() => import('./repo/schema/openapi/diff'), 'command'));
}
function registerLintCommand(program: Command) {
@@ -174,10 +152,10 @@ function registerLintCommand(program: Command) {
'Lint backend plugin packages for legacy exports and make sure it conforms to the new export pattern',
)
.action(
lazy(() =>
import(
'./lint-legacy-backend-exports/lint-legacy-backend-exports'
).then(m => m.lint),
lazy(
() =>
import('./lint-legacy-backend-exports/lint-legacy-backend-exports'),
'lint',
),
);
}
@@ -216,16 +194,12 @@ export function registerCommands(program: Command) {
'Turn on release tag validation for the public, beta, and alpha APIs',
)
.description('Generate an API report for selected packages')
.action(
lazy(() =>
import('./api-reports/api-reports').then(m => m.buildApiReports),
),
);
.action(lazy(() => import('./api-reports/api-reports'), 'buildApiReports'));
program
.command('type-deps')
.description('Find inconsistencies in types of all packages and plugins')
.action(lazy(() => import('./type-deps/type-deps').then(m => m.default)));
.action(lazy(() => import('./type-deps/type-deps'), 'default'));
program
.command('peer-deps')
@@ -233,7 +207,7 @@ export function registerCommands(program: Command) {
'Ensure your packages are using the correct peer dependency format.',
)
.option('--fix', 'Fix the issues found')
.action(lazy(() => import('./peer-deps/peer-deps').then(m => m.default)));
.action(lazy(() => import('./peer-deps/peer-deps'), 'default'));
program
.command('generate-catalog-info')
@@ -247,10 +221,9 @@ export function registerCommands(program: Command) {
)
.description('Create or fix info yaml files for all backstage packages')
.action(
lazy(() =>
import('./generate-catalog-info/generate-catalog-info').then(
m => m.default,
),
lazy(
() => import('./generate-catalog-info/generate-catalog-info'),
'default',
),
);
@@ -279,20 +252,14 @@ export function registerCommands(program: Command) {
.description(
'Generate a patch for the selected package in the target repository',
)
.action(
lazy(() =>
import('./generate-patch/generate-patch').then(m => m.default),
),
);
.action(lazy(() => import('./generate-patch/generate-patch'), 'default'));
program
.command('knip-reports [paths...]')
.option('--ci', 'CI run checks that there is no changes on knip reports')
.description('Generate a knip report for selected packages')
.action(
lazy(() =>
import('./knip-reports/knip-reports').then(m => m.buildKnipReports),
),
lazy(() => import('./knip-reports/knip-reports'), 'buildKnipReports'),
);
registerPackageCommand(program);
@@ -300,13 +267,25 @@ export function registerCommands(program: Command) {
registerLintCommand(program);
}
type ActionFunc = (...args: any[]) => Promise<void>;
type ActionExports<TModule extends object> = {
[KName in keyof TModule as TModule[KName] extends ActionFunc
? KName
: never]: TModule[KName];
};
// Wraps an action function so that it always exits and handles errors
function lazy(
getActionFunc: () => Promise<(...args: any[]) => Promise<void>>,
export function lazy<TModule extends object>(
moduleLoader: () => Promise<TModule>,
exportName: keyof ActionExports<TModule>,
): (...args: any[]) => Promise<never> {
return async (...args: any[]) => {
try {
const actionFunc = await getActionFunc();
const mod = await moduleLoader();
const actualModule = (
mod as unknown as { default: ActionExports<TModule> }
).default;
const actionFunc = actualModule[exportName] as ActionFunc;
await actionFunc(...args);
process.exit(0);
packages/repo-tools/src/commands/repo/schema/openapi/verify.ts
+1 -1
View File
@@ -54,7 +54,7 @@ async function verify(directoryPath: string) {
schemaPath = join(directoryPath, OLD_SCHEMA_PATH);
}
const schema = await import(resolvePath(schemaPath));
const { default: schema } = await import(resolvePath(schemaPath));
if (!schema.spec) {
throw new Error(`\`${TS_SCHEMA_PATH}\` needs to have a 'spec' export.`);
plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts
+5 -2
View File
@@ -38,7 +38,6 @@ import {
mockCredentials,
mockServices,
} from '@backstage/backend-test-utils';
import stripAnsi from 'strip-ansi';
import { loggerToWinstonLogger } from '@backstage/backend-common';
import { LoggerService } from '@backstage/backend-plugin-api';
@@ -48,6 +47,7 @@ describe('NunjucksWorkflowRunner', () => {
let runner: NunjucksWorkflowRunner;
let fakeActionHandler: jest.Mock;
let fakeTaskLog: jest.Mock;
let stripAnsi: typeof import('strip-ansi').default;
const mockDir = createMockDirectory();
@@ -92,9 +92,12 @@ describe('NunjucksWorkflowRunner', () => {
);
}
beforeEach(() => {
beforeEach(async () => {
mockDir.clear();
// This one is ESM-only
stripAnsi = await import('strip-ansi').then(m => m.default);
jest.resetAllMocks();
logger = mockServices.logger.mock();
actionRegistry = new TemplateActionRegistry();