@modern-js/plugin-koa 1.4.3 → 1.4.4

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @modern-js/plugin-koa
 
+## 1.4.4
+
+### Patch Changes
+
+- 952432ac: fix: upload files
+- c1b8fa0a: feat: convert to new server plugin
+- Updated dependencies [c2046f37]
+  - @modern-js/utils@1.3.6
+
 ## 1.4.3
 
 ### Patch Changes

package/dist/js/modern/plugin.js

@@ -2,7 +2,6 @@ import * as path from 'path';
 import Koa from 'koa';
 import Router from 'koa-router';
 import koaBody from 'koa-body';
-import { createPlugin } from '@modern-js/server-core';
 import { requireModule } from '@modern-js/bff-utils';
 import { fs } from '@modern-js/utils';
 import { run } from "./context";
@@ -28,37 +27,85 @@ const initMiddlewares = (middleware, app) => {
   });
 };
 
-export default createPlugin(() => ({
-  // eslint-disable-next-line max-statements
-  async prepareApiServer({
-    pwd,
-    mode,
-    config,
-    prefix
-  }) {
-    let app;
-    const router = new Router();
-    const apiDir = path.join(pwd, './api');
-
-    if (mode === 'framework') {
-      app = await findAppModule(apiDir);
-
-      if (!(app instanceof Koa)) {
+export default (() => ({
+  name: '@modern-js/plugin-koa',
+  pre: ['@modern-js/plugin-bff'],
+  setup: () => ({
+    async prepareApiServer({
+      pwd,
+      mode,
+      config,
+      prefix
+    }) {
+      let app;
+      const router = new Router();
+      const apiDir = path.join(pwd, './api');
+
+      if (mode === 'framework') {
+        app = await findAppModule(apiDir);
+
+        if (!(app instanceof Koa)) {
+          app = new Koa();
+          app.use(koaBody({
+            multipart: true
+          }));
+        }
+
+        if (config) {
+          const {
+            middleware
+          } = config;
+          initMiddlewares(middleware, app);
+        }
+
+        app.use(run);
+        registerRoutes(router, prefix);
+      } else if (mode === 'function') {
         app = new Koa();
-        app.use(koaBody());
-      }
+        app.use(koaBody({
+          multipart: true
+        }));
+
+        if (config) {
+          const {
+            middleware
+          } = config;
+          initMiddlewares(middleware, app);
+        }
 
-      if (config) {
-        const {
-          middleware
-        } = config;
-        initMiddlewares(middleware, app);
+        app.use(run);
+        registerRoutes(router, prefix);
+      } else {
+        throw new Error(`mode must be function or framework`);
       }
 
-      app.use(run);
-      registerRoutes(router, prefix);
-    } else if (mode === 'function') {
-      app = new Koa();
+      app.use(router.routes());
+      return (req, res) => {
+        app.on('error', err => {
+          if (err) {
+            throw err;
+          }
+        });
+        return Promise.resolve(app.callback()(req, res));
+      };
+    },
+
+    prepareWebServer({
+      config
+    }) {
+      const app = new Koa();
+      app.use(async (ctx, next) => {
+        await next();
+
+        if (!ctx.body) {
+          // restore statusCode
+          if (ctx.res.statusCode === 404 && !ctx.response._explicitStatus) {
+            ctx.res.statusCode = 200;
+          }
+
+          ctx.respond = false;
+        }
+      });
       app.use(koaBody());
 
       if (config) {
@@ -68,59 +115,15 @@ export default createPlugin(() => ({
         initMiddlewares(middleware, app);
       }
 
-      app.use(run);
-      registerRoutes(router, prefix);
-    } else {
-      throw new Error(`mode must be function or framework`);
+      return (req, res) => {
+        app.on('error', err => {
+          if (err) {
+            throw err;
+          }
+        });
+        return Promise.resolve(app.callback()(req, res));
+      };
     }
 
-    app.use(router.routes());
-    return (req, res) => {
-      app.on('error', err => {
-        if (err) {
-          throw err;
-        }
-      });
-      return Promise.resolve(app.callback()(req, res));
-    };
-  },
-
-  prepareWebServer({
-    config
-  }) {
-    const app = new Koa();
-    app.use(async (ctx, next) => {
-      await next();
-
-      if (!ctx.body) {
-        // restore statusCode
-        if (ctx.res.statusCode === 404 && !ctx.response._explicitStatus) {
-          ctx.res.statusCode = 200;
-        }
-
-        ctx.respond = false;
-      }
-    });
-    app.use(koaBody());
-
-    if (config) {
-      const {
-        middleware
-      } = config;
-      initMiddlewares(middleware, app);
-    }
-
-    return (req, res) => {
-      app.on('error', err => {
-        if (err) {
-          throw err;
-        }
-      });
-      return Promise.resolve(app.callback()(req, res));
-    };
-  }
-
-}), {
-  name: '@modern-js/plugin-koa',
-  pre: ['@modern-js/plugin-bff']
-});
+  })
+}));

package/dist/js/modern/registerRoutes.js

@@ -1,13 +1,6 @@
-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 { HttpMethod, useAPIHandlerInfos } from '@modern-js/bff-utils';
 import { isSchemaHandler } from '@modern-js/bff-runtime';
 import typeIs from 'type-is';
-import formidable from 'formidable';
 import { sortDynamicRoutes } from '@modern-js/adapter-helpers';
 import { createDebugger } from '@modern-js/utils';
 const debug = createDebugger('koa');
@@ -49,9 +42,7 @@ const registerRoutes = (router, prefix) => {
           ctx.body = result.value;
         }
       } else {
-        const args = Object.values(input.params).concat(input); // eslint-disable-next-line require-atomic-updates
-
-        ctx.type = 'json'; // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        const args = Object.values(input.params).concat(input); // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-expect-error
         // eslint-disable-next-line require-atomic-updates
 
@@ -85,7 +76,7 @@ const getInputFromRequest = async ctx => {
   if (typeIs.is(ctx.request.type, ['application/json'])) {
     draft.data = ctx.request.body;
   } else if (typeIs.is(ctx.request.type, ['multipart/form-data'])) {
-    draft.formData = await resvoleFormData(ctx);
+    draft.formData = ctx.request.files;
   } else if (typeIs.is(ctx.request.type, ['application/x-www-form-urlencoded'])) {
     draft.formUrlencoded = ctx.request.body;
   } else {
@@ -93,19 +84,4 @@ const getInputFromRequest = async ctx => {
   }
 
   return draft;
-};
-
-const resvoleFormData = ctx => {
-  const form = formidable({
-    multiples: true
-  });
-  return new Promise((resolve, reject) => {
-    form.parse(ctx.req, (err, fields, files) => {
-      if (err) {
-        reject(err);
-      }
-
-      resolve(_objectSpread(_objectSpread({}, fields), files));
-    });
-  });
 };

package/dist/js/node/plugin.js

@@ -13,8 +13,6 @@ var _koaRouter = _interopRequireDefault(require("koa-router"));
 
 var _koaBody = _interopRequireDefault(require("koa-body"));
 
-var _serverCore = require("@modern-js/server-core");
-
 var _bffUtils = require("@modern-js/bff-utils");
 
 var _utils = require("@modern-js/utils");
@@ -49,37 +47,85 @@ const initMiddlewares = (middleware, app) => {
   });
 };
 
-var _default = (0, _serverCore.createPlugin)(() => ({
-  // eslint-disable-next-line max-statements
-  async prepareApiServer({
-    pwd,
-    mode,
-    config,
-    prefix
-  }) {
-    let app;
-    const router = new _koaRouter.default();
-    const apiDir = path.join(pwd, './api');
-
-    if (mode === 'framework') {
-      app = await findAppModule(apiDir);
-
-      if (!(app instanceof _koa.default)) {
+var _default = () => ({
+  name: '@modern-js/plugin-koa',
+  pre: ['@modern-js/plugin-bff'],
+  setup: () => ({
+    async prepareApiServer({
+      pwd,
+      mode,
+      config,
+      prefix
+    }) {
+      let app;
+      const router = new _koaRouter.default();
+      const apiDir = path.join(pwd, './api');
+
+      if (mode === 'framework') {
+        app = await findAppModule(apiDir);
+
+        if (!(app instanceof _koa.default)) {
+          app = new _koa.default();
+          app.use((0, _koaBody.default)({
+            multipart: true
+          }));
+        }
+
+        if (config) {
+          const {
+            middleware
+          } = config;
+          initMiddlewares(middleware, app);
+        }
+
+        app.use(_context.run);
+        (0, _registerRoutes.default)(router, prefix);
+      } else if (mode === 'function') {
         app = new _koa.default();
-        app.use((0, _koaBody.default)());
-      }
+        app.use((0, _koaBody.default)({
+          multipart: true
+        }));
+
+        if (config) {
+          const {
+            middleware
+          } = config;
+          initMiddlewares(middleware, app);
+        }
 
-      if (config) {
-        const {
-          middleware
-        } = config;
-        initMiddlewares(middleware, app);
+        app.use(_context.run);
+        (0, _registerRoutes.default)(router, prefix);
+      } else {
+        throw new Error(`mode must be function or framework`);
       }
 
-      app.use(_context.run);
-      (0, _registerRoutes.default)(router, prefix);
-    } else if (mode === 'function') {
-      app = new _koa.default();
+      app.use(router.routes());
+      return (req, res) => {
+        app.on('error', err => {
+          if (err) {
+            throw err;
+          }
+        });
+        return Promise.resolve(app.callback()(req, res));
+      };
+    },
+
+    prepareWebServer({
+      config
+    }) {
+      const app = new _koa.default();
+      app.use(async (ctx, next) => {
+        await next();
+
+        if (!ctx.body) {
+          // restore statusCode
+          if (ctx.res.statusCode === 404 && !ctx.response._explicitStatus) {
+            ctx.res.statusCode = 200;
+          }
+
+          ctx.respond = false;
+        }
+      });
       app.use((0, _koaBody.default)());
 
       if (config) {
@@ -89,61 +135,17 @@ var _default = (0, _serverCore.createPlugin)(() => ({
         initMiddlewares(middleware, app);
       }
 
-      app.use(_context.run);
-      (0, _registerRoutes.default)(router, prefix);
-    } else {
-      throw new Error(`mode must be function or framework`);
+      return (req, res) => {
+        app.on('error', err => {
+          if (err) {
+            throw err;
+          }
+        });
+        return Promise.resolve(app.callback()(req, res));
+      };
     }
 
-    app.use(router.routes());
-    return (req, res) => {
-      app.on('error', err => {
-        if (err) {
-          throw err;
-        }
-      });
-      return Promise.resolve(app.callback()(req, res));
-    };
-  },
-
-  prepareWebServer({
-    config
-  }) {
-    const app = new _koa.default();
-    app.use(async (ctx, next) => {
-      await next();
-
-      if (!ctx.body) {
-        // restore statusCode
-        if (ctx.res.statusCode === 404 && !ctx.response._explicitStatus) {
-          ctx.res.statusCode = 200;
-        }
-
-        ctx.respond = false;
-      }
-    });
-    app.use((0, _koaBody.default)());
-
-    if (config) {
-      const {
-        middleware
-      } = config;
-      initMiddlewares(middleware, app);
-    }
-
-    return (req, res) => {
-      app.on('error', err => {
-        if (err) {
-          throw err;
-        }
-      });
-      return Promise.resolve(app.callback()(req, res));
-    };
-  }
-
-}), {
-  name: '@modern-js/plugin-koa',
-  pre: ['@modern-js/plugin-bff']
+  })
 });
 
 exports.default = _default;

package/dist/js/node/registerRoutes.js

@@ -11,20 +11,12 @@ var _bffRuntime = require("@modern-js/bff-runtime");
 
 var _typeIs = _interopRequireDefault(require("type-is"));
 
-var _formidable = _interopRequireDefault(require("formidable"));
-
 var _adapterHelpers = require("@modern-js/adapter-helpers");
 
 var _utils = require("@modern-js/utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-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; }
-
 const debug = (0, _utils.createDebugger)('koa');
 
 const registerRoutes = (router, prefix) => {
@@ -64,9 +56,7 @@ const registerRoutes = (router, prefix) => {
           ctx.body = result.value;
         }
       } else {
-        const args = Object.values(input.params).concat(input); // eslint-disable-next-line require-atomic-updates
-
-        ctx.type = 'json'; // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        const args = Object.values(input.params).concat(input); // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-expect-error
         // eslint-disable-next-line require-atomic-updates
 
@@ -101,7 +91,7 @@ const getInputFromRequest = async ctx => {
   if (_typeIs.default.is(ctx.request.type, ['application/json'])) {
     draft.data = ctx.request.body;
   } else if (_typeIs.default.is(ctx.request.type, ['multipart/form-data'])) {
-    draft.formData = await resvoleFormData(ctx);
+    draft.formData = ctx.request.files;
   } else if (_typeIs.default.is(ctx.request.type, ['application/x-www-form-urlencoded'])) {
     draft.formUrlencoded = ctx.request.body;
   } else {
@@ -109,19 +99,4 @@ const getInputFromRequest = async ctx => {
   }
 
   return draft;
-};
-
-const resvoleFormData = ctx => {
-  const form = (0, _formidable.default)({
-    multiples: true
-  });
-  return new Promise((resolve, reject) => {
-    form.parse(ctx.req, (err, fields, files) => {
-      if (err) {
-        reject(err);
-      }
-
-      resolve(_objectSpread(_objectSpread({}, fields), files));
-    });
-  });
 };

package/dist/types/plugin.d.ts

@@ -1,5 +1,6 @@
+import type { ServerPlugin } from '@modern-js/server-core';
 export declare type Mode = 'function' | 'framework';
 
-declare const _default: any;
+declare const _default: () => ServerPlugin;
 
 export default _default;

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.4.3",
+  "version": "1.4.4",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -35,30 +35,28 @@
   "dependencies": {
     "@babel/runtime": "^7.15.3",
     "@modern-js/adapter-helpers": "^1.2.1",
-    "@modern-js/utils": "^1.3.5",
-    "formidable": "^1.2.2",
+    "@modern-js/bff-runtime": "^1.2.1",
+    "@modern-js/bff-utils": "^1.2.2",
+    "@modern-js/utils": "^1.3.6",
     "koa-body": "^4.2.0",
     "koa-router": "^10.0.0",
-    "type-is": "^1.6.18",
-    "@modern-js/bff-utils": "^1.2.2",
-    "@modern-js/server-core": "^1.2.3",
-    "@modern-js/bff-runtime": "^1.2.1"
+    "type-is": "^1.6.18"
   },
   "devDependencies": {
-    "koa": "^2.13.3",
-    "@types/formidable": "^1.2.3",
+    "@scripts/build": "0.0.0",
+    "@scripts/jest-config": "0.0.0",
     "@types/jest": "^27.0.1",
     "@types/koa": "^2.13.4",
     "@types/koa-router": "^7.4.4",
     "@types/node": "^14",
     "@types/supertest": "^2.0.11",
     "@types/type-is": "^1.6.3",
-    "supertest": "^6.1.6",
-    "typescript": "^4",
-    "@scripts/build": "0.0.0",
     "jest": "^27",
-    "@scripts/jest-config": "0.0.0",
-    "@modern-js/core": "^1.5.0"
+    "@modern-js/server-core": "^1.2.4",
+    "@modern-js/core": "^1.6.0",
+    "supertest": "^6.1.6",
+    "koa": "^2.13.3",
+    "typescript": "^4"
   },
   "modernConfig": {
     "output": {

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

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

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

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

package/tests/functionMode.test.ts

@@ -50,4 +50,20 @@ describe('function-mode', () => {
     });
     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/lambdaMode.test.ts

@@ -18,6 +18,7 @@ describe('lambda-mode', () => {
   const id = '666';
   const name = 'foo';
   const foo = { id, name };
+  const prefix = '/api';
   let apiHandler: any;
 
   beforeAll(async () => {
@@ -28,36 +29,36 @@ describe('lambda-mode', () => {
     apiHandler = await runner.prepareApiServer({
       pwd,
       mode: 'framework',
-      prefix: '/api',
+      prefix,
     });
   });
 
   test('should works', async () => {
-    const res = await request(apiHandler).get('/api/hello');
+    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(`/api/nest/user?id=${id}`);
+    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('/api/nest/user').send(foo);
+    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(`/api/nest/${id}`);
+    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(`/api/nest/user?id=${id}`)
+      .post(`${prefix}/nest/user?id=${id}`)
       .send(foo);
     expect(res.status).toBe(200);
     expect(res.body.data).toEqual(foo);
@@ -66,7 +67,7 @@ describe('lambda-mode', () => {
 
   test('should support cookies', async () => {
     const res = await request(apiHandler)
-      .post(`/api/nest/user?id=${id}`)
+      .post(`${prefix}/nest/user?id=${id}`)
       .set('Cookie', [`id=${id};name=${name}`]);
     expect(res.status).toBe(200);
     expect(res.body.cookies.id).toBe(id);
@@ -74,19 +75,19 @@ describe('lambda-mode', () => {
   });
 
   test('should works with schema', async () => {
-    const res = await request(apiHandler).patch('/api/nest/user').send({
+    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('/api/nest/user').send({
+    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('/api/nest/user').send({
+    const res3 = await request(apiHandler).patch(`${prefix}/nest/user`).send({
       id: '777',
       name: 'xxx',
     });
@@ -95,11 +96,27 @@ describe('lambda-mode', () => {
 
   test('introspection', async () => {
     const res = await request(apiHandler).get(
-      `/api${INTROSPECTION_ROUTE_PATH}`,
+      `${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', () => {