@verdaccio/api 6.0.0-6-next.25 → 6.0.0-6-next.28

package/package.json

@@ -1,70 +1,72 @@
 {
-	"name": "@verdaccio/api",
-	"version": "6.0.0-6-next.25",
-	"description": "loaders logic",
-	"main": "./build/index.js",
-	"types": "build/index.d.ts",
-	"author": {
-		"name": "Juan Picado",
-		"email": "juanpicado19@gmail.com"
-	},
-	"repository": {
-		"type": "https",
-		"url": "https://github.com/verdaccio/verdaccio"
-	},
-	"homepage": "https://verdaccio.org",
-	"keywords": [
-		"private",
-		"package",
-		"repository",
-		"registry",
-		"enterprise",
-		"modules",
-		"proxy",
-		"server",
-		"verdaccio"
-	],
-	"engines": {
-		"node": ">=14",
-		"npm": ">=6"
-	},
-	"license": "MIT",
-	"dependencies": {
-		"@verdaccio/auth": "6.0.0-6-next.22",
-		"@verdaccio/config": "6.0.0-6-next.14",
-		"@verdaccio/core": "6.0.0-6-next.5",
-		"@verdaccio/hooks": "6.0.0-6-next.13",
-		"@verdaccio/logger": "6.0.0-6-next.11",
-		"@verdaccio/middleware": "6.0.0-6-next.22",
-		"@verdaccio/store": "6.0.0-6-next.22",
-		"@verdaccio/utils": "6.0.0-6-next.11",
-		"abortcontroller-polyfill": "1.7.3",
-		"cookies": "0.8.0",
-		"debug": "4.3.3",
-		"body-parser": "1.19.1",
-		"express": "4.17.2",
-		"lodash": "4.17.21",
-		"mime": "2.6.0",
-		"semver": "7.3.5"
-	},
-	"devDependencies": {
-		"@types/node": "16.11.21",
-		"@verdaccio/server": "6.0.0-6-next.30",
-		"@verdaccio/types": "11.0.0-6-next.12",
-		"@verdaccio/test-helper": "1.1.0-6-next.0",
-		"supertest": "6.2.2"
-	},
-	"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/api",
+  "version": "6.0.0-6-next.28",
+  "description": "loaders logic",
+  "main": "./build/index.js",
+  "types": "build/index.d.ts",
+  "author": {
+    "name": "Juan Picado",
+    "email": "juanpicado19@gmail.com"
+  },
+  "repository": {
+    "type": "https",
+    "url": "https://github.com/verdaccio/verdaccio"
+  },
+  "homepage": "https://verdaccio.org",
+  "keywords": [
+    "private",
+    "package",
+    "repository",
+    "registry",
+    "enterprise",
+    "modules",
+    "proxy",
+    "server",
+    "verdaccio"
+  ],
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@verdaccio/auth": "6.0.0-6-next.24",
+    "@verdaccio/config": "6.0.0-6-next.16",
+    "@verdaccio/core": "6.0.0-6-next.7",
+    "@verdaccio/logger": "6.0.0-6-next.13",
+    "@verdaccio/middleware": "6.0.0-6-next.24",
+    "@verdaccio/store": "6.0.0-6-next.25",
+    "@verdaccio/utils": "6.0.0-6-next.13",
+    "abortcontroller-polyfill": "1.7.3",
+    "cookies": "0.8.0",
+    "debug": "4.3.4",
+    "body-parser": "1.20.0",
+    "express": "4.18.1",
+    "lodash": "4.17.21",
+    "mime": "2.6.0",
+    "semver": "7.3.7"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.56",
+    "@verdaccio/server": "6.0.0-6-next.34",
+    "@verdaccio/types": "11.0.0-6-next.15",
+    "@verdaccio/test-helper": "1.1.0-6-next.3",
+    "supertest": "6.2.4",
+    "nock": "13.2.9",
+    "mockdate": "3.0.5"
+  },
+  "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": "# @verdaccio/api\n\n[![backers](https://opencollective.com/verdaccio/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/verdaccio)\n[![stackshare](https://img.shields.io/badge/Follow%20on-StackShare-blue.svg?logo=stackshare&style=flat)](https://stackshare.io/verdaccio)\n[![MIT](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)\n[![Crowdin](https://d322cqt584bo4o.cloudfront.net/verdaccio/localized.svg)](https://crowdin.com/project/verdaccio)\n[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/verdaccio/verdaccio)](https://www.tickgit.com/browse?repo=github.com/verdaccio/verdaccio)\n\n[![Twitter followers](https://img.shields.io/twitter/follow/verdaccio_npm.svg?style=social&label=Follow)](https://twitter.com/verdaccio_npm)\n[![Github](https://img.shields.io/github/stars/verdaccio/verdaccio.svg?style=social&label=Stars)](https://github.com/verdaccio/verdaccio/stargazers)\n\n## Donations\n\nVerdaccio is run by **volunteers**; nobody is working full-time on it. If you find this project to be useful and would like to support its development, consider making a donation - **your logo might end up in this readme.** 😉\n\n**[Donate](https://opencollective.com/verdaccio)** 💵👍🏻 starting from _\\$1/month_ or just one single contribution.\n\n## Report a vulnerability\n\nIf you want to report a security vulnerability, please follow the steps which we have defined for you in our [security policy](https://github.com/verdaccio/verdaccio/security/policy).\n\n## Open Collective Sponsors\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/verdaccio#sponsor)]\n\n[![sponsor](https://opencollective.com/verdaccio/sponsor/0/avatar.svg)](https://opencollective.com/verdaccio/sponsor/0/website)\n[![sponsor](https://opencollective.com/verdaccio/sponsor/1/avatar.svg)](https://opencollective.com/verdaccio/sponsor/1/website)\n[![sponsor](https://opencollective.com/verdaccio/sponsor/2/avatar.svg)](https://opencollective.com/verdaccio/sponsor/2/website)\n[![sponsor](https://opencollective.com/verdaccio/sponsor/3/avatar.svg)](https://opencollective.com/verdaccio/sponsor/3/website)\n[![sponsor](https://opencollective.com/verdaccio/sponsor/4/avatar.svg)](https://opencollective.com/verdaccio/sponsor/4/website)\n[![sponsor](https://opencollective.com/verdaccio/sponsor/5/avatar.svg)](https://opencollective.com/verdaccio/sponsor/5/website)\n[![sponsor](https://opencollective.com/verdaccio/sponsor/6/avatar.svg)](https://opencollective.com/verdaccio/sponsor/6/website)\n[![sponsor](https://opencollective.com/verdaccio/sponsor/7/avatar.svg)](https://opencollective.com/verdaccio/sponsor/7/website)\n[![sponsor](https://opencollective.com/verdaccio/sponsor/8/avatar.svg)](https://opencollective.com/verdaccio/sponsor/8/website)\n[![sponsor](https://opencollective.com/verdaccio/sponsor/9/avatar.svg)](https://opencollective.com/verdaccio/sponsor/9/website)\n\n## Open Collective Backers\n\nThank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/verdaccio#backer)]\n\n[![backers](https://opencollective.com/verdaccio/backers.svg?width=890)](https://opencollective.com/verdaccio#backers)\n\n## Special Thanks\n\nThanks to the following companies to help us to achieve our goals providing free open source licenses.\n"
+}

package/src/dist-tags.ts

@@ -3,106 +3,119 @@ import _ from 'lodash';
 import mime from 'mime';
 
 import { IAuth } from '@verdaccio/auth';
-import { VerdaccioError, constants } from '@verdaccio/core';
+import { constants, errorUtils } from '@verdaccio/core';
 import { allow, media } from '@verdaccio/middleware';
 import { Storage } from '@verdaccio/store';
-import { Package } from '@verdaccio/types';
 
 import { $NextFunctionVer, $RequestExtend, $ResponseExtend } from '../types/custom';
 
 export default function (route: Router, auth: IAuth, storage: Storage): void {
   const can = allow(auth);
-  const tag_package_version = function (
+  const addTagPackageVersionMiddleware = async function (
     req: $RequestExtend,
     res: $ResponseExtend,
     next: $NextFunctionVer
-  ): $NextFunctionVer {
+  ): Promise<$NextFunctionVer> {
     if (_.isString(req.body) === false) {
-      return next('route');
+      return next(errorUtils.getBadRequest('version is missing'));
     }
 
     const tags = {};
     tags[req.params.tag] = req.body;
-    storage.mergeTags(req.params.package, tags, function (err: Error): $NextFunctionVer {
-      if (err) {
-        return next(err);
-      }
+    try {
+      await storage.mergeTagsNext(req.params.package, tags);
       res.status(constants.HTTP_STATUS.CREATED);
-      return next({ ok: constants.API_MESSAGE.TAG_ADDED });
-    });
+      return next({
+        ok: constants.API_MESSAGE.TAG_ADDED,
+      });
+    } catch (err) {
+      next(err);
+    }
   };
 
   // tagging a package.
-  route.put('/:package/:tag', can('publish'), media(mime.getType('json')), tag_package_version);
-
-  route.post(
-    '/-/package/:package/dist-tags/:tag',
+  route.put(
+    '/:package/:tag',
     can('publish'),
     media(mime.getType('json')),
-    tag_package_version
+    addTagPackageVersionMiddleware
   );
 
   route.put(
     '/-/package/:package/dist-tags/:tag',
     can('publish'),
     media(mime.getType('json')),
-    tag_package_version
+    addTagPackageVersionMiddleware
   );
 
   route.delete(
     '/-/package/:package/dist-tags/:tag',
     can('publish'),
-    function (req: $RequestExtend, res: $ResponseExtend, next: $NextFunctionVer): void {
+    async function (
+      req: $RequestExtend,
+      res: $ResponseExtend,
+      next: $NextFunctionVer
+    ): Promise<void> {
       const tags = {};
       tags[req.params.tag] = null;
-      storage.mergeTags(req.params.package, tags, function (err: VerdaccioError): $NextFunctionVer {
-        if (err) {
-          return next(err);
-        }
+      try {
+        await storage.mergeTagsNext(req.params.package, tags);
         res.status(constants.HTTP_STATUS.CREATED);
         return next({
           ok: constants.API_MESSAGE.TAG_REMOVED,
         });
-      });
+      } catch (err) {
+        next(err);
+      }
     }
   );
 
   route.get(
     '/-/package/:package/dist-tags',
     can('access'),
-    function (req: $RequestExtend, res: $ResponseExtend, next: $NextFunctionVer): void {
-      storage.getPackage({
-        name: req.params.package,
-        uplinksLook: true,
-        req,
-        callback: function (err: VerdaccioError, info: Package): $NextFunctionVer {
-          if (err) {
-            return next(err);
-          }
-
-          next(info[constants.DIST_TAGS]);
-        },
-      });
+    async function (
+      req: $RequestExtend,
+      res: $ResponseExtend,
+      next: $NextFunctionVer
+    ): Promise<void> {
+      const name = req.params.package;
+      const requestOptions = {
+        protocol: req.protocol,
+        headers: req.headers as any,
+        // FIXME: if we migrate to req.hostname, the port is not longer included.
+        host: req.host,
+        remoteAddress: req.socket.remoteAddress,
+      };
+      try {
+        const manifest = await storage.getPackageByOptions({
+          name,
+          uplinksLook: true,
+          requestOptions,
+        });
+        next(manifest[constants.DIST_TAGS]);
+      } catch (err) {
+        next(err);
+      }
     }
   );
 
   route.post(
     '/-/package/:package/dist-tags',
     can('publish'),
-    function (req: $RequestExtend, res: $ResponseExtend, next: $NextFunctionVer): void {
-      storage.mergeTags(
-        req.params.package,
-        req.body,
-        function (err: VerdaccioError): $NextFunctionVer {
-          if (err) {
-            return next(err);
-          }
-          res.status(constants.HTTP_STATUS.CREATED);
-          return next({
-            ok: constants.API_MESSAGE.TAG_UPDATED,
-          });
-        }
-      );
+    async function (
+      req: $RequestExtend,
+      res: $ResponseExtend,
+      next: $NextFunctionVer
+    ): Promise<void> {
+      try {
+        await storage.mergeTagsNext(req.params.package, req.body);
+        res.status(constants.HTTP_STATUS.CREATED);
+        return next({
+          ok: constants.API_MESSAGE.TAG_UPDATED,
+        });
+      } catch (err) {
+        next(err);
+      }
     }
   );
 }

package/src/index.ts

@@ -1,6 +1,5 @@
 import bodyParser from 'body-parser';
 import express, { Router } from 'express';
-import semver from 'semver';
 
 import { IAuth } from '@verdaccio/auth';
 import {
@@ -25,10 +24,6 @@ import v1Search from './v1/search';
 import token from './v1/token';
 import whoami from './whoami';
 
-if (semver.lte(process.version, 'v15.0.0')) {
-  global.AbortController = require('abortcontroller-polyfill/dist/cjs-ponyfill').AbortController;
-}
-
 export default function (config: Config, auth: IAuth, storage: Storage): Router {
   /* eslint new-cap:off */
   const app = express.Router();
@@ -62,7 +57,7 @@ export default function (config: Config, auth: IAuth, storage: Storage): Router
   search(app);
   user(app, auth, config);
   distTags(app, auth, storage);
-  publish(app, auth, storage, config);
+  publish(app, auth, storage);
   ping(app);
   stars(app, storage);
   // @ts-ignore

package/src/package.ts

@@ -2,7 +2,7 @@ import buildDebug from 'debug';
 import { Router } from 'express';
 
 import { IAuth } from '@verdaccio/auth';
-import { HEADERS, errorUtils } from '@verdaccio/core';
+import { HEADERS, HEADER_TYPE } from '@verdaccio/core';
 import { allow } from '@verdaccio/middleware';
 import { Storage } from '@verdaccio/store';
 
@@ -10,27 +10,6 @@ import { $NextFunctionVer, $RequestExtend, $ResponseExtend } from '../types/cust
 
 const debug = buildDebug('verdaccio:api:package');
 
-const downloadStream = (
-  packageName: string,
-  filename: string,
-  storage: any,
-  _req: $RequestExtend,
-  res: $ResponseExtend
-): void => {
-  const stream = storage.getTarball(packageName, filename);
-
-  stream.on('content-length', function (content): void {
-    res.header('Content-Length', content);
-  });
-
-  stream.on('error', function (err): void {
-    return res.locals.report_error(err);
-  });
-
-  res.header(HEADERS.CONTENT_TYPE, HEADERS.OCTET_STREAM);
-  stream.pipe(res);
-};
-
 export default function (route: Router, auth: IAuth, storage: Storage): void {
   const can = allow(auth);
 
@@ -44,28 +23,24 @@ export default function (route: Router, auth: IAuth, storage: Storage): void {
     ): Promise<void> {
       debug('init package by version');
       const name = req.params.package;
-      let queryVersion = req.params.version;
+      let version = req.params.version;
+      const write = req.query.write === 'true';
+      const abbreviated = req.get('Accept') === Storage.ABBREVIATED_HEADER;
       const requestOptions = {
         protocol: req.protocol,
         headers: req.headers as any,
         // FIXME: if we migrate to req.hostname, the port is not longer included.
         host: req.host,
+        remoteAddress: req.socket.remoteAddress,
+        byPassCache: write,
       };
 
       try {
-        // TODO: this is just temporary while I migrate all plugins to use the new API
-        // the method will be renamed to getPackage again but Promise Based.
-        if (!storage.getPackageByOptions) {
-          throw errorUtils.getInternalError(
-            'getPackageByOptions not implemented, check pr-2750 for more details'
-          );
-        }
-
         const manifest = await storage.getPackageByOptions({
           name,
           uplinksLook: true,
-          req,
-          version: queryVersion,
+          abbreviated,
+          version,
           requestOptions,
         });
         next(manifest);
@@ -76,20 +51,38 @@ export default function (route: Router, auth: IAuth, storage: Storage): void {
   );
 
   route.get(
-    '/:scopedPackage/-/:scope/:filename',
+    '/:pkg/-/:filename',
     can('access'),
-    function (req: $RequestExtend, res: $ResponseExtend): void {
-      const { scopedPackage, filename } = req.params;
+    async function (req: $RequestExtend, res: $ResponseExtend, next): Promise<void> {
+      const { pkg, filename } = req.params;
+      const abort = new AbortController();
+      try {
+        const stream = (await storage.getTarballNext(pkg, filename, {
+          signal: abort.signal,
+          // enableRemote: true,
+        })) as any;
 
-      downloadStream(scopedPackage, filename, storage, req, res);
-    }
-  );
+        stream.on('content-length', (size) => {
+          res.header(HEADER_TYPE.CONTENT_LENGTH, size);
+        });
 
-  route.get(
-    '/:package/-/:filename',
-    can('access'),
-    function (req: $RequestExtend, res: $ResponseExtend): void {
-      downloadStream(req.params.package, req.params.filename, storage, req, res);
+        stream.once('error', (err) => {
+          res.locals.report_error(err);
+          next(err);
+        });
+
+        req.on('abort', () => {
+          debug('request aborted for %o', req.url);
+          abort.abort();
+        });
+
+        res.header(HEADERS.CONTENT_TYPE, HEADERS.OCTET_STREAM);
+        stream.pipe(res);
+      } catch (err: any) {
+        // console.log('catch API error request', err);
+        res.locals.report_error(err);
+        next(err);
+      }
     }
   );
 }