@modern-js/plugin-testing 1.5.6 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @modern-js/plugin-testing
 
+## 1.6.0
+
+### Minor Changes
+
+- 10f4283: chore(testing): merge `@modern-js/testing-plugin-bff` to `@modern-js/plugin-testing`
+
+  chore(testing): 合并 `@modern-js/testing-plugin-bff` 到 `@modern-js/plugin-testing`
+
+- 10f4283: chore(testing): delete `@modern-js/bff-utils`
+
+  chore(testing): 删除 `@modern-js/bff-utils`
+
+- 10f4283: chore(testing): merge `@modern-js/testing` to `@modern-js/plugin-testing`
+
+  chore(testing): 合并 `@modern-js/testing` 到 `@modern-js/plugin-testing`
+
+## 1.5.7
+
+### Patch Changes
+
+- 77a8e9e: fix: remove bff-utils
+- Updated dependencies [77a8e9e]
+- Updated dependencies [550e2bd]
+- Updated dependencies [87eb9f8]
+- Updated dependencies [43b2224]
+- Updated dependencies [2b06fe3]
+- Updated dependencies [3050acc]
+- Updated dependencies [f29e9ba]
+- Updated dependencies [2dacc89]
+- Updated dependencies [338496c]
+- Updated dependencies [a90bc96]
+  - @modern-js/testing-plugin-bff@1.5.0
+  - @modern-js/bff-utils@1.3.0
+  - @modern-js/webpack@1.11.3
+  - @modern-js/runtime-core@1.5.2
+  - @modern-js/utils@1.7.9
+  - @modern-js/testing@1.5.4
+
 ## 1.5.6
 
 ### Patch Changes

package/dist/js/modern/base/config/index.js

@@ -0,0 +1,18 @@
+import { applyPatches } from "./patches";
+import { TestConfigOperator } from "./testConfigOperator";
+/**
+ * Parse jest config
+ */
+
+const getJestUtils = testConfig => {
+  const testOperator = new TestConfigOperator(testConfig);
+  return testOperator;
+};
+
+const patchConfig = async testOperator => {
+  await applyPatches(testOperator);
+  return testOperator.jestConfig;
+};
+
+export const DEFAULT_RESOLVER_PATH = require.resolve("./resolver");
+export { getJestUtils, patchConfig };

package/dist/js/modern/base/config/patches/assetsModule.js

@@ -0,0 +1,11 @@
+/**
+ * Merge config from testConfig.jest
+ */
+export const patchAssetsModule = testOperator => {
+  testOperator.mergeJestConfig({
+    moduleNameMapper: {
+      '\\.(css|less|scss|sass)$': require.resolve('identity-obj-proxy'),
+      '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': require.resolve("./filemock.js")
+    }
+  });
+};

package/dist/js/modern/base/config/patches/filemock.js

@@ -0,0 +1 @@
+export default 'test-file-stub';

package/dist/js/modern/base/config/patches/index.js

@@ -0,0 +1,13 @@
+import { patchTransformer } from "./transformer";
+import { patchAssetsModule } from "./assetsModule";
+
+const _applyPatches = async (patches, testOperator) => {
+  for (const patch of patches) {
+    await patch(testOperator);
+  }
+};
+
+const patches = [patchTransformer, patchAssetsModule];
+export const applyPatches = async testConfig => {
+  await _applyPatches(patches, testConfig);
+};

package/dist/js/modern/base/config/patches/transformer.js

@@ -0,0 +1,49 @@
+import { readCompilerOptions } from "../../utils";
+
+const resolveTsCompilerOptions = () => {
+  const tsCompilerOptions = readCompilerOptions() || {};
+  const {
+    jsx
+  } = tsCompilerOptions;
+
+  if (!jsx) {
+    return null;
+  }
+
+  tsCompilerOptions.jsx = 'react-jsx';
+  return tsCompilerOptions;
+};
+/**
+ * Map `TestConfig.transformer` to jest config
+ */
+
+
+export const patchTransformer = testOperator => {
+  const {
+    transformer
+  } = testOperator.testConfig;
+
+  if (transformer === 'babel-jest') {
+    testOperator.mergeJestConfig({
+      transform: {
+        '\\.[jt]sx?$': require.resolve("../transformer/babelTransformer")
+      }
+    });
+  }
+
+  if (transformer === 'ts-jest') {
+    testOperator.mergeJestConfig({
+      transform: {
+        '\\.[jt]sx?$': require.resolve('ts-jest')
+      }
+    });
+    const compilerOptions = resolveTsCompilerOptions();
+    compilerOptions && testOperator.mergeJestConfig({
+      globals: {
+        'ts-jest': {
+          tsconfig: compilerOptions
+        }
+      }
+    });
+  }
+};

package/dist/js/modern/base/config/resolver.js

@@ -0,0 +1,15 @@
+import enhanceResolve from 'enhanced-resolve';
+const resolver = enhanceResolve.create.sync({
+  conditionNames: ['require', 'node', 'default'],
+  extensions: ['.js', '.json', '.node', '.ts', '.tsx']
+});
+
+const shouldResolveByEnhance = url => /^@[^/]+\/[^/]+\/.*/.test(url);
+
+module.exports = function (request, options) {
+  if (shouldResolveByEnhance(request)) {
+    return resolver(options.basedir, request);
+  }
+
+  return options.defaultResolver(request, options);
+};

package/dist/js/modern/base/config/testConfigOperator.js

@@ -0,0 +1,86 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import { merge } from '@modern-js/utils/lodash';
+
+class TestConfigOperator {
+  constructor(testConfig) {
+    _defineProperty(this, "_testConfig", void 0);
+
+    _defineProperty(this, "_jestConfig", void 0);
+
+    _defineProperty(this, "userJestConfig", void 0);
+
+    _defineProperty(this, "defaultTestConfig", {
+      transformer: 'babel-jest'
+    });
+
+    this._testConfig = testConfig;
+    this._jestConfig = {};
+    this.userJestConfig = testConfig.jest;
+    this.initial();
+  }
+
+  initial() {
+    this._testConfig = merge({}, this.defaultTestConfig, this.testConfig);
+  }
+
+  get jestConfig() {
+    return this._jestConfig;
+  }
+
+  get testConfig() {
+    return this._testConfig;
+  }
+
+  mergeJestConfig(sourceConfig) {
+    this._jestConfig = merge({}, this._jestConfig, sourceConfig);
+  }
+
+  setJestUserConfig() {
+    const {
+      userJestConfig
+    } = this;
+
+    if (typeof userJestConfig === 'object') {
+      this.setJestConfig(userJestConfig);
+    }
+  }
+
+  setJestConfig(sourceConfig, options) {
+    if (options) {
+      const {
+        force
+      } = options;
+
+      if (force) {
+        this._jestConfig = sourceConfig;
+        return;
+      }
+    }
+
+    this._jestConfig = _objectSpread(_objectSpread({}, this._jestConfig), sourceConfig);
+  }
+
+  getFinalConfig() {
+    const {
+      userJestConfig
+    } = this;
+
+    if (!userJestConfig) {
+      return this._jestConfig;
+    }
+
+    if (typeof userJestConfig === 'function') {
+      return userJestConfig(this._jestConfig);
+    }
+
+    return this.jestConfig;
+  }
+
+}
+
+export { TestConfigOperator };

package/dist/js/modern/base/config/transformer/babelTransformer.js

@@ -0,0 +1,12 @@
+var _babelJest$createTran;
+
+import babelJest from 'babel-jest';
+const babelTransformer = (_babelJest$createTran = babelJest.createTransformer) === null || _babelJest$createTran === void 0 ? void 0 : _babelJest$createTran.call(babelJest, {
+  presets: [[require.resolve('@modern-js/babel-preset-app'), {
+    appDirectory: process.cwd(),
+    modules: 'cjs'
+  }]],
+  configFile: false,
+  babelrc: false
+});
+export default babelTransformer;

package/dist/js/modern/base/hook.js

@@ -0,0 +1,7 @@
+import { createAsyncPipeline, createParallelWorkflow } from '@modern-js/plugin';
+export const jestConfigHook = createAsyncPipeline();
+export const afterTestHook = createParallelWorkflow();
+export const testingHooks = {
+  jestConfig: createAsyncPipeline(),
+  afterTest: createParallelWorkflow()
+};

package/dist/js/modern/base/index.js

@@ -0,0 +1,6 @@
+export { runTest, runJest } from "./runJest";
+export { getModuleNameMapper } from "./utils";
+export { DEFAULT_RESOLVER_PATH } from "./config";
+export { TestConfigOperator } from "./config/testConfigOperator";
+export { testingHooks } from "./hook";
+export * from "./types";

package/dist/js/modern/base/runJest.js

@@ -0,0 +1,94 @@
+/**
+ * @file run jest by nodejs API
+ * @description
+ * Jest does not provide node API to run jest.
+ * The followed code is inspired by
+ * https://github.com/facebook/jest/blob/fdc74af37235354e077edeeee8aa2d1a4a863032/packages/jest-cli/src/cli/index.ts#L21
+ */
+import yargs from 'yargs/yargs';
+import { runCLI } from 'jest';
+import { chalk } from '@modern-js/utils';
+import { getJestUtils, patchConfig } from "./config";
+import { debug } from "./utils";
+
+const buildArgv = async (rawArgv, config) => {
+  const argv = await yargs(rawArgv).argv;
+  const result = {
+    $0: argv.$0,
+    _: argv._.slice(1)
+  };
+  Object.keys(argv).forEach(key => {
+    if (key.includes('-') || key === '_') {
+      return;
+    }
+
+    result[key] = argv[key];
+  });
+
+  if (config) {
+    result.config = JSON.stringify(config);
+  }
+
+  return result;
+};
+
+const readResultsAndExit = (result, globalConfig) => {
+  const code = !result || result.success ? 0 : globalConfig.testFailureExitCode; // Only exit if needed
+
+  process.on('exit', () => {
+    if (typeof code === 'number' && code !== 0) {
+      process.exitCode = code;
+    }
+  });
+
+  if (globalConfig.forceExit) {
+    if (!globalConfig.detectOpenHandles) {
+      console.warn(`${chalk.bold('Force exiting Jest: ')}Have you considered using \`--detectOpenHandles\` to detect ` + `async operations that kept running after all tests finished?`);
+    } // eslint-disable-next-line no-process-exit
+
+
+    process.exit(code);
+  } else if (!globalConfig.detectOpenHandles) {
+    setTimeout(() => {
+      console.warn(chalk.yellow.bold('Jest did not exit one second after the test run has completed.\n\n') + chalk.yellow('This usually means that there are asynchronous operations that ' + "weren't stopped in your tests. Consider running Jest with " + '`--detectOpenHandles` to troubleshoot this issue.'));
+    }, 1000).unref();
+  }
+};
+/**
+ * Node API: execute jest
+ */
+
+
+export async function runJest(config, pwd = process.cwd()) {
+  try {
+    const argvConfig = await buildArgv(process.argv.slice(2), config);
+    const {
+      results,
+      globalConfig
+    } = await runCLI(argvConfig, [pwd]);
+    readResultsAndExit(results, globalConfig);
+  } catch (e) {
+    console.error(chalk.red((e === null || e === void 0 ? void 0 : e.stack) || e)); // eslint-disable-next-line no-process-exit
+
+    process.exit(1);
+  }
+}
+/**
+ * Node API: run test
+ */
+
+export async function runTest(api, config, pwd = process.cwd()) {
+  process.env.NODE_ENV = 'test';
+  const jestUtils = getJestUtils(config);
+  await patchConfig(jestUtils); // 确保用户设置的配置可以被插件处理，比如设置在 projects 中
+
+  jestUtils.setJestUserConfig();
+  const hookRunners = api.useHookRunners();
+  const testConfigOperator = await hookRunners.jestConfig(jestUtils, {
+    onLast: input => input
+  });
+  const finalConfig = testConfigOperator.getFinalConfig();
+  debug('Jest config:', finalConfig);
+  await runJest(finalConfig, pwd);
+  await hookRunners.afterTest();
+}

package/dist/js/modern/base/utils.js

@@ -0,0 +1,59 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import fs from 'fs';
+import path from 'path';
+import { createDebugger } from '@modern-js/utils';
+export const debug = createDebugger('test');
+
+/**
+ * Read `compilerOptions` in the current pwd's tsconfig.json file
+ */
+export const readCompilerOptions = (pwd = process.cwd(), filename = 'tsconfig.json') => {
+  let tsConfig = {};
+  let extendedCompilerOptions = {};
+  let tsconfigFile = '';
+
+  try {
+    const maybeTsconfigFile = path.join(pwd, filename);
+
+    if (fs.existsSync(maybeTsconfigFile)) {
+      tsconfigFile = maybeTsconfigFile;
+    } else {
+      tsconfigFile = require.resolve(filename);
+    }
+
+    ({
+      config: tsConfig
+    } = require('typescript').parseConfigFileTextToJson(tsconfigFile, fs.readFileSync(tsconfigFile, 'utf8')));
+  } catch (e) {
+    return {};
+  }
+
+  if (tsConfig.extends) {
+    extendedCompilerOptions = readCompilerOptions(path.dirname(tsconfigFile), tsConfig.extends);
+  }
+
+  return _objectSpread(_objectSpread({}, extendedCompilerOptions), tsConfig.compilerOptions);
+};
+export const getModuleNameMapper = alias => Object.keys(alias).reduce((memo, cur) => {
+  const aliasValue = Array.isArray(alias[cur]) ? alias[cur] : [alias[cur]];
+  const isFile = aliasValue.some(s => s.endsWith('.js')); // It's special for if using @modern-js/runtime alias other module @modern-js/runtime/model would not work.
+
+  if (cur === '@modern-js/runtime$') {
+    memo[`.+${cur}`] = aliasValue[0];
+    return memo;
+  }
+
+  if (isFile) {
+    memo[cur] = aliasValue[0];
+  }
+
+  const key = `^${cur}/(.*)$`;
+  const value = path.normalize(`${aliasValue}/$1`);
+  memo[key] = value;
+  return memo;
+}, {});

package/dist/js/modern/cli/bff/app.js

@@ -0,0 +1,22 @@
+import { AsyncLocalStorage } from 'async_hooks';
+import { Server } from '@modern-js/server';
+const store = new AsyncLocalStorage();
+export const isInHandler = () => Boolean(store.getStore());
+
+const createApp = async (pwd, config, plugins, routes) => {
+  config.output.path = './';
+  const server = new Server({
+    apiOnly: true,
+    dev: {
+      watch: false
+    },
+    pwd,
+    config,
+    plugins,
+    routes
+  });
+  await server.init();
+  return server.getRequestHandler();
+};
+
+export { createApp };

package/dist/js/modern/cli/bff/constant.js

@@ -0,0 +1 @@
+export const bff_info_key = 'modern_bff_info';

package/dist/js/modern/cli/bff/env.js

@@ -0,0 +1,28 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import NodeEnvironment from 'jest-environment-node';
+import { createApp } from "./app";
+import { bff_info_key } from "./constant";
+export default class extends NodeEnvironment {
+  constructor(...args) {
+    super(...args);
+
+    _defineProperty(this, "app", void 0);
+  }
+
+  async setup() {
+    const bff_info = this.global[bff_info_key];
+    const {
+      plugins
+    } = bff_info; // eslint-disable-next-line no-multi-assign
+
+    this.global.app = this.app = await createApp(bff_info.appDir, bff_info.modernUserConfig, plugins, bff_info.routes);
+  }
+
+  async teardown() {
+    var _this$app, _this$app$server;
+
+    await ((_this$app = this.app) === null || _this$app === void 0 ? void 0 : (_this$app$server = _this$app.server) === null || _this$app$server === void 0 ? void 0 : _this$app$server.close());
+  }
+
+}

package/dist/js/modern/cli/bff/index.js

@@ -0,0 +1,110 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import path from 'path';
+import { isApiOnly } from '@modern-js/utils';
+import { getModuleNameMapper, DEFAULT_RESOLVER_PATH } from "../../base";
+import { bff_info_key } from "./constant";
+import { isBFFProject } from "./utils";
+export const setJestConfigForBFF = async ({
+  pwd,
+  userConfig,
+  plugins,
+  routes,
+  utils
+}) => {
+  var _userConfig$source;
+
+  const bffConfig = {
+    rootDir: path.join(pwd, './api'),
+    setupFilesAfterEnv: [require.resolve("./setup")],
+    testEnvironment: require.resolve("./env"),
+    testMatch: [`**/api/**/*.test.[jt]s`],
+    globals: {
+      [bff_info_key]: {
+        appDir: pwd,
+        modernUserConfig: userConfig,
+        plugins,
+        routes
+      }
+    }
+  };
+  const {
+    jestConfig
+  } = utils;
+  const alias = (userConfig === null || userConfig === void 0 ? void 0 : (_userConfig$source = userConfig.source) === null || _userConfig$source === void 0 ? void 0 : _userConfig$source.alias) || {};
+  const aliasMapper = getModuleNameMapper(alias);
+  const {
+    transform,
+    moduleNameMapper
+  } = jestConfig;
+  const apiOnly = await isApiOnly(pwd);
+
+  const mergedModuleNameMapper = _objectSpread(_objectSpread({}, moduleNameMapper), aliasMapper);
+
+  const resolver = jestConfig.resolver || DEFAULT_RESOLVER_PATH; // 这三个配置不能设置在 projects 中，需要设置在外层(https://github.com/facebook/jest/issues/9696)
+
+  const configFields = ['coverage', 'collectCoverage', 'testTimeout'];
+  const commonConfig = configFields.reduce((obj, field) => {
+    if (jestConfig.hasOwnProperty(field)) {
+      obj[field] = jestConfig[field];
+    }
+
+    return obj;
+  }, {});
+
+  if (!apiOnly) {
+    utils.setJestConfig({
+      projects: [_objectSpread({}, jestConfig), _objectSpread({
+        transform,
+        moduleNameMapper: mergedModuleNameMapper,
+        resolver
+      }, bffConfig)]
+    }, {
+      force: true
+    });
+  } else {
+    utils.setJestConfig({
+      projects: [_objectSpread({
+        transform,
+        moduleNameMapper: mergedModuleNameMapper,
+        resolver
+      }, bffConfig)]
+    }, {
+      force: true
+    });
+  }
+
+  utils.setJestConfig(commonConfig);
+};
+export default (() => ({
+  name: '@modern-js/testing-plugin-bff',
+
+  setup(api) {
+    return {
+      jestConfig: async (utils, next) => {
+        const appContext = api.useAppContext();
+        const pwd = appContext.appDirectory;
+
+        if (!isBFFProject(pwd)) {
+          return next(utils);
+        }
+
+        const userConfig = api.useResolvedConfigContext();
+        const plugins = appContext.plugins.map(p => p.server).filter(Boolean);
+        await setJestConfigForBFF({
+          pwd,
+          userConfig,
+          plugins,
+          routes: appContext.serverRoutes,
+          utils
+        });
+        return next(utils);
+      }
+    };
+  }
+
+}));