feat(native fetch): Implement Node.js fetch (#1243)

* generalize http request params from nodejs type * complete fetch * reduce complexity * change flag to --use-node-fetch * change flag to --native-fetch * clean up doc
hyperjumptech · Mar 7, 2024 · ca5c3ac · ca5c3ac
1 parent a069bae
commit ca5c3ac
Show file tree

Hide file tree

Showing 11 changed files with 270 additions and 177 deletions.
diff --git a/docs/src/pages/guides/cli-options.md b/docs/src/pages/guides/cli-options.md
@@ -283,12 +283,12 @@ You can also set the maximum of delay by using the `--retryMaxDelayMs` flag. Def
 monika --retryMaxDelayMs 30000
 ```
 
-## Experimental Native Node Fetch
+## Native Fetch from Node.js
 
-Monika use Axios as HTTP client by default, use `--experimental-fetch` to switch to native fetch provided by Node.js runtime.
+Monika use Axios as HTTP client by default, use `--native-fetch` to switch to native fetch provided by Node.js runtime.
 
 ```sh
-monika --experimental-fetch
+monika --native-fetch
 ```
 
 ## Follow Redirects

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -105,6 +105,7 @@
     "sqlite3": "^5.0.2",
     "ssl-checker": "2.0.7",
     "stun": "^2.1.0",
+    "undici": "^6.6.2",
     "unzipper": "^0.10.11",
     "url-parse": "^1.5.10",
     "uuid": "9.0.1",

diff --git a/src/commands/monika.ts b/src/commands/monika.ts
@@ -105,8 +105,8 @@ export default class Monika extends Command {
         'Create config from HAR (-H), postman (-p), insomnia (-I), sitemap (--sitemap), textfile (--text) export file, or open Monika Configuration Generator using default browser',
     }),
 
-    'experimental-fetch': Flags.boolean({
-      default: monikaFlagsDefaultValue['experimental-fetch'],
+    'native-fetch': Flags.boolean({
+      default: monikaFlagsDefaultValue['native-fetch'],
       description:
         'Use native fetch Node.js API instead of Axios for HTTP client',
     }),

diff --git a/src/components/config/__tests__/parse-postman.test.ts b/src/components/config/__tests__/parse-postman.test.ts
@@ -81,29 +81,24 @@ describe('parseConfigFromPostman', () => {
             expect(req.body).to.deep.equals({ message: 'Hello, world!' })
           }
 
-          if (mode === 'formdata') {
-            expect((req.headers || {})['Content-Type']).to.equals(
-              'multipart/form-data'
-            )
+          const headers = req.headers || {}
+          if (mode === 'formdata' && 'Content-Type' in headers) {
+            expect(headers['Content-Type']).to.equals('multipart/form-data')
           }
 
-          if (mode === 'urlencoded') {
-            expect((req.headers || {})['Content-Type']).to.equals(
+          if (mode === 'urlencoded' && 'Content-Type' in headers) {
+            expect(headers['Content-Type']).to.equals(
               'application/x-www-form-urlencoded'
             )
           }
 
           if (mode === 'raw') {
-            if (language === 'json') {
-              expect((req.headers || {})['Content-Type']).to.equals(
-                'application/json'
-              )
+            if (language === 'json' && 'Content-Type' in headers) {
+              expect(headers['Content-Type']).to.equals('application/json')
             }
 
-            if (language === 'text') {
-              expect((req.headers || {})['Content-Type']).to.equals(
-                'text/plain'
-              )
+            if (language === 'text' && 'Content-Type' in headers) {
+              expect(headers['Content-Type']).to.equals('text/plain')
             }
           }
         }
@@ -134,29 +129,24 @@ describe('parseConfigFromPostman', () => {
             expect(req.body).to.deep.equals({ message: 'Hello, world!' })
           }
 
-          if (mode === 'formdata') {
-            expect((req.headers || {})['Content-Type']).to.equals(
-              'multipart/form-data'
-            )
+          const headers = req.headers || {}
+          if (mode === 'formdata' && 'Content-Type' in headers) {
+            expect(headers['Content-Type']).to.equals('multipart/form-data')
           }
 
-          if (mode === 'urlencoded') {
-            expect((req.headers || {})['Content-Type']).to.equals(
+          if (mode === 'urlencoded' && 'Content-Type' in headers) {
+            expect(headers['Content-Type']).to.equals(
               'application/x-www-form-urlencoded'
             )
           }
 
           if (mode === 'raw') {
-            if (language === 'json') {
-              expect((req.headers || {})['Content-Type']).to.equals(
-                'application/json'
-              )
+            if (language === 'json' && 'Content-Type' in headers) {
+              expect(headers['Content-Type']).to.equals('application/json')
             }
 
-            if (language === 'text') {
-              expect((req.headers || {})['Content-Type']).to.equals(
-                'text/plain'
-              )
+            if (language === 'text' && 'Content-Type' in headers) {
+              expect(headers['Content-Type']).to.equals('text/plain')
             }
           }
         }
@@ -192,29 +182,24 @@ describe('parseConfigFromPostman', () => {
             expect(req.body).to.deep.equals({ message: 'Hello, world!' })
           }
 
-          if (mode === 'formdata') {
-            expect((req.headers || {})['Content-Type']).to.equals(
-              'multipart/form-data'
-            )
+          const headers = req.headers || {}
+          if (mode === 'formdata' && 'Content-Type' in headers) {
+            expect(headers['Content-Type']).to.equals('multipart/form-data')
           }
 
-          if (mode === 'urlencoded') {
-            expect((req.headers || {})['Content-Type']).to.equals(
+          if (mode === 'urlencoded' && 'Content-Type' in headers) {
+            expect(headers['Content-Type']).to.equals(
               'application/x-www-form-urlencoded'
             )
           }
 
           if (mode === 'raw') {
-            if (language === 'json') {
-              expect((req.headers || {})['Content-Type']).to.equals(
-                'application/json'
-              )
+            if (language === 'json' && 'Content-Type' in headers) {
+              expect(headers['Content-Type']).to.equals('application/json')
             }
 
-            if (language === 'text') {
-              expect((req.headers || {})['Content-Type']).to.equals(
-                'text/plain'
-              )
+            if (language === 'text' && 'Content-Type' in headers) {
+              expect(headers['Content-Type']).to.equals('text/plain')
             }
           }
         }
@@ -248,29 +233,24 @@ describe('parseConfigFromPostman', () => {
             expect(req.body).to.deep.equals({ message: 'Hello, world!' })
           }
 
-          if (mode === 'formdata') {
-            expect((req.headers || {})['Content-Type']).to.equals(
-              'multipart/form-data'
-            )
+          const headers = req.headers || {}
+          if (mode === 'formdata' && 'Content-Type' in headers) {
+            expect(headers['Content-Type']).to.equals('multipart/form-data')
           }
 
-          if (mode === 'urlencoded') {
-            expect((req.headers || {})['Content-Type']).to.equals(
+          if (mode === 'urlencoded' && 'Content-Type' in headers) {
+            expect(headers['Content-Type']).to.equals(
               'application/x-www-form-urlencoded'
             )
           }
 
           if (mode === 'raw') {
-            if (language === 'json') {
-              expect((req.headers || {})['Content-Type']).to.equals(
-                'application/json'
-              )
+            if (language === 'json' && 'Content-Type' in headers) {
+              expect(headers['Content-Type']).to.equals('application/json')
             }
 
-            if (language === 'text') {
-              expect((req.headers || {})['Content-Type']).to.equals(
-                'text/plain'
-              )
+            if (language === 'text' && 'Content-Type' in headers) {
+              expect(headers['Content-Type']).to.equals('text/plain')
             }
           }
         }

diff --git a/src/components/logger/startup-message.test.ts b/src/components/logger/startup-message.test.ts
@@ -426,16 +426,18 @@ describe('Startup message', () => {
       // assert
       expect(logMessage).include('config file')
     })
+  })
 
-    // delete test on removing toggle
+  // delete tests on removing toggle
+  describe('Node fetch toggle', () => {
     it('should show experimental fetch toggle', () => {
       // act
       logStartupMessage({
         config: defaultConfig,
         flags: {
           config: ['./monika.yaml'],
           verbose: false,
-          'experimental-fetch': true,
+          'native-fetch': true,
         },
         isFirstRun: false,
       })
@@ -444,15 +446,14 @@ describe('Startup message', () => {
       expect(logMessage).include('Using native Node.js fetch for HTTP client')
     })
 
-    // delete test on removing toggle
     it('should hide experimental fetch toggle', () => {
       // act
       logStartupMessage({
         config: defaultConfig,
         flags: {
           config: ['./monika.yaml'],
           verbose: false,
-          'experimental-fetch': false,
+          'native-fetch': false,
         },
         isFirstRun: false,
       })

diff --git a/src/components/logger/startup-message.ts b/src/components/logger/startup-message.ts
@@ -39,7 +39,7 @@ type LogStartupMessage = {
   config: Config
   flags: Pick<
     MonikaFlags,
-    'config' | 'symonKey' | 'symonUrl' | 'verbose' | 'experimental-fetch'
+    'config' | 'symonKey' | 'symonUrl' | 'verbose' | 'native-fetch'
   >
   isFirstRun: boolean
 }
@@ -62,7 +62,7 @@ export function logStartupMessage({
     }
   }
 
-  if (flags['experimental-fetch']) {
+  if (flags['native-fetch']) {
     log.info('Using native Node.js fetch for HTTP client')
   }