global-agent 4.0.0 → 4.1.1

package/src/index.ts

@@ -4,3 +4,6 @@ export {
 export {
   createGlobalProxyAgent,
 } from './factories';
+export type {
+  Logger,
+} from './Logger';

package/src/routines/bootstrap.ts

@@ -1,5 +1,7 @@
 import createGlobalThis from 'globalthis';
-import Logger from '../Logger';
+import {
+  logger,
+} from '../Logger';
 import {
   createGlobalProxyAgent,
 } from '../factories';
@@ -9,7 +11,7 @@ import type {
 
 const globalThis: any = createGlobalThis();
 
-const log = Logger.child({
+const log = logger.child({
   namespace: 'bootstrap',
 });
 

package/src/types.ts

@@ -10,6 +10,9 @@ import type {
 import type {
   TLSSocket,
 } from 'tls';
+import type {
+  Logger,
+} from './Logger';
 
 export type ProxyConfigurationType = {
   authorization: string | null,
@@ -56,6 +59,7 @@ export type ProxyAgentConfigurationInputType = {
   forceGlobalAgent?: boolean,
   socketConnectionTimeout?: number,
   ca?: string[] | string,
+  logger?: Logger,
 };
 
 export type ProxyAgentConfigurationType = {

package/src/utilities/isUrlMatchingNoProxy.test.ts

@@ -0,0 +1,77 @@
+import {
+  expect,
+  test,
+} from 'vitest';
+import isUrlMatchingNoProxy from './isUrlMatchingNoProxy';
+
+test('returns `true` if hosts match', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com/', 'foo.com')).toBe(true);
+});
+
+test('returns `true` if hosts match (IP)', () => {
+  expect(isUrlMatchingNoProxy('http://127.0.0.1/', '127.0.0.1')).toBe(true);
+});
+
+test('returns `true` if hosts match (using asterisk wildcard)', () => {
+  expect(isUrlMatchingNoProxy('http://bar.foo.com/', '*.foo.com')).toBe(true);
+});
+
+test('returns `true` if domain matches (using dot wildcard)', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com/', '.foo.com')).toBe(true);
+});
+
+test('returns `true` if subdomain matches (using dot wildcard)', () => {
+  expect(isUrlMatchingNoProxy('http://bar.foo.com/', '.foo.com')).toBe(true);
+});
+
+test('returns `true` if hosts match (*) and ports match', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com:8080/', '*:8080')).toBe(true);
+});
+
+test('returns `true` if hosts and ports match', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com:8080/', 'foo.com:8080')).toBe(true);
+});
+
+test('returns `true` if hosts match and NO_PROXY does not define port', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com:8080/', 'foo.com')).toBe(true);
+});
+
+test('returns `true` if hosts (IP) and ports match', () => {
+  expect(isUrlMatchingNoProxy('http://127.0.0.1:8080/', '127.0.0.1:8080')).toBe(true);
+});
+
+test('returns `false` if hosts match and ports do not match (diffferent port)', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com:8080/', 'foo.com:8000')).toBe(false);
+});
+
+test('returns `false` if hosts match and ports do not match (port not present subject)', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com/', 'foo.com:8000')).toBe(false);
+});
+
+test('returns `true` if hosts match and ports do not match (port not present NO_PROXY)', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com:8000/', 'foo.com')).toBe(true);
+});
+
+test('returns `true` if hosts match in one of multiple rules separated with a comma', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com/', 'bar.org,foo.com,baz.io')).toBe(true);
+});
+
+test('returns `true` if hosts match in one of multiple rules separated with a comma and a space', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com/', 'bar.org, foo.com, baz.io')).toBe(true);
+});
+
+test('returns `true` if hosts match in one of multiple rules separated with a space', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com/', 'bar.org foo.com baz.io')).toBe(true);
+});
+
+test('handles trailing newline in NO_PROXY', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com/', 'foo.com\n')).toBe(true);
+});
+
+test('handles trailing whitespace in NO_PROXY', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com/', 'foo.com   ')).toBe(true);
+});
+
+test('handles leading whitespace in NO_PROXY', () => {
+  expect(isUrlMatchingNoProxy('http://foo.com/', '  foo.com')).toBe(true);
+});

package/src/utilities/isUrlMatchingNoProxy.ts

@@ -6,7 +6,7 @@ import {
 export default (subjectUrl: string, noProxy: string) => {
   const subjectUrlTokens = new URL(subjectUrl);
 
-  const rules = noProxy.split(/[\s,]+/);
+  const rules = noProxy.split(/[\s,]+/).filter(Boolean);
 
   for (const rule of rules) {
     const ruleMatch = rule

package/src/utilities/parseProxyUrl.test.ts

@@ -0,0 +1,35 @@
+import {
+  expect,
+  test,
+} from 'vitest';
+import parseProxyUrl from './parseProxyUrl';
+
+test('extracts hostname', () => {
+  expect(parseProxyUrl('http://0.0.0.0').hostname).toBe('0.0.0.0');
+});
+
+test('extracts port', () => {
+  expect(parseProxyUrl('http://0.0.0.0:3000').port).toBe(3_000);
+});
+
+test('extracts authorization', () => {
+  expect(parseProxyUrl('http://foo:bar@0.0.0.0').authorization).toBe('foo:bar');
+});
+
+test('throws an error if protocol is not "http:"', () => {
+  expect(() => {
+    parseProxyUrl('https://0.0.0.0:3000');
+  }).toThrow('Unsupported `GLOBAL_AGENT.HTTP_PROXY` configuration value: URL protocol must be "http:".');
+});
+
+test('throws an error if query is present', () => {
+  expect(() => {
+    parseProxyUrl('http://0.0.0.0:3000/?foo=bar');
+  }).toThrow('Unsupported `GLOBAL_AGENT.HTTP_PROXY` configuration value: URL must not have query.');
+});
+
+test('throws an error if hash is present', () => {
+  expect(() => {
+    parseProxyUrl('http://0.0.0.0:3000/#foo');
+  }).toThrow('Unsupported `GLOBAL_AGENT.HTTP_PROXY` configuration value: URL must not have hash.');
+});

package/vitest.config.ts

@@ -0,0 +1,11 @@
+import {defineConfig} from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    include: ['src/**/*.test.ts'],
+    isolate: false,
+    sequence: {
+      concurrent: false,
+    },
+  },
+});

package/.eslintignore

@@ -1 +0,0 @@
-/bootstrap.js

package/.eslintrc

@@ -1,27 +0,0 @@
-{
-  "extends": [
-    "canonical",
-    "canonical/node",
-    "canonical/typescript"
-  ],
-  "parserOptions": {
-    "project": "./tsconfig.json"
-  },
-  "root": true,
-  "rules": {
-    "@typescript-eslint/prefer-regexp-exec": 0,
-    "class-methods-use-this": 0,
-    "fp/no-class": 0,
-    "fp/no-events": 0,
-    "fp/no-this": 0,
-    "import/no-cycle": 0,
-    "no-continue": 0,
-    "no-restricted-syntax": 0,
-    "no-unused-expressions": [
-      2,
-      {
-        "allowTaggedTemplates": true
-      }
-    ]
-  }
-}

package/test/.eslintrc

@@ -1,10 +0,0 @@
-{
-  "rules": {
-    "ava/use-test": 0,
-    "filenames/match-regex": 0,
-    "flowtype/no-flow-fix-me-comments": 0,
-    "flowtype/no-weak-types": 0,
-    "id-length": 0,
-    "node/no-unpublished-import": 0
-  }
-}

package/test/global-agent/factories/createProxyController.ts

@@ -1,37 +0,0 @@
-import test from 'ava';
-import createProxyController from '../../../src/factories/createProxyController';
-
-test('sets HTTP_PROXY', (t) => {
-  const globalAgentGlobal = createProxyController();
-
-  globalAgentGlobal.HTTP_PROXY = 'http://127.0.0.1';
-
-  t.is(globalAgentGlobal.HTTP_PROXY, 'http://127.0.0.1');
-});
-
-test('sets HTTPS_PROXY', (t) => {
-  const globalAgentGlobal = createProxyController();
-
-  globalAgentGlobal.HTTPS_PROXY = 'http://127.0.0.1';
-
-  t.is(globalAgentGlobal.HTTPS_PROXY, 'http://127.0.0.1');
-});
-
-test('sets NO_PROXY', (t) => {
-  const globalAgentGlobal = createProxyController();
-
-  globalAgentGlobal.NO_PROXY = '*';
-
-  t.is(globalAgentGlobal.NO_PROXY, '*');
-});
-
-test('throws an error if unknown property is set', (t) => {
-  const globalAgentGlobal = createProxyController();
-
-  const error = t.throws(() => {
-    // @ts-expect-error expected unknown property.
-    globalAgentGlobal.FOO = 'BAR';
-  });
-
-  t.is(error.message, 'Cannot set an unmapped property "FOO".');
-});

package/test/global-agent/utilities/isUrlMatchingNoProxy.ts

@@ -1,62 +0,0 @@
-import test from 'ava';
-import isUrlMatchingNoProxy from '../../../src/utilities/isUrlMatchingNoProxy';
-
-test('returns `true` if hosts match', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com/', 'foo.com'));
-});
-
-test('returns `true` if hosts match (IP)', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://127.0.0.1/', '127.0.0.1'));
-});
-
-test('returns `true` if hosts match (using asterisk wildcard)', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://bar.foo.com/', '*.foo.com'));
-});
-
-test('returns `true` if domain matches (using dot wildcard)', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com/', '.foo.com'));
-});
-
-test('returns `true` if subdomain matches (using dot wildcard)', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://bar.foo.com/', '.foo.com'));
-});
-
-test('returns `true` if hosts match (*) and ports match', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com:8080/', '*:8080'));
-});
-
-test('returns `true` if hosts and ports match', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com:8080/', 'foo.com:8080'));
-});
-
-test('returns `true` if hosts match and NO_PROXY does not define port', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com:8080/', 'foo.com'));
-});
-
-test('returns `true` if hosts (IP) and ports match', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://127.0.0.1:8080/', '127.0.0.1:8080'));
-});
-
-test('returns `false` if hosts match and ports do not match (diffferent port)', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com:8080/', 'foo.com:8000') === false);
-});
-
-test('returns `false` if hosts match and ports do not match (port not present subject)', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com/', 'foo.com:8000') === false);
-});
-
-test('returns `true` if hosts match and ports do not match (port not present NO_PROXY)', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com:8000/', 'foo.com'));
-});
-
-test('returns `true` if hosts match in one of multiple rules separated with a comma', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com/', 'bar.org,foo.com,baz.io'));
-});
-
-test('returns `true` if hosts match in one of multiple rules separated with a comma and a space', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com/', 'bar.org, foo.com, baz.io'));
-});
-
-test('returns `true` if hosts match in one of multiple rules separated with a space', (t) => {
-  t.assert(isUrlMatchingNoProxy('http://foo.com/', 'bar.org foo.com baz.io'));
-});

package/test/global-agent/utilities/parseProxyUrl.ts

@@ -1,38 +0,0 @@
-import test from 'ava';
-import parseProxyUrl from '../../../src/utilities/parseProxyUrl';
-
-test('extracts hostname', (t) => {
-  t.is(parseProxyUrl('http://0.0.0.0').hostname, '0.0.0.0');
-});
-
-test('extracts port', (t) => {
-  t.is(parseProxyUrl('http://0.0.0.0:3000').port, 3_000);
-});
-
-test('extracts authorization', (t) => {
-  t.is(parseProxyUrl('http://foo:bar@0.0.0.0').authorization, 'foo:bar');
-});
-
-test('throws an error if protocol is not "http:"', (t) => {
-  const error = t.throws(() => {
-    parseProxyUrl('https://0.0.0.0:3000');
-  });
-
-  t.is(error.message, 'Unsupported `GLOBAL_AGENT.HTTP_PROXY` configuration value: URL protocol must be "http:".');
-});
-
-test('throws an error if query is present', (t) => {
-  const error = t.throws(() => {
-    parseProxyUrl('http://0.0.0.0:3000/?foo=bar');
-  });
-
-  t.is(error.message, 'Unsupported `GLOBAL_AGENT.HTTP_PROXY` configuration value: URL must not have query.');
-});
-
-test('throws an error if hash is present', (t) => {
-  const error = t.throws(() => {
-    parseProxyUrl('http://0.0.0.0:3000/#foo');
-  });
-
-  t.is(error.message, 'Unsupported `GLOBAL_AGENT.HTTP_PROXY` configuration value: URL must not have hash.');
-});