@tryghost/express-test 0.5.0 → 0.6.2

package/README.md

@@ -40,6 +40,16 @@ return await agent
 This is an initial version for review. More docs coming if it works :)
 
 
+### Assertion execution order
+The order of *chained* assertion execution is NOT the order they were declared in. The framework follows the priority order of the assertion types:
+1. `expect`
+2. `expectHeader`
+3. `expectStatus`
+
+Meaning, any `expect` declarations would be asserted first following by `expectHeader` and `expectStatus` declarations.
+
+The custom order is here to prioritize assertions with the most context first. The feature was added based on frustrations with frameworks like [superagent](https://github.com/visionmedia/superagent), which didn't provide enough information when the status code assertions failed.
+
 ## Develop
 
 This is a mono repository, managed with [lerna](https://lernajs.io/).

package/index.js

@@ -1 +1,9 @@
 module.exports = require('./lib/agent');
+
+// NOTE: exposing jest-snapshot as a part of express-test to avoid
+//       version missmatching on the client side
+module.exports.snapshot = {
+    mochaHooks: require('@tryghost/jest-snapshot').mochaHooks,
+    any: require('@tryghost/jest-snapshot').any,
+    stringMatching: require('@tryghost/jest-snapshot').stringMatching
+};

package/lib/agent.js

@@ -3,6 +3,14 @@ const ExpectRequest = require('./expect-request');
 const {RequestOptions} = require('./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
+     */
     constructor(app, defaults = {}) {
         this.app = app;
         this.defaults = defaults;
@@ -15,6 +23,20 @@ class Agent {
             url = `/${this.defaults.baseUrl}/${url}`.replace(/(^|[^:])\/\/+/g, '$1/');
         }
 
+        if (this.defaults.queryParams) {
+            const searchParams = new URLSearchParams();
+
+            for (const key in this.defaults.queryParams) {
+                searchParams.append(key, this.defaults.queryParams[key]);
+            }
+
+            if (url.includes('?')) {
+                url = `${url}&${searchParams.toString()}`;
+            } else {
+                url = `${url}?${searchParams.toString()}`;
+            }
+        }
+
         return url;
     }
 

package/lib/expect-request.js

@@ -8,7 +8,7 @@ const {makeMessageFromMatchMessage} = require('./utils');
  * @prop {function} fn - Wrapped assertion with response context
  * @prop {string} [message] - The message to display if the assertion fails
  * @prop {string} [method] - The method to call on the assertion object
- * @prop {'header' | 'status'} [type] - The type of assertion
+ * @prop {'body' | 'header' | 'status'} type - The type of assertion, with following priority: body > header > status
  * @prop {import('assert').AssertionError} [error] - The error to throw if the assertion fails
  * @prop {any} [expected]
  * @prop {any} [expectedValue]
@@ -43,7 +43,8 @@ class ExpectRequest extends Request {
         };
 
         const assertion = {
-            fn: wrapperFn
+            fn: wrapperFn,
+            type: 'body'
         };
 
         this._addAssertion(assertion);
@@ -80,7 +81,8 @@ class ExpectRequest extends Request {
         let assertion = {
             fn: this._assertSnapshot,
             properties: properties,
-            field: 'body'
+            field: 'body',
+            type: 'body'
         };
 
         this._addAssertion(assertion);
@@ -139,12 +141,14 @@ class ExpectRequest extends Request {
         const headerAssertions = [];
 
         for (const assertion of this.assertions) {
-            if (!['status', 'header'].includes(assertion.type)) {
+            if (assertion.type === 'body') {
                 assertion.fn(response, assertion);
             } else if (assertion.type === 'status') {
                 statusCodeAssertions.push(assertion);
             } else if (assertion.type === 'header') {
                 headerAssertions.push(assertion);
+            } else {
+                headerAssertions.push(assertion);
             }
         }
 

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@tryghost/express-test",
-  "version": "0.5.0",
+  "version": "0.6.2",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/express-test",
   "author": "Ghost Foundation",
   "license": "MIT",
   "main": "index.js",
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing c8 mocha --require ./test/utils/overrides.js './test/**/*.test.js'",
+    "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura mocha --require ./test/utils/overrides.js './test/**/*.test.js'",
     "lint": "eslint . --ext .js --cache",
     "posttest": "yarn lint"
   },
@@ -20,15 +20,15 @@
   },
   "devDependencies": {
     "c8": "7.11.0",
-    "express": "4.17.2",
+    "express": "4.17.3",
     "express-session": "1.17.2",
-    "mocha": "9.2.0",
+    "mocha": "9.2.1",
     "sinon": "13.0.1"
   },
   "dependencies": {
-    "@tryghost/jest-snapshot": "^0.3.2",
+    "@tryghost/jest-snapshot": "^0.3.5",
     "cookiejar": "^2.1.3",
     "reqresnext": "^1.7.0"
   },
-  "gitHead": "e954893434fda3f8c8de1970aaaa6f6a8b297f5d"
+  "gitHead": "d09bf53d3435dd9782cea9c5a7062e07538a2b0b"
 }