@verdaccio/web 6.0.0-6-next.26 → 6.0.0-6-next.29

package/package.json

@@ -1,66 +1,71 @@
 {
-	"name": "@verdaccio/web",
-	"version": "6.0.0-6-next.26",
-	"description": "web ui middleware",
-	"main": "./build/index.js",
-	"types": "build/index.d.ts",
-	"repository": {
-		"type": "https",
-		"url": "https://github.com/verdaccio/verdaccio"
-	},
-	"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.20",
-		"@verdaccio/core": "6.0.0-6-next.4",
-		"@verdaccio/config": "6.0.0-6-next.12",
-		"@verdaccio/loaders": "6.0.0-6-next.11",
-		"@verdaccio/logger": "6.0.0-6-next.10",
-		"@verdaccio/middleware": "6.0.0-6-next.20",
-		"@verdaccio/readme": "11.0.0-6-next.4",
-		"@verdaccio/store": "6.0.0-6-next.20",
-		"@verdaccio/tarball": "11.0.0-6-next.11",
-		"@verdaccio/url": "11.0.0-6-next.8",
-		"@verdaccio/utils": "6.0.0-6-next.10",
-		"body-parser": "1.19.1",
-		"debug": "4.3.3",
-		"express": "4.17.2",
-		"lodash": "4.17.21",
-		"lru-cache": "6.0.0"
-	},
-	"devDependencies": {
-		"@types/node": "16.11.21",
-		"@verdaccio/types": "11.0.0-6-next.10",
-		"node-html-parser": "4.1.5",
-		"supertest": "6.2.2",
-		"verdaccio-auth-memory": "11.0.0-6-next.7",
-		"verdaccio-memory": "11.0.0-6-next.8"
-	},
-	"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/web",
+  "version": "6.0.0-6-next.29",
+  "description": "web ui middleware",
+  "main": "./build/index.js",
+  "types": "build/index.d.ts",
+  "repository": {
+    "type": "https",
+    "url": "https://github.com/verdaccio/verdaccio"
+  },
+  "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/core": "6.0.0-6-next.5",
+    "@verdaccio/config": "6.0.0-6-next.14",
+    "@verdaccio/loaders": "6.0.0-6-next.12",
+    "@verdaccio/logger": "6.0.0-6-next.11",
+    "@verdaccio/middleware": "6.0.0-6-next.22",
+    "@verdaccio/readme": "11.0.0-6-next.4",
+    "@verdaccio/store": "6.0.0-6-next.22",
+    "@verdaccio/tarball": "11.0.0-6-next.12",
+    "@verdaccio/url": "11.0.0-6-next.9",
+    "@verdaccio/utils": "6.0.0-6-next.11",
+    "body-parser": "1.19.1",
+    "debug": "4.3.3",
+    "express": "4.17.2",
+    "lodash": "4.17.21",
+    "lru-cache": "6.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.21",
+    "@verdaccio/types": "11.0.0-6-next.12",
+    "@verdaccio/test-helper": "1.1.0-6-next.1",
+    "@verdaccio/api": "6.0.0-6-next.25",
+    "node-html-parser": "4.1.5",
+    "supertest": "6.2.2",
+    "nock": "13.2.2",
+    "jsdom": "20.0.0",
+    "undici": "4.15.0",
+    "verdaccio-auth-memory": "11.0.0-6-next.8",
+    "verdaccio-memory": "11.0.0-6-next.10"
+  },
+  "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"
+  }
+}

package/src/api/readme.ts

@@ -39,12 +39,11 @@ function addReadmeWebApi(storage: Storage, auth: IAuth): Router {
         uplinksLook: true,
         req,
         callback: function (err, info): void {
-          debug('readme plg %o', info?.name);
+          debug('readme pkg %o', info?.name);
+          res.set(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_PLAIN_UTF8);
           if (err) {
             return next(err);
           }
-
-          res.set(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_PLAIN_UTF8);
           try {
             next(parseReadme(info.name, info.readme));
           } catch {

package/src/api/search.ts

@@ -1,55 +1,39 @@
 import buildDebug from 'debug';
 import { Router } from 'express';
+import _ from 'lodash';
+import { URLSearchParams } from 'url';
 
 import { IAuth } from '@verdaccio/auth';
-import { DIST_TAGS } from '@verdaccio/core';
-import { SearchInstance } from '@verdaccio/store';
+import { errorUtils, searchUtils } from '@verdaccio/core';
+import { SearchQuery } from '@verdaccio/core/src/search-utils';
 import { Storage } from '@verdaccio/store';
-import { Package } from '@verdaccio/types';
+import { Manifest } from '@verdaccio/types';
 
 import { $NextFunctionVer, $RequestExtend, $ResponseExtend } from './package';
 
 const debug = buildDebug('verdaccio:web:api:search');
 
-function addSearchWebApi(storage: Storage, auth: IAuth): Router {
-  const router = Router(); /* eslint new-cap: 0 */
-  const getPackageInfo = async function (name, remoteUser): Promise<any> {
-    return new Promise((resolve, reject) => {
-      debug('searching for %o', name);
-      try {
-        // @ts-ignore
-        storage.getPackage({
-          name,
-          uplinksLook: false,
-          callback: (err, pkg: Package): void => {
-            debug('callback get package err %o', err?.message);
-            if (!err && pkg) {
-              debug('valid package  %o', pkg?.name);
-              auth.allow_access(
-                { packageName: pkg.name },
-                remoteUser,
-                function (err, allowed): void {
-                  debug('is allowed %o', allowed);
-                  if (err || !allowed) {
-                    debug('deny access');
-                    reject(err);
-                    return;
-                  }
-                  debug('access succeed');
-                  resolve(pkg.versions[pkg[DIST_TAGS].latest]);
-                }
-              );
-            } else {
-              reject(err);
-            }
-          },
-        });
-      } catch (err: any) {
-        reject(err);
+function checkAccess(pkg: any, auth: any, remoteUser): Promise<Manifest | null> {
+  return new Promise((resolve, reject) => {
+    auth.allow_access({ packageName: pkg?.package?.name }, remoteUser, function (err, allowed) {
+      if (err) {
+        if (err.status && String(err.status).match(/^4\d\d$/)) {
+          // auth plugin returns 4xx user error,
+          // that's equivalent of !allowed basically
+          allowed = false;
+          return resolve(null);
+        } else {
+          reject(err);
+        }
+      } else {
+        return resolve(allowed ? pkg : null);
       }
     });
-  };
+  });
+}
 
+function addSearchWebApi(storage: Storage, auth: IAuth): Router {
+  const router = Router(); /* eslint new-cap: 0 */
   router.get(
     '/search/:anything',
     async function (
@@ -57,22 +41,47 @@ function addSearchWebApi(storage: Storage, auth: IAuth): Router {
       res: $ResponseExtend,
       next: $NextFunctionVer
     ): Promise<void> {
-      const results = SearchInstance.query(req.params.anything);
-      debug('search results %o', results);
-      if (results.length > 0) {
-        let packages: Package[] = [];
-        for (let result of results) {
-          try {
-            const pkg = await getPackageInfo(result.ref, req.remote_user);
-            debug('package found %o', result.ref);
-            packages.push(pkg);
-          } catch (err: any) {
-            debug('search for %o failed err %o', result.ref, err?.message);
-          }
-        }
-        next(packages);
-      } else {
-        next([]);
+      try {
+        let data;
+        const abort = new AbortController();
+        req.on('aborted', () => {
+          debug('search web aborted');
+          abort.abort();
+        });
+        const text: string = (req.params.anything as string) ?? '';
+        // These values are declared as optimal by npm cli
+        // FUTURE: could be overwritten by ui settings.
+        const size = 20;
+        const from = 0;
+        const query: SearchQuery = {
+          from: 0,
+          maintenance: 0.5,
+          popularity: 0.98,
+          quality: 0.65,
+          size: 20,
+          text,
+        };
+        // @ts-ignore
+        const urlParams = new URLSearchParams(query);
+        debug('search web init');
+        data = await storage.searchManager?.search({
+          query,
+          url: `/-/v1/search?${urlParams.toString()}`,
+          abort,
+        });
+        const checkAccessPromises: searchUtils.SearchItemPkg[] = await Promise.all(
+          data.map((pkgItem) => {
+            return checkAccess(pkgItem, auth, req.remote_user);
+          })
+        );
+
+        const final: searchUtils.SearchItemPkg[] = checkAccessPromises
+          .filter((i) => !_.isNull(i))
+          .slice(from, size);
+
+        next(final);
+      } catch (err: any) {
+        next(errorUtils.getInternalError(err.message));
       }
     }
   );

package/src/middleware/render-web.ts

@@ -5,7 +5,6 @@ import path from 'path';
 
 import { HTTP_STATUS } from '@verdaccio/core';
 import { loadPlugin } from '@verdaccio/loaders';
-import { SearchInstance } from '@verdaccio/store';
 import { isURLhasValidProtocol } from '@verdaccio/url';
 
 import renderHTML from '../renderHTML';
@@ -40,10 +39,9 @@ const sendFileCallback = (next) => (err) => {
   }
 };
 
-export function renderWebMiddleware(config, auth, storage): any {
+export function renderWebMiddleware(config, auth): any {
   const { staticPath, manifest, manifestFiles } = require('@verdaccio/ui-theme')();
   debug('static path %o', staticPath);
-  SearchInstance.configureStorage(storage);
 
   /* eslint new-cap:off */
   const router = express.Router();

package/src/middleware/web-api.ts

@@ -3,7 +3,6 @@ import { Router } from 'express';
 
 import { IAuth } from '@verdaccio/auth';
 import { match, validateName, validatePackage } from '@verdaccio/middleware';
-import { SearchInstance } from '@verdaccio/store';
 import { Storage } from '@verdaccio/store';
 import { Config } from '@verdaccio/types';
 
@@ -13,7 +12,6 @@ import { setSecurityWebHeaders } from './security';
 export function webAPI(config: Config, auth: IAuth, storage: Storage): Router {
   // eslint-disable-next-line new-cap
   const route = Router();
-  SearchInstance.configureStorage(storage);
   // validate all of these params as a package name
   // this might be too harsh, so ask if it causes trouble=
   route.param('package', validatePackage);

package/src/renderHTML.ts

@@ -4,6 +4,7 @@ import { URL } from 'url';
 
 import { WEB_TITLE } from '@verdaccio/config';
 import { HEADERS } from '@verdaccio/core';
+import { TemplateUIOptions } from '@verdaccio/types';
 import { getPublicUrl } from '@verdaccio/url';
 
 import renderTemplate from './template';
@@ -25,6 +26,9 @@ export default function renderHTML(config, manifest, manifestFiles, req, res) {
   const base = getPublicUrl(config?.url_prefix, req);
   const basename = new URL(base).pathname;
   const language = config?.i18n?.web ?? DEFAULT_LANGUAGE;
+  const needHtmlCache = [undefined, null].includes(config?.web?.html_cache)
+    ? true
+    : config.web.html_cache;
   const darkMode = config?.web?.darkMode ?? false;
   const title = config?.web?.title ?? WEB_TITLE;
   const login = hasLogin(config);
@@ -32,8 +36,21 @@ export default function renderHTML(config, manifest, manifestFiles, req, res) {
   const logoURI = config?.web?.logo ?? '';
   const pkgManagers = config?.web?.pkgManagers ?? ['yarn', 'pnpm', 'npm'];
   const version = pkgJSON.version;
+  const flags = {
+    ...config.flags,
+  };
   const primaryColor = validatePrimaryColor(config?.web?.primary_color) ?? '#4b5e40';
-  const { scriptsBodyAfter, metaScripts, scriptsbodyBefore } = Object.assign(
+  const {
+    scriptsBodyAfter,
+    metaScripts,
+    scriptsbodyBefore,
+    showInfo,
+    showSettings,
+    showThemeSwitch,
+    showFooter,
+    showSearch,
+    showDownloadTarball,
+  } = Object.assign(
     {},
     {
       scriptsBodyAfter: [],
@@ -42,7 +59,13 @@ export default function renderHTML(config, manifest, manifestFiles, req, res) {
     },
     config?.web
   );
-  const options = {
+  const options: TemplateUIOptions = {
+    showInfo,
+    showSettings,
+    showThemeSwitch,
+    showFooter,
+    showSearch,
+    showDownloadTarball,
     darkMode,
     url_prefix,
     basename,
@@ -50,6 +73,7 @@ export default function renderHTML(config, manifest, manifestFiles, req, res) {
     primaryColor,
     version,
     logoURI,
+    flags,
     login,
     pkgManagers,
     title,
@@ -61,10 +85,7 @@ export default function renderHTML(config, manifest, manifestFiles, req, res) {
 
   try {
     webPage = cache.get('template');
-
     if (!webPage) {
-      debug('web options %o', options);
-      debug('web manifestFiles %o', manifestFiles);
       webPage = renderTemplate(
         {
           manifest: manifestFiles ?? defaultManifestFiles,
@@ -75,9 +96,10 @@ export default function renderHTML(config, manifest, manifestFiles, req, res) {
         },
         manifest
       );
-      debug('template :: %o', webPage);
-      cache.set('template', webPage);
-      debug('set template cache');
+      if (needHtmlCache) {
+        cache.set('template', webPage);
+        debug('set template cache');
+      }
     } else {
       debug('reuse template cache');
     }
@@ -86,5 +108,5 @@ export default function renderHTML(config, manifest, manifestFiles, req, res) {
   }
   res.setHeader('Content-Type', HEADERS.TEXT_HTML);
   res.send(webPage);
-  debug('render web');
+  debug('web rendered');
 }

package/src/utils/web-utils.ts

@@ -10,7 +10,7 @@ export type AuthorAvatar = Author & { avatar?: string };
 const debug = buildDebug('verdaccio:web:utils');
 
 export function validatePrimaryColor(primaryColor) {
-  const isHex = /^#+([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$/i.test(primaryColor);
+  const isHex = /^#([0-9A-F]{3}){1,2}$/i.test(primaryColor);
   if (!isHex) {
     debug('invalid primary color %o', primaryColor);
     return;

package/src/web-middleware.ts

@@ -7,7 +7,7 @@ export default (config, auth, storage) => {
   // eslint-disable-next-line new-cap
   const app = express.Router();
   // load application
-  app.use('/', renderWebMiddleware(config, auth, storage));
+  app.use('/', renderWebMiddleware(config, auth));
   // web endpoints, search, packages, etc
   app.use('/-/verdaccio/', webAPI(config, auth, storage));
   return app;

package/test/api.readme.test.ts

@@ -3,7 +3,7 @@ import supertest from 'supertest';
 
 import { HEADERS, HEADER_TYPE, HTTP_STATUS } from '@verdaccio/core';
 import { setup } from '@verdaccio/logger';
-import { IGetPackageOptions } from '@verdaccio/store';
+import { publishVersion } from '@verdaccio/test-helper';
 
 import { NOT_README_FOUND } from '../src/api/readme';
 import { initializeServer } from './helper';
@@ -13,30 +13,6 @@ setup([]);
 const mockManifest = jest.fn();
 jest.mock('@verdaccio/ui-theme', () => mockManifest());
 
-jest.mock('@verdaccio/store', () => ({
-  Storage: class {
-    public init() {
-      return Promise.resolve();
-    }
-    public getPackage({ name, callback }: IGetPackageOptions) {
-      callback(null, {
-        name,
-        ['dist-tags']: {
-          latest: '1.0.0',
-        },
-        versions: {
-          ['1.0.0']: {
-            name,
-          },
-        },
-      });
-    }
-  },
-  SearchInstance: {
-    configureStorage: () => {},
-  },
-}));
-
 describe('readme api', () => {
   beforeAll(() => {
     mockManifest.mockReturnValue(() => ({
@@ -54,7 +30,20 @@ describe('readme api', () => {
   });
 
   test('should fetch readme scoped package', async () => {
-    const response = await supertest(await initializeServer('default-test.yaml'))
+    const app = await initializeServer('default-test.yaml');
+    await publishVersion(app, '@scope/pk1-test', '1.0.0', { readme: 'my readme scoped' });
+    const response = await supertest(app)
+      .get('/-/verdaccio/data/package/readme/@scope/pk1-test')
+      .set('Accept', HEADERS.TEXT_PLAIN)
+      .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_PLAIN_UTF8)
+      .expect(HTTP_STATUS.OK);
+    expect(response.text).toMatch('my readme scoped');
+  });
+
+  test('should fetch readme scoped package with not found message', async () => {
+    const app = await initializeServer('default-test.yaml');
+    await publishVersion(app, '@scope/pk1-test', '1.0.0', { readme: null });
+    const response = await supertest(app)
       .get('/-/verdaccio/data/package/readme/@scope/pk1-test')
       .set('Accept', HEADERS.TEXT_PLAIN)
       .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_PLAIN_UTF8)
@@ -63,7 +52,20 @@ describe('readme api', () => {
   });
 
   test('should fetch readme a package', async () => {
-    const response = await supertest(await initializeServer('default-test.yaml'))
+    const app = await initializeServer('default-test.yaml');
+    await publishVersion(app, 'pk1-test', '1.0.0', { readme: 'my readme' });
+    const response = await supertest(app)
+      .get('/-/verdaccio/data/package/readme/pk1-test')
+      .set('Accept', HEADERS.TEXT_PLAIN)
+      .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_PLAIN_UTF8)
+      .expect(HTTP_STATUS.OK);
+    expect(response.text).toMatch('my readme');
+  });
+
+  test('should fetch readme a package with not found message', async () => {
+    const app = await initializeServer('default-test.yaml');
+    await publishVersion(app, 'pk1-test', '1.0.0', { readme: null });
+    const response = await supertest(app)
       .get('/-/verdaccio/data/package/readme/pk1-test')
       .set('Accept', HEADERS.TEXT_PLAIN)
       .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_PLAIN_UTF8)

package/test/api.search.test.ts

@@ -3,44 +3,15 @@ import supertest from 'supertest';
 
 import { HEADERS, HEADER_TYPE, HTTP_STATUS } from '@verdaccio/core';
 import { setup } from '@verdaccio/logger';
-import { IGetPackageOptions } from '@verdaccio/store';
+import { publishVersion } from '@verdaccio/test-helper';
 
 import { initializeServer } from './helper';
 
 setup([]);
 
 const mockManifest = jest.fn();
-const mockQuery = jest.fn(() => [
-  { ref: 'pkg1', score: 1 },
-  { ref: 'pk2', score: 0.9 },
-]);
 jest.mock('@verdaccio/ui-theme', () => mockManifest());
 
-jest.mock('@verdaccio/store', () => ({
-  Storage: class {
-    public init() {
-      return Promise.resolve();
-    }
-    public getPackage({ name, callback }: IGetPackageOptions) {
-      callback(null, {
-        name,
-        ['dist-tags']: {
-          latest: '1.0.0',
-        },
-        versions: {
-          ['1.0.0']: {
-            name,
-          },
-        },
-      });
-    }
-  },
-  SearchInstance: {
-    configureStorage: () => {},
-    query: () => mockQuery(),
-  },
-}));
-
 describe('test web server', () => {
   beforeAll(() => {
     mockManifest.mockReturnValue(() => ({
@@ -53,21 +24,24 @@ describe('test web server', () => {
   });
 
   afterEach(() => {
+    Date.now = jest.fn(() => new Date(Date.UTC(2017, 1, 14)).valueOf());
     jest.clearAllMocks();
     mockManifest.mockClear();
   });
 
-  test('should OK to search api', async () => {
-    const response = await supertest(await initializeServer('default-test.yaml'))
-      .get('/-/verdaccio/data/search/keyword')
+  test('should find results to search api', async () => {
+    const app = await initializeServer('default-test.yaml');
+    await publishVersion(app, 'foo', '1.0.0');
+    const response = await supertest(app)
+      .get('/-/verdaccio/data/search/foo')
       .set('Accept', HEADERS.JSON_CHARSET)
       .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.JSON_CHARSET)
       .expect(HTTP_STATUS.OK);
-    expect(response.body).toHaveLength(2);
+    expect(response.body).toHaveLength(1);
+    // FUTURE: we can improve here matching the right outcome
   });
 
-  test('should 404 to search api', async () => {
-    mockQuery.mockReturnValue([]);
+  test('should found no results to search', async () => {
     const response = await supertest(await initializeServer('default-test.yaml'))
       .get('/-/verdaccio/data/search/notFound')
       .set('Accept', HEADERS.JSON_CHARSET)
@@ -76,19 +50,18 @@ describe('test web server', () => {
     expect(response.body).toHaveLength(0);
   });
 
-  test('should fail search api', async () => {
-    mockQuery.mockImplementation(() => {
-      return [
-        { ref: 'aa', score: 1 },
-        { ref: 'bb', score: 0.8 },
-        { ref: 'cc', score: 0.6 },
-      ];
-    });
+  // TODO: need a way to make this fail
+  test.skip('should fail search api', async () => {
     const response = await supertest(await initializeServer('default-test.yaml'))
-      .get('/-/verdaccio/data/search/notFound')
+      .get('/-/verdaccio/data/search/thisWillFail')
       .set('Accept', HEADERS.JSON_CHARSET)
       .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.JSON_CHARSET)
       .expect(HTTP_STATUS.OK);
     expect(response.body).toHaveLength(3);
   });
+
+  test.todo('search abort request');
+  // maybe these could be done in storage package to avoid have specifics on this level
+  test.todo('search allow request permissions');
+  test.todo('search query params, pagination etc');
 });