@tryghost/webhook-mock-receiver 0.1.2 → 0.2.1

package/README.md

@@ -1,11 +1,6 @@
 # Webhook Mock Receiver
 
-Webhook request testing.
-
-It's a bare minimum implementation to be able to check webhook request payload. Few things that need to be done in the future:
-- cleaner module API
-- header snapshot recording/testing
-- better request resolution waiting mechanism (see @TODO list)
+Up to date documentation about the usage of the module available in [End-to-end Testing Codex](https://ghost.notion.site/End-to-end-Testing-6a2ef073b1754b18aff42e24a632a007#827471b6314640758460b9c1e22b34c4).
 
 ## Install
 

package/lib/webhook-mock-receiver.js

@@ -1,22 +1,25 @@
 const {AssertionError} = require('assert');
-const util = require('util');
 const {URL} = require('url');
 const nock = require('nock');
-const setTimeoutPromise = util.promisify(setTimeout);
+const pWaitFor = require('p-wait-for');
 
 class WebhookMockReceiver {
     constructor({snapshotManager}) {
-        this.bodyResponse;
-        this.receiver;
+        this.body;
+        this.headers;
+        this._receiver;
         this.snapshotManager = snapshotManager;
-        this.recordBodyResponse = this.recordBodyResponse.bind(this);
+        this.recordRequest = this.recordRequest.bind(this);
     }
 
-    recordBodyResponse(body) {
-        this.bodyResponse = {body};
+    recordRequest(body, options) {
+        this.body = {body};
+        this.headers = {headers: options.headers};
+    }
 
-        // let the nock continue with the response
-        return true;
+    async receivedRequest() {
+        // @NOTE: figure out a better waiting mechanism here, don't allow it to hang forever
+        await pWaitFor(() => this._receiver.isDone());
     }
 
     /**
@@ -26,9 +29,14 @@ class WebhookMockReceiver {
      */
     mock(url) {
         const parsedURL = new URL(url);
+        const recordRequest = this.recordRequest;
 
-        this.receiver = nock(parsedURL.origin)
-            .post(parsedURL.pathname, this.recordBodyResponse)
+        this._receiver = nock(parsedURL.origin)
+            .post(parsedURL.pathname, function (body) {
+                recordRequest(body, this);
+                // let the nock continue with the response
+                return true;
+            })
             .reply(200, {status: 'OK'});
 
         return this;
@@ -36,16 +44,12 @@ class WebhookMockReceiver {
 
     reset() {
         nock.cleanAll();
-        this.receiver = undefined;
-        this.bodyResponse = undefined;
+        this._receiver = undefined;
+        this.body = undefined;
+        this.headers = undefined;
     }
 
-    async matchBodySnapshot(properties = {}) {
-        // @TODO: figure out a better waiting mechanism here, don't allow it to hang forever
-        while (!this.receiver.isDone()) {
-            await setTimeoutPromise(10);
-        }
-
+    matchBodySnapshot(properties = {}) {
         const error = new AssertionError({});
         let assertion = {
             properties: properties,
@@ -54,7 +58,23 @@ class WebhookMockReceiver {
             error
         };
 
-        this.snapshotManager.assertSnapshot(this.bodyResponse, assertion);
+        this.snapshotManager.assertSnapshot(this.body, assertion);
+
+        return this;
+    }
+
+    matchHeaderSnapshot(properties = {}) {
+        const error = new AssertionError({});
+        let assertion = {
+            properties: properties,
+            field: 'headers',
+            type: 'header',
+            error
+        };
+
+        this.snapshotManager.assertSnapshot(this.headers, assertion);
+        
+        return this;
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/webhook-mock-receiver",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/webhook-mock-receiver",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -24,7 +24,10 @@
     "c8": "7.12.0",
     "got": "9.6.0",
     "mocha": "10.0.0",
-    "sinon": "14.0.0"
+    "sinon": "14.0.1"
   },
-  "gitHead": "cc9195ea06015d9711ed1fa65267ff85c19edb05"
+  "dependencies": {
+    "p-wait-for": "3.2.0"
+  },
+  "gitHead": "73748c86fd0a1416792974234dfe88e3f5a62f25"
 }