@adaptivestone/framework 4.2.0 → 4.3.1

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 4.3.1
+
+[UPDATE] Yup file validator update. As formidable now return all fields as an array
+
+### 4.3.0
+
+[BREAKING] updated formidable with a new version + tests. Marked as breaking because of a new major version, but this is internal of framework and exernal still the same. Should break nothing
+
 ### 4.2.0
 
 [UPDATE] updated deps

package/helpers/yup.js

@@ -13,7 +13,8 @@ class YupFile extends Schema {
   constructor() {
     super({
       type: 'file',
-      check: (value) => value instanceof formidable.PersistentFile,
+      check: (value) =>
+        value.every((item) => item instanceof formidable.PersistentFile),
     });
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "4.2.0",
+  "version": "4.3.1",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "engines": {
@@ -43,7 +43,7 @@
     "deepmerge": "^4.2.2",
     "dotenv": "^16.0.0",
     "express": "^4.17.1",
-    "formidable": "^2.1.1",
+    "formidable": "^3.5.1",
     "html-to-text": "^9.0.3",
     "i18next": "^23.2.8",
     "i18next-chained-backend": "^4.0.0",

package/services/http/middleware/RequestParser.js

@@ -1,4 +1,4 @@
-const formidable = require('formidable');
+const formidable = require('formidable').default;
 
 const AbstractMiddleware = require('./AbstractMiddleware');
 
@@ -13,23 +13,25 @@ class RequestParser extends AbstractMiddleware {
     // TODO update this to https://github.com/node-formidable/formidable/issues/412#issuecomment-1367914268 in node v20 (in 2023?)
 
     const form = formidable(this.params); // not in construstor as reuse formidable affects performance
-    form.parse(req, (err, fields, files) => {
-      this.logger.verbose(
-        `Parsing multipart/formdata request DONE ${Date.now() - time}ms`,
-      );
-      if (err) {
-        this.logger.error(`Parsing failed ${err}`);
-        return next(err);
-      }
+    let fields;
+    let files;
+    try {
+      [fields, files] = await form.parse(req);
+    } catch (err) {
+      this.logger.error(`Parsing failed ${err}`);
+      return next(err);
+    }
+    this.logger.verbose(
+      `Parsing multipart/formdata request DONE ${Date.now() - time}ms`,
+    );
 
-      req.body = {
-        // todo avoid body in next versions
-        ...req.body,
-        ...fields,
-        ...files,
-      };
-      return next();
-    });
+    req.body = {
+      // todo avoid body in next versions
+      ...req.body,
+      ...fields,
+      ...files,
+    };
+    return next();
   }
 }
 

package/services/http/middleware/RequestParser.test.js

@@ -0,0 +1,111 @@
+const { createServer } = require('node:http');
+const formidable = require('formidable');
+
+const RequestParser = require('./RequestParser');
+
+describe('reqest parser limiter methods', () => {
+  it('have description fields', async () => {
+    expect.assertions(1);
+    const middleware = new RequestParser(global.server.app);
+    expect(middleware.constructor.description).toBeDefined();
+  });
+  it('middleware that works', async () => {
+    expect.assertions(4);
+
+    await new Promise((done) => {
+      // from https://github.com/node-formidable/formidable/blob/master/test-node/standalone/promise.test.js
+
+      const server = createServer(async (req, res) => {
+        req.appInfo = {};
+        const middleware = new RequestParser(global.server.app);
+        middleware.middleware(req, {}, (err) => {
+          expect(err).toBeUndefined();
+          expect(req.body.title).toBeDefined();
+          expect(req.body.multipleFiles).toBeDefined();
+          expect(
+            req.body.multipleFiles[0] instanceof formidable.PersistentFile,
+          ).toBe(true);
+
+          res.writeHead(200);
+          res.end('ok');
+        });
+      });
+      server.listen(null, async () => {
+        const chosenPort = server.address().port;
+        const body = `----13068458571765726332503797717\r
+Content-Disposition: form-data; name="title"\r
+\r
+a\r
+----13068458571765726332503797717\r
+Content-Disposition: form-data; name="multipleFiles"; filename="x.txt"\r
+Content-Type: application/x-javascript\r
+\r
+\r
+\r
+a\r
+b\r
+c\r
+d\r
+\r
+----13068458571765726332503797717--\r
+`;
+        await fetch(String(new URL(`http:localhost:${chosenPort}/`)), {
+          method: 'POST',
+
+          headers: {
+            'Content-Length': body.length,
+            Host: `localhost:${chosenPort}`,
+            'Content-Type':
+              'multipart/form-data; boundary=--13068458571765726332503797717',
+          },
+          body,
+        }).catch((err) => {
+          console.error(err);
+          done(err);
+        });
+        server.close(() => {
+          done();
+        });
+      });
+    });
+  });
+  it('middleware with a problem', async () => {
+    expect.assertions(1);
+
+    await new Promise((done) => {
+      // from https://github.com/node-formidable/formidable/blob/master/test-node/standalone/promise.test.js
+
+      const server = createServer(async (req, res) => {
+        req.appInfo = {};
+        const middleware = new RequestParser(global.server.app);
+        middleware.middleware(req, {}, (err) => {
+          expect(err).toBeDefined();
+
+          res.writeHead(200);
+          res.end('ok');
+        });
+      });
+      server.listen(null, async () => {
+        const chosenPort = server.address().port;
+        const body = 'someBadBody';
+
+        await fetch(String(new URL(`http:localhost:${chosenPort}/`)), {
+          method: 'POST',
+
+          headers: {
+            'Content-Length': body.length,
+            Host: `localhost:${chosenPort}`,
+            'Content-Type': 'badContentType',
+          },
+          body,
+        }).catch((err) => {
+          console.error(err);
+          done(err);
+        });
+        server.close(() => {
+          done();
+        });
+      });
+    });
+  });
+});