hmpo-model 4.0.2 → 4.1.0

package/.github/workflows/ci.yaml

@@ -0,0 +1,27 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 15.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm test

package/lib/remote-model.js

@@ -122,28 +122,36 @@ class RemoteModel extends LocalModel {
     proxy(proxy = this.options.proxy, url) {
         if (!proxy || !url) return;
 
-        if (typeof proxy === 'string') proxy = { proxy };
+        if (typeof proxy === 'string') proxy = { uri: proxy };
+
+        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),
+            maxSockets: 1,
+            keepAlive: false
+        }, proxy);
 
         const isHttps = (new URL(url).protocol === 'https:');
 
         if (isHttps) {
-            const { HttpsProxyAgent } = require('hpagent');
-            return {
-                https: new HttpsProxyAgent(Object.assign({
-                    keepAlive: false,
-                    maxSockets: 1,
-                    maxFreeSockets: 1,
-                }, proxy))
-            };
+            const HttpsProxyAgent = require('https-proxy-agent');
+            const agent = new HttpsProxyAgent(options);
+            return { https: agent };
         } else {
-            const { HttpProxyAgent } = require('hpagent');
-            return {
-                http: new HttpProxyAgent(Object.assign({
-                    keepAlive: false,
-                    maxSockets: 1,
-                    maxFreeSockets: 1,
-                }, proxy))
-            };
+            const HttpProxyAgent = require('http-proxy-agent');
+            const agent = new HttpProxyAgent(options);
+            return { http: agent };
         }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hmpo-model",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Simple model for interacting with http/rest apis.",
   "main": "index.js",
   "scripts": {
@@ -27,17 +27,18 @@
   "dependencies": {
     "debug": "^4.3.3",
     "got": "^11.8.3",
-    "hpagent": "^0.1.2",
+    "http-proxy-agent": "^5.0.0",
+    "https-proxy-agent": "^5.0.0",
     "lodash.kebabcase": "^4.1.1"
   },
   "devDependencies": {
-    "chai": "^4.3.4",
-    "eslint": "^8.3.0",
-    "hmpo-logger": "^4.1.3",
-    "mocha": "^9.1.3",
+    "chai": "^4.3.6",
+    "eslint": "^8.10.0",
+    "hmpo-logger": "^4.1.5",
+    "mocha": "^9.2.1",
     "nyc": "^15.1.0",
     "proxyquire": "^2.0.0",
-    "sinon": "^12.0.1",
+    "sinon": "^13.0.1",
     "sinon-chai": "^3.7.0"
   },
   "nyc": {

package/test/helper.js

@@ -4,3 +4,5 @@ global.should = chai.should();
 global.expect = chai.expect;
 global.sinon = require('sinon');
 chai.use(require('sinon-chai'));
+
+require('hmpo-logger').config();

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

@@ -5,7 +5,8 @@ const ModelError = require('../../lib/model-error');
 const BaseModel = require('../../lib/local-model');
 const logger = require('hmpo-logger');
 
-const { HttpProxyAgent, HttpsProxyAgent } = require('hpagent');
+const HttpsProxyAgent = require('https-proxy-agent');
+const HttpProxyAgent = require('http-proxy-agent');
 
 describe('Remote Model', () => {
     let model, cb, mocks;
@@ -71,7 +72,7 @@ describe('Remote Model', () => {
         });
 
         it('should use console log and a trimHtml pass-through if hmpo-logger is not available', () => {
-            logger.get.throws(new Error());
+            logger.get.throws({ message: 'test error' });
 
             model = new Model();
 
@@ -431,19 +432,43 @@ describe('Remote Model', () => {
                     'method': 'VERB',
                     'url': 'http://example.net',
                     'proxy': {
-                        proxy: 'http://proxy.example.com:8000',
-                        keepAlive: true
+                        uri: 'http://proxy.example.com:8000',
+                        keepAlive: true,
+                        maxSockets: 200
                     }
                 });
 
                 sinon.assert.match(returnedConfig, {
                     agent: {
                         http: {
-                            keepAlive: true
+                            proxy: {
+                                keepAlive: true,
+                                maxSockets: 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:'
+                });
+
+                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:'
+                });
+            });
         });
 
         describe('with headers supplied into the constructor', () => {
@@ -742,7 +767,6 @@ describe('Remote Model', () => {
                 };
 
                 model.request(settings, cb);
-                console.log(model.logError.args[0][0]);
                 model.logError.should.have.been.calledWithExactly({
                     settings: settings,
                     statusCode: 404,

package/.circleci/config.yml

@@ -1,21 +0,0 @@
-# This config is equivalent to both the '.circleci/extended/orb-free.yml' and the base '.circleci/config.yml'
-version: 2.1
-
-# Orbs are reusable packages of CircleCI configuration that you may share across projects, enabling you to create encapsulated, parameterized commands, jobs, and executors that can be used across multiple projects.
-# See: https://circleci.com/docs/2.0/orb-intro/
-orbs:
-  node: circleci/node@4.7
-
-# Invoke jobs via workflows
-# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
-workflows:
-  sample: # This is the name of the workflow, feel free to change it to better match your workflow.
-    # Inside the workflow, you define the jobs you want to run.
-    jobs:
-      - node/test:
-          # This is the node version to use for the `cimg/node` tag
-          # Relevant tags can be found on the CircleCI Developer Hub
-          # https://circleci.com/developer/images/image/cimg/node
-          version: '16.10'
-          # If you are using yarn, change the line below from "npm" to "yarn"
-          pkg-manager: npm