global-agent 4.0.0 → 4.1.1

package/.github/workflows/feature.yaml

@@ -1,7 +1,10 @@
 jobs:
   test:
-    name: Test
+    name: Test (Node ${{ matrix.node-version }})
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ['20', '22', '24']
     steps:
       - name: setup repository
         uses: actions/checkout@v3
@@ -10,7 +13,7 @@ jobs:
       - name: setup node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '24'
+          node-version: ${{ matrix.node-version }}
       - name: setup npm
         uses: npm/action-setup@v4
         with:

package/.github/workflows/main.yaml

@@ -1,5 +1,26 @@
 jobs:
+  test:
+    name: Test (Node ${{ matrix.node-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ['20', '22', '24']
+    steps:
+      - name: setup repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: setup node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm run lint
+      - run: npm run test
+      - run: npm run build
+    timeout-minutes: 10
   release:
+    needs: test
     environment: release
     name: Release
     permissions:
@@ -18,8 +39,6 @@ jobs:
         with:
           node-version: '24'
       - run: npm install
-      - run: npm run lint
-      - run: npm run test
       - run: npm run build
       - env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.gitignore

@@ -5,8 +5,6 @@ node_modules
 .*
 !.babelrc
 !.editorconfig
-!.eslintignore
-!.eslintrc
 !.github
 !.gitignore
 !.npmignore

package/README.md

@@ -1,6 +1,5 @@
 # global-agent
 
-[![Coveralls](https://img.shields.io/coveralls/gajus/global-agent.svg?style=flat-square)](https://coveralls.io/github/gajus/global-agent)
 [![NPM version](http://img.shields.io/npm/v/global-agent.svg?style=flat-square)](https://www.npmjs.org/package/global-agent)
 [![Canonical Code Style](https://img.shields.io/badge/code%20style-canonical-blue.svg?style=flat-square)](https://github.com/gajus/canonical)
 [![Twitter Follow](https://img.shields.io/twitter/follow/kuizinas.svg?style=social&label=Follow)](https://twitter.com/kuizinas)
@@ -12,7 +11,6 @@ Global HTTP/HTTPS proxy configurable using environment variables.
   * [Setup proxy using `bootstrap` routine](#setup-proxy-using-bootstrap-routine)
   * [Runtime configuration](#runtime-configuration)
   * [Exclude URLs](#exclude-urls)
-  * [Enable logging](#enable-logging)
 * [API](#api)
   * [`createGlobalProxyAgent`](#createglobalproxyagent)
   * [Environment variables](#environment-variables)
@@ -142,20 +140,6 @@ says to contact all machines with the 'foo.com' TLD and 'baz.com' domains direct
 
 The environment variable `GLOBAL_AGENT_HTTPS_PROXY` can be set to specify a separate proxy for HTTPS requests. When this variable is not set `GLOBAL_AGENT_HTTP_PROXY` is used for both HTTP and HTTPS requests.
 
-### Enable logging
-
-`global-agent` is using [`roarr`](https://www.npmjs.com/package/roarr) logger to log HTTP requests and response (HTTP status code and headers), e.g.
-
-```json
-{"context":{"program":"global-agent","namespace":"Agent","logLevel":10,"destination":"http://gajus.com","proxy":"http://127.0.0.1:8076"},"message":"proxying request","sequence":1,"time":1556269669663,"version":"1.0.0"}
-{"context":{"program":"global-agent","namespace":"Agent","logLevel":10,"headers":{"content-type":"text/plain","content-length":"2","date":"Fri, 26 Apr 2019 12:07:50 GMT","connection":"close"},"requestId":6,"statusCode":200},"message":"proxying response","sequence":2,"time":1557133856955,"version":"1.0.0"}
-
-```
-
-Export `ROARR_LOG=true` environment variable to enable log printing to stdout.
-
-Use [`roarr-cli`](https://github.com/gajus/roarr-cli) program to pretty-print the logs.
-
 ## API
 
 ### `createGlobalProxyAgent`
@@ -166,18 +150,52 @@ Use [`roarr-cli`](https://github.com/gajus/roarr-cli) program to pretty-print th
  * @property forceGlobalAgent Forces to use `global-agent` HTTP(S) agent even when request was explicitly constructed with another agent. (Default: `true`)
  * @property socketConnectionTimeout Destroys socket if connection is not established within the timeout. (Default: `60000`)
  * @property ca Single CA certificate or an array of CA certificates that is trusted for secure connections to the registry.
+ * @property logger Custom logger instance for debug logging. Must implement `child`, `debug`, `error`, `info`, `trace`, and `warn` methods.
  */
 type ProxyAgentConfigurationInputType = {|
   +environmentVariableNamespace?: string,
   +forceGlobalAgent?: boolean,
   +socketConnectionTimeout?: number,
   +ca?: string[] | string,
+  +logger?: Logger,
 |};
 
 (configurationInput: ProxyAgentConfigurationInputType) => ProxyAgentConfigurationType;
 
 ```
 
+### Custom Logger
+
+You can provide a custom logger to `global-agent` for debugging purposes. The logger must implement the following interface:
+
+```ts
+type Logger = {
+  child: (context: object) => Logger,
+  debug: (context: object | string, message?: string) => void,
+  error: (context: object | string, message?: string) => void,
+  info: (context: object | string, message?: string) => void,
+  trace: (context: object | string, message?: string) => void,
+  warn: (context: object | string, message?: string) => void,
+};
+```
+
+Example using a custom logger:
+
+```js
+import { createGlobalProxyAgent } from 'global-agent';
+
+createGlobalProxyAgent({
+  logger: {
+    child: () => logger,
+    debug: console.debug,
+    error: console.error,
+    info: console.info,
+    trace: console.trace,
+    warn: console.warn,
+  },
+});
+```
+
 ### Environment variables
 
 |Name|Description|Default|

package/package.json

@@ -2,38 +2,24 @@
   "author": {
     "email": "gajus@gajus.com",
     "name": "Gajus Kuizinas",
-    "url": "http://gajus.com"
-  },
-  "ava": {
-    "extensions": [
-      "ts"
-    ],
-    "files": [
-      "test/global-agent/**/*"
-    ],
-    "require": [
-      "ts-node/register/transpile-only"
-    ]
+    "url": "https://gajus.com"
   },
   "dependencies": {
     "es6-error": "^4.1.1",
     "globalthis": "^1.0.2",
     "matcher": "^4.0.0",
     "omit-undefined": "^1.0.1",
-    "roarr": "^7.0.3",
     "semver": "^7.3.5",
     "serialize-error": "^8.1.0"
   },
   "description": "Global HTTP/HTTPS proxy configurable using environment variables.",
   "devDependencies": {
-    "@ava/babel": "^2.0.0",
     "@babel/cli": "^7.14.8",
     "@babel/core": "^7.14.8",
     "@babel/node": "^7.14.7",
     "@babel/plugin-transform-flow-strip-types": "^7.14.5",
     "@babel/preset-env": "^7.14.8",
     "@babel/register": "^7.14.5",
-    "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/github": "^12.0.3",
     "@semantic-release/npm": "^13.1.3",
@@ -42,24 +28,20 @@
     "@types/request": "^2.48.6",
     "@types/semver": "^7.3.8",
     "@types/sinon": "^10.0.2",
-    "ava": "^3.15.0",
     "axios": "^0.21.1",
-    "babel-plugin-istanbul": "^6.0.0",
     "babel-plugin-transform-export-default-name": "^2.1.0",
-    "coveralls": "^3.1.1",
     "del-cli": "^4.0.1",
-    "eslint": "^7.31.0",
-    "eslint-config-canonical": "^26.2.3",
     "get-port": "^5.1.1",
     "got": "^11.8.2",
     "husky": "^7.0.1",
-    "nyc": "^15.1.0",
+    "oxlint": "^1.43.0",
     "pem": "^1.14.4",
     "request": "^2.88.2",
     "semantic-release": "^25.0.3",
     "sinon": "^11.1.2",
     "ts-node": "^10.1.0",
-    "typescript": "^4.3.5"
+    "typescript": "^4.3.5",
+    "vitest": "^4.0.18"
   },
   "engines": {
     "node": ">=10.0"
@@ -78,20 +60,16 @@
   "license": "BSD-3-Clause",
   "main": "./dist/src/index.js",
   "name": "global-agent",
-  "nyc": {
-    "extends": "@istanbuljs/nyc-config-typescript",
-    "all": true
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/gajus/global-agent"
   },
   "scripts": {
     "build": "del-cli ./dist && tsc",
-    "lint": "eslint ./src ./test && tsc",
-    "test": "ava --verbose --serial",
+    "lint": "oxlint ./src && tsc",
+    "test": "vitest run",
     "create-readme": "gitdown ./.README/README.md --output-file ./README.md"
   },
   "typings": "./dist/src/index.d.ts",
-  "version": "4.0.0"
+  "version": "4.1.1"
 }

package/src/Logger.ts

@@ -1,10 +1,70 @@
-import {
-  Roarr,
-} from 'roarr';
+export type LogMethod = (context: object | string, message?: string) => void;
 
-const Logger = Roarr
-  .child({
-    package: 'global-agent',
-  });
+export type Logger = {
+  child: (context: object) => Logger,
+  debug: LogMethod,
+  error: LogMethod,
+  info: LogMethod,
+  trace: LogMethod,
+  warn: LogMethod,
+};
 
-export default Logger;
+// oxlint-disable-next-line @typescript-eslint/no-empty-function
+const noop = () => {};
+
+const createNoopLogger = (): Logger => {
+  return {
+    child: () => {
+      return createNoopLogger();
+    },
+    debug: noop,
+    error: noop,
+    info: noop,
+    trace: noop,
+    warn: noop,
+  };
+};
+
+let currentLogger: Logger = createNoopLogger();
+
+export const setLogger = (newLogger: Logger): void => {
+  currentLogger = newLogger;
+};
+
+const createDelegatingLogger = (getContext: () => object): Logger => {
+  const getLogger = () => {
+    let targetLogger = currentLogger;
+    for (const [key, value] of Object.entries(getContext())) {
+      targetLogger = targetLogger.child({[key]: value});
+    }
+
+    return targetLogger;
+  };
+
+  return {
+    child: (context: object) => {
+      return createDelegatingLogger(() => {
+        return {...getContext(), ...context};
+      });
+    },
+    debug: (context, message) => {
+      getLogger().debug(context, message);
+    },
+    error: (context, message) => {
+      getLogger().error(context, message);
+    },
+    info: (context, message) => {
+      getLogger().info(context, message);
+    },
+    trace: (context, message) => {
+      getLogger().trace(context, message);
+    },
+    warn: (context, message) => {
+      getLogger().warn(context, message);
+    },
+  };
+};
+
+export const logger = createDelegatingLogger(() => {
+  return {package: 'global-agent'};
+});

package/src/classes/Agent.ts

@@ -4,7 +4,9 @@ import net from 'net';
 import {
   serializeError,
 } from 'serialize-error';
-import Logger from '../Logger';
+import {
+  logger,
+} from '../Logger';
 import type {
   AgentType,
   ConnectionCallbackType,
@@ -15,7 +17,7 @@ import type {
   ProtocolType,
 } from '../types';
 
-const log = Logger.child({
+const log = logger.child({
   namespace: 'Agent',
 });
 
@@ -106,7 +108,7 @@ abstract class Agent {
    * Evaluate value for tls reject unauthorized variable
    */
   public getRejectUnauthorized () {
-    // eslint-disable-next-line node/no-process-env
+    // oxlint-disable-next-line node/no-process-env
     const rejectUnauthorized = process.env.NODE_TLS_REJECT_UNAUTHORIZED;
     let returnValue = true;
     if (typeof rejectUnauthorized === 'boolean') {
@@ -134,7 +136,7 @@ abstract class Agent {
     } else if (request.method === 'CONNECT') {
       requestUrl = 'https://' + request.path;
     } else {
-      requestUrl = this.protocol + '//' + (configuration.hostname ?? configuration.host) + (configuration.port === 80 ?? configuration.port === 443 ? '' : ':' + configuration.port) + request.path;
+      requestUrl = this.protocol + '//' + (configuration.hostname ?? configuration.host) + (configuration.port === 80 || configuration.port === 443 ? '' : ':' + configuration.port) + request.path;
     }
 
     // If a request should go to a local socket, proxying it through an HTTP