@tryghost/express-test 0.9.0 → 0.11.0

package/index.js

@@ -4,6 +4,7 @@ module.exports = require('./lib/agent');
 //       version missmatching on the client side
 module.exports.snapshot = {
     mochaHooks: require('@tryghost/jest-snapshot').mochaHooks,
+    snapshotManager: require('@tryghost/jest-snapshot').snapshotManager,
     any: require('@tryghost/jest-snapshot').any,
     stringMatching: require('@tryghost/jest-snapshot').stringMatching
 };

package/lib/agent.js

@@ -3,36 +3,53 @@ const ExpectRequest = require('./expect-request');
 const {RequestOptions} = require('./request');
 const {normalizeURL} = require('./utils');
 
+/**
+ * @typedef AgentOptions
+ * @param {string} [baseUrl] - the base URL path for the API query
+ * @param {Object} [queryParams] - custom query params to append to each request
+ * @param {Object} [headers] - any default headers to append to each request
+ * @param {Object} [body] - a default body to append to each request
+ * */
+
 class Agent {
     /**
      *
      * @param {Object} app instance of Express app
-     * @param {Object} [defaults]
-     * @param {string} [defaults.baseUrl]
-     * @param {Object} [defaults.headers]
-     * @param {Object} [defaults.queryParams] - custom query params to append to each request
+     * @param {AgentOptions} [defaults]
      */
-    constructor(app, defaults = {}) {
+    constructor(app, defaults = {}, snapshotManager) {
         this.app = app;
         this.defaults = defaults;
 
         this.jar = new CookieJar();
+        this.snapshotManager = snapshotManager;
     }
 
-    _makeUrl(url) {
+    /**
+     *
+     * @param {String} url
+     * @param {object} [urlOptions]
+     * @param {string} [urlOptions.baseUrl] - the base URL path for the API query
+     * @param {Object} [urlOptions.queryParams] - custom query params to append to each request
+     * @returns
+     */
+    _makeUrl(url, urlOptions = {}) {
         let processedURL = url;
+        const baseUrl = urlOptions.baseUrl || this.defaults.baseUrl || null;
 
-        if (this.defaults.baseUrl) {
-            processedURL = `/${this.defaults.baseUrl}/${processedURL}`.replace(/(^|[^:])\/\/+/g, '$1/');
+        if (baseUrl) {
+            processedURL = `/${baseUrl}/${processedURL}`.replace(/(^|[^:])\/\/+/g, '$1/');
         }
 
         processedURL = normalizeURL(processedURL);
 
-        if (this.defaults.queryParams) {
+        const queryParams = Object.assign({}, this.defaults.queryParams, urlOptions.queryParams);
+
+        if (Object.keys(queryParams).length > 0) {
             const searchParams = new URLSearchParams();
 
-            for (const key in this.defaults.queryParams) {
-                searchParams.append(key, this.defaults.queryParams[key]);
+            for (const key in queryParams) {
+                searchParams.append(key, queryParams[key]);
             }
 
             if (processedURL.includes('?')) {
@@ -45,6 +62,13 @@ class Agent {
         return processedURL;
     }
 
+    /**
+     *
+     * @param {string}} method - HTTP method
+     * @param {string} url - url to request
+     * @param {AgentOptions} options
+     * @returns
+     */
     _mergeOptions(method, url, options = {}) {
         // It doesn't make sense to call this method without these properties
         if (!method) {
@@ -55,9 +79,12 @@ class Agent {
             throw new Error('_mergeOptions cannot be called without a url'); /* eslint-disable-line no-restricted-syntax */
         }
 
+        // urlOptions
+        const {baseUrl, queryParams} = options;
+
         return new RequestOptions({
             method,
-            url: this._makeUrl(url),
+            url: this._makeUrl(url, Object.assign({}, {baseUrl, queryParams})),
             headers: Object.assign({}, this.defaults.headers, options.headers),
             // Set this to an empty object for ease, as express.json will do this anyway
             body: Object.assign({}, this.defaults.body, options.body)
@@ -70,7 +97,7 @@ class Agent {
         if (!url) {
             throw new Error('Cannot make a request without supplying a url'); /* eslint-disable-line no-restricted-syntax */
         }
-        return new ExpectRequest(this.app, this.jar, this._mergeOptions(method.toUpperCase(), url, options));
+        return new ExpectRequest(this.app, this.jar, this._mergeOptions(method.toUpperCase(), url, options), this.snapshotManager);
     };
 });
 

package/lib/expect-request.js

@@ -1,7 +1,6 @@
 const assert = require('assert');
 const {Request, RequestOptions} = require('./request');
 const {snapshotManager} = require('@tryghost/jest-snapshot');
-const {makeMessageFromMatchMessage} = require('./utils');
 
 /**
  * @typedef {object} ExpressTestAssertion
@@ -17,13 +16,16 @@ const {makeMessageFromMatchMessage} = require('./utils');
  */
 
 class ExpectRequest extends Request {
-    constructor(...args) {
-        super(...args);
+    constructor(app, cookieJar, reqOptions, _snapshotManager) {
+        super(app, cookieJar, reqOptions);
 
         /**
          * @property {ExpressTestAssertion[]} assertions
          */
         this.assertions = [];
+
+        this.snapshotManager = _snapshotManager ?? snapshotManager;
+        this._assertSnapshot = this._assertSnapshot.bind(this);
     }
 
     expect(callback) {
@@ -244,37 +246,7 @@ class ExpectRequest extends Request {
     }
 
     _assertSnapshot(response, assertion) {
-        const {properties, field, error} = assertion;
-
-        if (!response[field]) {
-            error.message = `Unable to match snapshot on undefined field ${field} ${error.contextString}`;
-            error.expected = field;
-            error.actual = 'undefined';
-            assert.notEqual(response[field], undefined, error);
-        }
-
-        const hint = `[${field}]`;
-        const match = snapshotManager.match(response[field], properties, hint);
-
-        Object.keys(properties).forEach((prop) => {
-            const errorMessage = `"response.${field}" is missing the expected property "${prop}"`;
-            error.message = makeMessageFromMatchMessage(match.message(), errorMessage);
-            error.expected = prop;
-            error.actual = 'undefined';
-            error.showDiff = false; // Disable mocha's diff output as it's already present in match.message()
-
-            assert.notEqual(response[field][prop], undefined, error);
-        });
-
-        if (match.pass !== true) {
-            const errorMessage = `"response.${field}" does not match snapshot.`;
-            error.message = makeMessageFromMatchMessage(match.message(), errorMessage);
-            error.expected = match.expected;
-            error.actual = match.actual;
-            error.showDiff = false; // Disable mocha's diff output as it's already present in match.message()
-        }
-
-        assert.equal(match.pass, true, error);
+        this.snapshotManager.assertSnapshot(response, assertion);
     }
 }
 

package/lib/utils.js

@@ -1,17 +1,9 @@
-// const url = require('url');
-
 module.exports.isJSON = function isJSON(mime) {
     // should match /json or +json
     // but not /json-seq
     return /[/+]json($|[^-\w])/i.test(mime);
 };
 
-module.exports.makeMessageFromMatchMessage = function makeMessageFromMatchMessage(message, errorMessage) {
-    const messageLines = message.split('\n');
-    messageLines.splice(0, 1, errorMessage);
-    return messageLines.join('\n');
-};
-
 module.exports.normalizeURL = function normalizeURL(toNormalize) {
     const split = toNormalize.split('?');
     const pathname = split[0];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/express-test",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/express-test",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -19,16 +19,16 @@
     "access": "public"
   },
   "devDependencies": {
-    "c8": "7.11.0",
-    "express": "4.17.3",
+    "c8": "7.11.3",
+    "express": "4.18.0",
     "express-session": "1.17.2",
-    "mocha": "9.2.2",
-    "sinon": "13.0.2"
+    "mocha": "10.0.0",
+    "sinon": "14.0.0"
   },
   "dependencies": {
-    "@tryghost/jest-snapshot": "^0.3.12",
+    "@tryghost/jest-snapshot": "^0.4.0",
     "cookiejar": "^2.1.3",
     "reqresnext": "^1.7.0"
   },
-  "gitHead": "9799b440419e56125eabc4ddd34290d3f40733f9"
+  "gitHead": "0af921ce800c79f89685307914bd6d704302c043"
 }