@verdaccio/url 11.0.0-6-next.7 → 11.0.0-6-next.10

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Change Log
 
+## 11.0.0-6-next.10
+
+### 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/core@6.0.0-6-next.6
+
+## 11.0.0-6-next.9
+
+### Patch Changes
+
+- Updated dependencies [82cb0f2b]
+- Updated dependencies [5167bb52]
+  - @verdaccio/core@6.0.0-6-next.5
+
+## 11.0.0-6-next.8
+
+### Patch Changes
+
+- Updated dependencies [24b9be02]
+  - @verdaccio/core@6.0.0-6-next.4
+
 ## 11.0.0-6-next.7
 
 ### Patch Changes

package/build/index.d.ts

@@ -15,4 +15,12 @@ export declare function wrapPrefix(prefix: string | void): string;
  */
 export declare function combineBaseUrl(protocol: string, host: string, prefix?: string): string;
 export declare function validateURL(publicUrl: string | void): boolean;
-export declare function getPublicUrl(url_prefix: string | undefined, req: any): string;
+export declare type RequestOptions = {
+    host: string;
+    protocol: string;
+    headers: {
+        [key: string]: string;
+    };
+    remoteAddress?: string;
+};
+export declare function getPublicUrl(url_prefix: string | undefined, requestOptions: RequestOptions): string;

package/build/index.js

@@ -11,22 +11,16 @@ exports.isURLhasValidProtocol = isURLhasValidProtocol;
 exports.validateURL = validateURL;
 exports.wrapPrefix = wrapPrefix;
 
-var _url = require("url");
-
 var _debug = _interopRequireDefault(require("debug"));
 
+var _url = require("url");
+
 var _isURL = _interopRequireDefault(require("validator/lib/isURL"));
 
 var _core = require("@verdaccio/core");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 const debug = (0, _debug.default)('verdaccio:core:url');
 const validProtocols = ['https', 'http'];
 /**
@@ -39,14 +33,15 @@ function isURLhasValidProtocol(uri) {
 }
 
 function isHost(url = '', options = {}) {
-  return (0, _isURL.default)(url, _objectSpread({
+  return (0, _isURL.default)(url, {
     require_host: true,
     allow_trailing_dot: false,
     require_valid_protocol: false,
     // @ts-ignore
     require_port: false,
-    require_tld: false
-  }, options));
+    require_tld: false,
+    ...options
+  });
 }
 /**
  * Detect running protocol (http or https)
@@ -60,7 +55,7 @@ function getWebProtocol(headerProtocol, protocol) {
   if (typeof headerProtocol === 'string' && headerProtocol !== '') {
     debug('header protocol: %o', protocol);
     const commaIndex = headerProtocol.indexOf(',');
-    returnProtocol = commaIndex > 0 ? headerProtocol.substr(0, commaIndex) : headerProtocol;
+    returnProtocol = commaIndex > 0 ? headerProtocol.slice(0, commaIndex) : headerProtocol;
   } else {
     debug('req protocol: %o', headerProtocol);
     returnProtocol = protocol;
@@ -114,22 +109,23 @@ function validateURL(publicUrl) {
   }
 }
 
-function getPublicUrl(url_prefix = '', req) {
+function getPublicUrl(url_prefix = '', requestOptions) {
   if (validateURL(process.env.VERDACCIO_PUBLIC_URL)) {
     const envURL = new _url.URL(wrapPrefix(url_prefix), process.env.VERDACCIO_PUBLIC_URL).href;
     debug('public url by env %o', envURL);
     return envURL;
-  } else if (req.get('host')) {
+  } else if (requestOptions.headers['host']) {
     var _process$env$VERDACCI;
 
-    const host = req.get('host');
+    const host = requestOptions.headers['host'];
 
     if (!isHost(host)) {
       throw new Error('invalid host');
     }
 
-    const protoHeader = (_process$env$VERDACCI = process.env.VERDACCIO_FORWARDED_PROTO) !== null && _process$env$VERDACCI !== void 0 ? _process$env$VERDACCI : _core.HEADERS.FORWARDED_PROTO;
-    const protocol = getWebProtocol(req.get(protoHeader), req.protocol);
+    const protoHeader = ((_process$env$VERDACCI = process.env.VERDACCIO_FORWARDED_PROTO) === null || _process$env$VERDACCI === void 0 ? void 0 : _process$env$VERDACCI.toLocaleLowerCase()) ?? _core.HEADERS.FORWARDED_PROTO.toLowerCase();
+
+    const protocol = getWebProtocol(requestOptions.headers[protoHeader], requestOptions.protocol);
     const combinedUrl = combineBaseUrl(protocol, host, url_prefix);
     debug('public url by request %o', combinedUrl);
     return combinedUrl;

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":["debug","validProtocols","isURLhasValidProtocol","uri","test","isHost","url","options","require_host","allow_trailing_dot","require_valid_protocol","require_port","require_tld","getWebProtocol","headerProtocol","protocol","returnProtocol","defaultProtocol","commaIndex","indexOf","substr","includes","wrapPrefix","prefix","startsWith","endsWith","combineBaseUrl","host","newPrefix","groupedURI","URL","result","href","validateURL","publicUrl","parsed","replace","Error","err","getPublicUrl","url_prefix","req","process","env","VERDACCIO_PUBLIC_URL","envURL","get","protoHeader","VERDACCIO_FORWARDED_PROTO","HEADERS","FORWARDED_PROTO","combinedUrl"],"mappings":";;;;;;;;;;;;;AAAA;;AACA;;AACA;;AACA;;;;;;;;;;AAEA,MAAMA,KAAK,GAAG,oBAAW,oBAAX,CAAd;AAEA,MAAMC,cAAc,GAAG,CAAC,OAAD,EAAU,MAAV,CAAvB;AAEA;AACA;AACA;AACA;;AACO,SAASC,qBAAT,CAA+BC,GAA/B,EAAqD;AAC1D,SAAO,kBAAkBC,IAAlB,CAAuBD,GAAvB,CAAP;AACD;;AAEM,SAASE,MAAT,CAAgBC,GAAW,GAAG,EAA9B,EAAkCC,OAAO,GAAG,EAA5C,EAAyD;AAC9D,SAAO,oBAAeD,GAAf;AACLE,IAAAA,YAAY,EAAE,IADT;AAELC,IAAAA,kBAAkB,EAAE,KAFf;AAGLC,IAAAA,sBAAsB,EAAE,KAHnB;AAIL;AACAC,IAAAA,YAAY,EAAE,KALT;AAMLC,IAAAA,WAAW,EAAE;AANR,KAOFL,OAPE,EAAP;AASD;AAED;AACA;AACA;;;AACO,SAASM,cAAT,CAAwBC,cAAxB,EAAuDC,QAAvD,EAAiF;AACtF,MAAIC,cAAJ;AACA,QAAM,GAAGC,eAAH,IAAsBhB,cAA5B,CAFsF,CAGtF;;AACA,MAAI,OAAOa,cAAP,KAA0B,QAA1B,IAAsCA,cAAc,KAAK,EAA7D,EAAiE;AAC/Dd,IAAAA,KAAK,CAAC,qBAAD,EAAwBe,QAAxB,CAAL;AACA,UAAMG,UAAU,GAAGJ,cAAc,CAACK,OAAf,CAAuB,GAAvB,CAAnB;AACAH,IAAAA,cAAc,GAAGE,UAAU,GAAG,CAAb,GAAiBJ,cAAc,CAACM,MAAf,CAAsB,CAAtB,EAAyBF,UAAzB,CAAjB,GAAwDJ,cAAzE;AACD,GAJD,MAIO;AACLd,IAAAA,KAAK,CAAC,kBAAD,EAAqBc,cAArB,CAAL;AACAE,IAAAA,cAAc,GAAGD,QAAjB;AACD;;AAED,SAAOd,cAAc,CAACoB,QAAf,CAAwBL,cAAxB,IAA0CA,cAA1C,GAA2DC,eAAlE;AACD;;AAEM,SAASK,UAAT,CAAoBC,MAApB,EAAmD;AACxD,MAAIA,MAAM,KAAK,EAAX,IAAiB,OAAOA,MAAP,KAAkB,WAAnC,IAAkDA,MAAM,KAAK,IAAjE,EAAuE;AACrE,WAAO,EAAP;AACD,GAFD,MAEO,IAAI,CAACA,MAAM,CAACC,UAAP,CAAkB,GAAlB,CAAD,IAA2BD,MAAM,CAACE,QAAP,CAAgB,GAAhB,CAA/B,EAAqD;AAC1D,WAAQ,IAAGF,MAAO,EAAlB;AACD,GAFM,MAEA,IAAI,CAACA,MAAM,CAACC,UAAP,CAAkB,GAAlB,CAAD,IAA2B,CAACD,MAAM,CAACE,QAAP,CAAgB,GAAhB,CAAhC,EAAsD;AAC3D,WAAQ,IAAGF,MAAO,GAAlB;AACD,GAFM,MAEA,IAAIA,MAAM,CAACC,UAAP,CAAkB,GAAlB,KAA0B,CAACD,MAAM,CAACE,QAAP,CAAgB,GAAhB,CAA/B,EAAqD;AAC1D,WAAQ,GAAEF,MAAO,GAAjB;AACD,GAFM,MAEA;AACL,WAAOA,MAAP;AACD;AACF;AAED;AACA;AACA;AACA;;;AACO,SAASG,cAAT,CAAwBX,QAAxB,EAA0CY,IAA1C,EAAwDJ,MAAc,GAAG,EAAzE,EAAqF;AAC1FvB,EAAAA,KAAK,CAAC,sBAAD,EAAyBe,QAAzB,CAAL;AACAf,EAAAA,KAAK,CAAC,kBAAD,EAAqB2B,IAArB,CAAL;AACA,QAAMC,SAAS,GAAGN,UAAU,CAACC,MAAD,CAA5B;AACAvB,EAAAA,KAAK,CAAC,oBAAD,EAAuB4B,SAAvB,CAAL;AACA,QAAMC,UAAU,GAAG,IAAIC,QAAJ,CAAQR,UAAU,CAACC,MAAD,CAAlB,EAA6B,GAAER,QAAS,MAAKY,IAAK,EAAlD,CAAnB;AACA,QAAMI,MAAM,GAAGF,UAAU,CAACG,IAA1B;AACAhC,EAAAA,KAAK,CAAC,iBAAD,EAAoB+B,MAApB,CAAL;AACA,SAAOA,MAAP;AACD;;AAEM,SAASE,WAAT,CAAqBC,SAArB,EAA+C;AACpD,MAAI;AACF,UAAMC,MAAM,GAAG,IAAIL,QAAJ,CAAQI,SAAR,CAAf;;AACA,QAAI,CAACjC,cAAc,CAACoB,QAAf,CAAwBc,MAAM,CAACpB,QAAP,CAAgBqB,OAAhB,CAAwB,GAAxB,EAA6B,EAA7B,CAAxB,CAAL,EAAgE;AAC9D,YAAMC,KAAK,CAAC,kBAAD,CAAX;AACD;;AACD,WAAO,IAAP;AACD,GAND,CAME,OAAOC,GAAP,EAAiB;AACjB;AACA,WAAO,KAAP;AACD;AACF;;AAEM,SAASC,YAAT,CAAsBC,UAAkB,GAAG,EAA3C,EAA+CC,GAA/C,EAA4D;AACjE,MAAIR,WAAW,CAACS,OAAO,CAACC,GAAR,CAAYC,oBAAb,CAAf,EAA6D;AAC3D,UAAMC,MAAM,GAAG,IAAIf,QAAJ,CAAQR,UAAU,CAACkB,UAAD,CAAlB,EAAgCE,OAAO,CAACC,GAAR,CAAYC,oBAA5C,EAA4EZ,IAA3F;AACAhC,IAAAA,KAAK,CAAC,sBAAD,EAAyB6C,MAAzB,CAAL;AACA,WAAOA,MAAP;AACD,GAJD,MAIO,IAAIJ,GAAG,CAACK,GAAJ,CAAQ,MAAR,CAAJ,EAAqB;AAAA;;AAC1B,UAAMnB,IAAI,GAAGc,GAAG,CAACK,GAAJ,CAAQ,MAAR,CAAb;;AACA,QAAI,CAACzC,MAAM,CAACsB,IAAD,CAAX,EAAmB;AACjB,YAAM,IAAIU,KAAJ,CAAU,cAAV,CAAN;AACD;;AACD,UAAMU,WAAW,4BAAGL,OAAO,CAACC,GAAR,CAAYK,yBAAf,yEAA4CC,cAAQC,eAArE;AACA,UAAMnC,QAAQ,GAAGF,cAAc,CAAC4B,GAAG,CAACK,GAAJ,CAAQC,WAAR,CAAD,EAAuBN,GAAG,CAAC1B,QAA3B,CAA/B;AACA,UAAMoC,WAAW,GAAGzB,cAAc,CAACX,QAAD,EAAWY,IAAX,EAAiBa,UAAjB,CAAlC;AACAxC,IAAAA,KAAK,CAAC,0BAAD,EAA6BmD,WAA7B,CAAL;AACA,WAAOA,WAAP;AACD,GAVM,MAUA;AACL,WAAO,GAAP;AACD;AACF","sourcesContent":["import { URL } from 'url';\nimport buildDebug from 'debug';\nimport isURLValidator from 'validator/lib/isURL';\nimport { HEADERS } from '@verdaccio/core';\n\nconst debug = buildDebug('verdaccio:core:url');\n\nconst validProtocols = ['https', 'http'];\n\n/**\n * Check if URI is starting with \"http://\", \"https://\" or \"//\"\n * @param {string} uri\n */\nexport function isURLhasValidProtocol(uri: string): boolean {\n  return /^(https?:)?\\/\\//.test(uri);\n}\n\nexport function isHost(url: string = '', options = {}): boolean {\n  return isURLValidator(url, {\n    require_host: true,\n    allow_trailing_dot: false,\n    require_valid_protocol: false,\n    // @ts-ignore\n    require_port: false,\n    require_tld: false,\n    ...options,\n  });\n}\n\n/**\n * Detect running protocol (http or https)\n */\nexport function getWebProtocol(headerProtocol: string | void, protocol: string): string {\n  let returnProtocol;\n  const [, defaultProtocol] = validProtocols;\n  // HAProxy variant might return http,http with X-Forwarded-Proto\n  if (typeof headerProtocol === 'string' && headerProtocol !== '') {\n    debug('header protocol: %o', protocol);\n    const commaIndex = headerProtocol.indexOf(',');\n    returnProtocol = commaIndex > 0 ? headerProtocol.substr(0, commaIndex) : headerProtocol;\n  } else {\n    debug('req protocol: %o', headerProtocol);\n    returnProtocol = protocol;\n  }\n\n  return validProtocols.includes(returnProtocol) ? returnProtocol : defaultProtocol;\n}\n\nexport function wrapPrefix(prefix: string | void): string {\n  if (prefix === '' || typeof prefix === 'undefined' || prefix === null) {\n    return '';\n  } else if (!prefix.startsWith('/') && prefix.endsWith('/')) {\n    return `/${prefix}`;\n  } else if (!prefix.startsWith('/') && !prefix.endsWith('/')) {\n    return `/${prefix}/`;\n  } else if (prefix.startsWith('/') && !prefix.endsWith('/')) {\n    return `${prefix}/`;\n  } else {\n    return prefix;\n  }\n}\n\n/**\n * Create base url for registry.\n * @return {String} base registry url\n */\nexport function combineBaseUrl(protocol: string, host: string, prefix: string = ''): string {\n  debug('combined protocol %o', protocol);\n  debug('combined host %o', host);\n  const newPrefix = wrapPrefix(prefix);\n  debug('combined prefix %o', newPrefix);\n  const groupedURI = new URL(wrapPrefix(prefix), `${protocol}://${host}`);\n  const result = groupedURI.href;\n  debug('combined url %o', result);\n  return result;\n}\n\nexport function validateURL(publicUrl: string | void) {\n  try {\n    const parsed = new URL(publicUrl as string);\n    if (!validProtocols.includes(parsed.protocol.replace(':', ''))) {\n      throw Error('invalid protocol');\n    }\n    return true;\n  } catch (err: any) {\n    // TODO: add error logger here\n    return false;\n  }\n}\n\nexport function getPublicUrl(url_prefix: string = '', req): string {\n  if (validateURL(process.env.VERDACCIO_PUBLIC_URL as string)) {\n    const envURL = new URL(wrapPrefix(url_prefix), process.env.VERDACCIO_PUBLIC_URL as string).href;\n    debug('public url by env %o', envURL);\n    return envURL;\n  } else if (req.get('host')) {\n    const host = req.get('host');\n    if (!isHost(host)) {\n      throw new Error('invalid host');\n    }\n    const protoHeader = process.env.VERDACCIO_FORWARDED_PROTO ?? HEADERS.FORWARDED_PROTO;\n    const protocol = getWebProtocol(req.get(protoHeader), req.protocol);\n    const combinedUrl = combineBaseUrl(protocol, host, url_prefix);\n    debug('public url by request %o', combinedUrl);\n    return combinedUrl;\n  } else {\n    return '/';\n  }\n}\n"],"file":"index.js"}
+{"version":3,"file":"index.js","names":["debug","buildDebug","validProtocols","isURLhasValidProtocol","uri","test","isHost","url","options","isURLValidator","require_host","allow_trailing_dot","require_valid_protocol","require_port","require_tld","getWebProtocol","headerProtocol","protocol","returnProtocol","defaultProtocol","commaIndex","indexOf","slice","includes","wrapPrefix","prefix","startsWith","endsWith","combineBaseUrl","host","newPrefix","groupedURI","URL","result","href","validateURL","publicUrl","parsed","replace","Error","err","getPublicUrl","url_prefix","requestOptions","process","env","VERDACCIO_PUBLIC_URL","envURL","headers","protoHeader","VERDACCIO_FORWARDED_PROTO","toLocaleLowerCase","HEADERS","FORWARDED_PROTO","toLowerCase","combinedUrl"],"sources":["../src/index.ts"],"sourcesContent":["import buildDebug from 'debug';\nimport { URL } from 'url';\nimport isURLValidator from 'validator/lib/isURL';\n\nimport { HEADERS } from '@verdaccio/core';\n\nconst debug = buildDebug('verdaccio:core:url');\n\nconst validProtocols = ['https', 'http'];\n\n/**\n * Check if URI is starting with \"http://\", \"https://\" or \"//\"\n * @param {string} uri\n */\nexport function isURLhasValidProtocol(uri: string): boolean {\n  return /^(https?:)?\\/\\//.test(uri);\n}\n\nexport function isHost(url: string = '', options = {}): boolean {\n  return isURLValidator(url, {\n    require_host: true,\n    allow_trailing_dot: false,\n    require_valid_protocol: false,\n    // @ts-ignore\n    require_port: false,\n    require_tld: false,\n    ...options,\n  });\n}\n\n/**\n * Detect running protocol (http or https)\n */\nexport function getWebProtocol(headerProtocol: string | void, protocol: string): string {\n  let returnProtocol;\n  const [, defaultProtocol] = validProtocols;\n  // HAProxy variant might return http,http with X-Forwarded-Proto\n  if (typeof headerProtocol === 'string' && headerProtocol !== '') {\n    debug('header protocol: %o', protocol);\n    const commaIndex = headerProtocol.indexOf(',');\n    returnProtocol = commaIndex > 0 ? headerProtocol.slice(0, commaIndex) : headerProtocol;\n  } else {\n    debug('req protocol: %o', headerProtocol);\n    returnProtocol = protocol;\n  }\n\n  return validProtocols.includes(returnProtocol) ? returnProtocol : defaultProtocol;\n}\n\nexport function wrapPrefix(prefix: string | void): string {\n  if (prefix === '' || typeof prefix === 'undefined' || prefix === null) {\n    return '';\n  } else if (!prefix.startsWith('/') && prefix.endsWith('/')) {\n    return `/${prefix}`;\n  } else if (!prefix.startsWith('/') && !prefix.endsWith('/')) {\n    return `/${prefix}/`;\n  } else if (prefix.startsWith('/') && !prefix.endsWith('/')) {\n    return `${prefix}/`;\n  } else {\n    return prefix;\n  }\n}\n\n/**\n * Create base url for registry.\n * @return {String} base registry url\n */\nexport function combineBaseUrl(protocol: string, host: string, prefix: string = ''): string {\n  debug('combined protocol %o', protocol);\n  debug('combined host %o', host);\n  const newPrefix = wrapPrefix(prefix);\n  debug('combined prefix %o', newPrefix);\n  const groupedURI = new URL(wrapPrefix(prefix), `${protocol}://${host}`);\n  const result = groupedURI.href;\n  debug('combined url %o', result);\n  return result;\n}\n\nexport function validateURL(publicUrl: string | void) {\n  try {\n    const parsed = new URL(publicUrl as string);\n    if (!validProtocols.includes(parsed.protocol.replace(':', ''))) {\n      throw Error('invalid protocol');\n    }\n    return true;\n  } catch (err: any) {\n    // TODO: add error logger here\n    return false;\n  }\n}\n\nexport type RequestOptions = {\n  host: string;\n  protocol: string;\n  headers: { [key: string]: string };\n  remoteAddress?: string;\n};\n\nexport function getPublicUrl(url_prefix: string = '', requestOptions: RequestOptions): string {\n  if (validateURL(process.env.VERDACCIO_PUBLIC_URL as string)) {\n    const envURL = new URL(wrapPrefix(url_prefix), process.env.VERDACCIO_PUBLIC_URL as string).href;\n    debug('public url by env %o', envURL);\n    return envURL;\n  } else if (requestOptions.headers['host']) {\n    const host = requestOptions.headers['host'];\n    if (!isHost(host)) {\n      throw new Error('invalid host');\n    }\n    const protoHeader =\n      process.env.VERDACCIO_FORWARDED_PROTO?.toLocaleLowerCase() ??\n      HEADERS.FORWARDED_PROTO.toLowerCase();\n    const protocol = getWebProtocol(requestOptions.headers[protoHeader], requestOptions.protocol);\n    const combinedUrl = combineBaseUrl(protocol, host, url_prefix);\n    debug('public url by request %o', combinedUrl);\n    return combinedUrl;\n  } else {\n    return '/';\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAAA;;AACA;;AACA;;AAEA;;;;AAEA,MAAMA,KAAK,GAAG,IAAAC,cAAA,EAAW,oBAAX,CAAd;AAEA,MAAMC,cAAc,GAAG,CAAC,OAAD,EAAU,MAAV,CAAvB;AAEA;AACA;AACA;AACA;;AACO,SAASC,qBAAT,CAA+BC,GAA/B,EAAqD;EAC1D,OAAO,kBAAkBC,IAAlB,CAAuBD,GAAvB,CAAP;AACD;;AAEM,SAASE,MAAT,CAAgBC,GAAW,GAAG,EAA9B,EAAkCC,OAAO,GAAG,EAA5C,EAAyD;EAC9D,OAAO,IAAAC,cAAA,EAAeF,GAAf,EAAoB;IACzBG,YAAY,EAAE,IADW;IAEzBC,kBAAkB,EAAE,KAFK;IAGzBC,sBAAsB,EAAE,KAHC;IAIzB;IACAC,YAAY,EAAE,KALW;IAMzBC,WAAW,EAAE,KANY;IAOzB,GAAGN;EAPsB,CAApB,CAAP;AASD;AAED;AACA;AACA;;;AACO,SAASO,cAAT,CAAwBC,cAAxB,EAAuDC,QAAvD,EAAiF;EACtF,IAAIC,cAAJ;EACA,MAAM,GAAGC,eAAH,IAAsBjB,cAA5B,CAFsF,CAGtF;;EACA,IAAI,OAAOc,cAAP,KAA0B,QAA1B,IAAsCA,cAAc,KAAK,EAA7D,EAAiE;IAC/DhB,KAAK,CAAC,qBAAD,EAAwBiB,QAAxB,CAAL;IACA,MAAMG,UAAU,GAAGJ,cAAc,CAACK,OAAf,CAAuB,GAAvB,CAAnB;IACAH,cAAc,GAAGE,UAAU,GAAG,CAAb,GAAiBJ,cAAc,CAACM,KAAf,CAAqB,CAArB,EAAwBF,UAAxB,CAAjB,GAAuDJ,cAAxE;EACD,CAJD,MAIO;IACLhB,KAAK,CAAC,kBAAD,EAAqBgB,cAArB,CAAL;IACAE,cAAc,GAAGD,QAAjB;EACD;;EAED,OAAOf,cAAc,CAACqB,QAAf,CAAwBL,cAAxB,IAA0CA,cAA1C,GAA2DC,eAAlE;AACD;;AAEM,SAASK,UAAT,CAAoBC,MAApB,EAAmD;EACxD,IAAIA,MAAM,KAAK,EAAX,IAAiB,OAAOA,MAAP,KAAkB,WAAnC,IAAkDA,MAAM,KAAK,IAAjE,EAAuE;IACrE,OAAO,EAAP;EACD,CAFD,MAEO,IAAI,CAACA,MAAM,CAACC,UAAP,CAAkB,GAAlB,CAAD,IAA2BD,MAAM,CAACE,QAAP,CAAgB,GAAhB,CAA/B,EAAqD;IAC1D,OAAQ,IAAGF,MAAO,EAAlB;EACD,CAFM,MAEA,IAAI,CAACA,MAAM,CAACC,UAAP,CAAkB,GAAlB,CAAD,IAA2B,CAACD,MAAM,CAACE,QAAP,CAAgB,GAAhB,CAAhC,EAAsD;IAC3D,OAAQ,IAAGF,MAAO,GAAlB;EACD,CAFM,MAEA,IAAIA,MAAM,CAACC,UAAP,CAAkB,GAAlB,KAA0B,CAACD,MAAM,CAACE,QAAP,CAAgB,GAAhB,CAA/B,EAAqD;IAC1D,OAAQ,GAAEF,MAAO,GAAjB;EACD,CAFM,MAEA;IACL,OAAOA,MAAP;EACD;AACF;AAED;AACA;AACA;AACA;;;AACO,SAASG,cAAT,CAAwBX,QAAxB,EAA0CY,IAA1C,EAAwDJ,MAAc,GAAG,EAAzE,EAAqF;EAC1FzB,KAAK,CAAC,sBAAD,EAAyBiB,QAAzB,CAAL;EACAjB,KAAK,CAAC,kBAAD,EAAqB6B,IAArB,CAAL;EACA,MAAMC,SAAS,GAAGN,UAAU,CAACC,MAAD,CAA5B;EACAzB,KAAK,CAAC,oBAAD,EAAuB8B,SAAvB,CAAL;EACA,MAAMC,UAAU,GAAG,IAAIC,QAAJ,CAAQR,UAAU,CAACC,MAAD,CAAlB,EAA6B,GAAER,QAAS,MAAKY,IAAK,EAAlD,CAAnB;EACA,MAAMI,MAAM,GAAGF,UAAU,CAACG,IAA1B;EACAlC,KAAK,CAAC,iBAAD,EAAoBiC,MAApB,CAAL;EACA,OAAOA,MAAP;AACD;;AAEM,SAASE,WAAT,CAAqBC,SAArB,EAA+C;EACpD,IAAI;IACF,MAAMC,MAAM,GAAG,IAAIL,QAAJ,CAAQI,SAAR,CAAf;;IACA,IAAI,CAAClC,cAAc,CAACqB,QAAf,CAAwBc,MAAM,CAACpB,QAAP,CAAgBqB,OAAhB,CAAwB,GAAxB,EAA6B,EAA7B,CAAxB,CAAL,EAAgE;MAC9D,MAAMC,KAAK,CAAC,kBAAD,CAAX;IACD;;IACD,OAAO,IAAP;EACD,CAND,CAME,OAAOC,GAAP,EAAiB;IACjB;IACA,OAAO,KAAP;EACD;AACF;;AASM,SAASC,YAAT,CAAsBC,UAAkB,GAAG,EAA3C,EAA+CC,cAA/C,EAAuF;EAC5F,IAAIR,WAAW,CAACS,OAAO,CAACC,GAAR,CAAYC,oBAAb,CAAf,EAA6D;IAC3D,MAAMC,MAAM,GAAG,IAAIf,QAAJ,CAAQR,UAAU,CAACkB,UAAD,CAAlB,EAAgCE,OAAO,CAACC,GAAR,CAAYC,oBAA5C,EAA4EZ,IAA3F;IACAlC,KAAK,CAAC,sBAAD,EAAyB+C,MAAzB,CAAL;IACA,OAAOA,MAAP;EACD,CAJD,MAIO,IAAIJ,cAAc,CAACK,OAAf,CAAuB,MAAvB,CAAJ,EAAoC;IAAA;;IACzC,MAAMnB,IAAI,GAAGc,cAAc,CAACK,OAAf,CAAuB,MAAvB,CAAb;;IACA,IAAI,CAAC1C,MAAM,CAACuB,IAAD,CAAX,EAAmB;MACjB,MAAM,IAAIU,KAAJ,CAAU,cAAV,CAAN;IACD;;IACD,MAAMU,WAAW,GACf,0BAAAL,OAAO,CAACC,GAAR,CAAYK,yBAAZ,gFAAuCC,iBAAvC,OACAC,aAAA,CAAQC,eAAR,CAAwBC,WAAxB,EAFF;;IAGA,MAAMrC,QAAQ,GAAGF,cAAc,CAAC4B,cAAc,CAACK,OAAf,CAAuBC,WAAvB,CAAD,EAAsCN,cAAc,CAAC1B,QAArD,CAA/B;IACA,MAAMsC,WAAW,GAAG3B,cAAc,CAACX,QAAD,EAAWY,IAAX,EAAiBa,UAAjB,CAAlC;IACA1C,KAAK,CAAC,0BAAD,EAA6BuD,WAA7B,CAAL;IACA,OAAOA,WAAP;EACD,CAZM,MAYA;IACL,OAAO,GAAP;EACD;AACF"}

package/package.json

@@ -1,59 +1,60 @@
 {
-	"name": "@verdaccio/url",
-	"version": "11.0.0-6-next.7",
-	"description": "url utilities resolver",
-	"keywords": [
-		"private",
-		"package",
-		"repository",
-		"registry",
-		"enterprise",
-		"modules",
-		"proxy",
-		"server",
-		"verdaccio"
-	],
-	"main": "./build/index.js",
-	"types": "./build/index.d.ts",
-	"author": "Juan Picado <juanpicado19@gmail.com>",
-	"license": "MIT",
-	"homepage": "https://verdaccio.org",
-	"engines": {
-		"node": ">=14",
-		"npm": ">=6"
-	},
-	"repository": {
-		"type": "https",
-		"url": "https://github.com/verdaccio/verdaccio",
-		"directory": "packages/core/url-resolver"
-	},
-	"bugs": {
-		"url": "https://github.com/verdaccio/verdaccio/issues"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"dependencies": {
-		"@verdaccio/core": "6.0.0-6-next.3",
-		"debug": "4.3.2",
-		"lodash": "4.17.21",
-		"validator": "13.6.0"
-	},
-	"devDependencies": {
-		"@verdaccio/types": "11.0.0-6-next.9",
-		"node-mocks-http": "1.10.1"
-	},
-	"funding": {
-		"type": "opencollective",
-		"url": "https://opencollective.com/verdaccio"
-	},
-	"scripts": {
-		"clean": "rimraf ./build",
-		"test": "cross-env NODE_ENV=test BABEL_ENV=test jest",
-		"type-check": "tsc --noEmit -p tsconfig.build.json",
-		"build:types": "tsc --emitDeclarationOnly -p tsconfig.build.json",
-		"build:js": "babel src/ --out-dir build/ --copy-files --extensions \".ts,.tsx\" --source-maps",
-		"watch": "pnpm build:js -- --watch",
-		"build": "pnpm run build:js && pnpm run build:types"
-	}
-}
+  "name": "@verdaccio/url",
+  "version": "11.0.0-6-next.10",
+  "description": "url utilities resolver",
+  "keywords": [
+    "private",
+    "package",
+    "repository",
+    "registry",
+    "enterprise",
+    "modules",
+    "proxy",
+    "server",
+    "verdaccio"
+  ],
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "author": "Juan Picado <juanpicado19@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://verdaccio.org",
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6"
+  },
+  "repository": {
+    "type": "https",
+    "url": "https://github.com/verdaccio/verdaccio",
+    "directory": "packages/core/url-resolver"
+  },
+  "bugs": {
+    "url": "https://github.com/verdaccio/verdaccio/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@verdaccio/core": "6.0.0-6-next.6",
+    "debug": "4.3.4",
+    "lodash": "4.17.21",
+    "validator": "13.7.0"
+  },
+  "devDependencies": {
+    "@verdaccio/types": "11.0.0-6-next.13",
+    "node-mocks-http": "1.11.0"
+  },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/verdaccio"
+  },
+  "scripts": {
+    "clean": "rimraf ./build",
+    "test": "jest",
+    "type-check": "tsc --noEmit -p tsconfig.build.json",
+    "build:types": "tsc --emitDeclarationOnly -p tsconfig.build.json",
+    "build:js": "babel src/ --out-dir build/ --copy-files --extensions \".ts,.tsx\" --source-maps",
+    "watch": "pnpm build:js -- --watch",
+    "build": "pnpm run build:js && pnpm run build:types"
+  },
+  "readme": "# Streams\n\n[![CircleCI](https://circleci.com/gh/verdaccio/streams.svg?style=svg)](https://circleci.com/gh/ayusharma/@verdaccio/streams)\n[![codecov](https://codecov.io/gh/verdaccio/streams/branch/master/graph/badge.svg)](https://codecov.io/gh/verdaccio/streams)\n[![verdaccio (latest)](https://img.shields.io/npm/v/@verdaccio/streams/latest.svg)](https://www.npmjs.com/package/@verdaccio/streams)\n[![backers](https://opencollective.com/verdaccio/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/verdaccio)\n[![discord](https://img.shields.io/discord/388674437219745793.svg)](http://chat.verdaccio.org/)\n![MIT](https://img.shields.io/github/license/mashape/apistatus.svg)\n[![node](https://img.shields.io/node/v/@verdaccio/streams/latest.svg)](https://www.npmjs.com/package/@verdaccio/streams)\n\nThis project provides an extension of `PassThrough` stream.\n\n## Detail\n\nIt provides 2 additional methods `abort()` and `done()`. Those implementations are widely use in the verdaccio core for handle `tarballs`.\n\n## License\n\nMIT (http://www.opensource.org/licenses/mit-license.php)\n"
+}

package/src/index.ts

@@ -1,6 +1,7 @@
-import { URL } from 'url';
 import buildDebug from 'debug';
+import { URL } from 'url';
 import isURLValidator from 'validator/lib/isURL';
+
 import { HEADERS } from '@verdaccio/core';
 
 const debug = buildDebug('verdaccio:core:url');
@@ -37,7 +38,7 @@ export function getWebProtocol(headerProtocol: string | void, protocol: string):
   if (typeof headerProtocol === 'string' && headerProtocol !== '') {
     debug('header protocol: %o', protocol);
     const commaIndex = headerProtocol.indexOf(',');
-    returnProtocol = commaIndex > 0 ? headerProtocol.substr(0, commaIndex) : headerProtocol;
+    returnProtocol = commaIndex > 0 ? headerProtocol.slice(0, commaIndex) : headerProtocol;
   } else {
     debug('req protocol: %o', headerProtocol);
     returnProtocol = protocol;
@@ -88,18 +89,27 @@ export function validateURL(publicUrl: string | void) {
   }
 }
 
-export function getPublicUrl(url_prefix: string = '', req): string {
+export type RequestOptions = {
+  host: string;
+  protocol: string;
+  headers: { [key: string]: string };
+  remoteAddress?: string;
+};
+
+export function getPublicUrl(url_prefix: string = '', requestOptions: RequestOptions): string {
   if (validateURL(process.env.VERDACCIO_PUBLIC_URL as string)) {
     const envURL = new URL(wrapPrefix(url_prefix), process.env.VERDACCIO_PUBLIC_URL as string).href;
     debug('public url by env %o', envURL);
     return envURL;
-  } else if (req.get('host')) {
-    const host = req.get('host');
+  } else if (requestOptions.headers['host']) {
+    const host = requestOptions.headers['host'];
     if (!isHost(host)) {
       throw new Error('invalid host');
     }
-    const protoHeader = process.env.VERDACCIO_FORWARDED_PROTO ?? HEADERS.FORWARDED_PROTO;
-    const protocol = getWebProtocol(req.get(protoHeader), req.protocol);
+    const protoHeader =
+      process.env.VERDACCIO_FORWARDED_PROTO?.toLocaleLowerCase() ??
+      HEADERS.FORWARDED_PROTO.toLowerCase();
+    const protocol = getWebProtocol(requestOptions.headers[protoHeader], requestOptions.protocol);
     const combinedUrl = combineBaseUrl(protocol, host, url_prefix);
     debug('public url by request %o', combinedUrl);
     return combinedUrl;

package/tests/getPublicUrl.spec.ts

@@ -1,6 +1,7 @@
 import * as httpMocks from 'node-mocks-http';
 
 import { HEADERS } from '@verdaccio/core';
+
 import { getPublicUrl } from '../src';
 
 describe('host', () => {
@@ -11,7 +12,13 @@ describe('host', () => {
       method: 'GET',
       url: '/',
     });
-    expect(getPublicUrl(undefined, req)).toEqual('/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('/');
   });
 
   test('get a valid host', () => {
@@ -22,7 +29,13 @@ describe('host', () => {
       },
       url: '/',
     });
-    expect(getPublicUrl(undefined, req)).toEqual('http://some.com/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('http://some.com/');
   });
 
   test('check a valid host header injection', () => {
@@ -31,11 +44,15 @@ describe('host', () => {
       headers: {
         host: `some.com"><svg onload="alert(1)">`,
       },
+      hostname: `some.com"><svg onload="alert(1)">`,
       url: '/',
     });
     expect(function () {
-      // @ts-expect-error
-      getPublicUrl({}, req);
+      getPublicUrl('', {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      });
     }).toThrow('invalid host');
   });
 
@@ -48,7 +65,13 @@ describe('host', () => {
       url: '/',
     });
 
-    expect(getPublicUrl('/prefix/', req)).toEqual('http://some.com/prefix/');
+    expect(
+      getPublicUrl('/prefix/', {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('http://some.com/prefix/');
   });
 
   test('get a valid host with prefix no trailing', () => {
@@ -60,7 +83,13 @@ describe('host', () => {
       url: '/',
     });
 
-    expect(getPublicUrl('/prefix-no-trailing', req)).toEqual('http://some.com/prefix-no-trailing/');
+    expect(
+      getPublicUrl('/prefix-no-trailing', {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('http://some.com/prefix-no-trailing/');
   });
 
   test('get a valid host with null prefix', () => {
@@ -72,7 +101,13 @@ describe('host', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(null, req)).toEqual('http://some.com/');
+    expect(
+      getPublicUrl(null, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('http://some.com/');
   });
 });
 
@@ -87,7 +122,13 @@ describe('X-Forwarded-Proto', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('https://some.com/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('https://some.com/');
   });
 
   test('with a invalid X-Forwarded-Proto https', () => {
@@ -100,7 +141,13 @@ describe('X-Forwarded-Proto', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('http://some.com/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('http://some.com/');
   });
 
   test('with a HAProxy X-Forwarded-Proto https', () => {
@@ -113,7 +160,13 @@ describe('X-Forwarded-Proto', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('https://some.com/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('https://some.com/');
   });
 
   test('with a HAProxy X-Forwarded-Proto different protocol', () => {
@@ -126,7 +179,13 @@ describe('X-Forwarded-Proto', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('http://some.com/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('http://some.com/');
   });
 });
 
@@ -142,7 +201,13 @@ describe('env variable', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('https://env.domain.com/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('https://env.domain.com/');
     delete process.env.VERDACCIO_PUBLIC_URL;
   });
 
@@ -157,7 +222,13 @@ describe('env variable', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('https://env.domain.com/urlPrefix/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('https://env.domain.com/urlPrefix/');
     delete process.env.VERDACCIO_PUBLIC_URL;
   });
 
@@ -172,7 +243,13 @@ describe('env variable', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('https://env.domain.com/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('https://env.domain.com/');
     delete process.env.VERDACCIO_PUBLIC_URL;
   });
 
@@ -187,7 +264,13 @@ describe('env variable', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('http://some.com/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('http://some.com/');
     delete process.env.VERDACCIO_PUBLIC_URL;
   });
 
@@ -202,7 +285,13 @@ describe('env variable', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('http://some.com/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('http://some.com/');
     delete process.env.VERDACCIO_PUBLIC_URL;
   });
 
@@ -217,7 +306,13 @@ describe('env variable', () => {
       url: '/',
     });
 
-    expect(getPublicUrl(undefined, req)).toEqual('http://some/');
+    expect(
+      getPublicUrl(undefined, {
+        host: req.hostname,
+        headers: req.headers as any,
+        protocol: req.protocol,
+      })
+    ).toEqual('http://some/');
     delete process.env.VERDACCIO_PUBLIC_URL;
   });
 });