@verdaccio/proxy 6.0.0-6-next.20 → 6.0.0-6-next.21

package/build/up-storage.js

@@ -1,691 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ProxyStorage = void 0;
-
-var _JSONStream = _interopRequireDefault(require("JSONStream"));
-
-var _debug = _interopRequireDefault(require("debug"));
-
-var _lodash = _interopRequireDefault(require("lodash"));
-
-var _request = _interopRequireDefault(require("request"));
-
-var _stream = _interopRequireWildcard(require("stream"));
-
-var _undici = require("undici");
-
-var _url = require("url");
-
-var _core = require("@verdaccio/core");
-
-var _streams = require("@verdaccio/streams");
-
-var _utils = require("@verdaccio/utils");
-
-var _proxyUtils = require("./proxy-utils");
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/* global AbortController */
-const LoggerApi = require('@verdaccio/logger');
-
-const debug = (0, _debug.default)('verdaccio:proxy');
-
-const encode = function (thing) {
-  return encodeURIComponent(thing).replace(/^%40/, '@');
-};
-
-const jsonContentType = _core.HEADERS.JSON;
-const contentTypeAccept = `${jsonContentType};`;
-/**
- * Just a helper (`config[key] || default` doesn't work because of zeroes)
- */
-
-const setConfig = (config, key, def) => {
-  return _lodash.default.isNil(config[key]) === false ? config[key] : def;
-};
-
-/**
- * Implements Storage interface
- * (same for storage.js, local-storage.js, up-storage.js)
- */
-class ProxyStorage {
-  // FIXME: upname is assigned to each instance
-  // @ts-ignore
-  // FIXME: proxy can be boolean or object, something smells here
-  // @ts-ignore
-  // @ts-ignore
-
-  /**
-   * Constructor
-   * @param {*} config
-   * @param {*} mainConfig
-   */
-  constructor(config, mainConfig) {
-    this.config = config;
-    this.failed_requests = 0;
-    this.userAgent = mainConfig.user_agent;
-    this.ca = config.ca;
-    this.logger = LoggerApi.logger.child({
-      sub: 'out'
-    });
-    this.server_id = mainConfig.server_id;
-    this.url = new _url.URL(this.config.url);
-
-    this._setupProxy(this.url.hostname, config, mainConfig, this.url.protocol === 'https:');
-
-    this.config.url = this.config.url.replace(/\/$/, '');
-
-    if (this.config.timeout && Number(this.config.timeout) >= 1000) {
-      this.logger.warn(['Too big timeout value: ' + this.config.timeout, 'We changed time format to nginx-like one', '(see http://nginx.org/en/docs/syntax.html)', 'so please update your config accordingly'].join('\n'));
-    } // a bunch of different configurable timers
-
-
-    this.maxage = (0, _proxyUtils.parseInterval)(setConfig(this.config, 'maxage', '2m'));
-    this.timeout = (0, _proxyUtils.parseInterval)(setConfig(this.config, 'timeout', '30s'));
-    this.max_fails = Number(setConfig(this.config, 'max_fails', 2));
-    this.fail_timeout = (0, _proxyUtils.parseInterval)(setConfig(this.config, 'fail_timeout', '5m'));
-    this.strict_ssl = Boolean(setConfig(this.config, 'strict_ssl', true));
-    this.agent_options = setConfig(this.config, 'agent_options', {
-      keepAlive: true,
-      maxSockets: 40,
-      maxFreeSockets: 10
-    });
-  }
-  /**
-   * Fetch an asset.
-   * @param {*} options
-   * @param {*} cb
-   * @return {Request}
-   */
-
-
-  request(options, cb) {
-    let json;
-
-    if (this._statusCheck() === false) {
-      const streamRead = new _stream.default.Readable();
-      process.nextTick(function () {
-        if (cb) {
-          cb(_core.errorUtils.getInternalError(_core.errorUtils.API_ERROR.UPLINK_OFFLINE));
-        }
-
-        streamRead.emit('error', _core.errorUtils.getInternalError(_core.errorUtils.API_ERROR.UPLINK_OFFLINE));
-      });
-
-      streamRead._read = function () {}; // preventing 'Uncaught, unspecified "error" event'
-
-
-      streamRead.on('error', function () {});
-      return streamRead;
-    }
-
-    const self = this;
-
-    const headers = this._setHeaders(options);
-
-    this._addProxyHeaders(options.req, headers);
-
-    this._overrideWithUpLinkConfLocaligHeaders(headers);
-
-    const method = options.method || 'GET';
-    const uri = options.uri_full || this.config.url + options.uri;
-    self.logger.info({
-      method: method,
-      headers: headers,
-      uri: uri
-    }, "making request: '@{method} @{uri}'");
-
-    if (_core.validatioUtils.isObject(options.json)) {
-      json = JSON.stringify(options.json);
-      headers['Content-Type'] = headers['Content-Type'] || _core.HEADERS.JSON;
-    }
-
-    const requestCallback = cb ? function (err, res, body) {
-      let error;
-      const responseLength = err ? 0 : body.length; // $FlowFixMe
-
-      processBody();
-      logActivity(); // $FlowFixMe
-
-      cb(err, res, body);
-      /**
-       * Perform a decode.
-       */
-
-      function processBody() {
-        if (err) {
-          error = err.message;
-          return;
-        }
-
-        if (options.json && res.statusCode < 300) {
-          try {
-            // $FlowFixMe
-            body = JSON.parse(body.toString(_core.CHARACTER_ENCODING.UTF8));
-          } catch (_err) {
-            body = {};
-            err = _err;
-            error = err.message;
-          }
-        }
-
-        if (!err && _core.validatioUtils.isObject(body)) {
-          if (_lodash.default.isString(body.error)) {
-            error = body.error;
-          }
-        }
-      }
-      /**
-       * Perform a log.
-       */
-
-
-      function logActivity() {
-        let message = "@{!status}, req: '@{request.method} @{request.url}'"; // FIXME: use LOG_VERDACCIO_BYTES
-
-        message += error ? ', error: @{!error}' : ', bytes: @{bytes.in}/@{bytes.out}';
-        self.logger.http({
-          // if error is null/false change this to undefined so it wont log
-          err: err || undefined,
-          request: {
-            method: method,
-            url: uri
-          },
-          status: res != null ? res.statusCode : 'ERR',
-          error: error,
-          bytes: {
-            in: json ? json.length : 0,
-            out: responseLength || 0
-          }
-        }, message);
-      }
-    } : undefined;
-    let requestOptions = {
-      url: uri,
-      method: method,
-      headers: headers,
-      body: json,
-      proxy: this.proxy,
-      encoding: null,
-      gzip: true,
-      timeout: this.timeout,
-      strictSSL: this.strict_ssl,
-      agentOptions: this.agent_options
-    };
-
-    if (this.ca) {
-      requestOptions = Object.assign({}, requestOptions, {
-        ca: this.ca
-      });
-    }
-
-    const req = (0, _request.default)(requestOptions, requestCallback);
-    let statusCalled = false;
-    req.on('response', function (res) {
-      // FIXME: _verdaccio_aborted seems not used
-      // @ts-ignore
-      if (!req._verdaccio_aborted && !statusCalled) {
-        statusCalled = true;
-
-        self._statusCheck(true);
-      }
-
-      if (_lodash.default.isNil(requestCallback) === false) {
-        (function do_log() {
-          const message = "@{!status}, req: '@{request.method} @{request.url}' (streaming)";
-          self.logger.http({
-            request: {
-              method: method,
-              url: uri
-            },
-            status: _lodash.default.isNull(res) === false ? res.statusCode : 'ERR'
-          }, message);
-        })();
-      }
-    }); // eslint-disable-next-line @typescript-eslint/no-unused-vars
-
-    req.on('error', function (_err) {
-      // FIXME: _verdaccio_aborted seems not used
-      // @ts-ignore
-      if (!req._verdaccio_aborted && !statusCalled) {
-        statusCalled = true;
-
-        self._statusCheck(false);
-      }
-    }); // @ts-ignore
-
-    return req;
-  }
-  /**
-   * Set default headers.
-   * @param {Object} options
-   * @return {Object}
-   * @private
-   */
-
-
-  _setHeaders(options) {
-    const headers = options.headers || {};
-    const accept = _core.HEADERS.ACCEPT;
-    const acceptEncoding = _core.HEADERS.ACCEPT_ENCODING;
-    const userAgent = _core.HEADERS.USER_AGENT;
-    headers[accept] = headers[accept] || contentTypeAccept;
-    headers[acceptEncoding] = headers[acceptEncoding] || 'gzip'; // registry.npmjs.org will only return search result if user-agent include string 'npm'
-
-    headers[userAgent] = headers[userAgent] || `npm (${this.userAgent})`;
-    return this._setAuth(headers);
-  }
-  /**
-   * Validate configuration auth and assign Header authorization
-   * @param {Object} headers
-   * @return {Object}
-   * @private
-   */
-
-
-  _setAuth(headers) {
-    const {
-      auth
-    } = this.config;
-
-    if (_lodash.default.isNil(auth) || headers[_core.HEADERS.AUTHORIZATION]) {
-      return headers;
-    }
-
-    if (_lodash.default.isObject(auth) === false && _lodash.default.isObject(auth.token) === false) {
-      this._throwErrorAuth('Auth invalid');
-    } // get NPM_TOKEN http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules
-    // or get other variable export in env
-    // https://github.com/verdaccio/verdaccio/releases/tag/v2.5.0
-
-
-    let token;
-    const tokenConf = auth;
-
-    if (_lodash.default.isNil(tokenConf.token) === false && _lodash.default.isString(tokenConf.token)) {
-      token = tokenConf.token;
-    } else if (_lodash.default.isNil(tokenConf.token_env) === false) {
-      if (_lodash.default.isString(tokenConf.token_env)) {
-        token = process.env[tokenConf.token_env];
-      } else if (_lodash.default.isBoolean(tokenConf.token_env) && tokenConf.token_env) {
-        token = process.env.NPM_TOKEN;
-      } else {
-        this.logger.error(_core.constants.ERROR_CODE.token_required);
-
-        this._throwErrorAuth(_core.constants.ERROR_CODE.token_required);
-      }
-    } else {
-      token = process.env.NPM_TOKEN;
-    }
-
-    if (_lodash.default.isNil(token)) {
-      this._throwErrorAuth(_core.constants.ERROR_CODE.token_required);
-    } // define type Auth allow basic and bearer
-
-
-    const type = tokenConf.type || _core.TOKEN_BASIC;
-
-    this._setHeaderAuthorization(headers, type, token);
-
-    return headers;
-  }
-  /**
-   * @param {string} message
-   * @throws {Error}
-   * @private
-   */
-
-
-  _throwErrorAuth(message) {
-    this.logger.error(message);
-    throw new Error(message);
-  }
-  /**
-   * Assign Header authorization with type authentication
-   * @param {Object} headers
-   * @param {string} type
-   * @param {string} token
-   * @private
-   */
-
-
-  _setHeaderAuthorization(headers, type, token) {
-    const _type = type.toLowerCase();
-
-    if (_type !== _core.TOKEN_BEARER.toLowerCase() && _type !== _core.TOKEN_BASIC.toLowerCase()) {
-      this._throwErrorAuth(`Auth type '${_type}' not allowed`);
-    }
-
-    type = _lodash.default.upperFirst(type);
-    headers[_core.HEADERS.AUTHORIZATION] = (0, _utils.buildToken)(type, token);
-  }
-  /**
-   * It will add or override specified headers from config file.
-   *
-   * Eg:
-   *
-   * uplinks:
-   npmjs:
-   url: https://registry.npmjs.org/
-   headers:
-   Accept: "application/vnd.npm.install-v2+json; q=1.0"
-   verdaccio-staging:
-   url: https://mycompany.com/npm
-   headers:
-   Accept: "application/json"
-   authorization: "Basic YourBase64EncodedCredentials=="
-    * @param {Object} headers
-   * @private
-   */
-
-
-  _overrideWithUpLinkConfLocaligHeaders(headers) {
-    if (!this.config.headers) {
-      return headers;
-    } // add/override headers specified in the config
-
-    /* eslint guard-for-in: 0 */
-
-
-    for (const key in this.config.headers) {
-      headers[key] = this.config.headers[key];
-    }
-  }
-  /**
-   * Get a remote package metadata
-   * @param {*} name package name
-   * @param {*} options request options, eg: eTag.
-   * @param {*} callback
-   */
-
-
-  getRemoteMetadata(name, options, callback) {
-    const headers = {};
-
-    if (_lodash.default.isNil(options.etag) === false) {
-      headers['If-None-Match'] = options.etag;
-      headers[_core.HEADERS.ACCEPT] = contentTypeAccept;
-    }
-
-    this.request({
-      uri: `/${encode(name)}`,
-      json: true,
-      headers: headers,
-      req: options.req
-    }, (err, res, body) => {
-      if (err) {
-        return callback(err);
-      }
-
-      if (res.statusCode === _core.HTTP_STATUS.NOT_FOUND) {
-        return callback(_core.errorUtils.getNotFound(_core.errorUtils.API_ERROR.NOT_PACKAGE_UPLINK));
-      }
-
-      if (!(res.statusCode >= _core.HTTP_STATUS.OK && res.statusCode < _core.HTTP_STATUS.MULTIPLE_CHOICES)) {
-        const error = _core.errorUtils.getInternalError(`${_core.errorUtils.API_ERROR.BAD_STATUS_CODE}: ${res.statusCode}`);
-
-        error.remoteStatus = res.statusCode;
-        return callback(error);
-      }
-
-      callback(null, body, res.headers.etag);
-    });
-  }
-  /**
-   * Fetch a tarball from the uplink.
-   * @param {String} url
-   * @return {Stream}
-   */
-
-
-  fetchTarball(url) {
-    const stream = new _streams.ReadTarball({});
-    let current_length = 0;
-    let expected_length;
-
-    stream.abort = () => {};
-
-    const readStream = this.request({
-      uri_full: url,
-      encoding: null,
-      headers: {
-        Accept: contentTypeAccept
-      }
-    });
-    readStream.on('response', function (res) {
-      if (res.statusCode === _core.HTTP_STATUS.NOT_FOUND) {
-        return stream.emit('error', _core.errorUtils.getNotFound(_core.errorUtils.API_ERROR.NOT_FILE_UPLINK));
-      }
-
-      if (!(res.statusCode >= _core.HTTP_STATUS.OK && res.statusCode < _core.HTTP_STATUS.MULTIPLE_CHOICES)) {
-        return stream.emit('error', _core.errorUtils.getInternalError(`bad uplink status code: ${res.statusCode}`));
-      }
-
-      if (res.headers[_core.HEADER_TYPE.CONTENT_LENGTH]) {
-        expected_length = res.headers[_core.HEADER_TYPE.CONTENT_LENGTH];
-        stream.emit(_core.HEADER_TYPE.CONTENT_LENGTH, res.headers[_core.HEADER_TYPE.CONTENT_LENGTH]);
-      }
-
-      readStream.pipe(stream);
-    });
-    readStream.on('error', function (err) {
-      stream.emit('error', err);
-    });
-    readStream.on('data', function (data) {
-      current_length += data.length;
-    });
-    readStream.on('end', function (data) {
-      if (data) {
-        current_length += data.length;
-      }
-
-      if (expected_length && current_length != expected_length) {
-        stream.emit('error', _core.errorUtils.getInternalError(_core.errorUtils.API_ERROR.CONTENT_MISMATCH));
-      }
-    });
-    return stream;
-  }
-  /**
-   * Perform a stream search.
-   * @param {*} options request options
-   * @return {Stream}
-   */
-
-
-  async search({
-    url,
-    abort
-  }) {
-    debug('search url %o', url);
-    let response;
-
-    try {
-      const fullURL = new _url.URL(`${this.url}${url}`); // FIXME: a better way to remove duplicate slashes?
-
-      const uri = fullURL.href.replace(/([^:]\/)\/+/g, '$1');
-      this.logger.http({
-        uri,
-        uplink: this.upname
-      }, 'search request to uplink @{uplink} - @{uri}');
-      response = await (0, _undici.fetch)(uri, {
-        method: 'GET',
-        // FUTURE: whitelist domains what we are sending not need it headers, security check
-        // headers: new Headers({
-        //   ...headers,
-        //   connection: 'keep-alive',
-        // }),
-        signal: abort === null || abort === void 0 ? void 0 : abort.signal
-      });
-      debug('response.status  %o', response.status);
-
-      if (response.status >= _core.HTTP_STATUS.BAD_REQUEST) {
-        throw _core.errorUtils.getInternalError(`bad status code ${response.status} from uplink`);
-      }
-
-      const streamSearch = new _stream.PassThrough({
-        objectMode: true
-      });
-      const res = await response.text();
-
-      const streamResponse = _stream.Readable.from(res); // objects is one of the properties on the body, it ignores date and total
-
-
-      streamResponse.pipe(_JSONStream.default.parse('objects')).pipe(streamSearch, {
-        end: true
-      });
-      return streamSearch;
-    } catch (err) {
-      this.logger.error({
-        errorMessage: err === null || err === void 0 ? void 0 : err.message,
-        name: this.upname
-      }, 'proxy uplink @{name} search error: @{errorMessage}');
-      throw err;
-    }
-  }
-  /**
-   * Add proxy headers.
-   * FIXME: object mutations, it should return an new object
-   * @param {*} req the http request
-   * @param {*} headers the request headers
-   */
-
-
-  _addProxyHeaders(req, headers) {
-    if (req) {
-      // Only submit X-Forwarded-For field if we don't have a proxy selected
-      // in the config file.
-      //
-      // Otherwise misconfigured proxy could return 407:
-      // https://github.com/rlidwka/sinopia/issues/254
-      // @ts-ignore
-      if (!this.proxy) {
-        headers[_core.HEADERS.FORWARDED_FOR] = (req.headers['x-forwarded-for'] ? req.headers['x-forwarded-for'] + ', ' : '') + req.connection.remoteAddress;
-      }
-    } // always attach Via header to avoid loops, even if we're not proxying
-
-
-    headers['Via'] = req !== null && req !== void 0 && req.headers['via'] ? req.headers['via'] + ', ' : '';
-    headers['Via'] += '1.1 ' + this.server_id + ' (Verdaccio)';
-  }
-  /**
-   * Check whether the remote host is available.
-   * @param {*} alive
-   * @return {Boolean}
-   */
-
-
-  _statusCheck(alive) {
-    if (arguments.length === 0) {
-      return this._ifRequestFailure() === false;
-    }
-
-    if (alive) {
-      if (this.failed_requests >= this.max_fails) {
-        this.logger.warn({
-          host: this.url.host
-        }, 'host @{host} is back online');
-      }
-
-      this.failed_requests = 0;
-    } else {
-      this.failed_requests++;
-
-      if (this.failed_requests === this.max_fails) {
-        this.logger.warn({
-          host: this.url.host
-        }, 'host @{host} is now offline');
-      }
-    }
-
-    this.last_request_time = Date.now();
-  }
-  /**
-   * If the request failure.
-   * @return {boolean}
-   * @private
-   */
-
-
-  _ifRequestFailure() {
-    return this.failed_requests >= this.max_fails && Math.abs(Date.now() - this.last_request_time) < this.fail_timeout;
-  }
-  /**
-   * Set up a proxy.
-   * @param {*} hostname
-   * @param {*} config
-   * @param {*} mainconfig
-   * @param {*} isHTTPS
-   */
-
-
-  _setupProxy(hostname, config, mainconfig, isHTTPS) {
-    let noProxyList;
-    const proxy_key = isHTTPS ? 'https_proxy' : 'http_proxy'; // get http_proxy and no_proxy configs
-
-    if (proxy_key in config) {
-      this.proxy = config[proxy_key];
-    } else if (proxy_key in mainconfig) {
-      this.proxy = mainconfig[proxy_key];
-    }
-
-    if ('no_proxy' in config) {
-      noProxyList = config.no_proxy;
-    } else if ('no_proxy' in mainconfig) {
-      noProxyList = mainconfig.no_proxy;
-    } // use wget-like algorithm to determine if proxy shouldn't be used
-
-
-    if (hostname[0] !== '.') {
-      hostname = '.' + hostname;
-    }
-
-    if (_lodash.default.isString(noProxyList) && noProxyList.length) {
-      noProxyList = noProxyList.split(',');
-    }
-
-    if (_lodash.default.isArray(noProxyList)) {
-      for (let i = 0; i < noProxyList.length; i++) {
-        let noProxyItem = noProxyList[i];
-
-        if (noProxyItem[0] !== '.') {
-          noProxyItem = '.' + noProxyItem;
-        }
-
-        if (hostname.lastIndexOf(noProxyItem) === hostname.length - noProxyItem.length) {
-          if (this.proxy) {
-            this.logger.debug({
-              url: this.url.href,
-              rule: noProxyItem
-            }, 'not using proxy for @{url}, excluded by @{rule} rule'); // @ts-ignore
-
-            this.proxy = false;
-          }
-
-          break;
-        }
-      }
-    } // if it's non-string (i.e. "false"), don't use it
-
-
-    if (_lodash.default.isString(this.proxy) === false) {
-      delete this.proxy;
-    } else {
-      this.logger.debug({
-        url: this.url.href,
-        proxy: this.proxy
-      }, 'using proxy @{proxy} for @{url}');
-    }
-  }
-
-}
-
-exports.ProxyStorage = ProxyStorage;
-//# sourceMappingURL=up-storage.js.map