@verdaccio/node-api 8.0.0-next-8.11 → 8.0.0-next-8.13

package/examples/.eslintrc

@@ -1,5 +0,0 @@
-{
-  "rules": {
-    "no-console": "off"
-  }
-}

package/examples/default.configuration.example.js

@@ -1,8 +0,0 @@
-const { runServer } = require('../build');
-
-(async () => {
-  const app = await runServer();
-  app.listen(4000, () => {
-    console.log('server started');
-  });
-})();

package/src/cli-utils.ts

@@ -1,84 +0,0 @@
-import { warningUtils } from '@verdaccio/core';
-
-export const DEFAULT_PORT = '4873';
-export const DEFAULT_PROTOCOL = 'http';
-export const DEFAULT_DOMAIN = 'localhost';
-/**
- * Parse an internet address
- * Allow:
- - https:localhost:1234        - protocol + host + port
- - localhost:1234              - host + port
- - 1234                        - port
- - http::1234                  - protocol + port
- - https://localhost:443/      - full url + https
- - http://[::1]:443/           - ipv6
- - unix:/tmp/http.sock         - unix sockets
- - https://unix:/tmp/http.sock - unix sockets (https)
- * @param {*} urlAddress the internet address definition
- * @return {Object|Null} literal object that represent the address parsed
- */
-export function parseAddress(urlAddress: any): any {
-  //
-  // TODO: refactor it to something more reasonable?
-  //
-  //        protocol :  //      (  host  )|(    ipv6     ):  port  /
-  let urlPattern = /^((https?):(\/\/)?)?((([^\/:]*)|\[([^\[\]]+)\]):)?(\d+)\/?$/.exec(urlAddress);
-
-  if (urlPattern) {
-    return {
-      proto: urlPattern[2] || DEFAULT_PROTOCOL,
-      host: urlPattern[6] || urlPattern[7] || DEFAULT_DOMAIN,
-      port: urlPattern[8] || DEFAULT_PORT,
-    };
-  }
-
-  urlPattern = /^((https?):(\/\/)?)?unix:(.*)$/.exec(urlAddress);
-
-  if (urlPattern) {
-    return {
-      proto: urlPattern[2] || DEFAULT_PROTOCOL,
-      path: urlPattern[4],
-    };
-  }
-
-  return null;
-}
-
-/**
- * Retrieve all addresses defined in the config file.
- * Verdaccio is able to listen multiple ports
- * @param {String} argListen
- * @param {String} configListen
- * eg:
- *  listen:
- - localhost:5555
- - localhost:5557
- @return {Array}
- */
-export function getListListenAddresses(argListen: string | void, configListen: any): any {
-  // command line || config file || default
-  let addresses;
-  if (argListen) {
-    addresses = [argListen];
-  } else if (Array.isArray(configListen)) {
-    addresses = configListen;
-    process.emitWarning('multiple addresses will be deprecated in the next major, only use one');
-  } else if (configListen) {
-    addresses = [configListen];
-  } else {
-    addresses = [DEFAULT_PORT];
-  }
-  addresses = addresses
-    .map(function (addr): string {
-      const parsedAddr = parseAddress(addr);
-
-      if (!parsedAddr) {
-        warningUtils.emit(warningUtils.Codes.VERWAR004, addr);
-      }
-
-      return parsedAddr;
-    })
-    .filter(Boolean);
-
-  return addresses;
-}

package/src/experiments.ts

@@ -1,23 +0,0 @@
-import { logger } from '@verdaccio/logger';
-
-export function displayExperimentsInfoBox(flags) {
-  if (!flags) {
-    return;
-  }
-
-  const experimentList = Object.keys(flags);
-  if (experimentList.length >= 1) {
-    logger.warn(
-      // eslint-disable-next-line max-len
-      `experiments are enabled, it is recommended do not use experiments in production comment out this section to disable it`
-    );
-    experimentList.forEach((experiment) => {
-      // eslint-disable-next-line max-len
-      logger.info(
-        `support for experiment [${experiment}] ${
-          flags[experiment] ? 'is enabled' : ' is disabled'
-        }`
-      );
-    });
-  }
-}

package/src/index.ts

@@ -1 +0,0 @@
-export { initServer, runServer } from './server';

package/src/server.ts

@@ -1,217 +0,0 @@
-/* eslint-disable */
-import constants from 'constants';
-import buildDebug from 'debug';
-import fs from 'fs';
-import http from 'http';
-import https from 'https';
-import _, { assign, isFunction } from 'lodash';
-import url from 'url';
-
-import { findConfigFile, parseConfigFile } from '@verdaccio/config';
-import { API_ERROR } from '@verdaccio/core';
-import { setup } from '@verdaccio/logger';
-import expressServer from '@verdaccio/server';
-import fastifyServer from '@verdaccio/server-fastify';
-import { ConfigYaml, HttpsConfKeyCert, HttpsConfPfx } from '@verdaccio/types';
-
-import { getListListenAddresses } from './cli-utils';
-import { displayExperimentsInfoBox } from './experiments';
-
-const debug = buildDebug('verdaccio:node-api');
-
-function unlinkAddressPath(addr) {
-  if (addr.path && fs.existsSync(addr.path)) {
-    fs.unlinkSync(addr.path);
-  }
-}
-
-/**
- * Return a native HTTP/HTTPS server instance
- * @param config
- * @param addr
- * @param app
- */
-export function createServerFactory(config: ConfigYaml, addr, app) {
-  let serverFactory;
-  if (addr.proto === 'https') {
-    debug('https enabled');
-    try {
-      let httpsOptions = {
-        // disable insecure SSLv2 and SSLv3
-        secureOptions: constants.SSL_OP_NO_SSLv2 | constants.SSL_OP_NO_SSLv3,
-      };
-
-      const keyCertConfig = config.https as HttpsConfKeyCert;
-      const pfxConfig = config.https as HttpsConfPfx;
-
-      // https must either have key and cert or a pfx and (optionally) a passphrase
-      if (!((keyCertConfig.key && keyCertConfig.cert) || pfxConfig.pfx)) {
-        // logHTTPSError(configPath);
-        throw Error('bad format https configuration');
-      }
-
-      if (pfxConfig.pfx) {
-        const { pfx, passphrase } = pfxConfig;
-        httpsOptions = assign(httpsOptions, {
-          pfx: fs.readFileSync(pfx),
-          passphrase: passphrase || '',
-        });
-      } else {
-        const { key, cert, ca } = keyCertConfig;
-        httpsOptions = assign(httpsOptions, {
-          key: fs.readFileSync(key),
-          cert: fs.readFileSync(cert),
-          ...(ca && {
-            ca: fs.readFileSync(ca),
-          }),
-        });
-      }
-      // TODO: enable http2 as feature
-      // if (config.server.http2) <-- check if force http2
-      serverFactory = https.createServer(httpsOptions, app);
-    } catch (err: any) {
-      throw new Error(`cannot create https server: ${err.message}`);
-    }
-  } else {
-    // http
-    debug('http enabled');
-    serverFactory = http.createServer(app);
-  }
-
-  // List of all routes registered in the app
-  function printRoutes(layer) {
-    if (layer.route) {
-      debug('%s (%s)', layer.route.path, Object.keys(layer.route.methods).join(', '));
-    } else if (layer.name === 'router') {
-      layer.handle.stack.forEach((nestedLayer) => {
-        printRoutes(nestedLayer);
-      });
-    }
-  }
-
-  debug('registered routes:');
-  app._router.stack.forEach(printRoutes);
-
-  if (
-    config.server &&
-    typeof config.server.keepAliveTimeout !== 'undefined' &&
-    // @ts-ignore
-    config.server.keepAliveTimeout !== 'null'
-  ) {
-    // library definition for node is not up to date (doesn't contain recent 8.0 changes)
-    serverFactory.keepAliveTimeout = config.server.keepAliveTimeout * 1000;
-  }
-  // FIXE: I could not find the reason of this code.
-  unlinkAddressPath(addr);
-
-  return serverFactory;
-}
-
-/**
- * Start the server on the port defined
- * @param config
- * @param port
- * @param version
- * @param pkgName
- */
-export async function initServer(
-  config: ConfigYaml,
-  port: string | void,
-  version: string,
-  pkgName: string
-): Promise<void> {
-  return new Promise(async (resolve, reject) => {
-    // FIXME: get only the first match, the multiple address will be removed
-    const [addr] = getListListenAddresses(port, config.listen);
-    const logger = setup(config?.log as any);
-    displayExperimentsInfoBox(config.flags);
-
-    let app;
-    if (process.env.VERDACCIO_SERVER === 'fastify') {
-      app = await fastifyServer(config);
-      app.listen({ port: addr.port, host: addr.host }, (err) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve();
-        }
-      });
-    } else {
-      app = await expressServer(config);
-      const serverFactory = createServerFactory(config, addr, app);
-      serverFactory
-        .listen(addr.port || addr.path, addr.host, (): void => {
-          // send a message for test
-          if (isFunction(process.send)) {
-            process.send({
-              verdaccio_started: true,
-            });
-          }
-          const addressServer = `${
-            addr.path
-              ? url.format({
-                  protocol: 'unix',
-                  pathname: addr.path,
-                })
-              : url.format({
-                  protocol: addr.proto,
-                  hostname: addr.host,
-                  port: addr.port,
-                  pathname: '/',
-                })
-          }`;
-          logger.info({ addressServer }, 'http address: @{addressServer}');
-          logger.info({ version }, 'version: @{version}');
-          resolve();
-        })
-        .on('error', function (err): void {
-          reject(err);
-          process.exitCode = 1;
-        });
-      function handleShutdownGracefully() {
-        logger.info('received shutdown signal - closing server gracefully...');
-        serverFactory.close(() => {
-          logger.info('server closed.');
-          process.exit(0);
-        });
-      }
-
-      for (const signal of ['SIGINT', 'SIGTERM', 'SIGHUP']) {
-        // Use once() so that receiving double signals exit the app.
-        process.once(signal, handleShutdownGracefully);
-      }
-    }
-  });
-}
-
-/**
- * Exposes a server factory to be instantiated programmatically.
- *
-    ```ts
-    const app = await runServer(); // default configuration
-    const app = await runServer('./config/config.yaml');
-    const app = await runServer({ configuration });
-    app.listen(4000, (event) => {
-    // do something
-    });
-    ```
- * @param config
- */
-export async function runServer(config?: string | ConfigYaml): Promise<any> {
-  let configurationParsed: ConfigYaml;
-  if (config === undefined || typeof config === 'string') {
-    const configPathLocation = findConfigFile(config);
-    configurationParsed = parseConfigFile(configPathLocation);
-  } else if (_.isObject(config)) {
-    configurationParsed = config;
-  } else {
-    throw new Error(API_ERROR.CONFIG_BAD_FORMAT);
-  }
-
-  setup(configurationParsed.log as any);
-  displayExperimentsInfoBox(configurationParsed.flags);
-  // FIXME: get only the first match, the multiple address will be removed
-  const [addr] = getListListenAddresses(undefined, configurationParsed.listen);
-  const app = await expressServer(configurationParsed);
-  return createServerFactory(configurationParsed, addr, app);
-}

package/test/node-api.utils.spec.ts

@@ -1,68 +0,0 @@
-import _ from 'lodash';
-import { describe, expect, test } from 'vitest';
-
-import {
-  DEFAULT_DOMAIN,
-  DEFAULT_PORT,
-  DEFAULT_PROTOCOL,
-  getListListenAddresses,
-} from '../src/cli-utils';
-
-describe('getListListenAddresses test', () => {
-  test('should return no address if a single address is wrong', () => {
-    // @ts-ignore
-    const addrs = getListListenAddresses('wrong');
-
-    expect(_.isArray(addrs)).toBeTruthy();
-    expect(addrs).toHaveLength(0);
-  });
-
-  test('should return no address if a two address are wrong', () => {
-    // @ts-ignore
-    const addrs = getListListenAddresses(['wrong', 'same-wrong']);
-
-    expect(_.isArray(addrs)).toBeTruthy();
-    expect(addrs).toHaveLength(0);
-  });
-
-  test('should return a list of 1 address provided', () => {
-    // @ts-ignore
-    const addrs = getListListenAddresses(null, '1000');
-
-    expect(_.isArray(addrs)).toBeTruthy();
-    expect(addrs).toHaveLength(1);
-  });
-
-  test('should return a list of 2 address provided', () => {
-    // @ts-ignore
-    const addrs = getListListenAddresses(null, ['1000', '2000']);
-
-    expect(_.isArray(addrs)).toBeTruthy();
-    expect(addrs).toHaveLength(2);
-  });
-
-  test(`should return by default ${DEFAULT_PORT}`, () => {
-    // @ts-ignore
-    const [addrs] = getListListenAddresses();
-
-    // @ts-ignore
-    expect(addrs.proto).toBe(DEFAULT_PROTOCOL);
-    // @ts-ignore
-    expect(addrs.host).toBe(DEFAULT_DOMAIN);
-    // @ts-ignore
-    expect(addrs.port).toBe(DEFAULT_PORT);
-  });
-
-  test('should return default proto, host and custom port', () => {
-    const initPort = '1000';
-    // @ts-ignore
-    const [addrs] = getListListenAddresses(null, initPort);
-
-    // @ts-ignore
-    expect(addrs.proto).toEqual(DEFAULT_PROTOCOL);
-    // @ts-ignore
-    expect(addrs.host).toEqual(DEFAULT_DOMAIN);
-    // @ts-ignore
-    expect(addrs.port).toEqual(initPort);
-  });
-});

package/test/parseAddress.spec.ts

@@ -1,52 +0,0 @@
-import _ from 'lodash';
-import { describe, expect, test } from 'vitest';
-
-import { DEFAULT_DOMAIN, DEFAULT_PORT, parseAddress } from '../src/cli-utils';
-
-describe('Parse listen address', () => {
-  const useCases: any[] = [];
-
-  function addTest(uri: string, proto: string | null, host?: string, port?: string) {
-    useCases.push([uri, proto, host, port]);
-  }
-
-  addTest(DEFAULT_PORT, 'http', DEFAULT_DOMAIN, DEFAULT_PORT);
-  addTest(':4873', 'http', DEFAULT_DOMAIN, DEFAULT_PORT);
-  addTest('blah:4873', 'http', 'blah', DEFAULT_PORT);
-  addTest('http://:4873', 'http', DEFAULT_DOMAIN, DEFAULT_PORT);
-  addTest('https::4873', 'https', DEFAULT_DOMAIN, DEFAULT_PORT);
-  addTest('https:blah:4873', 'https', 'blah', DEFAULT_PORT);
-  addTest('https://blah:4873/', 'https', 'blah', DEFAULT_PORT);
-  addTest('[::1]:4873', 'http', '::1', DEFAULT_PORT);
-  addTest('https:[::1]:4873', 'https', '::1', DEFAULT_PORT);
-
-  addTest('unix:/tmp/foo.sock', 'http', '/tmp/foo.sock');
-  addTest('http:unix:foo.sock', 'http', 'foo.sock');
-  addTest('https://unix:foo.sock', 'https', 'foo.sock');
-  addTest('https://unix:foo.sock:34', 'https', 'foo.sock:34');
-  addTest('http://foo.sock:34', 'http', 'foo.sock', '34');
-
-  addTest('blah', null);
-  addTest('blah://4873', null);
-  addTest('https://blah:4873///', null);
-  addTest('unix:1234', 'http', 'unix', '1234'); // not unix socket
-
-  test.each(useCases)(`should parse (%s - %s - %s - %s)`, (uri, proto, host, port) => {
-    const parsed = parseAddress(uri);
-
-    if (_.isNull(proto)) {
-      expect(parsed).toBeNull();
-    } else if (port) {
-      expect(parsed).toEqual({
-        proto,
-        host,
-        port,
-      });
-    } else {
-      expect(parsed).toEqual({
-        proto,
-        path: host,
-      });
-    }
-  });
-});

package/test/partials/config/yaml/server/keepalivetimeout-0.yaml

@@ -1,2 +0,0 @@
-server:
-  keepAliveTimeout: 0

package/test/partials/config/yaml/server/keepalivetimeout-60.yaml

@@ -1,2 +0,0 @@
-server:
-  keepAliveTimeout: 60

package/test/partials/config/yaml/server/keepalivetimeout-undefined.yaml

@@ -1,2 +0,0 @@
-server:
-  foo: 'bar'

package/test/run-server.spec.ts

@@ -1,23 +0,0 @@
-import request from 'supertest';
-import { describe, expect, test } from 'vitest';
-
-import { runServer } from '../src';
-
-describe('startServer via API', () => {
-  // TODO: fix this test does not runs with vitest
-  test.skip('should provide all HTTP server data', async () => {
-    const webServer = await runServer();
-    expect(webServer).toBeDefined();
-    await request(webServer).get('/').expect(200);
-  });
-
-  test('should fail on start with empty configuration', async () => {
-    // @ts-expect-error
-    await expect(runServer({})).rejects.toThrow('configPath property is required');
-  });
-
-  test('should fail on start with null as entry', async () => {
-    // @ts-expect-error
-    await expect(runServer(null)).rejects.toThrow();
-  });
-});

package/tsconfig.build.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../../tsconfig.base",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./build"
-  },
-  "include": ["src/**/*.ts", "types/*.d.ts"]
-}

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "extends": "../../tsconfig.reference.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./build"
-  },
-  "include": ["src/**/*.ts", "types/*.d.ts"],
-  "exclude": ["src/**/*.test.ts"],
-  "references": [
-    {
-      "path": "../config"
-    },
-    {
-      "path": "../logger/logger"
-    },
-    {
-      "path": "../server/express"
-    },
-    {
-      "path": "../server/fastify"
-    }
-  ]
-}