@modern-js/plugin-bff 1.3.9 → 1.4.2

package/CHANGELOG.md

@@ -1,5 +1,62 @@
 # @modern-js/plugin-bff
 
+## 1.4.2
+
+### Patch Changes
+
+- 895fa0ff: chore: using "workspace:\*" in devDependencies
+- Updated dependencies [2d155c4c]
+- Updated dependencies [123e432d]
+- Updated dependencies [e5a9b26d]
+- Updated dependencies [0b26b93b]
+- Updated dependencies [123e432d]
+- Updated dependencies [f9f66ef9]
+- Updated dependencies [592edabc]
+- Updated dependencies [895fa0ff]
+- Updated dependencies [3578913e]
+- Updated dependencies [0fccff68]
+- Updated dependencies [1c3beab3]
+  - @modern-js/utils@1.6.0
+  - @modern-js/bff-utils@1.2.4
+  - @modern-js/server-utils@1.2.4
+  - @modern-js/create-request@1.2.5
+
+## 1.4.1
+
+### Patch Changes
+
+- 04ae5262: chore: bump @modern-js/utils to v1.4.1 in dependencies
+- 60f7d8bf: feat: add tests dir to npmignore
+- e4cec1ce: types: fix config hook type
+- Updated dependencies [b8599d09]
+- Updated dependencies [6cffe99d]
+- Updated dependencies [04ae5262]
+- Updated dependencies [60f7d8bf]
+- Updated dependencies [3bf4f8b0]
+  - @modern-js/utils@1.5.0
+  - @modern-js/bff-utils@1.2.3
+  - @modern-js/server-utils@1.2.3
+  - @modern-js/babel-compiler@1.2.3
+  - @modern-js/create-request@1.2.4
+
+## 1.4.0
+
+### Minor Changes
+
+- d2d1d6b2: feat: support server config
+
+### Patch Changes
+
+- d2d1d6b2: feat: add prepare hook
+- Updated dependencies [77ff9754]
+- Updated dependencies [d2d1d6b2]
+- Updated dependencies [07a4887e]
+- Updated dependencies [ea2ae711]
+- Updated dependencies [17d0cc46]
+- Updated dependencies [d2d1d6b2]
+  - @modern-js/utils@1.4.0
+  - @modern-js/server-utils@1.2.2
+
 ## 1.3.9
 
 ### Patch Changes

package/dist/js/modern/cli.js

@@ -1,7 +1,6 @@
 import path from 'path';
-import fs from 'fs-extra';
 import { compiler } from '@modern-js/babel-compiler';
-import { PLUGIN_SCHEMAS, normalizeOutputPath, API_DIR } from '@modern-js/utils';
+import { fs, API_DIR, PLUGIN_SCHEMAS, normalizeOutputPath } from '@modern-js/utils';
 import { resolveBabelConfig } from '@modern-js/server-utils';
 const DEFAULT_API_PREFIX = '/api';
 const TS_CONFIG_FILENAME = 'tsconfig.json';

package/dist/js/modern/server.js

@@ -24,22 +24,25 @@ const createTransformAPI = storage => ({
 export default (() => ({
   name: '@modern-js/plugin-bff',
   setup: api => {
-    const {
-      appDirectory,
-      distDirectory
-    } = api.useAppContext();
-    const root = isProd() ? distDirectory : appDirectory;
-    const apiPath = path.resolve(root || process.cwd(), API_DIR);
-    const apiAppPath = path.resolve(apiPath, API_APP_NAME);
     const storage = new Storage();
     const transformAPI = createTransformAPI(storage);
-    const apiMod = requireExistModule(apiAppPath);
+    let apiAppPath = '';
+    return {
+      prepare() {
+        const {
+          appDirectory,
+          distDirectory
+        } = api.useAppContext();
+        const root = isProd() ? distDirectory : appDirectory;
+        const apiPath = path.resolve(root || process.cwd(), API_DIR);
+        apiAppPath = path.resolve(apiPath, API_APP_NAME);
+        const apiMod = requireExistModule(apiAppPath);
 
-    if (apiMod && typeof apiMod === 'function') {
-      apiMod(transformAPI);
-    }
+        if (apiMod && typeof apiMod === 'function') {
+          apiMod(transformAPI);
+        }
+      },
 
-    return {
       reset() {
         storage.reset();
         const newApiModule = requireExistModule(apiAppPath);

package/dist/js/node/cli.js

@@ -7,8 +7,6 @@ exports.default = void 0;
 
 var _path = _interopRequireDefault(require("path"));
 
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
-
 var _babelCompiler = require("@modern-js/babel-compiler");
 
 var _utils = require("@modern-js/utils");
@@ -124,8 +122,8 @@ var _default = () => ({
         ignore: [`**/__tests__/**`, '**/typings/**', '*.d.ts', '*.test.ts']
       }, babelConfig);
 
-      if (await _fsExtra.default.pathExists(rootDir)) {
-        await _fsExtra.default.copy(rootDir, distDir, {
+      if (await _utils.fs.pathExists(rootDir)) {
+        await _utils.fs.copy(rootDir, distDir, {
           filter: src => !['.ts', '.js'].includes(_path.default.extname(src)) && src !== tsconfigPath
         });
       }

package/dist/js/node/server.js

@@ -36,25 +36,27 @@ const createTransformAPI = storage => ({
 var _default = () => ({
   name: '@modern-js/plugin-bff',
   setup: api => {
-    const {
-      appDirectory,
-      distDirectory
-    } = api.useAppContext();
-    const root = (0, _utils.isProd)() ? distDirectory : appDirectory;
-
-    const apiPath = _path.default.resolve(root || process.cwd(), _utils.API_DIR);
-
-    const apiAppPath = _path.default.resolve(apiPath, _constants.API_APP_NAME);
-
     const storage = new Storage();
     const transformAPI = createTransformAPI(storage);
-    const apiMod = (0, _utils.requireExistModule)(apiAppPath);
+    let apiAppPath = '';
+    return {
+      prepare() {
+        const {
+          appDirectory,
+          distDirectory
+        } = api.useAppContext();
+        const root = (0, _utils.isProd)() ? distDirectory : appDirectory;
 
-    if (apiMod && typeof apiMod === 'function') {
-      apiMod(transformAPI);
-    }
+        const apiPath = _path.default.resolve(root || process.cwd(), _utils.API_DIR);
+
+        apiAppPath = _path.default.resolve(apiPath, _constants.API_APP_NAME);
+        const apiMod = (0, _utils.requireExistModule)(apiAppPath);
+
+        if (apiMod && typeof apiMod === 'function') {
+          apiMod(transformAPI);
+        }
+      },
 
-    return {
       reset() {
         storage.reset();
         const newApiModule = (0, _utils.requireExistModule)(apiAppPath);

package/dist/types/loader.d.ts

@@ -1,4 +1,4 @@
-import { LoaderContext } from 'webpack';
+import type { LoaderContext } from 'webpack';
 export declare type APILoaderOptions = {
   prefix: string;
   apiDir: string;

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.3.9",
+  "version": "1.4.2",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -55,24 +55,22 @@
   "dependencies": {
     "@babel/core": "7.16.7",
     "@babel/runtime": "^7",
-    "@modern-js/babel-compiler": "^1.2.2",
-    "@modern-js/bff-utils": "^1.2.2",
-    "@modern-js/create-request": "^1.2.2",
-    "@modern-js/server-utils": "^1.2.2",
-    "@modern-js/utils": "^1.3.7",
-    "fs-extra": "^10.0.0",
+    "@modern-js/babel-compiler": "^1.2.3",
+    "@modern-js/bff-utils": "^1.2.4",
+    "@modern-js/create-request": "^1.2.5",
+    "@modern-js/server-utils": "^1.2.4",
+    "@modern-js/utils": "^1.6.0",
     "loader-utils": "^2.0.0"
   },
   "devDependencies": {
-    "@modern-js/core": "1.6.1",
-    "@modern-js/plugin-analyze": "^1.3.5",
-    "@modern-js/runtime": "^1.2.5",
-    "@modern-js/server-core": "1.2.5",
-    "@modern-js/types": "^1.3.6",
+    "@modern-js/core": "1.9.0",
+    "@modern-js/plugin-analyze": "1.4.1",
+    "@modern-js/runtime": "1.2.7",
+    "@modern-js/server-core": "1.3.2",
+    "@modern-js/types": "1.5.1",
     "@scripts/build": "0.0.0",
     "@scripts/jest-config": "0.0.0",
     "@types/babel__core": "^7.1.15",
-    "@types/fs-extra": "^9.0.13",
     "@types/jest": "^26",
     "@types/loader-utils": "^2.0.3",
     "@types/node": "^14",

package/types.d.ts

@@ -0,0 +1,9 @@
+declare module '@modern-js/core' {
+  interface UserConfig {
+    bff?: Partial<{
+      prefix: string;
+      requestCreator: string;
+      fetcher: string;
+    }>;
+  }
+}

package/tests/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: ['@modern-js'],
-  parserOptions: {
-    project: require.resolve('./tsconfig.json'),
-  },
-};

package/tests/__snapshots__/cli.test.ts.snap

@@ -1,64 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`bff cli plugin config 1`] = `
-Array [
-  Object {
-    "source": Object {
-      "moduleScopes": Array [
-        "./api",
-        /create-request/,
-      ],
-    },
-    "tools": Object {
-      "webpack": [Function],
-    },
-  },
-]
-`;
-
-exports[`bff cli plugin schema 1`] = `
-Array [
-  Array [
-    Object {
-      "schema": Object {
-        "properties": Object {
-          "fetcher": Object {
-            "type": "string",
-          },
-          "prefix": Object {
-            "items": Object {
-              "type": "string",
-            },
-            "type": Array [
-              "string",
-              "array",
-            ],
-          },
-          "proxy": Object {
-            "type": "object",
-          },
-          "requestCreator": Object {
-            "type": "string",
-          },
-        },
-        "type": "object",
-      },
-      "target": "bff",
-    },
-  ],
-]
-`;
-
-exports[`bff cli plugin server routes 1`] = `
-Object {
-  "routes": Array [
-    Object {
-      "entryPath": "",
-      "isApi": true,
-      "isSPA": false,
-      "isSSR": false,
-      "urlPath": "/api",
-    },
-  ],
-}
-`;

package/tests/__snapshots__/loader.test.ts.snap

@@ -1,43 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`bff loader should work well 1`] = `
-"import { createRequest } from '/packages/server/create-request/src/node.ts';
-
-export const get = createRequest('/hello', 'GET', process.env.PORT || 3000);
-export const patch = createRequest('/hello', 'PATCH', process.env.PORT || 3000);
-"
-`;
-
-exports[`bff loader should work well with client 1`] = `
-"import { createRequest } from '/packages/server/create-request/src/node.ts';
-
-export const get = createRequest('/hello', 'GET', process.env.PORT || 3000);
-export const patch = createRequest('/hello', 'PATCH', process.env.PORT || 3000);
-"
-`;
-
-exports[`bff loader should work well with fetcher 1`] = `undefined`;
-
-exports[`bff loader should work well with port 1`] = `
-"import { createRequest } from '/packages/server/create-request/src/node.ts';
-
-export const get = createRequest('/hello', 'GET', process.env.PORT || 80);
-export const patch = createRequest('/hello', 'PATCH', process.env.PORT || 80);
-"
-`;
-
-exports[`bff loader should work well with prefix 1`] = `
-"import { createRequest } from '/packages/server/create-request/src/node.ts';
-
-export const get = createRequest('api/hello', 'GET', process.env.PORT || 3000);
-export const patch = createRequest('api/hello', 'PATCH', process.env.PORT || 3000);
-"
-`;
-
-exports[`bff loader should work well with requestCreator 1`] = `
-"import { createRequest } from '/packages/cli/plugin-bff/tests/fixtures/requestCreator/client';
-
-export const get = createRequest('/hello', 'GET', process.env.PORT || 80);
-export const patch = createRequest('/hello', 'PATCH', process.env.PORT || 80);
-"
-`;

package/tests/__snapshots__/server.test.ts.snap

@@ -1,66 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`bff server plugin prepareApiServer should work well 1`] = `
-Array [
-  Object {
-    "handler": [Function],
-    "method": "GET",
-    "name": "/hello",
-  },
-  Object {
-    "handler": [Function],
-    "method": "PATCH",
-    "name": "/hello",
-  },
-  Object {
-    "handler": [Function],
-    "method": "GET",
-    "name": "/upload",
-  },
-  Object {
-    "handler": [Function],
-    "method": "GET",
-    "name": "/user/:id",
-  },
-  Object {
-    "handler": [Function],
-    "method": "GET",
-    "name": "/__introspection__",
-  },
-]
-`;
-
-exports[`bff server plugin prepareApiServer should work well with prefix 1`] = `
-Array [
-  Object {
-    "handler": [Function],
-    "method": "GET",
-    "name": "/hello",
-    "path": "/api/hello",
-  },
-  Object {
-    "handler": [Function],
-    "method": "PATCH",
-    "name": "/hello",
-    "path": "/api/hello",
-  },
-  Object {
-    "handler": [Function],
-    "method": "GET",
-    "name": "/upload",
-    "path": "/api/upload",
-  },
-  Object {
-    "handler": [Function],
-    "method": "GET",
-    "name": "/user/:id",
-    "path": "/api/user/:id",
-  },
-  Object {
-    "handler": [Function],
-    "method": "GET",
-    "name": "/__introspection__",
-    "path": "/api/__introspection__",
-  },
-]
-`;

package/tests/cli.test.ts

@@ -1,98 +0,0 @@
-import path from 'path';
-import { manager, AppContext } from '@modern-js/core';
-import { modifyServerRoutes } from '@modern-js/plugin-analyze';
-import Chain from 'webpack-chain';
-import plugin from '../src/cli';
-
-const root = path.normalize(path.resolve(__dirname, '../../../../'));
-expect.addSnapshotSerializer({
-  test: val =>
-    typeof val === 'string' &&
-    (val.includes('modern.js') ||
-      val.includes('node_modules') ||
-      val.includes(root)),
-  print: val =>
-    // eslint-disable-next-line no-nested-ternary
-    typeof val === 'string'
-      ? // eslint-disable-next-line no-nested-ternary
-        val.includes('node_modules')
-        ? `"${val.replace(/.+node_modules/, '')}"`
-        : val.includes('modern.js')
-        ? `"${val.replace(/.+modern\.js/, '')}"`
-        : `"${val.replace(root, '')}"`
-      : (val as string),
-});
-
-describe('bff cli plugin', () => {
-  it('schema', async () => {
-    const main = manager.clone().usePlugin(plugin);
-    const runner = await main.init();
-    const result = await runner.validateSchema();
-
-    expect(result).toMatchSnapshot();
-  });
-
-  it('config', async () => {
-    const main = manager.clone().usePlugin(plugin);
-    const runner = await main.init();
-    const result = await runner.config();
-
-    expect(result).toMatchSnapshot();
-  });
-
-  it('config webpack chain', async () => {
-    const main = manager.clone().usePlugin(plugin);
-    const runner = await main.init();
-    const [{ tools }]: any = await runner.config();
-    const chain = new Chain();
-    manager.run(() => {
-      AppContext.set({
-        appDirectory: './fixtures/function',
-        port: 3000,
-      } as any);
-    });
-    manager.run(() => tools.webpack({}, { chain }));
-
-    expect(chain.toConfig()).toMatchObject({
-      module: {
-        rules: [
-          {
-            oneOf: [
-              {
-                test: /.\/fixtures\/function\/api\/\.*(\.[tj]s)$/,
-                use: [
-                  {
-                    loader: require
-                      .resolve('../src/loader.ts')
-                      .replace(/\\/g, '/'),
-                    options: {
-                      apiDir: path.resolve('./fixtures/function/api'),
-                      fetcher: undefined,
-                      port: 3000,
-                      prefix: '/api',
-                      target: undefined,
-                    },
-                  },
-                ],
-              },
-            ],
-          },
-        ],
-      },
-      resolve: {
-        alias: {
-          '@api': path.resolve('./fixtures/function/api'),
-        },
-      },
-    });
-  });
-
-  it('server routes', async () => {
-    const main = manager.clone().usePlugin(plugin);
-    main.registerHook({ modifyServerRoutes });
-    const runner = await main.init();
-    const result = await runner.modifyServerRoutes({ routes: [] });
-
-    expect(result).toMatchSnapshot();
-  });
-});

package/tests/compiler.ts

@@ -1,52 +0,0 @@
-import path from 'path';
-import webpack from 'webpack';
-import { createFsFromVolume, Volume } from 'memfs';
-import { APILoaderOptions } from '../src/loader';
-
-// globby needs setImmediate
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-expect-error
-global.setImmediate = setTimeout;
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-expect-error
-global.clearImmediate = clearTimeout;
-
-export const compiler = (fixture: string, options: APILoaderOptions) => {
-  const compiler = webpack({
-    context: __dirname,
-    entry: fixture,
-    target: 'node',
-    output: {
-      path: path.resolve(__dirname),
-      filename: 'bundle.js',
-    },
-    module: {
-      rules: [
-        {
-          test: /\.ts$/,
-          use: {
-            loader: path.resolve(__dirname, '../src/loader.ts'),
-            options,
-          },
-        },
-      ],
-    },
-    resolve: { extensions: ['.ts', '...'] },
-  });
-
-  compiler.outputFileSystem = createFsFromVolume(new Volume());
-  compiler.outputFileSystem.join = path.join.bind(path);
-
-  return new Promise<webpack.Stats | undefined>((resolve, reject) => {
-    compiler.run((err, stats) => {
-      if (err) {
-        reject(err);
-      }
-      if (stats?.hasErrors()) {
-        reject(stats.toJson().errors);
-      }
-
-      resolve(stats);
-    });
-  });
-};

package/tests/fixtures/function/api/hello.ts

@@ -1,17 +0,0 @@
-import { match } from '@modern-js/runtime/server';
-
-export const get = ({ query }: { query: Record<string, unknown> }) => ({
-  query,
-});
-export const patch = match(
-  {
-    request: {
-      data: {
-        id: Number,
-        name: String,
-      },
-    },
-    response: { id: Number },
-  },
-  ({ data: { id } }) => ({ id }),
-);

package/tests/fixtures/function/api/upload.ts

@@ -1,3 +0,0 @@
-export const get = ({ query }: { query: Record<string, unknown> }) => ({
-  query,
-});

package/tests/fixtures/function/api/user/[id].ts

@@ -1,3 +0,0 @@
-export const get = ({ query }: { query: Record<string, unknown> }) => ({
-  query,
-});

package/tests/fixtures/requestCreator/client.ts

@@ -1,3 +0,0 @@
-console.info('');
-
-export {};

package/tests/fixtures/requestCreator/server.ts

@@ -1,3 +0,0 @@
-console.info('');
-
-export {};

package/tests/fixtures/test-fetcher.ts

@@ -1,3 +0,0 @@
-console.info('');
-
-export {};

package/tests/loader.test.ts

@@ -1,107 +0,0 @@
-import path from 'path';
-import { compiler } from './compiler';
-
-const apiDir = path.resolve(__dirname, './fixtures/function/api');
-const filepath = path.resolve(__dirname, './fixtures/function/api/hello.ts');
-
-// jest.setTimeout(100000);
-
-const root = path.resolve(__dirname, '../../../../');
-expect.addSnapshotSerializer({
-  test: val =>
-    typeof val === 'string' &&
-    (val.includes('modern.js') ||
-      val.includes('node_modules') ||
-      val.includes(root)),
-  print: val =>
-    // eslint-disable-next-line no-nested-ternary
-    typeof val === 'string'
-      ? // eslint-disable-next-line no-nested-ternary
-        val.includes('node_modules')
-        ? `"${val.replace(/'.+node_modules/, `'`)}"`
-        : val.includes('modern.js')
-        ? `"${val.replace(/'.+modern\.js/, `'`)}"`
-        : `"${val.replace(root, '')}"`
-      : (val as string),
-});
-
-describe('bff loader', () => {
-  it('should work well', async () => {
-    const stats = await compiler(filepath, {
-      apiDir,
-      prefix: '',
-      port: 3000,
-      target: 'server',
-    });
-    const output = stats?.toJson({ source: true }).modules?.[0]?.source;
-
-    expect(output).toMatchSnapshot();
-  });
-
-  it('should work well with prefix', async () => {
-    const stats = await compiler(filepath, {
-      apiDir,
-      prefix: 'api',
-      port: 3000,
-      target: 'server',
-    });
-    const output = stats?.toJson({ source: true }).modules?.[0]?.source;
-
-    expect(output).toMatchSnapshot();
-  });
-
-  it('should work well with client', async () => {
-    const stats = await compiler(filepath, {
-      apiDir,
-      prefix: '',
-      port: 3000,
-      target: 'server',
-    });
-    const output = stats?.toJson({ source: true }).modules?.[0]?.source;
-
-    expect(output).toMatchSnapshot();
-  });
-
-  it('should work well with port', async () => {
-    const stats = await compiler(filepath, {
-      apiDir,
-      prefix: '',
-      port: 80,
-      target: 'server',
-    });
-    const output = stats?.toJson({ source: true }).modules?.[0]?.source;
-
-    expect(output).toMatchSnapshot();
-  });
-
-  // TODO: 暂时有问题，先屏蔽这个测试
-  xit('should work well with fetcher', async () => {
-    const stats = await compiler(filepath, {
-      apiDir,
-      prefix: '',
-      port: 80,
-      target: 'client',
-      fetcher: path
-        .resolve(__dirname, './fixtures/test-fetcher')
-        .replace(/\\/g, '/'),
-    });
-    const output = stats?.toJson({ source: true }).modules?.[0]?.source;
-
-    expect(output).toMatchSnapshot();
-  });
-
-  it('should work well with requestCreator', async () => {
-    const stats = await compiler(filepath, {
-      apiDir,
-      prefix: '',
-      port: 80,
-      target: 'client',
-      requestCreator: path
-        .resolve(__dirname, './fixtures/requestCreator')
-        .replace(/\\/g, '/'),
-    });
-    const output = stats?.toJson({ source: true }).modules?.[0]?.source;
-
-    expect(output).toMatchSnapshot();
-  });
-});

package/tests/server.test.ts

@@ -1,39 +0,0 @@
-import path from 'path';
-import { serverManager } from '@modern-js/server-core';
-import { useAPIHandlerInfos } from '@modern-js/bff-utils';
-import plugin from '../src/server';
-
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-export const noop = () => {};
-
-const pwd = path.resolve(__dirname, './fixtures/function');
-
-describe('bff server plugin', () => {
-  describe('prepareApiServer', () => {
-    it('should work well', async () => {
-      const main = serverManager.clone().usePlugin(plugin);
-      const runner = await main.init();
-
-      await runner.prepareApiServer(
-        { pwd, mode: 'function' },
-        { onLast: () => noop },
-      );
-
-      const apiHandlerInfos = main.run(useAPIHandlerInfos);
-      expect(apiHandlerInfos).toMatchSnapshot();
-    });
-
-    it('should work well with prefix', async () => {
-      const main = serverManager.clone().usePlugin(plugin);
-      const runner = await main.init();
-
-      await runner.prepareApiServer(
-        { pwd, mode: 'function', prefix: '/api' },
-        { onLast: () => noop },
-      );
-
-      const apiHandlerInfos = main.run(useAPIHandlerInfos);
-      expect(apiHandlerInfos).toMatchSnapshot();
-    });
-  });
-});

package/tests/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "extends": "@modern-js/tsconfig/base",
-  "compilerOptions": {
-    "declaration": true,
-    "jsx": "preserve",
-    "baseUrl": ".",
-    "noEmit": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "isolatedModules": true,
-    "paths": {},
-    "types": ["node", "jest"]
-  }
-}