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

package/test/api.sidebar.test.ts

@@ -3,9 +3,8 @@ 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';
 
 setup([]);
@@ -13,36 +12,15 @@ 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.skip('sidebar api', () => {
+describe('sidebar api', () => {
   beforeAll(() => {
-    mockManifest.mockReturnValue({
+    mockManifest.mockReturnValue(() => ({
       staticPath: path.join(__dirname, 'static'),
+      manifestFiles: {
+        js: ['runtime.js', 'vendors.js', 'main.js'],
+      },
       manifest: require('./partials/manifest/manifest.json'),
-    });
+    }));
   });
 
   afterEach(() => {
@@ -50,15 +28,23 @@ describe.skip('sidebar api', () => {
     mockManifest.mockClear();
   });
 
-  test('should display sidebar info', async () => {
-    mockManifest.mockReturnValue({
-      manifest: require('./partials/manifest/manifest.json'),
-    });
-    const response = await supertest(await initializeServer('default-test.yaml'))
+  test('should display sidebar info scoped package', async () => {
+    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/sidebar/@scope/pk1-test')
-      .set('Accept', HEADERS.TEXT_PLAIN)
       .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.JSON_CHARSET)
       .expect(HTTP_STATUS.OK);
-    expect(response.text).toMatch(NOT_README_FOUND);
+    expect(response.text).toMatch('@scope/pk1-test');
+  });
+
+  test('should display sidebar info package', async () => {
+    const app = await initializeServer('default-test.yaml');
+    await publishVersion(app, 'pk2-test', '1.0.0', { readme: 'my readme scoped' });
+    const response = await supertest(app)
+      .get('/-/verdaccio/data/sidebar/pk2-test')
+      .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.JSON_CHARSET)
+      .expect(HTTP_STATUS.OK);
+    expect(response.text).toMatch('pk2-test');
   });
 });

package/test/api.user.test.ts

@@ -64,7 +64,7 @@ describe('test web server', () => {
       });
   });
 
-  test('log in should be disabled', async () => {
+  test.skip('log in should be disabled', async () => {
     return supertest(await initializeServer('login-disabled.yaml'))
       .post('/-/verdaccio/sec/login')
       .send(

package/test/config/default-test.yaml

@@ -1,7 +1,3 @@
-store:
-  memory:
-    limit: 1000
-
 auth:
   auth-memory:
     users:
@@ -17,7 +13,7 @@ publish:
 
 uplinks:
 
-logs: { type: stdout, format: pretty, level: trace }
+log: { type: stdout, format: pretty, level: trace }
 
 packages:
   '@*/*':

package/test/config/login-disabled.yaml

@@ -1,7 +1,3 @@
-store:
-  memory:
-    limit: 1000
-
 auth:
   auth-memory:
     users:
@@ -18,7 +14,7 @@ publish:
 
 uplinks:
 
-logs: { type: stdout, format: pretty, level: trace }
+log: { type: stdout, format: pretty, level: trace }
 
 packages:
   '@*/*':

package/test/config/web.yaml

@@ -0,0 +1,46 @@
+auth:
+  auth-memory:
+    users:
+      test:
+        name: test
+        password: test
+
+web:
+  title: verdaccio web
+  login: true
+  scope: '@scope'
+  pkgManagers:
+    - pnpm
+    - yarn
+  showInfo: true
+  showSettings: true
+  showSearch: true
+  showFooter: true
+  showThemeSwitch: true
+  showDownloadTarball: true
+  showRaw: true
+  primary_color: '#ffffff'
+  logoURI: 'http://logo.org/logo.png'
+  flags:
+    - something: false
+
+url_prefix: /prefix
+
+publish:
+  allow_offline: false
+
+uplinks:
+
+log: { type: stdout, format: pretty, level: trace }
+
+packages:
+  '@*/*':
+    access: $anonymous
+    publish: $anonymous
+  '**':
+    access: $anonymous
+    publish: $anonymous
+_debug: true
+
+flags:
+  changePassword: true

package/test/helper.ts

@@ -1,38 +1,22 @@
-import bodyParser from 'body-parser';
-import express from 'express';
 import { Application } from 'express';
 import path from 'path';
 
-import { Auth, IAuth } from '@verdaccio/auth';
-import { Config, parseConfigFile } from '@verdaccio/config';
+import apiMiddleware from '@verdaccio/api';
+import { parseConfigFile } from '@verdaccio/config';
 import { setup } from '@verdaccio/logger';
-import { errorReportingMiddleware, final, handleError } from '@verdaccio/middleware';
 import { Storage } from '@verdaccio/store';
+import { initializeServer as initializeServerHelper } from '@verdaccio/test-helper';
 
 import routes from '../src';
 
 setup([]);
 
-const getConf = (configName: string) => {
+export const getConf = (configName: string) => {
   const configPath = path.join(__dirname, 'config', configName);
   return parseConfigFile(configPath);
 };
 
-export async function initializeServer(configName: string): Promise<Application> {
-  const app = express();
-  const config = new Config(getConf(configName));
-  config.checkSecretKey('12345');
-  const storage = new Storage(config);
-  await storage.init(config, []);
-  const auth: IAuth = new Auth(config);
-  // for parsing the body (login api)
-  app.use(bodyParser.json({ strict: false, limit: '10mb' }));
-  // @ts-ignore
-  app.use(errorReportingMiddleware);
-  app.use(routes(config, auth, storage));
-  // @ts-ignore
-  app.use(handleError);
-  // @ts-ignore
-  app.use(final);
-  return app;
+// @deprecated
+export async function initializeServer(configName): Promise<Application> {
+  return initializeServerHelper(getConf(configName), [apiMiddleware, routes], Storage);
 }

package/test/partials/search/search-v1.json

@@ -0,0 +1,157 @@
+{
+  "objects": [
+    {
+      "package": {
+        "name": "verdaccio",
+        "scope": "unscoped",
+        "version": "5.1.2",
+        "description": "A lightweight private npm proxy registry",
+        "keywords": [
+          "private",
+          "package",
+          "repository",
+          "registry",
+          "enterprise",
+          "modules",
+          "proxy",
+          "server",
+          "verdaccio"
+        ],
+        "date": "2021-07-14T18:26:48.823Z",
+        "links": {
+          "npm": "https://www.npmjs.com/package/verdaccio",
+          "homepage": "https://verdaccio.org",
+          "repository": "https://github.com/verdaccio/verdaccio",
+          "bugs": "https://github.com/verdaccio/verdaccio/issues"
+        },
+        "author": {
+          "name": "Verdaccio Maintainers",
+          "email": "verdaccio.npm@gmail.com",
+          "username": "verdaccio.npm"
+        },
+        "publisher": { "username": "verdaccio.npm", "email": "verdaccio.npm@gmail.com" },
+        "maintainers": [
+          { "username": "jotadeveloper", "email": "juanpicado19@gmail.com" },
+          { "username": "ayusharma", "email": "ayush.aceit@gmail.com" },
+          { "username": "trentearl", "email": "trent@trentearl.com" },
+          { "username": "jmwilkinson", "email": "J.Wilkinson@f5.com" },
+          { "username": "sergiohgz", "email": "sergio@sergiohgz.eu" },
+          { "username": "verdaccio.npm", "email": "verdaccio.npm@gmail.com" }
+        ]
+      },
+      "score": {
+        "final": 0.38839042352668346,
+        "detail": {
+          "quality": 0.6389690936404147,
+          "popularity": 0.22866579647969262,
+          "maintenance": 0.3333333333333333
+        }
+      },
+      "searchScore": 100000.375
+    },
+    {
+      "package": {
+        "name": "verdaccio-bitbucket",
+        "scope": "unscoped",
+        "version": "3.0.1",
+        "description": "Verdaccio module to authenticate users via Bitbucket",
+        "keywords": [
+          "sinopia",
+          "verdaccio",
+          "bitbucket",
+          "atlassian",
+          "auth",
+          "node",
+          "nodejs",
+          "js",
+          "javascript"
+        ],
+        "date": "2020-11-17T18:31:50.893Z",
+        "links": { "npm": "https://www.npmjs.com/package/verdaccio-bitbucket" },
+        "author": {
+          "name": "Idan Gozlan",
+          "email": "idangozlan@gmail.com",
+          "username": "idangozlan"
+        },
+        "publisher": { "username": "idangozlan", "email": "idangozlan@gmail.com" },
+        "maintainers": [{ "username": "idangozlan", "email": "idangozlan@gmail.com" }]
+      },
+      "score": {
+        "final": 0.3676150990565089,
+        "detail": {
+          "quality": 0.9333033508158308,
+          "popularity": 0.005251300076726234,
+          "maintenance": 0.2451032536711585
+        }
+      },
+      "searchScore": 0.00029462433
+    },
+    {
+      "package": {
+        "name": "verdaccio-badger",
+        "scope": "unscoped",
+        "version": "1.0.0",
+        "description": "verdaccio middleware plugin to serve svg badges",
+        "keywords": ["verdaccio", "plugin", "middleware", "badge", "badges"],
+        "date": "2020-08-02T18:08:10.321Z",
+        "links": {
+          "npm": "https://www.npmjs.com/package/verdaccio-badger",
+          "homepage": "https://github.com/PaddeK/verdaccio-badger",
+          "repository": "https://github.com/PaddeK/verdaccio-badger",
+          "bugs": "https://github.com/PaddeK/verdaccio-badger/issues"
+        },
+        "author": { "name": "Patrick Klös", "email": "pkloes@web.de", "username": "paddek" },
+        "publisher": { "username": "paddek", "email": "pkloes@web.de" },
+        "maintainers": [{ "username": "paddek", "email": "pkloes@web.de" }]
+      },
+      "score": {
+        "final": 0.3595405976501428,
+        "detail": {
+          "quality": 0.920245406776651,
+          "popularity": 0.0027140305161327217,
+          "maintenance": 0.23576304267571743
+        }
+      },
+      "searchScore": 0.00022687363
+    },
+    {
+      "package": {
+        "name": "@verdaccio/streams",
+        "scope": "verdaccio",
+        "version": "10.0.0",
+        "description": "Stream extension for Verdaccio",
+        "keywords": ["verdaccio", "streams"],
+        "date": "2021-03-29T13:01:49.263Z",
+        "links": {
+          "npm": "https://www.npmjs.com/package/%40verdaccio%2Fstreams",
+          "homepage": "https://verdaccio.org",
+          "repository": "https://github.com/verdaccio/monorepo",
+          "bugs": "https://github.com/verdaccio/monorepo/issues"
+        },
+        "author": {
+          "name": "Juan Picado",
+          "email": "juanpicado19@gmail.com",
+          "username": "jotadeveloper"
+        },
+        "publisher": { "username": "verdaccio.npm", "email": "verdaccio.npm@gmail.com" },
+        "maintainers": [
+          { "username": "sergiohgz", "email": "sergio@sergiohgz.eu" },
+          { "username": "verdaccio.npm", "email": "verdaccio.npm@gmail.com" },
+          { "username": "jotadeveloper", "email": "juanpicado19@gmail.com" },
+          { "username": "ayusharma", "email": "ayush.aceit@gmail.com" }
+        ]
+      },
+      "score": {
+        "final": 0.34805712275547446,
+        "detail": {
+          "quality": 0.6324693223008875,
+          "popularity": 0.11950424927689082,
+          "maintenance": 0.3328281109094184
+        }
+      },
+      "searchScore": 0.00015023774
+    }
+  ],
+  "total": 218,
+  "time": "Sun Jul 25 2021 14:11:11 GMT+0000 (Coordinated Universal Time)"
+}

package/test/render.test.ts

@@ -1,3 +1,4 @@
+import { JSDOM } from 'jsdom';
 import path from 'path';
 import supertest from 'supertest';
 
@@ -28,34 +29,80 @@ describe('test web server', () => {
   });
 
   describe('render', () => {
-    test('should return the root', async () => {
-      return supertest(await initializeServer('default-test.yaml'))
-        .get('/')
-        .set('Accept', HEADERS.TEXT_HTML)
-        .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
-        .expect(HTTP_STATUS.OK);
-    });
+    describe('output', () => {
+      const render = async (config = 'default-test.yaml') => {
+        const response = await supertest(await initializeServer(config))
+          .get('/')
+          .set('Accept', HEADERS.TEXT_HTML)
+          .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
+          .expect(HTTP_STATUS.OK);
+        return new JSDOM(response.text, { runScripts: 'dangerously' });
+      };
 
-    test('should return the body for a package detail page', async () => {
-      return supertest(await initializeServer('default-test.yaml'))
-        .get('/-/web/section/some-package')
-        .set('Accept', HEADERS.TEXT_HTML)
-        .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
-        .expect(HTTP_STATUS.OK);
-    });
+      test('should match render set ui properties', async () => {
+        const {
+          window: { __VERDACCIO_BASENAME_UI_OPTIONS },
+        } = await render('web.yaml');
+        expect(__VERDACCIO_BASENAME_UI_OPTIONS).toEqual(
+          expect.objectContaining({
+            showInfo: true,
+            showSettings: true,
+            showThemeSwitch: true,
+            showFooter: true,
+            showSearch: true,
+            showDownloadTarball: true,
+            darkMode: false,
+            url_prefix: '/prefix',
+            basename: '/prefix/',
+            primaryColor: '#ffffff',
+            // FIXME: mock these values, avoid random
+            // base: 'http://127.0.0.1:60864/prefix/',
+            // version: '6.0.0-6-next.28',
+            logoURI: '',
+            flags: { searchRemote: true },
+            login: true,
+            pkgManagers: ['pnpm', 'yarn'],
+            title: 'verdaccio web',
+            scope: '@scope',
+            language: 'es-US',
+          })
+        );
+      });
 
-    test('should static file not found', async () => {
-      return supertest(await initializeServer('default-test.yaml'))
-        .get('/-/static/not-found.js')
-        .set('Accept', HEADERS.TEXT_HTML)
-        .expect(HTTP_STATUS.NOT_FOUND);
+      test.todo('test default title');
+      test.todo('test need html cache');
     });
 
-    test('should static file found', async () => {
-      return supertest(await initializeServer('default-test.yaml'))
-        .get('/-/static/main.js')
-        .set('Accept', HEADERS.TEXT_HTML)
-        .expect(HTTP_STATUS.OK);
+    describe('status', () => {
+      test('should return the http status 200 for root', async () => {
+        return supertest(await initializeServer('default-test.yaml'))
+          .get('/')
+          .set('Accept', HEADERS.TEXT_HTML)
+          .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
+          .expect(HTTP_STATUS.OK);
+      });
+
+      test('should return the body for a package detail page', async () => {
+        return supertest(await initializeServer('default-test.yaml'))
+          .get('/-/web/section/some-package')
+          .set('Accept', HEADERS.TEXT_HTML)
+          .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
+          .expect(HTTP_STATUS.OK);
+      });
+
+      test('should static file not found', async () => {
+        return supertest(await initializeServer('default-test.yaml'))
+          .get('/-/static/not-found.js')
+          .set('Accept', HEADERS.TEXT_HTML)
+          .expect(HTTP_STATUS.NOT_FOUND);
+      });
+
+      test('should static file found', async () => {
+        return supertest(await initializeServer('default-test.yaml'))
+          .get('/-/static/main.js')
+          .set('Accept', HEADERS.TEXT_HTML)
+          .expect(HTTP_STATUS.OK);
+      });
     });
   });
 });

package/test/utils.spec.ts

@@ -1,13 +1,22 @@
 import fs from 'fs';
 import path from 'path';
 
-import { parseReadme } from '../src/utils/web-utils';
+import { parseReadme, validatePrimaryColor } from '../src/utils/web-utils';
 
 const readmeFile = (fileName = 'markdown.md') => {
   return fs.readFileSync(path.join(__dirname, `./partials/readme/${fileName}`));
 };
 
 describe('Utilities', () => {
+  describe('validatePrimaryColor', () => {
+    test('is valid', () => {
+      expect(validatePrimaryColor('#222222')).toEqual('#222222');
+      expect(validatePrimaryColor('#222fff')).toEqual('#222fff');
+    });
+    test('is invalid', () => {
+      expect(validatePrimaryColor('fff')).toBeUndefined();
+    });
+  });
   describe('parseReadme', () => {
     test('should parse makrdown text to html template', () => {
       const markdown = '# markdown';

package/tsconfig.json

@@ -28,6 +28,9 @@
     {
       "path": "../loaders"
     },
+    {
+      "path": "../api"
+    },
     {
       "path": "../logger"
     },
@@ -43,6 +46,9 @@
     {
       "path": "../store"
     },
+    {
+      "path": "../tools/helpers"
+    },
     {
       "path": "../utils"
     }