fix: support await tests and add auto-complete .test and .expect

Kong · Feb 25, 2025 · 69fa119 · 69fa119
1 parent 28816ed
commit 69fa119
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 13 deletions.
diff --git a/packages/insomnia-sdk/src/objects/insomnia.ts b/packages/insomnia-sdk/src/objects/insomnia.ts
@@ -82,6 +82,22 @@ export class InsomniaObject {
 
         this.requestTestResults = new Array<RequestTestResult>();
         this.parentFolders = rawObj.parentFolders;
+
+        return new Proxy(this, {
+            get: (target, prop, receiver) => {
+                if (prop === 'test') {
+                    const testHandler: TestHandler = async (msg: string, fn: () => Promise<void>) => {
+                        await this._test(msg, fn, this.pushRequestTestResult);
+                    };
+                    testHandler.skip = async (msg: string, fn: () => Promise<void>) => {
+                        await this._skip(msg, fn, this.pushRequestTestResult);
+                    };
+
+                    return testHandler;
+                }
+                return Reflect.get(target, prop, receiver);
+            },
+        });
     }
 
     sendRequest(
@@ -91,24 +107,17 @@ export class InsomniaObject {
         return sendRequest(request, cb, this._settings);
     }
 
-    get test() {
-        const testHandler: TestHandler = async (msg: string, fn: () => Promise<void>) => {
-            await this._test(msg, fn, this.pushRequestTestResult);
-        };
-        testHandler.skip = async (msg: string, fn: () => Promise<void>) => {
-            await this._skip(msg, fn, this.pushRequestTestResult);
-        };
-
-        return testHandler;
-    }
+    test = () => {
+        // this method is intercepted by the proxy above
+    };
 
     private pushRequestTestResult = (testResult: RequestTestResult) => {
         this.requestTestResults = [...this.requestTestResults, testResult];
     };
 
-    expect(exp: boolean | number | string | object) {
+    expect = (exp: boolean | number | string | object) => {
         return this._expect(exp);
-    }
+    };
 
     get settings() {
         return undefined;

diff --git a/packages/insomnia-sdk/src/objects/test.ts b/packages/insomnia-sdk/src/objects/test.ts
@@ -28,7 +28,9 @@ export async function test(
         }
     };
 
-    startTestObserver(wrapFn());
+    const testPromise = wrapFn();
+    startTestObserver(testPromise);
+    return testPromise;
 }
 
 let testPromises = new Array<Promise<void>>();

diff --git a/packages/insomnia-smoke-test/fixtures/runner-collection.yaml b/packages/insomnia-smoke-test/fixtures/runner-collection.yaml
@@ -95,6 +95,40 @@ collection:
         send: true
         store: true
       rebuildPath: true
+  - url: http://127.0.0.1:4010/echo
+    name: await-test
+    meta:
+      id: req_823443a369a74ac48cb9baa27ed8245c
+      created: 1636141014550
+      modified: 1636707449230
+      isPrivate: false
+      sortKey: -1636141014552
+    method: POST
+    scripts:
+      afterResponse: |-
+        await insomnia.test('t1', async () => {
+          await new Promise((resolve) => setTimeout(resolve, 50));
+          insomnia.expect(201).to.eql(200);
+        });
+
+        async function myTest() {
+          await insomnia.test('t2', () => {
+            insomnia.expect(201).to.eql(200);
+          });
+        }
+        await myTest();
+
+        insomnia.test('t3', () => {
+          insomnia.expect(201).to.eql(200);
+        });
+    settings:
+      renderRequestBody: true
+      encodeUrl: true
+      followRedirects: global
+      cookies:
+        send: true
+        store: true
+      rebuildPath: true
   - url: http://127.0.0.1:4010/echo
     name: req01
     meta:

diff --git a/packages/insomnia-smoke-test/tests/smoke/runner.test.ts b/packages/insomnia-smoke-test/tests/smoke/runner.test.ts
@@ -165,6 +165,26 @@ test.describe('runner features tests', async () => {
         await verifyResultRows(page, 3, 0, 3, expectedTestOrder, 1);
     });
 
+    test('await test works', async ({ page }) => {
+        await page.getByTestId('run-collection-btn-quick').click();
+
+        await page.locator('.runner-request-list-await-test').click();
+
+        // send
+        await page.getByRole('button', { name: 'Run', exact: true }).click();
+
+        // check result
+        await page.getByText('0 / 3').first().click();
+
+        const expectedTestOrder = [
+            't1',
+            't2',
+            't3',
+        ];
+
+        await verifyResultRows(page, 0, 0, 3, expectedTestOrder, 1);
+    });
+
     test('run req5 3 times with setNextRequest in the after-response script', async ({ page }) => {
         await page.getByTestId('run-collection-btn-quick').click();