@verdaccio/proxy 6.0.0-6-next.19 → 6.0.0-6-next.22

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # @verdaccio/proxy
 
+## 6.0.0-6-next.22
+
+### Patch Changes
+
+- Updated dependencies [37274e4c]
+  - @verdaccio/local-storage@11.0.0-6-next.14
+  - @verdaccio/core@6.0.0-6-next.6
+  - @verdaccio/logger@6.0.0-6-next.12
+
+## 6.0.0-6-next.21
+
+### Major Changes
+
+- 292c0a37: feat!: replace deprecated request dependency by got
+
+  This is a big refactoring of the core, fetching dependencies, improve code, more tests and better stability. This is essential for the next release, will take some time but would allow modularize more the core.
+
+  ## Notes
+
+  - Remove deprecated `request` by other `got`, retry improved, custom Agent ( got does not include it built-in)
+  - Remove `async` dependency from storage (used by core) it was linked with proxy somehow safe to remove now
+  - Refactor with promises instead callback wherever is possible
+  - ~Document the API~
+  - Improve testing, integration tests
+  - Bugfix
+  - Clean up old validations
+  - Improve performance
+
+  ## 💥 Breaking changes
+
+  - Plugin API methods were callbacks based are returning promises, this will break current storage plugins, check documentation for upgrade.
+  - Write Tarball, Read Tarball methods parameters change, a new set of options like `AbortController` signals are being provided to the `addAbortSignal` can be internally used with Streams when a request is aborted. eg: `addAbortSignal(signal, fs.createReadStream(pathName));`
+  - `@verdaccio/streams` stream abort support is legacy is being deprecated removed
+  - Remove AWS and Google Cloud packages for future refactoring [#2574](https://github.com/verdaccio/verdaccio/pull/2574).
+
+### Patch Changes
+
+- Updated dependencies [292c0a37]
+- Updated dependencies [a3a209b5]
+- Updated dependencies [00d1d2a1]
+  - @verdaccio/config@6.0.0-6-next.15
+  - @verdaccio/core@6.0.0-6-next.6
+  - @verdaccio/logger@6.0.0-6-next.12
+  - @verdaccio/local-storage@11.0.0-6-next.13
+  - @verdaccio/utils@6.0.0-6-next.12
+
+## 6.0.0-6-next.20
+
+### Patch Changes
+
+- Updated dependencies [d43894e8]
+- Updated dependencies [d08fe29d]
+  - @verdaccio/config@6.0.0-6-next.14
+  - @verdaccio/local-storage@11.0.0-6-next.12
+  - @verdaccio/core@6.0.0-6-next.5
+  - @verdaccio/streams@11.0.0-6-next.5
+  - @verdaccio/logger@6.0.0-6-next.11
+
 ## 6.0.0-6-next.19
 
 ### Major Changes

package/build/agent.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Agents } from 'got';
+import { AgentOptions as HttpAgentOptions } from 'http';
+import { AgentOptions as HttpsAgentOptions } from 'https';
+export declare type AgentOptionsConf = HttpAgentOptions | HttpsAgentOptions;
+declare class CustomAgents {
+    private url;
+    private proxy;
+    private agentOptions;
+    private agent;
+    constructor(url: string, proxy: string | undefined, agentOptions: HttpAgentOptions | HttpsAgentOptions);
+    get(): Agents;
+    private getAgent;
+    private getParsedUrl;
+}
+export default CustomAgents;

package/build/agent.js

@@ -0,0 +1,63 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _hpagent = require("hpagent");
+
+var _http = require("http");
+
+var _https = require("https");
+
+var _url = require("url");
+
+class CustomAgents {
+  constructor(url, proxy, agentOptions) {
+    this.proxy = proxy;
+    this.url = url;
+    this.agentOptions = agentOptions;
+    const {
+      protocol
+    } = this.getParsedUrl();
+    this.agent = this.getAgent(protocol);
+  }
+
+  get() {
+    return this.agent;
+  }
+
+  getAgent(protocol) {
+    const isHTTPS = protocol === 'https:';
+
+    if (this.proxy) {
+      const options = {
+        proxy: this.proxy,
+        ...this.agentOptions
+      }; // use hpagent
+
+      return isHTTPS ? {
+        https: new _hpagent.HttpsProxyAgent(options)
+      } : {
+        http: new _hpagent.HttpProxyAgent(options)
+      };
+    } else {
+      // use native http/https agent
+      return isHTTPS ? {
+        https: new _https.Agent(this.agentOptions)
+      } : {
+        http: new _http.Agent(this.agentOptions)
+      };
+    }
+  }
+
+  getParsedUrl() {
+    return this.proxy ? new _url.URL(this.proxy) : new _url.URL(this.url);
+  }
+
+}
+
+var _default = CustomAgents;
+exports.default = _default;
+//# sourceMappingURL=agent.js.map

package/build/agent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.js","names":["CustomAgents","constructor","url","proxy","agentOptions","protocol","getParsedUrl","agent","getAgent","get","isHTTPS","options","https","HttpsProxyAgent","http","HttpProxyAgent","HttpsAgent","HttpAgent","URL"],"sources":["../src/agent.ts"],"sourcesContent":["import { Agents } from 'got';\nimport { HttpProxyAgent, HttpsProxyAgent } from 'hpagent';\nimport { Agent as HttpAgent, AgentOptions as HttpAgentOptions } from 'http';\nimport { Agent as HttpsAgent, AgentOptions as HttpsAgentOptions } from 'https';\nimport { URL } from 'url';\n\nexport type AgentOptionsConf = HttpAgentOptions | HttpsAgentOptions;\n\nclass CustomAgents {\n  private url: string;\n  private proxy: string | undefined;\n  private agentOptions: HttpAgentOptions | HttpsAgentOptions;\n  private agent: Agents;\n  public constructor(\n    url: string,\n    proxy: string | undefined,\n    agentOptions: HttpAgentOptions | HttpsAgentOptions\n  ) {\n    this.proxy = proxy;\n    this.url = url;\n    this.agentOptions = agentOptions;\n    const { protocol } = this.getParsedUrl();\n    this.agent = this.getAgent(protocol);\n  }\n\n  public get() {\n    return this.agent;\n  }\n\n  private getAgent(protocol: string): Agents {\n    const isHTTPS = protocol === 'https:';\n    if (this.proxy) {\n      const options = {\n        proxy: this.proxy,\n        ...this.agentOptions,\n      };\n      // use hpagent\n      return isHTTPS\n        ? { https: new HttpsProxyAgent(options) }\n        : { http: new HttpProxyAgent(options) };\n    } else {\n      // use native http/https agent\n      return isHTTPS\n        ? { https: new HttpsAgent(this.agentOptions) }\n        : { http: new HttpAgent(this.agentOptions) };\n    }\n  }\n\n  private getParsedUrl() {\n    return this.proxy ? new URL(this.proxy) : new URL(this.url);\n  }\n}\n\nexport default CustomAgents;\n"],"mappings":";;;;;;;AACA;;AACA;;AACA;;AACA;;AAIA,MAAMA,YAAN,CAAmB;EAKVC,WAAW,CAChBC,GADgB,EAEhBC,KAFgB,EAGhBC,YAHgB,EAIhB;IACA,KAAKD,KAAL,GAAaA,KAAb;IACA,KAAKD,GAAL,GAAWA,GAAX;IACA,KAAKE,YAAL,GAAoBA,YAApB;IACA,MAAM;MAAEC;IAAF,IAAe,KAAKC,YAAL,EAArB;IACA,KAAKC,KAAL,GAAa,KAAKC,QAAL,CAAcH,QAAd,CAAb;EACD;;EAEMI,GAAG,GAAG;IACX,OAAO,KAAKF,KAAZ;EACD;;EAEOC,QAAQ,CAACH,QAAD,EAA2B;IACzC,MAAMK,OAAO,GAAGL,QAAQ,KAAK,QAA7B;;IACA,IAAI,KAAKF,KAAT,EAAgB;MACd,MAAMQ,OAAO,GAAG;QACdR,KAAK,EAAE,KAAKA,KADE;QAEd,GAAG,KAAKC;MAFM,CAAhB,CADc,CAKd;;MACA,OAAOM,OAAO,GACV;QAAEE,KAAK,EAAE,IAAIC,wBAAJ,CAAoBF,OAApB;MAAT,CADU,GAEV;QAAEG,IAAI,EAAE,IAAIC,uBAAJ,CAAmBJ,OAAnB;MAAR,CAFJ;IAGD,CATD,MASO;MACL;MACA,OAAOD,OAAO,GACV;QAAEE,KAAK,EAAE,IAAII,YAAJ,CAAe,KAAKZ,YAApB;MAAT,CADU,GAEV;QAAEU,IAAI,EAAE,IAAIG,WAAJ,CAAc,KAAKb,YAAnB;MAAR,CAFJ;IAGD;EACF;;EAEOE,YAAY,GAAG;IACrB,OAAO,KAAKH,KAAL,GAAa,IAAIe,QAAJ,CAAQ,KAAKf,KAAb,CAAb,GAAmC,IAAIe,QAAJ,CAAQ,KAAKhB,GAAb,CAA1C;EACD;;AA1CgB;;eA6CJF,Y"}

package/build/index.d.ts

@@ -1 +1 @@
-export * from './up-storage';
+export * from './proxy';

package/build/index.js

@@ -4,15 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
-var _upStorage = require("./up-storage");
+var _proxy = require("./proxy");
 
-Object.keys(_upStorage).forEach(function (key) {
+Object.keys(_proxy).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _upStorage[key]) return;
+  if (key in exports && exports[key] === _proxy[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _upStorage[key];
+      return _proxy[key];
     }
   });
 });

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA","sourcesContent":["export * from './up-storage';\n"],"file":"index.js"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export * from './proxy';\n"],"mappings":";;;;;;AAAA;;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}

package/build/proxy-utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/proxy-utils.ts"],"names":["parseIntervalTable","ms","s","m","h","d","w","M","y","parseInterval","interval","result","last_suffix","Infinity","split","forEach","x","match","Error","Number"],"mappings":";;;;;;AAAA,MAAMA,kBAAkB,GAAG;AACzB,MAAI,IADqB;AAEzBC,EAAAA,EAAE,EAAE,CAFqB;AAGzBC,EAAAA,CAAC,EAAE,IAHsB;AAIzBC,EAAAA,CAAC,EAAE,KAAK,IAJiB;AAKzBC,EAAAA,CAAC,EAAE,KAAK,EAAL,GAAU,IALY;AAMzBC,EAAAA,CAAC,EAAE,QANsB;AAOzBC,EAAAA,CAAC,EAAE,IAAI,QAPkB;AAQzBC,EAAAA,CAAC,EAAE,KAAK,QARiB;AASzBC,EAAAA,CAAC,EAAE,MAAM;AATgB,CAA3B;AAYA;AACA;AACA;AACA;AACA;AACA;;AACO,SAASC,aAAT,CAAuBC,QAAvB,EAA8C;AACnD,MAAI,OAAOA,QAAP,KAAoB,QAAxB,EAAkC;AAChC,WAAOA,QAAQ,GAAG,IAAlB;AACD;;AACD,MAAIC,MAAM,GAAG,CAAb;AACA,MAAIC,WAAW,GAAGC,QAAlB;AACAH,EAAAA,QAAQ,CAACI,KAAT,CAAe,KAAf,EAAsBC,OAAtB,CAA8B,UAAUC,CAAV,EAAmB;AAC/C,QAAI,CAACA,CAAL,EAAQ;AACN;AACD;;AACD,UAAMb,CAAC,GAAGa,CAAC,CAACC,KAAF,CAAQ,mDAAR,CAAV;;AACA,QACE,CAACd,CAAD,IACAH,kBAAkB,CAACG,CAAC,CAAC,CAAD,CAAF,CAAlB,IAA4BS,WAD5B,IAECT,CAAC,CAAC,CAAD,CAAD,KAAS,EAAT,IAAeS,WAAW,KAAKC,QAHlC,EAIE;AACA,YAAMK,KAAK,CAAC,uBAAuBR,QAAxB,CAAX;AACD;;AACDE,IAAAA,WAAW,GAAGZ,kBAAkB,CAACG,CAAC,CAAC,CAAD,CAAF,CAAhC;AACAQ,IAAAA,MAAM,IAAIQ,MAAM,CAAChB,CAAC,CAAC,CAAD,CAAF,CAAN,GAAeH,kBAAkB,CAACG,CAAC,CAAC,CAAD,CAAF,CAA3C;AACD,GAdD;AAeA,SAAOQ,MAAP;AACD","sourcesContent":["const parseIntervalTable = {\n  '': 1000,\n  ms: 1,\n  s: 1000,\n  m: 60 * 1000,\n  h: 60 * 60 * 1000,\n  d: 86400000,\n  w: 7 * 86400000,\n  M: 30 * 86400000,\n  y: 365 * 86400000,\n};\n\n/**\n * Parse an internal string to number\n * @param {*} interval\n * @return {Number}\n * @deprecated\n */\nexport function parseInterval(interval: any): number {\n  if (typeof interval === 'number') {\n    return interval * 1000;\n  }\n  let result = 0;\n  let last_suffix = Infinity;\n  interval.split(/\\s+/).forEach(function (x): void {\n    if (!x) {\n      return;\n    }\n    const m = x.match(/^((0|[1-9][0-9]*)(\\.[0-9]+)?)(ms|s|m|h|d|w|M|y|)$/);\n    if (\n      !m ||\n      parseIntervalTable[m[4]] >= last_suffix ||\n      (m[4] === '' && last_suffix !== Infinity)\n    ) {\n      throw Error('invalid interval: ' + interval);\n    }\n    last_suffix = parseIntervalTable[m[4]];\n    result += Number(m[1]) * parseIntervalTable[m[4]];\n  });\n  return result;\n}\n"],"file":"proxy-utils.js"}
+{"version":3,"file":"proxy-utils.js","names":["parseIntervalTable","ms","s","m","h","d","w","M","y","parseInterval","interval","result","last_suffix","Infinity","split","forEach","x","match","Error","Number"],"sources":["../src/proxy-utils.ts"],"sourcesContent":["const parseIntervalTable = {\n  '': 1000,\n  ms: 1,\n  s: 1000,\n  m: 60 * 1000,\n  h: 60 * 60 * 1000,\n  d: 86400000,\n  w: 7 * 86400000,\n  M: 30 * 86400000,\n  y: 365 * 86400000,\n};\n\n/**\n * Parse an internal string to number\n * @param {*} interval\n * @return {Number}\n * @deprecated\n */\nexport function parseInterval(interval: any): number {\n  if (typeof interval === 'number') {\n    return interval * 1000;\n  }\n  let result = 0;\n  let last_suffix = Infinity;\n  interval.split(/\\s+/).forEach(function (x): void {\n    if (!x) {\n      return;\n    }\n    const m = x.match(/^((0|[1-9][0-9]*)(\\.[0-9]+)?)(ms|s|m|h|d|w|M|y|)$/);\n    if (\n      !m ||\n      parseIntervalTable[m[4]] >= last_suffix ||\n      (m[4] === '' && last_suffix !== Infinity)\n    ) {\n      throw Error('invalid interval: ' + interval);\n    }\n    last_suffix = parseIntervalTable[m[4]];\n    result += Number(m[1]) * parseIntervalTable[m[4]];\n  });\n  return result;\n}\n"],"mappings":";;;;;;AAAA,MAAMA,kBAAkB,GAAG;EACzB,IAAI,IADqB;EAEzBC,EAAE,EAAE,CAFqB;EAGzBC,CAAC,EAAE,IAHsB;EAIzBC,CAAC,EAAE,KAAK,IAJiB;EAKzBC,CAAC,EAAE,KAAK,EAAL,GAAU,IALY;EAMzBC,CAAC,EAAE,QANsB;EAOzBC,CAAC,EAAE,IAAI,QAPkB;EAQzBC,CAAC,EAAE,KAAK,QARiB;EASzBC,CAAC,EAAE,MAAM;AATgB,CAA3B;AAYA;AACA;AACA;AACA;AACA;AACA;;AACO,SAASC,aAAT,CAAuBC,QAAvB,EAA8C;EACnD,IAAI,OAAOA,QAAP,KAAoB,QAAxB,EAAkC;IAChC,OAAOA,QAAQ,GAAG,IAAlB;EACD;;EACD,IAAIC,MAAM,GAAG,CAAb;EACA,IAAIC,WAAW,GAAGC,QAAlB;EACAH,QAAQ,CAACI,KAAT,CAAe,KAAf,EAAsBC,OAAtB,CAA8B,UAAUC,CAAV,EAAmB;IAC/C,IAAI,CAACA,CAAL,EAAQ;MACN;IACD;;IACD,MAAMb,CAAC,GAAGa,CAAC,CAACC,KAAF,CAAQ,mDAAR,CAAV;;IACA,IACE,CAACd,CAAD,IACAH,kBAAkB,CAACG,CAAC,CAAC,CAAD,CAAF,CAAlB,IAA4BS,WAD5B,IAECT,CAAC,CAAC,CAAD,CAAD,KAAS,EAAT,IAAeS,WAAW,KAAKC,QAHlC,EAIE;MACA,MAAMK,KAAK,CAAC,uBAAuBR,QAAxB,CAAX;IACD;;IACDE,WAAW,GAAGZ,kBAAkB,CAACG,CAAC,CAAC,CAAD,CAAF,CAAhC;IACAQ,MAAM,IAAIQ,MAAM,CAAChB,CAAC,CAAC,CAAD,CAAF,CAAN,GAAeH,kBAAkB,CAACG,CAAC,CAAC,CAAD,CAAF,CAA3C;EACD,CAdD;EAeA,OAAOQ,MAAP;AACD"}

package/build/{up-storage.d.ts → proxy.d.ts}

@@ -1,10 +1,14 @@
 /// <reference types="node" />
-import Stream from 'stream';
+/// <reference types="node" />
+import { Headers as gotHeaders } from 'got';
+import type { Agents, Options } from 'got';
+import Stream, { PassThrough } from 'stream';
 import { Headers } from 'undici';
 import { URL } from 'url';
 import { searchUtils } from '@verdaccio/core';
-import { ReadTarball } from '@verdaccio/streams';
-import { Callback, Config, IReadTarball, Logger, UpLinkConf } from '@verdaccio/types';
+import { Manifest } from '@verdaccio/types';
+import { Config, Logger, UpLinkConf } from '@verdaccio/types';
+import { AgentOptionsConf } from './agent';
 export declare type UpLinkConfLocal = UpLinkConf & {
     no_proxy?: string;
 };
@@ -30,9 +34,15 @@ export interface IProxy {
     max_fails: number;
     fail_timeout: number;
     upname: string;
-    fetchTarball(url: string): IReadTarball;
     search(options: ProxySearchParams): Promise<Stream.Readable>;
-    getRemoteMetadata(name: string, options: any, callback: Callback): void;
+    getRemoteMetadataNext(name: string, options: ISyncUplinksOptions): Promise<[Manifest, string]>;
+    fetchTarballNext(url: string, options: Pick<ISyncUplinksOptions, 'remoteAddress' | 'etag' | 'retry'>): PassThrough;
+}
+export { Options as FetchOptions };
+export interface ISyncUplinksOptions extends Options {
+    uplinksLook?: boolean;
+    etag?: string;
+    remoteAddress?: string;
 }
 /**
  * Implements Storage interface
@@ -50,38 +60,23 @@ declare class ProxyStorage implements IProxy {
     timeout: number;
     max_fails: number;
     fail_timeout: number;
-    agent_options: any;
+    agent_options: AgentOptionsConf;
     upname: string;
-    proxy: any;
+    proxy: string | undefined;
+    private agent;
     last_request_time: number | null;
     strict_ssl: boolean;
-    /**
-     * Constructor
-     * @param {*} config
-     * @param {*} mainConfig
-     */
-    constructor(config: UpLinkConfLocal, mainConfig: Config);
-    /**
-     * Fetch an asset.
-     * @param {*} options
-     * @param {*} cb
-     * @return {Request}
-     */
-    private request;
-    /**
-     * Set default headers.
-     * @param {Object} options
-     * @return {Object}
-     * @private
-     */
-    private _setHeaders;
+    private retry;
+    constructor(config: UpLinkConfLocal, mainConfig: Config, agent?: Agents);
+    private getAgent;
+    getHeadersNext(headers?: {}): gotHeaders;
     /**
      * Validate configuration auth and assign Header authorization
      * @param {Object} headers
      * @return {Object}
      * @private
      */
-    private _setAuth;
+    private setAuthNext;
     /**
      * @param {string} message
      * @throws {Error}
@@ -114,40 +109,19 @@ declare class ProxyStorage implements IProxy {
   
      * @param {Object} headers
      * @private
+     * @deprecated use applyUplinkHeaders
      */
     private _overrideWithUpLinkConfLocaligHeaders;
-    /**
-     * Get a remote package metadata
-     * @param {*} name package name
-     * @param {*} options request options, eg: eTag.
-     * @param {*} callback
-     */
-    getRemoteMetadata(name: string, options: any, callback: Callback): void;
-    /**
-     * Fetch a tarball from the uplink.
-     * @param {String} url
-     * @return {Stream}
-     */
-    fetchTarball(url: string): ReadTarball;
+    private applyUplinkHeaders;
+    getRemoteMetadataNext(name: string, options: ISyncUplinksOptions): Promise<[Manifest, string]>;
+    fetchTarballNext(url: string, overrideOptions: Pick<ISyncUplinksOptions, 'remoteAddress' | 'etag' | 'retry'>): any;
     /**
      * Perform a stream search.
      * @param {*} options request options
      * @return {Stream}
      */
     search({ url, abort }: ProxySearchParams): Promise<Stream.Readable>;
-    /**
-     * Add proxy headers.
-     * FIXME: object mutations, it should return an new object
-     * @param {*} req the http request
-     * @param {*} headers the request headers
-     */
-    private _addProxyHeaders;
-    /**
-     * Check whether the remote host is available.
-     * @param {*} alive
-     * @return {Boolean}
-     */
-    private _statusCheck;
+    private addProxyHeaders;
     /**
      * If the request failure.
      * @return {boolean}