@verdaccio/store 6.0.0-6-next.16 → 6.0.0-6-next.19

package/CHANGELOG.md

@@ -1,5 +1,74 @@
 # @verdaccio/store
 
+## 6.0.0-6-next.19
+
+### Patch Changes
+
+- Updated dependencies [b78f3525]
+  - @verdaccio/logger@6.0.0-6-next.10
+  - @verdaccio/loaders@6.0.0-6-next.10
+  - @verdaccio/proxy@6.0.0-6-next.18
+
+## 6.0.0-6-next.18
+
+### Patch Changes
+
+- Updated dependencies [730b5d8c]
+  - @verdaccio/logger@6.0.0-6-next.9
+  - @verdaccio/loaders@6.0.0-6-next.9
+  - @verdaccio/proxy@6.0.0-6-next.17
+
+## 6.0.0-6-next.17
+
+### Major Changes
+
+- a828271d: refactor: download manifest endpoint and integrate fastify
+
+  Much simpler API for fetching a package
+
+  ```
+   const manifest = await storage.getPackageNext({
+        name,
+        uplinksLook: true,
+        req,
+        version: queryVersion,
+        requestOptions,
+   });
+  ```
+
+  > not perfect, the `req` still is being passed to the proxy (this has to be refactored at proxy package) and then removed from here, in proxy we pass the request instance to the `request` library.
+
+  ### Details
+
+  - `async/await` sugar for getPackage()
+  - Improve and reuse code between current implementation and new fastify endpoint (add scaffolding for request manifest)
+  - Improve performance
+  - Add new tests
+
+  ### Breaking changes
+
+  All storage plugins will stop to work since the storage uses `getPackageNext` method which is Promise based, I won't replace this now because will force me to update all plugins, I'll follow up in another PR. Currently will throw http 500
+
+### Minor Changes
+
+- b13a3fef: refactor: improve versions and dist-tag filters
+
+### Patch Changes
+
+- Updated dependencies [a828271d]
+- Updated dependencies [24b9be02]
+- Updated dependencies [e75c0a3b]
+- Updated dependencies [b13a3fef]
+  - @verdaccio/tarball@11.0.0-6-next.11
+  - @verdaccio/local-storage@11.0.0-6-next.11
+  - @verdaccio/utils@6.0.0-6-next.10
+  - @verdaccio/core@6.0.0-6-next.4
+  - @verdaccio/logger@6.0.0-6-next.8
+  - @verdaccio/proxy@6.0.0-6-next.16
+  - @verdaccio/config@6.0.0-6-next.12
+  - @verdaccio/loaders@6.0.0-6-next.8
+  - @verdaccio/streams@11.0.0-6-next.5
+
 ## 6.0.0-6-next.16
 
 ### Minor Changes

package/build/index.d.ts

@@ -1,4 +1,5 @@
 export * from './storage';
 export * from './storage-utils';
+export * from './star-utils';
 export * from './search';
 export * from './type';

package/build/index.js

@@ -30,6 +30,19 @@ Object.keys(_storageUtils).forEach(function (key) {
   });
 });
 
+var _starUtils = require("./star-utils");
+
+Object.keys(_starUtils).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _starUtils[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _starUtils[key];
+    }
+  });
+});
+
 var _search = require("./search");
 
 Object.keys(_search).forEach(function (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;;AACA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA","sourcesContent":["export * from './storage';\nexport * from './storage-utils';\nexport * from './search';\nexport * from './type';\n"],"file":"index.js"}
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA","sourcesContent":["export * from './storage';\nexport * from './storage-utils';\nexport * from './star-utils';\nexport * from './search';\nexport * from './type';\n"],"file":"index.js"}

package/build/local-storage.d.ts

@@ -2,6 +2,8 @@
 import { PassThrough } from 'stream';
 import { pluginUtils, searchUtils } from '@verdaccio/core';
 import { Callback, CallbackAction, Config, IReadTarball, IUploadTarball, Logger, MergeTags, Package, StringValue, Token, TokenFilter, Version } from '@verdaccio/types';
+export declare const noSuchFile = "ENOENT";
+export declare const resourceNotAvailable = "EAGAIN";
 export declare type IPluginStorage = pluginUtils.IPluginStorage<Config>;
 export declare function normalizeSearchPackage(pkg: Package, searchItem: searchUtils.SearchItem): searchUtils.SearchPackageBody;
 export declare const PROTO_NAME = "__proto__";
@@ -35,6 +37,7 @@ declare class LocalStorage {
      * @param {*} callback
      */
     addVersion(name: string, version: string, metadata: Version, tag: StringValue, callback: Callback): void;
+    addVersionNext(name: string, version: string, metadata: Version, tag: StringValue): Promise<void>;
     /**
      * Merge a new list of tags for a local packages with the existing one.
      * @param {*} pkgName
@@ -51,7 +54,17 @@ declare class LocalStorage {
      * @param {*} callback
      * @return {Function}
      */
-    changePackage(name: string, incomingPkg: Package, revision: string | void, callback: Callback): void;
+    changePackage(name: string, incomingPkg: Package, revision: string | undefined, callback: Callback): void;
+    /**
+     * Update the package metadata, tags and attachments (tarballs).
+     * Note: Currently supports unpublishing and deprecation.
+     * @param {*} name
+     * @param {*} incomingPkg
+     * @param {*} revision
+     * @param {*} callback
+     * @return {Function}
+     */
+    changePackageNext(name: string, incomingPkg: Package, revision: string | undefined): Promise<void>;
     /**
      * Remove a tarball.
      * @param {*} name
@@ -88,11 +101,13 @@ declare class LocalStorage {
      * @return {ReadTarball}
      */
     private _streamSuccessReadTarBall;
+    getPackageMetadataNext(name: string): Promise<Package>;
     /**
      * Retrieve a package by name.
      * @param {*} name
      * @param {*} callback
      * @return {Function}
+     * @deprecated
      */
     getPackageMetadata(name: string, callback?: Callback): void;
     search(searchStream: PassThrough, query: searchUtils.SearchQuery): Promise<void>;
@@ -106,8 +121,10 @@ declare class LocalStorage {
      * Read a json file from storage.
      * @param {Object} storage
      * @param {Function} callback
+     * @deprecated
      */
     private _readPackage;
+    private _readPackageNext;
     /**
      * Retrieve either a previous created local package or a boilerplate.
      * @param {*} pkgName
@@ -131,6 +148,13 @@ declare class LocalStorage {
      * @return {Function}
      */
     private _updatePackage;
+    /**
+     * @param {*} name package name
+     * @param {*} updateHandler function(package, cb) - update function
+     * @param {*} callback callback that gets invoked after it's all updated
+     * @return {Function}
+     */
+    private updatePackageNext;
     /**
      * Update the revision (_rev) string for a package.
      * @param {*} name
@@ -139,6 +163,7 @@ declare class LocalStorage {
      * @return {Function}
      */
     private _writePackage;
+    private writePackageNext;
     private _setDefaultRevision;
     /**
      * Ensure the dist file remains as the same protocol

package/build/local-storage.js

@@ -3,8 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.PROTO_NAME = exports.LocalStorage = void 0;
+exports.noSuchFile = exports.PROTO_NAME = exports.LocalStorage = void 0;
 exports.normalizeSearchPackage = normalizeSearchPackage;
+exports.resourceNotAvailable = void 0;
 
 var _assert = _interopRequireDefault(require("assert"));
 
@@ -28,9 +29,11 @@ var _storageUtils = require("./storage-utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-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:storage:local');
+const noSuchFile = 'ENOENT';
+exports.noSuchFile = noSuchFile;
+const resourceNotAvailable = 'EAGAIN';
+exports.resourceNotAvailable = resourceNotAvailable;
 
 function normalizeSearchPackage(pkg, searchItem) {
   const latest = _core.pkgUtils.getLatest(pkg);
@@ -73,12 +76,6 @@ exports.PROTO_NAME = PROTO_NAME;
 
 class LocalStorage {
   constructor(config, logger) {
-    _defineProperty(this, "config", void 0);
-
-    _defineProperty(this, "storagePlugin", void 0);
-
-    _defineProperty(this, "logger", void 0);
-
     debug('local storage created');
     this.logger = logger.child({
       sub: 'fs'
@@ -350,6 +347,124 @@ class LocalStorage {
       }
     }, callback);
   }
+
+  async addVersionNext(name, version, metadata, tag) {
+    debug(`add version %s package for %s`, version, name);
+    await this.updatePackageNext(name, async data => {
+      debug('%s package is being updated', name); // keep only one readme per package
+
+      data.readme = metadata.readme;
+      debug('%s` readme mutated', name); // TODO: lodash remove
+
+      metadata = (0, _storageUtils.cleanUpReadme)(metadata);
+      metadata.contributors = (0, _utils.normalizeContributors)(metadata.contributors);
+      debug('%s` contributors normalized', name);
+      const hasVersion = data.versions[version] != null;
+
+      if (hasVersion) {
+        debug('%s version %s already exists', name, version);
+        throw _core.errorUtils.getConflict();
+      } // if uploaded tarball has a different shasum, it's very likely that we
+      // have some kind of error
+
+
+      if (_core.validatioUtils.isObject(metadata.dist) && _lodash.default.isString(metadata.dist.tarball)) {
+        const tarball = metadata.dist.tarball.replace(/.*\//, '');
+
+        if (_core.validatioUtils.isObject(data._attachments[tarball])) {
+          if (_lodash.default.isNil(data._attachments[tarball].shasum) === false && _lodash.default.isNil(metadata.dist.shasum) === false) {
+            if (data._attachments[tarball].shasum != metadata.dist.shasum) {
+              const errorMessage = `shasum error, ` + `${data._attachments[tarball].shasum} != ${metadata.dist.shasum}`;
+              throw _core.errorUtils.getBadRequest(errorMessage);
+            }
+          }
+
+          const currentDate = new Date().toISOString(); // some old storage do not have this field #740
+
+          if (_lodash.default.isNil(data.time)) {
+            data.time = {};
+          }
+
+          data.time['modified'] = currentDate;
+
+          if ('created' in data.time === false) {
+            data.time.created = currentDate;
+          }
+
+          data.time[version] = currentDate;
+          data._attachments[tarball].version = version;
+        }
+      }
+
+      data.versions[version] = metadata;
+      (0, _storageUtils.tagVersion)(data, version, tag);
+
+      try {
+        debug('%s` add on database', name);
+        await this.storagePlugin.add(name);
+      } catch (err) {
+        throw _core.errorUtils.getBadData(err.message);
+      }
+
+      return data;
+    }); // this._updatePackage(
+    //   name,
+    //   async (data, cb: Callback): Promise<void> => {
+    //     debug('%s package is being updated', name);
+    //     // keep only one readme per package
+    //     data.readme = metadata.readme;
+    //     debug('%s` readme mutated', name);
+    //     // TODO: lodash remove
+    //     metadata = cleanUpReadme(metadata);
+    //     metadata.contributors = normalizeContributors(metadata.contributors as Author[]);
+    //     debug('%s` contributors normalized', name);
+    //     const hasVersion = data.versions[version] != null;
+    //     if (hasVersion) {
+    //       debug('%s version %s already exists', name, version);
+    //       return cb(errorUtils.getConflict());
+    //     }
+    //     // if uploaded tarball has a different shasum, it's very likely that we
+    //     // have some kind of error
+    //     if (validatioUtils.isObject(metadata.dist) && _.isString(metadata.dist.tarball)) {
+    //       const tarball = metadata.dist.tarball.replace(/.*\//, '');
+    //       if (validatioUtils.isObject(data._attachments[tarball])) {
+    //         if (
+    //           _.isNil(data._attachments[tarball].shasum) === false &&
+    //           _.isNil(metadata.dist.shasum) === false
+    //         ) {
+    //           if (data._attachments[tarball].shasum != metadata.dist.shasum) {
+    //             const errorMessage =
+    //               `shasum error, ` +
+    //               `${data._attachments[tarball].shasum} != ${metadata.dist.shasum}`;
+    //             return cb(errorUtils.getBadRequest(errorMessage));
+    //           }
+    //         }
+    //         const currentDate = new Date().toISOString();
+    //         // some old storage do not have this field #740
+    //         if (_.isNil(data.time)) {
+    //           data.time = {};
+    //         }
+    //         data.time['modified'] = currentDate;
+    //         if ('created' in data.time === false) {
+    //           data.time.created = currentDate;
+    //         }
+    //         data.time[version] = currentDate;
+    //         data._attachments[tarball].version = version;
+    //       }
+    //     }
+    //     data.versions[version] = metadata;
+    //     tagVersion(data, version, tag);
+    //     try {
+    //       debug('%s` add on database', name);
+    //       await this.storagePlugin.add(name);
+    //       cb();
+    //     } catch (err: any) {
+    //       cb(errorUtils.getBadData(err.message));
+    //     }
+    //   },
+    //   callback
+    // );
+  }
   /**
    * Merge a new list of tags for a local packages with the existing one.
    * @param {*} pkgName
@@ -454,6 +569,72 @@ class LocalStorage {
       callback();
     });
   }
+  /**
+   * Update the package metadata, tags and attachments (tarballs).
+   * Note: Currently supports unpublishing and deprecation.
+   * @param {*} name
+   * @param {*} incomingPkg
+   * @param {*} revision
+   * @param {*} callback
+   * @return {Function}
+   */
+
+
+  async changePackageNext(name, incomingPkg, revision) {
+    debug(`change package tags for %o revision %s`, name, revision);
+
+    if (!_core.validatioUtils.isObject(incomingPkg.versions) || !_core.validatioUtils.isObject(incomingPkg[_core.DIST_TAGS])) {
+      debug(`change package bad data for %o`, name);
+      throw _core.errorUtils.getBadData();
+    }
+
+    debug(`change package udapting package for %o`, name);
+    await this.updatePackageNext(name, async localData => {
+      for (const version in localData.versions) {
+        const incomingVersion = incomingPkg.versions[version];
+
+        if (_lodash.default.isNil(incomingVersion)) {
+          this.logger.info({
+            name: name,
+            version: version
+          }, 'unpublishing @{name}@@{version}'); // FIXME: I prefer return a new object rather mutate the metadata
+
+          delete localData.versions[version];
+          delete localData.time[version];
+
+          for (const file in localData._attachments) {
+            if (localData._attachments[file].version === version) {
+              delete localData._attachments[file].version;
+            }
+          }
+        } else if (Object.prototype.hasOwnProperty.call(incomingVersion, 'deprecated')) {
+          const incomingDeprecated = incomingVersion.deprecated;
+
+          if (incomingDeprecated != localData.versions[version].deprecated) {
+            if (!incomingDeprecated) {
+              this.logger.info({
+                name: name,
+                version: version
+              }, 'undeprecating @{name}@@{version}');
+              delete localData.versions[version].deprecated;
+            } else {
+              this.logger.info({
+                name: name,
+                version: version
+              }, 'deprecating @{name}@@{version}');
+              localData.versions[version].deprecated = incomingDeprecated;
+            }
+
+            localData.time.modified = new Date().toISOString();
+          }
+        }
+      }
+
+      localData[_core.USERS] = incomingPkg[_core.USERS];
+      localData[_core.DIST_TAGS] = incomingPkg[_core.DIST_TAGS];
+      return localData;
+    });
+  }
   /**
    * Remove a tarball.
    * @param {*} name
@@ -676,11 +857,26 @@ class LocalStorage {
     });
     return stream;
   }
+
+  async getPackageMetadataNext(name) {
+    const storage = this._getLocalStorage(name);
+
+    debug('get package metadata for %o', name);
+
+    if (typeof storage === 'undefined') {
+      // TODO: this might be a better an error to throw
+      // if storage is not there cannot be 404.
+      throw _core.errorUtils.getNotFound();
+    }
+
+    return await this._readPackageNext(name, storage);
+  }
   /**
    * Retrieve a package by name.
    * @param {*} name
    * @param {*} callback
    * @return {Function}
+   * @deprecated
    */
 
 
@@ -776,6 +972,7 @@ class LocalStorage {
    * Read a json file from storage.
    * @param {Object} storage
    * @param {Function} callback
+   * @deprecated
    */
 
 
@@ -793,6 +990,24 @@ class LocalStorage {
       callback(err, (0, _storageUtils.normalizePackage)(result));
     });
   }
+
+  async _readPackageNext(name, storage) {
+    try {
+      const result = await storage.readPackageNext(name);
+      return (0, _storageUtils.normalizePackage)(result);
+    } catch (err) {
+      if (err.code === _storageUtils.STORAGE.NO_SUCH_FILE_ERROR || err.code === _core.HTTP_STATUS.NOT_FOUND) {
+        debug('package %s not found', name);
+        throw _core.errorUtils.getNotFound();
+      }
+
+      this.logger.error({
+        err: err,
+        file: _storageUtils.STORAGE.PACKAGE_FILE_NAME
+      }, `error reading  @{file}: @{!err.message}`);
+      throw _core.errorUtils.getInternalError();
+    }
+  }
   /**
    * Retrieve either a previous created local package or a boilerplate.
    * @param {*} pkgName
@@ -851,14 +1066,44 @@ class LocalStorage {
    */
 
 
-  _updatePackage(name, updateHandler, callback) {
+  _updatePackage(name, updateHandler, onEnd) {
     const storage = this._getLocalStorage(name);
 
     if (!storage) {
-      return callback(_core.errorUtils.getNotFound());
+      return onEnd(_core.errorUtils.getNotFound());
     }
 
-    storage.updatePackage(name, updateHandler, this._writePackage.bind(this), _storageUtils.normalizePackage, callback);
+    storage.updatePackage(name, updateHandler, this._writePackage.bind(this), _storageUtils.normalizePackage, onEnd);
+  }
+  /**
+   * @param {*} name package name
+   * @param {*} updateHandler function(package, cb) - update function
+   * @param {*} callback callback that gets invoked after it's all updated
+   * @return {Function}
+   */
+
+
+  async updatePackageNext(name, updateHandler) {
+    const storage = this._getLocalStorage(name);
+
+    if (!storage) {
+      throw _core.errorUtils.getNotFound();
+    } // we update the package on the local storage
+
+
+    const updatedManifest = await storage.updatePackageNext(name, updateHandler); // after correctly updated write to the storage
+
+    try {
+      await this.writePackageNext(name, (0, _storageUtils.normalizePackage)(updatedManifest));
+    } catch (err) {
+      if (err.code === resourceNotAvailable) {
+        throw _core.errorUtils.getInternalError('resource temporarily unavailable');
+      } else if (err.code === noSuchFile) {
+        throw _core.errorUtils.getNotFound();
+      } else {
+        throw err;
+      }
+    }
   }
   /**
    * Update the revision (_rev) string for a package.
@@ -879,6 +1124,17 @@ class LocalStorage {
     storage.savePackage(name, this._setDefaultRevision(json), callback);
   }
 
+  async writePackageNext(name, json) {
+    const storage = this._getLocalStorage(name);
+
+    if (_lodash.default.isNil(storage)) {
+      // TODO: replace here 500 error
+      throw _core.errorUtils.getBadData();
+    }
+
+    await storage.savePackageNext(name, this._setDefaultRevision(json));
+  }
+
   _setDefaultRevision(json) {
     // calculate revision from couch db
     if (_lodash.default.isString(json._rev) === false) {