@modern-js/plugin-koa 1.4.5 → 1.4.6

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @modern-js/plugin-koa
 
+## 1.4.6
+
+### Patch Changes
+
+- 04ae5262: chore: bump @modern-js/utils to v1.4.1 in dependencies
+- 60f7d8bf: feat: add tests dir to npmignore
+- befd9e5b: fix: compatible with babel-plugin-resolver's handling of relative paths on windows
+- Updated dependencies [b8599d09]
+- Updated dependencies [6cffe99d]
+- Updated dependencies [04ae5262]
+- Updated dependencies [60f7d8bf]
+- Updated dependencies [befd9e5b]
+- Updated dependencies [3bf4f8b0]
+  - @modern-js/utils@1.5.0
+  - @modern-js/adapter-helpers@1.2.3
+  - @modern-js/bff-runtime@1.2.2
+  - @modern-js/bff-utils@1.2.3
+
 ## 1.4.5
 
 ### Patch Changes

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

@@ -1,5 +1,6 @@
 import * as path from 'path';
 import { createRuntimeExportsUtils } from '@modern-js/utils';
+import { getRelativeRuntimePath } from '@modern-js/adapter-helpers';
 export default (() => ({
   name: '@modern-js/plugin-koa',
   setup: api => {
@@ -16,14 +17,8 @@ export default (() => ({
           appDirectory
         } = appContext;
         bffExportsUtils = createRuntimeExportsUtils(appContext.internalDirectory, 'server');
-        const serverRuntimePath = bffExportsUtils.getPath(); // Look up one level, because the artifacts after build have dist directories
-
-        let relativeRuntimePath = path.join('../', path.relative(appDirectory, serverRuntimePath));
-
-        if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
-          relativeRuntimePath = `./${path.relative(appDirectory, serverRuntimePath)}`;
-        }
-
+        const serverRuntimePath = bffExportsUtils.getPath();
+        const relativeRuntimePath = getRelativeRuntimePath(appDirectory, serverRuntimePath);
         return {
           source: {
             alias: {

package/dist/js/node/cli/index.js

@@ -9,6 +9,8 @@ var path = _interopRequireWildcard(require("path"));
 
 var _utils = require("@modern-js/utils");
 
+var _adapterHelpers = require("@modern-js/adapter-helpers");
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -29,14 +31,8 @@ var _default = () => ({
           appDirectory
         } = appContext;
         bffExportsUtils = (0, _utils.createRuntimeExportsUtils)(appContext.internalDirectory, 'server');
-        const serverRuntimePath = bffExportsUtils.getPath(); // Look up one level, because the artifacts after build have dist directories
-
-        let relativeRuntimePath = path.join('../', path.relative(appDirectory, serverRuntimePath));
-
-        if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
-          relativeRuntimePath = `./${path.relative(appDirectory, serverRuntimePath)}`;
-        }
-
+        const serverRuntimePath = bffExportsUtils.getPath();
+        const relativeRuntimePath = (0, _adapterHelpers.getRelativeRuntimePath)(appDirectory, serverRuntimePath);
         return {
           source: {
             alias: {

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.4.5",
+  "version": "1.4.6",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -34,10 +34,10 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.15.3",
-    "@modern-js/adapter-helpers": "^1.2.1",
-    "@modern-js/bff-runtime": "^1.2.1",
-    "@modern-js/bff-utils": "^1.2.2",
-    "@modern-js/utils": "^1.3.7",
+    "@modern-js/adapter-helpers": "^1.2.3",
+    "@modern-js/bff-runtime": "^1.2.2",
+    "@modern-js/bff-utils": "^1.2.3",
+    "@modern-js/utils": "^1.5.0",
     "koa-body": "^4.2.0",
     "koa-router": "^10.0.0",
     "type-is": "^1.6.18"
@@ -52,8 +52,8 @@
     "@types/supertest": "^2.0.11",
     "@types/type-is": "^1.6.3",
     "jest": "^27",
-    "@modern-js/server-core": "1.2.5",
-    "@modern-js/core": "1.6.1",
+    "@modern-js/server-core": "1.3.1",
+    "@modern-js/core": "1.8.0",
     "supertest": "^6.1.6",
     "koa": "^2.13.3",
     "typescript": "^4"

package/tests/.eslintrc.js

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

package/tests/common.ts

@@ -1,9 +0,0 @@
-// 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 INTROSPECTION_ROUTE_PATH = '/__introspection__';

package/tests/fixtures/assets/index.html

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Document</title>
-</head>
-<body>
-  hello koa plugin
-</body>
-</html>

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

@@ -1 +0,0 @@
-export const get = () => ({ message: 'hello koa' });

package/tests/fixtures/function-mode/api/nest/user.ts

@@ -1,33 +0,0 @@
-import { match } from '@modern-js/bff-runtime';
-import { useContext } from '../../../../../src/context';
-
-export const get = ({ query }: { query: Record<string, unknown> }) => ({
-  query,
-});
-
-export const post = ({ data }: { data: Record<string, unknown> }) => {
-  // eslint-disable-next-line react-hooks/rules-of-hooks
-  const ctx = useContext();
-  const { cookies } = ctx;
-  return {
-    query: ctx.query,
-    data,
-    cookies: {
-      id: cookies.get('id'),
-      name: cookies.get('name'),
-    },
-  };
-};
-
-export const patch = match(
-  {
-    request: {
-      data: {
-        id: Number,
-        name: String,
-      },
-    },
-    response: { id: Number },
-  },
-  ({ data: { id } }) => ({ id }),
-);

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

@@ -1,4 +0,0 @@
-export const post = ({ formData }) => ({
-  message: 'success',
-  formData,
-});

package/tests/fixtures/lambda-mode/api/app.ts

@@ -1 +0,0 @@
-// used by the test, empty file

package/tests/fixtures/lambda-mode/api/lambda/hello.ts

@@ -1 +0,0 @@
-export const get = () => ({ message: 'hello koa' });

package/tests/fixtures/lambda-mode/api/lambda/nest/[id].ts

@@ -1 +0,0 @@
-export const post = (id: string) => ({ id });

package/tests/fixtures/lambda-mode/api/lambda/nest/user.ts

@@ -1,33 +0,0 @@
-import { match } from '@modern-js/bff-runtime';
-import { useContext } from '../../../../../../src/context';
-
-export const get = ({ query }: { query: Record<string, unknown> }) => ({
-  query,
-});
-
-export const post = ({ data }: { data: Record<string, unknown> }) => {
-  // eslint-disable-next-line react-hooks/rules-of-hooks
-  const ctx = useContext();
-  const { cookies } = ctx;
-  return {
-    query: ctx.query,
-    data,
-    cookies: {
-      id: cookies.get('id'),
-      name: cookies.get('name'),
-    },
-  };
-};
-
-export const patch = match(
-  {
-    request: {
-      data: {
-        id: Number,
-        name: String,
-      },
-    },
-    response: { id: Number },
-  },
-  ({ data: { id } }) => ({ id }),
-);

package/tests/fixtures/lambda-mode/api/lambda/upload.ts

@@ -1,4 +0,0 @@
-export const post = ({ formData }) => ({
-  message: 'success',
-  formData,
-});

package/tests/functionMode.test.ts

@@ -1,69 +0,0 @@
-import * as path from 'path';
-import request from 'supertest';
-import { serverManager } from '@modern-js/server-core';
-import plugin from '../src/plugin';
-import { APIPlugin } from './helpers';
-import './common';
-
-const pwd = path.join(__dirname, './fixtures/function-mode');
-
-describe('function-mode', () => {
-  const id = '666';
-  const name = 'foo';
-  const foo = { id, name };
-  let apiHandler: any;
-
-  beforeAll(async () => {
-    const runner = await serverManager
-      .clone()
-      .usePlugin(APIPlugin, plugin)
-      .init();
-    apiHandler = await runner.prepareApiServer({
-      pwd,
-      mode: 'function',
-    });
-  });
-
-  test('should works with body', async () => {
-    const res = await request(apiHandler).post('/nest/user').send(foo);
-    expect(res.status).toBe(200);
-    expect(res.body.data).toEqual(foo);
-  });
-
-  test('should works with schema', async () => {
-    const res = await request(apiHandler).patch('/nest/user').send({
-      id: 777,
-      name: 'xxx',
-    });
-    expect(res.status).toBe(200);
-    expect(res.body.id).toBe(777);
-
-    const res2 = await request(apiHandler).patch('/nest/user').send({
-      id: 'aaa',
-      name: 'xxx',
-    });
-    expect(res2.status).toBe(400);
-
-    const res3 = await request(apiHandler).patch('/nest/user').send({
-      id: '777',
-      name: 'xxx',
-    });
-    expect(res3.status).toBe(500);
-  });
-
-  test('should support upload file', done => {
-    request(apiHandler)
-      .post('/upload')
-      .field('my_field', 'value')
-      .attach('file', path.join(__dirname, './fixtures/assets/index.html'))
-      .end(async (err, res) => {
-        if (err) {
-          throw err;
-        }
-        expect(res.statusCode).toBe(200);
-        expect(res.body.message).toBe('success');
-        expect(res.body.formData).not.toBeUndefined();
-        done();
-      });
-  });
-});

package/tests/helpers.ts

@@ -1,14 +0,0 @@
-import path from 'path';
-import { createPlugin } from '@modern-js/server-core';
-import { injectAPIHandlerInfos, API_DIR } from '@modern-js/bff-utils';
-
-export const APIPlugin = createPlugin(() => ({
-  prepareApiServer(props, next) {
-    const { pwd, prefix } = props;
-    const apiDir = path.resolve(pwd, API_DIR);
-
-    injectAPIHandlerInfos(apiDir, prefix);
-
-    return next(props);
-  },
-}));

package/tests/lambdaMode.test.ts

@@ -1,318 +0,0 @@
-import * as path from 'path';
-import request from 'supertest';
-import Koa from 'koa';
-import { serverManager } from '@modern-js/server-core';
-import Router from 'koa-router';
-import koaBody from 'koa-body';
-import plugin from '../src/plugin';
-import { APIPlugin } from './helpers';
-import { INTROSPECTION_ROUTE_PATH } from './common';
-
-const pwd = path.join(__dirname, './fixtures/lambda-mode');
-const API_DIR = './api';
-const MockKoa = Koa;
-const MockRouter = Router;
-const MockKoaBody = koaBody;
-
-describe('lambda-mode', () => {
-  const id = '666';
-  const name = 'foo';
-  const foo = { id, name };
-  const prefix = '/api';
-  let apiHandler: any;
-
-  beforeAll(async () => {
-    const runner = await serverManager
-      .clone()
-      .usePlugin(APIPlugin, plugin)
-      .init();
-    apiHandler = await runner.prepareApiServer({
-      pwd,
-      mode: 'framework',
-      prefix,
-    });
-  });
-
-  test('should works', async () => {
-    const res = await request(apiHandler).get(`${prefix}/hello`);
-    expect(res.status).toBe(200);
-  });
-
-  test('should works with query', async () => {
-    const res = await request(apiHandler).get(`${prefix}/nest/user?id=${id}`);
-    expect(res.status).toBe(200);
-    expect(res.body.query.id).toBe(id);
-  });
-
-  test('should works with body', async () => {
-    const res = await request(apiHandler).post(`${prefix}/nest/user`).send(foo);
-    expect(res.status).toBe(200);
-    expect(res.body.data).toEqual(foo);
-  });
-
-  test('should works with dynamic route ', async () => {
-    const res = await request(apiHandler).post(`${prefix}/nest/${id}`);
-    expect(res.status).toBe(200);
-    expect(res.body).toEqual({ id });
-  });
-
-  test('should works with context', async () => {
-    const res = await request(apiHandler)
-      .post(`${prefix}/nest/user?id=${id}`)
-      .send(foo);
-    expect(res.status).toBe(200);
-    expect(res.body.data).toEqual(foo);
-    expect(res.body.query.id).toBe(id);
-  });
-
-  test('should support cookies', async () => {
-    const res = await request(apiHandler)
-      .post(`${prefix}/nest/user?id=${id}`)
-      .set('Cookie', [`id=${id};name=${name}`]);
-    expect(res.status).toBe(200);
-    expect(res.body.cookies.id).toBe(id);
-    expect(res.body.cookies.name).toBe(name);
-  });
-
-  test('should works with schema', async () => {
-    const res = await request(apiHandler).patch(`${prefix}/nest/user`).send({
-      id: 777,
-      name: 'xxx',
-    });
-    expect(res.status).toBe(200);
-
-    const res2 = await request(apiHandler).patch(`${prefix}/nest/user`).send({
-      id: 'aaa',
-      name: 'xxx',
-    });
-    expect(res2.status).toBe(400);
-
-    const res3 = await request(apiHandler).patch(`${prefix}/nest/user`).send({
-      id: '777',
-      name: 'xxx',
-    });
-    expect(res3.status).toBe(500);
-  });
-
-  test('introspection', async () => {
-    const res = await request(apiHandler).get(
-      `${prefix}${INTROSPECTION_ROUTE_PATH}`,
-    );
-    expect(res.status).toBe(200);
-    expect(res.body.protocol).toBe('Farrow-API');
-  });
-
-  test('should support upload file', done => {
-    request(apiHandler)
-      .post(`${prefix}/upload`)
-      .field('my_field', 'value')
-      .attach('file', path.join(__dirname, './fixtures/assets/index.html'))
-      .end(async (err, res) => {
-        if (err) {
-          throw err;
-        }
-        expect(res.statusCode).toBe(200);
-        expect(res.body.message).toBe('success');
-        expect(res.body.formData).not.toBeUndefined();
-        done();
-      });
-  });
-});
-
-describe('add middlewares', () => {
-  let runner: any;
-
-  beforeAll(async () => {
-    runner = await serverManager.clone().usePlugin(APIPlugin, plugin).init();
-  });
-
-  test('should works', async () => {
-    const foo = 'foo';
-    const fakeMiddleware = jest.fn(async (ctx: any, next: any) => {
-      await next();
-      ctx.body = foo;
-    });
-    const fakeMiddleware2 = jest.fn(async (ctx: any, next: any) => {
-      await next();
-    });
-
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    const [mock_fakeMiddleware, mock_fakeMiddleware2] = [
-      fakeMiddleware,
-      fakeMiddleware2,
-    ];
-    const apiHandler = await runner.prepareApiServer({
-      pwd,
-      mode: 'framework',
-      config: {
-        middleware: [
-          mock_fakeMiddleware,
-          mock_fakeMiddleware2,
-          mock_fakeMiddleware2,
-        ],
-      },
-    });
-
-    const res = await request(apiHandler).get('/user');
-    expect(fakeMiddleware.mock.calls.length).toBe(1);
-    expect(fakeMiddleware2.mock.calls.length).toBe(2);
-    expect(res.status).toBe(200);
-    expect(res.text).toEqual(foo);
-  });
-});
-
-describe('support use koaBody in app.ts', () => {
-  const id = '666';
-  const name = 'modernjs';
-  const foo = { id, name };
-
-  let runner: any;
-
-  beforeAll(async () => {
-    runner = await serverManager.clone().usePlugin(APIPlugin, plugin).init();
-  });
-
-  test('support use koaBody', async () => {
-    const mock_foo = foo;
-    jest.mock(
-      path.join(pwd, API_DIR, 'app.ts'),
-      () => {
-        const app = new MockKoa();
-        // test app takes effect
-        app.use(async (ctx, next) => {
-          ctx.request.query = mock_foo;
-          await next();
-        });
-
-        app.use(MockKoaBody());
-
-        return {
-          __esModule: true,
-          default: app,
-        };
-      },
-      { virtual: true },
-    );
-
-    const apiHandler = await runner.prepareApiServer({
-      pwd,
-      mode: 'framework',
-    });
-    const res = await request(apiHandler).post('/nest/user').send(foo);
-    expect(res.status).toBe(200);
-    expect(res.body.query).toEqual(foo);
-    expect(res.body.data).toEqual(foo);
-  });
-});
-
-describe('support app.ts in lambda mode', () => {
-  const name = 'modernjs';
-
-  let runner: any;
-
-  beforeAll(async () => {
-    runner = await serverManager.clone().usePlugin(APIPlugin, plugin).init();
-  });
-
-  beforeEach(() => {
-    jest.resetModules();
-  });
-
-  test('support es module', async () => {
-    jest.mock(
-      path.join(pwd, API_DIR, 'app.ts'),
-      () => {
-        const app = new MockKoa();
-        return {
-          __esModule: true,
-          default: app,
-        };
-      },
-      { virtual: true },
-    );
-
-    const apiHandler = await runner.prepareApiServer({
-      pwd,
-      mode: 'framework',
-    });
-
-    const res = await request(apiHandler).get(`/nest/user?name=${name}`);
-    expect(res.status).toBe(200);
-    expect(res.body.query.name).toBe(name);
-  });
-
-  test('support commonjs module', async () => {
-    jest.mock(
-      path.join(pwd, API_DIR, 'app.ts'),
-      () => {
-        const app = new MockKoa();
-        return app;
-      },
-      { virtual: true },
-    );
-
-    const apiHandler = await runner.prepareApiServer({
-      pwd,
-      mode: 'framework',
-    });
-
-    const res = await request(apiHandler).get(`/nest/user?name=${name}`);
-    expect(res.status).toBe(200);
-    expect(res.body.query.name).toBe(name);
-  });
-
-  test('support use middleware', async () => {
-    const mock_name = name;
-    jest.mock(
-      path.join(pwd, API_DIR, 'app.ts'),
-      () => {
-        const app = new MockKoa();
-        app.use(async (ctx, next) => {
-          ctx.query.name = mock_name;
-          await next();
-        });
-        return app;
-      },
-      { virtual: true },
-    );
-
-    const apiHandler = await runner.prepareApiServer({
-      pwd,
-      mode: 'framework',
-    });
-
-    const res = await request(apiHandler).get(`/nest/user`);
-    expect(res.status).toBe(200);
-    expect(res.body.query.name).toBe(name);
-  });
-
-  test('support use router', async () => {
-    jest.mock(
-      path.join(pwd, API_DIR, 'app.ts'),
-      () => {
-        const app = new MockKoa();
-        const router = new MockRouter();
-        router.get('/hello', ctx => {
-          ctx.body = `foo`;
-        });
-
-        app.use(router.routes());
-        return app;
-      },
-      { virtual: true },
-    );
-
-    const apiHandler = await runner.prepareApiServer({
-      pwd,
-      mode: 'framework',
-    });
-
-    const res1 = await request(apiHandler).get(`/hello`);
-    expect(res1.status).toBe(200);
-    expect(res1.text).toBe('foo');
-
-    const res2 = await request(apiHandler).get(`/nest/user?name=${name}`);
-    expect(res2.status).toBe(200);
-    expect(res2.body.query.name).toBe(name);
-  });
-});

package/tests/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "extends": "@modern-js/tsconfig/base",
-  "compilerOptions": {
-    "declaration": false,
-    "jsx": "preserve",
-    "baseUrl": "./",
-    "isolatedModules": true,
-    "sourceMap": true
-  },
-  "paths": {},
-  "exclude": ["src/__test__/fixtures/**"]
-}

package/tests/webServer.test.ts

@@ -1,81 +0,0 @@
-import * as path from 'path';
-import fs from 'fs';
-import request from 'supertest';
-import { serverManager } from '@modern-js/server-core';
-import plugin from '../src/plugin';
-import { APIPlugin } from './helpers';
-import './common';
-
-const pwd = path.join(__dirname, './fixtures/function-mode');
-
-describe('webServer', () => {
-  const id = '666';
-  const name = 'foo';
-  const foo = { id, name };
-  let webHandler: any;
-  let runner: any;
-
-  beforeAll(async () => {
-    runner = await serverManager.clone().usePlugin(APIPlugin, plugin).init();
-  });
-
-  test('support json', async () => {
-    const middleware = (ctx: any) => {
-      // ctx.req.url = `${ctx.req.url}?id=${id}`;
-      ctx.body = foo;
-    };
-
-    webHandler = await runner.prepareWebServer({
-      pwd,
-      config: { middleware: [middleware] },
-    });
-
-    const res = await request(webHandler).get('/');
-    expect(res.status).toBe(200);
-    expect(res.get('content-type')).toBe('application/json; charset=utf-8');
-    expect(res.body).toEqual(foo);
-  });
-
-  test('support stream', async () => {
-    const middleware = (ctx: any) => {
-      ctx.response.set('content-type', 'text/html');
-      ctx.body = fs.createReadStream(
-        path.resolve(__dirname, './fixtures/assets/index.html'),
-      );
-    };
-
-    webHandler = await runner.prepareWebServer({
-      pwd,
-      config: { middleware: [middleware] },
-    });
-
-    const res = await request(webHandler).get('/');
-    expect(res.status).toBe(200);
-    expect(res.get('content-type')).toBe('text/html');
-    expect(res.text).toContain(`hello koa plugin`);
-  });
-
-  test('should support Multiple middleware', async () => {
-    const middleware1 = async (ctx: any, next: any) => {
-      await next();
-    };
-
-    const middleware2 = async (ctx: any, next: any) => {
-      ctx.response.set('content-type', 'text/html');
-      ctx.body = fs.createReadStream(
-        path.resolve(__dirname, './fixtures/assets/index.html'),
-      );
-      await next();
-    };
-
-    webHandler = await runner.prepareWebServer({
-      pwd,
-      config: { middleware: [middleware1, middleware2] },
-    });
-
-    const res = await request(webHandler).get('/');
-    expect(res.status).toBe(200);
-    expect(res.get('content-type')).toBe('text/html');
-    expect(res.text).toContain(`hello koa plugin`);
-  });
-});