feat: oauth revamp + support for multiple grant types in oauth (#3885)

Co-authored-by: jamesgeorge007 <jamesgeorge998001@gmail.com>
hoppscotch · Mar 19, 2024 · 6b58915 · 6b58915
1 parent 457857a
commit 6b58915
Show file tree

Hide file tree

Showing 44 changed files with 2,728 additions and 363 deletions.
diff --git a/.../hoppscotch-cli/src/__tests__/samples/collections/collection-level-headers-auth-coll.json b/.../hoppscotch-cli/src/__tests__/samples/collections/collection-level-headers-auth-coll.json
@@ -17,7 +17,7 @@
                 "folders": [],
                 "requests": [
                   {
-                    "v": "2",
+                    "v": "3",
                     "endpoint": "https://echo.hoppscotch.io",
                     "name": "RequestD",
                     "params": [],
@@ -53,7 +53,7 @@
             ],
             "requests": [
               {
-                "v": "2",
+                "v": "3",
                 "endpoint": "https://echo.hoppscotch.io",
                 "name": "RequestC",
                 "params": [],
@@ -90,7 +90,7 @@
         ],
         "requests": [
           {
-            "v": "2",
+            "v": "3",
             "endpoint": "https://echo.hoppscotch.io",
             "name": "RequestB",
             "params": [],
@@ -119,7 +119,7 @@
     ],
     "requests": [
       {
-        "v": "2",
+        "v": "3",
         "endpoint": "https://echo.hoppscotch.io",
         "name": "RequestA",
         "params": [],
@@ -162,7 +162,7 @@
         "folders": [],
         "requests": [
           {
-            "v": "2",
+            "v": "3",
             "endpoint": "https://echo.hoppscotch.io",
             "name": "RequestB",
             "params": [],
@@ -191,7 +191,7 @@
     ],
     "requests": [
       {
-        "v": "2",
+        "v": "3",
         "endpoint": "https://echo.hoppscotch.io",
         "name": "RequestA",
         "params": [],

diff --git a/packages/hoppscotch-cli/src/__tests__/samples/collections/env-flag-tests-coll.json b/packages/hoppscotch-cli/src/__tests__/samples/collections/env-flag-tests-coll.json
@@ -4,7 +4,7 @@
   "folders": [],
   "requests": [
     {
-      "v": "2",
+      "v": "3",
       "endpoint": "<<URL>>",
       "name": "test1",
       "params": [],

diff --git a/packages/hoppscotch-cli/src/__tests__/samples/collections/fails-coll.json b/packages/hoppscotch-cli/src/__tests__/samples/collections/fails-coll.json
@@ -5,40 +5,34 @@
     "folders": [],
     "requests": [
       {
-        "v": "2",
+        "v": "3",
         "endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
         "name": "",
         "params": [],
         "headers": [],
         "method": "GET",
         "auth": {
           "authType": "none",
-          "authActive": true,
-          "addTo": "Headers",
-          "key": "",
-          "value": ""
+          "authActive": true
         },
         "preRequestScript": "pw.env.set(\"HEADERS_TYPE1\", \"devblin_local1\");",
         "testScript": "// Check status code is 200\npwd.test(\"Status code is 200\", ()=> {\n    pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n    pw.expect(pw.response.body.method).toBe(\"GET\");\n    pw.expect(pw.response.body.headers).toBeType(\"string\");\n});",
         "body": {
           "contentType": "application/json",
           "body": "{\n\"test\": \"<<HEADERS_TYPE1>>\"\n}"
         },
-        "requestVariables": [],
+        "requestVariables": []
       },
       {
-        "v": "2",
+        "v": "3",
         "endpoint": "https://echo.hoppscotch.dio/<<HEADERS_TYPE2>>",
         "name": "success",
         "params": [],
         "headers": [],
         "method": "GET",
         "auth": {
           "authType": "none",
-          "authActive": true,
-          "addTo": "Headers",
-          "key": "",
-          "value": ""
+          "authActive": true
         },
         "preRequestScript": "pw.env.setd(\"HEADERS_TYPE2\", \"devblin_local2\");",
         "testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n    pw.expect(pw.response.status).toBe(300);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n    pw.expect(pw.response.body.method).toBe(\"GET\");\n    pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",

diff --git a/packages/hoppscotch-cli/src/__tests__/samples/collections/malformed-coll.json b/packages/hoppscotch-cli/src/__tests__/samples/collections/malformed-coll.json
@@ -4,18 +4,15 @@
 		"folders": [],
 		"requests":
 			{
-				"v": "2",
+				"v": "3",
 				"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
 				"name": "fail",
 				"params": [],
 				"headers": [],
 				"method": "GET",
 				"auth": {
 					"authType": "none",
-					"authActive": true,
-					"addTo": "Headers",
-					"key": "",
-					"value": ""
+					"authActive": true
 				},
 				"preRequestScript": "pw.env.set(\"HEADERS_TYPE1\", \"devblin_local1\");",
 				"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n    pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n    pw.expect(pw.response.body.method).toBe(\"GET\");\n    pw.expect(pw.response.body.headers).toBeType(\"string\");\n});",
@@ -26,18 +23,15 @@
         "requestVariables": [],
 			},
 			{
-				"v": "2",
+				"v": "3",
 				"endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE2>>",
 				"name": "success",
 				"params": [],
 				"headers": [],
 				"method": "GET",
 				"auth": {
 					"authType": "none",
-					"authActive": true,
-					"addTo": "Headers",
-					"key": "",
-					"value": ""
+					"authActive": true
 				},
 				"preRequestScript": "pw.env.set(\"HEADERS_TYPE2\", \"devblin_local2\");",
 				"testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n    pw.expect(pw.response.status).toBe(300);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n    pw.expect(pw.response.body.method).toBe(\"GET\");\n    pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",

diff --git a/packages/hoppscotch-cli/src/__tests__/samples/collections/passes-coll.json b/packages/hoppscotch-cli/src/__tests__/samples/collections/passes-coll.json
@@ -5,18 +5,15 @@
     "folders": [],
     "requests": [
       {
-        "v": "2",
+        "v": "3",
         "endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE1>>",
         "name": "",
         "params": [],
         "headers": [],
         "method": "GET",
         "auth": {
           "authType": "none",
-          "authActive": true,
-          "addTo": "Headers",
-          "key": "",
-          "value": ""
+          "authActive": true
         },
         "preRequestScript": "pw.env.set(\"HEADERS_TYPE1\", \"devblin_local1\");",
         "testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n    pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n    pw.expect(pw.response.body.method).toBe(\"GET\");\n    pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",
@@ -27,18 +24,15 @@
         "requestVariables": []
       },
       {
-        "v": "2",
+        "v": "3",
         "endpoint": "https://echo.hoppscotch.io/<<HEADERS_TYPE2>>",
         "name": "success",
         "params": [],
         "headers": [],
         "method": "GET",
         "auth": {
           "authType": "none",
-          "authActive": true,
-          "addTo": "Headers",
-          "key": "",
-          "value": ""
+          "authActive": true
         },
         "preRequestScript": "pw.env.set(\"HEADERS_TYPE2\", \"devblin_local2\");",
         "testScript": "// Check status code is 200\npw.test(\"Status code is 200\", ()=> {\n    pw.expect(pw.response.status).toBe(200);\n});\n\n// Check JSON response property\npw.test(\"Check JSON response property\", ()=> {\n    pw.expect(pw.response.body.method).toBe(\"GET\");\n    pw.expect(pw.response.body.headers).toBeType(\"object\");\n});",

diff --git a/...scotch-cli/src/__tests__/samples/collections/pre-req-script-env-var-persistence-coll.json b/...scotch-cli/src/__tests__/samples/collections/pre-req-script-env-var-persistence-coll.json
@@ -4,7 +4,7 @@
   "folders": [],
   "requests": [
     {
-      "v": "2",
+      "v": "3",
       "auth": { "authType": "none", "authActive": true },
       "body": { "body": null, "contentType": null },
       "name": "sample-req",

diff --git a/packages/hoppscotch-cli/src/__tests__/samples/collections/req-body-env-vars-coll.json b/packages/hoppscotch-cli/src/__tests__/samples/collections/req-body-env-vars-coll.json
@@ -4,7 +4,7 @@
   "folders": [],
   "requests": [
     {
-      "v": "2",
+      "v": "3",
       "name": "test-request",
       "endpoint": "https://echo.hoppscotch.io",
       "method": "POST",

diff --git a/packages/hoppscotch-cli/src/__tests__/samples/collections/secret-envs-coll.json b/packages/hoppscotch-cli/src/__tests__/samples/collections/secret-envs-coll.json
@@ -4,7 +4,7 @@
   "folders": [],
   "requests": [
     {
-      "v": "2",
+      "v": "3",
       "auth": { "authType": "none", "authActive": true },
       "body": { "body": null, "contentType": null },
       "name": "test-secret-headers",
@@ -23,7 +23,7 @@
       "preRequestScript": "const secretHeaderValueFromPreReqScript = pw.env.get(\"secretHeaderValue\")\npw.env.set(\"secretHeaderValueFromPreReqScript\", secretHeaderValueFromPreReqScript)"
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": { "authType": "none", "authActive": true },
       "body": {
         "body": "{\n  \"secretBodyKey\": \"<<secretBodyValue>>\"\n}",
@@ -39,7 +39,7 @@
       "preRequestScript": "const secretBodyValueFromPreReqScript = pw.env.get(\"secretBodyValue\")\npw.env.set(\"secretBodyValueFromPreReqScript\", secretBodyValueFromPreReqScript)"
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": { "authType": "none", "authActive": true },
       "body": { "body": null, "contentType": null },
       "name": "test-secret-query-params",
@@ -58,7 +58,7 @@
       "preRequestScript": "const secretQueryParamValueFromPreReqScript = pw.env.get(\"secretQueryParamValue\")\npw.env.set(\"secretQueryParamValueFromPreReqScript\", secretQueryParamValueFromPreReqScript)"
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": {
         "authType": "basic",
         "password": "<<secretBasicAuthPassword>>",
@@ -76,7 +76,7 @@
       "preRequestScript": ""
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": {
         "token": "<<secretBearerToken>>",
         "authType": "bearer",
@@ -95,7 +95,7 @@
       "preRequestScript": "const secretBearerToken = pw.env.get(\"secretBearerToken\")\npw.env.set(\"preReqSecretBearerToken\", secretBearerToken)"
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": { "authType": "none", "authActive": true },
       "body": { "body": null, "contentType": null },
       "name": "test-secret-fallback",

diff --git a/packages/hoppscotch-cli/src/__tests__/samples/collections/secret-envs-persistence-coll.json b/packages/hoppscotch-cli/src/__tests__/samples/collections/secret-envs-persistence-coll.json
@@ -4,7 +4,7 @@
   "folders": [],
   "requests": [
     {
-      "v": "2",
+      "v": "3",
       "auth": {
         "authType": "none",
         "authActive": true
@@ -29,7 +29,7 @@
       "preRequestScript": "pw.env.set(\"secretHeaderValue\", \"secret-header-value\")\n\nconst secretHeaderValueFromPreReqScript = pw.env.getResolve(\"secretHeaderValue\")\npw.env.set(\"secretHeaderValueFromPreReqScript\", secretHeaderValueFromPreReqScript)"
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": {
         "authType": "none",
         "authActive": true
@@ -54,7 +54,7 @@
       "preRequestScript": "pw.env.set(\"secretHeaderValue\", \"secret-header-value-overriden\")\n\nconst secretHeaderValueFromPreReqScript = pw.env.getResolve(\"secretHeaderValue\")\npw.env.set(\"secretHeaderValueFromPreReqScript\", secretHeaderValueFromPreReqScript)"
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": {
         "authType": "none",
         "authActive": true
@@ -73,7 +73,7 @@
       "preRequestScript": "const secretBodyValue = pw.env.get(\"secretBodyValue\")\n\nif (!secretBodyValue) { \n  pw.env.set(\"secretBodyValue\", \"secret-body-value\")\n}\n\nconst secretBodyValueFromPreReqScript = pw.env.get(\"secretBodyValue\")\npw.env.set(\"secretBodyValueFromPreReqScript\", secretBodyValueFromPreReqScript)"
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": {
         "authType": "none",
         "authActive": true
@@ -98,7 +98,7 @@
       "preRequestScript": "const secretQueryParamValue = pw.env.get(\"secretQueryParamValue\")\n\nif (!secretQueryParamValue) {\n  pw.env.set(\"secretQueryParamValue\", \"secret-query-param-value\")\n}\n\nconst secretQueryParamValueFromPreReqScript = pw.env.get(\"secretQueryParamValue\")\npw.env.set(\"secretQueryParamValueFromPreReqScript\", secretQueryParamValueFromPreReqScript)"
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": {
         "authType": "basic",
         "password": "<<secretBasicAuthPassword>>",
@@ -119,7 +119,7 @@
       "preRequestScript": "let secretBasicAuthUsername = pw.env.get(\"secretBasicAuthUsername\")\n\nlet secretBasicAuthPassword = pw.env.get(\"secretBasicAuthPassword\")\n\nif (!secretBasicAuthUsername) {\n  pw.env.set(\"secretBasicAuthUsername\", \"test-user\")\n}\n\nif (!secretBasicAuthPassword) {\n  pw.env.set(\"secretBasicAuthPassword\", \"test-pass\")\n}"
     },
     {
-      "v": "2",
+      "v": "3",
       "auth": {
         "token": "<<secretBearerToken>>",
         "authType": "bearer",

diff --git a/...pscotch-cli/src/__tests__/samples/collections/secret-envs-persistence-scripting-coll.json b/...pscotch-cli/src/__tests__/samples/collections/secret-envs-persistence-scripting-coll.json
@@ -4,7 +4,7 @@
   "folders": [],
   "requests": [
     {
-      "v": "2",
+      "v": "3",
       "endpoint": "https://httpbin.org/post",
       "name": "req",
       "params": [],

diff --git a/packages/hoppscotch-cli/src/options/test/env.ts b/packages/hoppscotch-cli/src/options/test/env.ts
@@ -6,7 +6,7 @@ import { error } from "../../types/errors";
 import {
   HoppEnvKeyPairObject,
   HoppEnvPair,
-  HoppEnvs
+  HoppEnvs,
 } from "../../types/request";
 import { readJsonFile } from "../../utils/mutators";
 
@@ -17,7 +17,7 @@ import { readJsonFile } from "../../utils/mutators";
  */
 export async function parseEnvsData(path: string) {
   const contents = await readJsonFile(path);
-  const envPairs: Array<Environment["variables"][number] | HoppEnvPair> = [];
+  const envPairs: Array<HoppEnvPair | Record<string, string>> = [];
 
   // The legacy key-value pair format that is still supported
   const HoppEnvKeyPairResult = HoppEnvKeyPairObject.safeParse(contents);
@@ -26,7 +26,9 @@ export async function parseEnvsData(path: string) {
   const HoppEnvExportObjectResult = Environment.safeParse(contents);
 
   // Shape of the bulk environment export object that is exported from the app
-  const HoppBulkEnvExportObjectResult = z.array(entityReference(Environment)).safeParse(contents)
+  const HoppBulkEnvExportObjectResult = z
+    .array(entityReference(Environment))
+    .safeParse(contents);
 
   // CLI doesnt support bulk environments export
   // Hence we check for this case and throw an error if it matches the format
@@ -36,7 +38,10 @@ export async function parseEnvsData(path: string) {
 
   //  Checks if the environment file is of the correct format
   // If it doesnt match either of them, we throw an error
-  if (!HoppEnvKeyPairResult.success && HoppEnvExportObjectResult.type === "err") {
+  if (
+    !HoppEnvKeyPairResult.success &&
+    HoppEnvExportObjectResult.type === "err"
+  ) {
     throw error({ code: "MALFORMED_ENV_FILE", path, data: error });
   }