@tryghost/express-test 2.0.3 → 2.1.0

package/README.md

@@ -8,8 +8,7 @@ Rapid express testing without HTTP
 
 or
 
-`yarn add @tryghost/express-test`
-
+`pnpm add @tryghost/express-test`
 
 ## Purpose
 
@@ -26,7 +25,6 @@ For the most up-to-date and clear usage info, there's a live working example of
 
 An instantiated agent can make HTTP-like calls, with a supertest-like chained API to set headers & body and to check status, headers and anything else.
 
-
 ```
 const agent = new TestAgent(app)
 
@@ -56,9 +54,10 @@ await agent.logout().get('/protected-route');
 
 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:
+
+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`
@@ -69,25 +68,21 @@ The custom order is here to prioritize assertions with the most context first. T
 
 ## Develop
 
-This is a mono repository, managed with [lerna](https://lernajs.io/).
+This is a mono repository, managed with [Nx](https://nx.dev).
 
 Follow the instructions for the top-level repo.
-1. `git clone` this repo & `cd` into it as usual
-2. Run `yarn` to install top-level dependencies.
 
+1. `git clone` this repo & `cd` into it as usual
+2. Run `pnpm install` to install top-level dependencies.
 
 ## Run
 
-- `yarn dev`
-
+- `pnpm dev`
 
 ## Test
 
-- `yarn lint` run just eslint
-- `yarn test` run lint and tests
-
-
-
+- `pnpm lint` runs oxlint
+- `pnpm test` runs lint and tests
 
 # Copyright & License
 

package/index.js

@@ -7,5 +7,5 @@ module.exports.snapshot = {
     snapshotManager: require('@tryghost/jest-snapshot').snapshotManager,
     matchSnapshotAssertion: require('@tryghost/jest-snapshot').matchSnapshotAssertion,
     any: require('@tryghost/jest-snapshot').any,
-    stringMatching: require('@tryghost/jest-snapshot').stringMatching
+    stringMatching: require('@tryghost/jest-snapshot').stringMatching,
 };

package/lib/Agent.js

@@ -1,8 +1,7 @@
-/* eslint-disable ghost/ghost-custom/no-native-error */
-const {CookieJar} = require('cookiejar');
+const { CookieJar } = require('cookiejar');
 const ExpectRequest = require('./ExpectRequest');
-const {RequestOptions} = require('./Request');
-const {normalizeURL} = require('./utils');
+const { RequestOptions } = require('./Request');
+const { normalizeURL } = require('./utils');
 
 /**
  * @typedef AgentOptions
@@ -73,22 +72,22 @@ class Agent {
     _mergeOptions(method, url, options = {}) {
         // It doesn't make sense to call this method without these properties
         if (!method) {
-            throw new Error('_mergeOptions cannot be called without a method'); /* eslint-disable-line no-restricted-syntax */
+            throw new Error('_mergeOptions cannot be called without a method');
         }
 
         if (!url) {
-            throw new Error('_mergeOptions cannot be called without a url'); /* eslint-disable-line no-restricted-syntax */
+            throw new Error('_mergeOptions cannot be called without a url');
         }
 
         // urlOptions
-        const {baseUrl, queryParams} = options;
+        const { baseUrl, queryParams } = options;
 
         return new RequestOptions({
             method,
-            url: this._makeUrl(url, Object.assign({}, {baseUrl, queryParams})),
+            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)
+            body: Object.assign({}, this.defaults.body, options.body),
         });
     }
 
@@ -105,9 +104,14 @@ class Agent {
 ['get', 'post', 'put', 'patch', 'delete', 'options', 'head'].forEach((method) => {
     Agent.prototype[method] = function (url, options) {
         if (!url) {
-            throw new Error('Cannot make a request without supplying a url'); /* eslint-disable-line no-restricted-syntax */
+            throw new Error('Cannot make a request without supplying a url');
         }
-        return new ExpectRequest(this.app, this.jar, this._mergeOptions(method.toUpperCase(), url, options), this.snapshotManager);
+        return new ExpectRequest(
+            this.app,
+            this.jar,
+            this._mergeOptions(method.toUpperCase(), url, options),
+            this.snapshotManager,
+        );
     };
 });
 

package/lib/ExpectRequest.js

@@ -1,6 +1,6 @@
 const assert = require('assert');
-const {Request, RequestOptions} = require('./Request');
-const {snapshotManager} = require('@tryghost/jest-snapshot');
+const { Request, RequestOptions } = require('./Request');
+const { snapshotManager } = require('@tryghost/jest-snapshot');
 
 /**
  * @typedef {object} ExpressTestAssertion
@@ -30,9 +30,8 @@ class ExpectRequest extends Request {
 
     expect(callback) {
         if (typeof callback !== 'function') {
-            // eslint-disable-next-line ghost/ghost-custom/no-native-error
             throw new Error(
-                'express-test expect() requires a callback function, did you mean expectStatus or expectHeader?'
+                'express-test expect() requires a callback function, did you mean expectStatus or expectHeader?',
             );
         }
 
@@ -47,7 +46,7 @@ class ExpectRequest extends Request {
 
         const assertion = {
             fn: wrapperFn,
-            type: 'body'
+            type: 'body',
         };
 
         this._addAssertion(assertion);
@@ -59,7 +58,7 @@ class ExpectRequest extends Request {
         const assertion = {
             fn: this._assertStatus,
             expected,
-            type: 'status'
+            type: 'status',
         };
 
         this._addAssertion(assertion);
@@ -72,7 +71,7 @@ class ExpectRequest extends Request {
             fn: this._assertHeader,
             expectedField: expectedField.toLowerCase(),
             expectedValue,
-            type: 'header'
+            type: 'header',
         };
 
         this._addAssertion(assertion);
@@ -84,7 +83,7 @@ class ExpectRequest extends Request {
         const assertion = {
             fn: this._assertEmptyBody,
             expected: {},
-            type: 'body'
+            type: 'body',
         };
 
         this._addAssertion(assertion);
@@ -97,7 +96,7 @@ class ExpectRequest extends Request {
             fn: this._assertSnapshot,
             properties: properties,
             field: 'body',
-            type: 'body'
+            type: 'body',
         };
 
         this._addAssertion(assertion);
@@ -110,7 +109,7 @@ class ExpectRequest extends Request {
             fn: this._assertSnapshot,
             properties: properties,
             field: 'headers',
-            type: 'header'
+            type: 'header',
         };
 
         this._addAssertion(assertion);
@@ -185,7 +184,7 @@ class ExpectRequest extends Request {
         let error = new assert.AssertionError({
             message: 'Unexpected assertion error',
             expected: assertion.expected,
-            stackStartFn: this._addAssertion
+            stackStartFn: this._addAssertion,
         });
 
         error.contextString = this.reqOptions.toString();
@@ -195,11 +194,16 @@ class ExpectRequest extends Request {
     }
 
     _assertStatus(response, assertion) {
-        const {error} = assertion;
+        const { error } = assertion;
 
         error.message = `Expected statusCode ${assertion.expected}, got statusCode ${response.statusCode} ${error.contextString}`;
 
-        if (response.body && response.body.errors && response.body.errors[0] && response.body.errors[0].message) {
+        if (
+            response.body &&
+            response.body.errors &&
+            response.body.errors[0] &&
+            response.body.errors[0].message
+        ) {
             error.message += `\n${response.body.errors[0].message}`;
 
             if (response.body.errors[0].context) {
@@ -213,7 +217,7 @@ class ExpectRequest extends Request {
     }
 
     _assertHeader(response, assertion) {
-        const {expectedField, expectedValue, error} = assertion;
+        const { expectedField, expectedValue, error } = assertion;
         const actual = response.headers[expectedField];
 
         const expectedHeaderString = `${expectedField}: ${expectedValue}`;
@@ -237,7 +241,7 @@ class ExpectRequest extends Request {
     }
 
     _assertEmptyBody(response, assertion) {
-        const {error, expected} = assertion;
+        const { error, expected } = assertion;
         const actual = response.body;
 
         error.actual = actual;

package/lib/Request.js

@@ -1,9 +1,9 @@
 const http = require('http');
-const {Writable, Readable} = require('stream');
+const { Writable, Readable } = require('stream');
 const express = require('express');
-const {CookieAccessInfo} = require('cookiejar');
-const {parse} = require('url');
-const {isJSON, attachFile} = require('./utils');
+const { CookieAccessInfo } = require('cookiejar');
+const { parse } = require('url');
+const { isJSON, attachFile } = require('./utils');
 
 class MockSocket extends Writable {
     constructor() {
@@ -16,7 +16,7 @@ class MockSocket extends Writable {
 }
 
 class RequestOptions {
-    constructor({method, url, headers, body} = {}) {
+    constructor({ method, url, headers, body } = {}) {
         this.method = method || 'GET';
         this.url = url || '/';
         this.headers = headers || {};
@@ -31,7 +31,8 @@ class RequestOptions {
 class Request {
     constructor(app, cookieJar, reqOptions) {
         this.app = app;
-        this.reqOptions = reqOptions instanceof RequestOptions ? reqOptions : new RequestOptions(reqOptions);
+        this.reqOptions =
+            reqOptions instanceof RequestOptions ? reqOptions : new RequestOptions(reqOptions);
         this.cookieJar = cookieJar;
         this._formData = null; // Track FormData instance for multiple attachments
     }
@@ -53,7 +54,7 @@ class Request {
             // body is FormData (we cannot reliably check instanceof, not working in all situations)
             const requestBuffer = body.getBuffer();
             const headers = body.getHeaders({
-                ...this.reqOptions.headers
+                ...this.reqOptions.headers,
             });
             this.reqOptions.headers = headers;
             return this.body(requestBuffer);
@@ -110,7 +111,7 @@ class Request {
             },
             read: () => {
                 return readableStream.read(...arguments);
-            }
+            },
         };
         return this;
     }
@@ -149,7 +150,7 @@ class Request {
     }
 
     _getReqRes() {
-        const {app, reqOptions} = this;
+        const { app, reqOptions } = this;
 
         // Create proper Node.js req/res objects using built-in http module.
         // MockSocket provides a writable stream so that res.end() properly emits 'finish'.
@@ -159,7 +160,7 @@ class Request {
         // When streaming body data, the socket must appear readable so that
         // body-parser's on-finished check doesn't skip the request as "already finished".
         if (hasStreamOverrides) {
-            Object.defineProperty(socket, 'readable', {value: true});
+            Object.defineProperty(socket, 'readable', { value: true });
         }
 
         const req = new http.IncomingMessage(socket);
@@ -211,12 +212,15 @@ class Request {
         if (hasStreamOverrides) {
             const props = Object.keys(this.reqOptions.methodOverrides);
             for (const prop of props) {
-                const descriptor = Object.getOwnPropertyDescriptor(this.reqOptions.methodOverrides, prop);
+                const descriptor = Object.getOwnPropertyDescriptor(
+                    this.reqOptions.methodOverrides,
+                    prop,
+                );
                 Object.defineProperty(req, prop, descriptor);
             }
         }
 
-        return {req, res};
+        return { req, res };
     }
 
     _buildResponse(res) {
@@ -229,12 +233,12 @@ class Request {
             body = text && JSON.parse(text);
         }
 
-        return {statusCode, headers, text, body, response: res};
+        return { statusCode, headers, text, body, response: res };
     }
 
     _doRequest(callback) {
         try {
-            const {req, res} = this._getReqRes();
+            const { req, res } = this._getReqRes();
 
             this._restoreCookies(req);
 
@@ -255,11 +259,7 @@ class Request {
     _getCookies(req) {
         const url = parse(req.url);
 
-        const access = new CookieAccessInfo(
-            url.hostname,
-            url.pathname,
-            url.protocol === 'https:'
-        );
+        const access = new CookieAccessInfo(url.hostname, url.pathname, url.protocol === 'https:');
 
         return this.cookieJar.getCookies(access).toValueString();
     }

package/lib/utils.js

@@ -29,7 +29,7 @@ module.exports.attachFile = function attachFile(name, filePath, existingFormData
 
     formData.append(name, fileContent, {
         filename,
-        contentType
+        contentType,
     });
 
     return formData;

package/package.json

@@ -1,40 +1,40 @@
 {
   "name": "@tryghost/express-test",
-  "version": "2.0.3",
+  "version": "2.1.0",
+  "license": "MIT",
+  "author": "Ghost Foundation",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TryGhost/framework.git",
     "directory": "packages/express-test"
   },
-  "author": "Ghost Foundation",
-  "license": "MIT",
-  "main": "index.js",
-  "scripts": {
-    "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing vitest run --coverage",
-    "lint": "eslint . --ext .js --cache",
-    "posttest": "yarn lint"
-  },
   "files": [
     "index.js",
     "lib"
   ],
+  "main": "index.js",
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "cookiejar": "2.1.4",
+    "form-data": "4.0.5",
+    "mime-types": "3.0.2",
+    "@tryghost/jest-snapshot": "2.1.0"
+  },
   "devDependencies": {
     "express": "5.2.1",
     "express-session": "1.19.0",
     "multer": "2.1.1",
-    "sinon": "21.0.2"
+    "sinon": "21.1.2"
   },
   "peerDependencies": {
     "express": "^4.0.0 || ^5.0.0"
   },
-  "dependencies": {
-    "@tryghost/jest-snapshot": "^2.0.3",
-    "cookiejar": "2.1.4",
-    "form-data": "4.0.5",
-    "mime-types": "3.0.2"
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing vitest run --coverage",
+    "lint": "oxlint -c ../../.oxlintrc.json .",
+    "posttest": "pnpm run lint"
   }
-}
+}