hmpo-model 5.0.0 → 6.0.0

package/.github/workflows/ci.yaml

@@ -13,12 +13,12 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x, 20.x]
+        node-version: [20.x, 22.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies

package/.husky/pre-push

@@ -0,0 +1 @@
+npm test

package/eslint.config.js

@@ -0,0 +1,53 @@
+const js = require('@eslint/js');
+const globals = require('globals');
+
+
+const styleRules = {
+    quotes: ['error', 'single', { avoidEscape: true }],
+    'no-trailing-spaces': 'error',
+    indent: 'error',
+    'linebreak-style': ['error', 'unix'],
+    semi: ['error', 'always'],
+    'brace-style': ['error', '1tbs', { allowSingleLine: true }],
+    'keyword-spacing': 'error',
+    'space-before-blocks': 'error',
+    'space-before-function-paren': [
+        'error',
+        { anonymous: 'always', named: 'never' },
+    ],
+    'no-mixed-spaces-and-tabs': 'error',
+    'comma-spacing': ['error', { before: false, after: true }],
+    'key-spacing': ['error', { beforeColon: false, afterColon: true }],
+};
+
+
+module.exports = [
+    js.configs.recommended,
+    {
+        languageOptions: {
+            ecmaVersion: 2022,
+            globals: {
+                ...globals.node,
+            }
+        },
+        rules: {
+            'no-unused-vars': [
+                'error',
+                { argsIgnorePattern: '^(err|req|res|next)$' },
+            ],
+            'one-var': ['error', { initialized: 'never' }],
+            'no-var': 'error',
+            ...styleRules,
+        },
+    },
+    // Unit tests
+    {
+        files: ['test/**'],
+        languageOptions: {
+            globals: {
+                ...globals.mocha,
+                sinon: 'readonly',
+            },
+        },
+    },
+];

package/lib/remote-model.js

@@ -6,7 +6,6 @@ const got = require('got');
 const kebabCase = require('lodash.kebabcase');
 const { URL } = require('url');
 const ModelError = require('./model-error');
-
 const DEFAULT_TIMEOUT = 60000;
 
 const consoleLogger = { outbound: console.log, trimHtml: html => html };
@@ -22,7 +21,7 @@ class RemoteModel extends LocalModel {
     setLogger() {
         try {
             this.logger = require('hmpo-logger');
-        } catch (e) {
+        } catch {
             /* istanbul ignore next */
             console.warn('Warning: ' + this.options.label + ': Unable to find hmpo-logger for logging, using console instead!');
         }
@@ -131,31 +130,22 @@ class RemoteModel extends LocalModel {
 
         const proxyUrl = new URL(proxy.uri);
 
-        const getAuth = u =>
-            u.username && u.password ? decodeURIComponent(`${u.username}:${u.password}`) :
-                u.username ? decodeURIComponent(u.username) : null;
-
-        const getPath = u => u.pathname + u.search + u.hash;
-
-        const options = Object.assign({
-            host: proxyUrl.hostname,
-            port: proxyUrl.port,
-            protocol: proxyUrl.protocol,
-            path: getPath(proxyUrl),
-            auth: getAuth(proxyUrl),
+        const options = {
+            headers: this.options.headers || {},
+            keepAlive: false,
             maxSockets: 1,
-            keepAlive: false
-        }, proxy);
+            ...proxy
+        };
 
         const isHttps = (new URL(url).protocol === 'https:');
 
         if (isHttps) {
-            const HttpsProxyAgent = require('https-proxy-agent');
-            const agent = new HttpsProxyAgent(options);
+            const { HttpsProxyAgent } = require('https-proxy-agent');
+            const agent = new HttpsProxyAgent(proxyUrl, options);
             return { https: agent };
         } else {
-            const HttpProxyAgent = require('http-proxy-agent');
-            const agent = new HttpProxyAgent(options);
+            const { HttpProxyAgent } = require('http-proxy-agent');
+            const agent = new HttpProxyAgent(proxyUrl, options);
             return { http: agent };
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hmpo-model",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "description": "Simple model for interacting with http/rest apis.",
   "main": "index.js",
   "scripts": {
@@ -9,43 +9,47 @@
     "posttest": "npm run check-coverage && npm audit --production",
     "lint": "eslint .",
     "unit": "nyc --reporter=lcov --reporter=text-summary _mocha test/ --recursive --require test/helper",
-    "check-coverage": "nyc check-coverage"
+    "check-coverage": "nyc check-coverage",
+    "prepare": "husky"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/UKHomeOffice/passports-model.git"
+    "url": "https://github.com/HMPO/hmpo-model.git"
   },
   "author": "PEX",
   "license": "MIT",
   "engines": {
-    "node": ">=14"
+    "node": "20.x || 22.x"
   },
   "bugs": {
-    "url": "https://github.com/UKHomeOffice/passports-model/issues"
+    "url": "https://github.com/HMPO/hmpo-model/issues"
   },
-  "homepage": "https://github.com/UKHomeOffice/passports-model",
+  "homepage": "https://github.com/HMPO/hmpo-model#readme",
   "dependencies": {
-    "debug": "^4.3.4",
+    "debug": "^4.3.7",
     "got": "<12",
-    "http-proxy-agent": "^5.0.0",
-    "https-proxy-agent": "^5.0.1",
+    "http-proxy-agent": "^7.0.2",
+    "https-proxy-agent": "^7.0.5",
     "lodash.kebabcase": "^4.1.1"
   },
   "devDependencies": {
-    "chai": "^4.3.6",
-    "eslint": "^8.18.0",
-    "hmpo-logger": "^7.0.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.1.0",
-    "proxyquire": "^2.0.0",
-    "sinon": "^15.0.4",
-    "sinon-chai": "^3.7.0"
+    "chai": "^4.5.0",
+    "eslint": "^9.12.0",
+    "hmpo-logger": "git+https://github.com/HMPO/hmpo-logger.git#DD-272-update-dependencies",
+    "mocha": "^10.7.3",
+    "nyc": "^17.1.0",
+    "proxyquire": "^2.1.3",
+    "sinon": "^19.0.2",
+    "sinon-chai": "^3.7.0",
+    "husky": "^9.1.6",
+    "globals": "^15.9.0"
   },
   "nyc": {
     "all": true,
     "exclude": [
       "coverage/**",
-      "test/**"
+      "test/**",
+      "eslint.config.js"
     ],
     "lines": 100,
     "branches": 100,

package/test/lib/spec.local-model.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const Model = require('../../lib/local-model');
+const { expect } = require('chai');
 
 describe('Local Model', () => {
     let model;

package/test/lib/spec.remote-model.js

@@ -4,9 +4,10 @@ const Model = require('../../lib/remote-model');
 const ModelError = require('../../lib/model-error');
 const BaseModel = require('../../lib/local-model');
 const logger = require('hmpo-logger');
+const { expect } = require('chai');
 
-const HttpsProxyAgent = require('https-proxy-agent');
-const HttpProxyAgent = require('http-proxy-agent');
+const { HttpProxyAgent }  = require('http-proxy-agent');
+const { HttpsProxyAgent }  = require('https-proxy-agent');
 
 describe('Remote Model', () => {
     let model, cb, mocks;
@@ -400,16 +401,12 @@ describe('Remote Model', () => {
 
             it('should set up http proxy if specified', () => {
                 const returnedConfig = model.requestConfig({
-                    'method': 'VERB',
-                    'url': 'http://example.net',
-                    'proxy': 'http://proxy.example.com:8000'
+                    method: 'VERB',
+                    url: 'http://example.net',
+                    proxy: 'http://proxy.example.com:8000'
                 });
 
-                sinon.assert.match(returnedConfig, {
-                    agent: {
-                        http: sinon.match.instanceOf(HttpProxyAgent)
-                    }
-                });
+                expect(returnedConfig.agent.http).to.be.an.instanceOf(HttpProxyAgent);
             });
 
             it('should set up https proxy if specified', () => {
@@ -428,46 +425,56 @@ describe('Remote Model', () => {
 
             it('should pass proxy options to the new proxy', () => {
                 const returnedConfig = model.requestConfig({
-                    'method': 'VERB',
-                    'url': 'http://example.net',
-                    'proxy': {
+                    method: 'VERB',
+                    url: 'http://example.net',
+                    proxy: {
                         uri: 'http://proxy.example.com:8000',
                         keepAlive: true,
                         maxSockets: 200
                     }
                 });
 
-                sinon.assert.match(returnedConfig, {
-                    agent: {
-                        http: {
-                            proxy: {
-                                keepAlive: true,
-                                maxSockets: 200
-                            }
-                        }
-                    }
-                });
+                const agent = returnedConfig.agent.http;
+                expect(agent).to.be.instanceOf(require('http').Agent);
+                expect(agent.keepAlive).to.equal(true);
+                expect(agent.maxSockets).to.equal(200);
             });
 
+
             it('should process auth for the proxy', () => {
                 let agent;
 
                 agent = model.proxy('http://username:password@host:123/path', 'https://example.com');
                 sinon.assert.match(agent.https.proxy, {
-                    auth: 'username:password',
-                    host: 'host',
-                    port: 123,
-                    protocol: 'http:'
+                    href: 'http://username:password@host:123/path',
+                    origin: 'http://host:123',
+                    protocol: 'http:',
+                    username: 'username',
+                    password: 'password',
+                    host: 'host:123',
+                    hostname: 'host',
+                    port: '123',
+                    pathname: '/path',
+                    search: '',
+                    hash: ''
                 });
 
                 agent = model.proxy('http://username@host:123/path', 'https://example.com');
                 sinon.assert.match(agent.https.proxy, {
-                    auth: 'username',
-                    host: 'host',
-                    port: 123,
-                    protocol: 'http:'
+                    href: 'http://username@host:123/path',
+                    origin: 'http://host:123',
+                    protocol: 'http:',
+                    username: 'username',
+                    password: '',
+                    host: 'host:123',
+                    hostname: 'host',
+                    port: '123',
+                    pathname: '/path',
+                    search: '',
+                    hash: ''
                 });
             });
+
         });
 
         describe('with headers supplied into the constructor', () => {

package/test/spec.index.js

@@ -1,4 +1,5 @@
 'use strict';
+const { expect } = require('chai');
 
 describe('hmpo-model', () => {
 

package/.eslintignore

@@ -1 +0,0 @@
-/coverage/**

package/.eslintrc

@@ -1,25 +0,0 @@
-{
-    "env": {
-        "node": true,
-        "es6": true
-    },
-    "extends": "eslint:recommended",
-    "rules": {
-        "no-unused-vars": ["error", { "argsIgnorePattern": "^(err|req|res|next)$" }],
-        "no-mixed-requires": ["error", { "allowCall": true }],
-        "quotes": ["error", "single"],
-        "no-trailing-spaces": "error",
-        "indent": "error",
-        "linebreak-style": ["error", "unix"],
-        "semi": ["error", "always"],
-        "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
-        "keyword-spacing": "error",
-        "space-before-blocks": "error",
-        "space-before-function-paren": ["error", { "anonymous": "always", "named": "never" }],
-        "no-mixed-spaces-and-tabs": "error",
-        "comma-spacing": ["error", {"before": false, "after": true}],
-        "key-spacing": ["error", {"beforeColon": false, "afterColon": true}],
-        "one-var": ["off", { "initialized": "never" }],
-        "no-var": "error"
-    }
-}

package/test/.eslintrc

@@ -1,9 +0,0 @@
-{
-    "env": {
-        "mocha": true
-    },
-    "globals": {
-        "sinon": true,
-        "expect": true
-    }
-}