config.logs throw an error, logging config not longer accept array or… (verdaccio#3097)

Author: juanpicado

.changeset/proud-jobs-hope.md

@@ -0,0 +1,45 @@
+---
+'@verdaccio/api': major
+'@verdaccio/cli': major
+'@verdaccio/config': major
+'@verdaccio/core': major
+'@verdaccio/types': major
+'@verdaccio/logger': major
+'@verdaccio/node-api': major
+'verdaccio-aws-s3-storage': major
+'verdaccio-google-cloud': major
+'verdaccio-htpasswd': major
+'@verdaccio/local-storage': major
+'verdaccio-memory': major
+'@verdaccio/ui-theme': major
+'@verdaccio/proxy': major
+'@verdaccio/server': major
+'@verdaccio/mock': major
+'verdaccio': major
+'@verdaccio/web': major
+'@verdaccio/e2e-cli': major
+'@verdaccio/website': major
+---
+
+feat!: config.logs throw an error, logging config not longer accept array or logs property
+
+### 💥 Breaking change
+
+This is valid
+
+```yaml
+log: { type: stdout, format: pretty, level: http }
+```
+
+This is invalid
+
+```yaml
+logs: { type: stdout, format: pretty, level: http }
+```
+
+or
+
+```yaml
+logs:
+  - [{ type: stdout, format: pretty, level: http }]
+```

docker-examples/v6/reverse_proxy/nginx/relative_path/conf/v6/config.yaml

@@ -46,4 +46,4 @@ middlewares:
   audit:
     enabled: true
 
-logs: { type: stdout, format: pretty, level: trace }
+log: { type: stdout, format: pretty, level: trace }

docker-examples/v6/reverse_proxy/nginx/relative_path/conf/v6_root/config.yaml

@@ -42,4 +42,4 @@ middlewares:
   audit:
     enabled: true
 
-logs: { type: stdout, format: json, level: trace }
+log: { type: stdout, format: json, level: trace }

docs/warnings.md

@@ -22,7 +22,8 @@ invalid address - xxxxxx, we expect a port (e.g. "4873"),
 
 ## VERDEP002
 
-'deprecate: multiple logger configuration is deprecated, please check the migration guide.'
+> After version `[email protected]` this is not longer a warning and
+> will crash your application
 
 ## VERDEP003
 

package.json

@@ -116,7 +116,7 @@
     "docker": "docker build -t verdaccio/verdaccio:local . --no-cache",
     "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,yml,yaml,md}\"",
     "format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,yml,yaml,md}\"",
-    "lint": "eslint  --max-warnings 45 \"**/*.{js,jsx,ts,tsx}\"",
+    "lint": "eslint  --max-warnings 46 \"**/*.{js,jsx,ts,tsx}\"",
     "test": "pnpm recursive test --filter ./packages",
     "test:e2e:cli": "pnpm test --filter ...@verdaccio/e2e-cli",
     "test:e2e:ui": "pnpm test --filter ...@verdaccio/e2e-ui",

packages/api/test/integration/config/package.yaml

@@ -18,7 +18,7 @@ publish:
 
 uplinks:
 
-logs: { type: stdout, format: pretty, level: trace }
+log: { type: stdout, format: pretty, level: trace }
 
 packages:
   '@*/*':

packages/api/test/integration/config/ping.yaml

@@ -11,7 +11,7 @@ web:
 
 uplinks:
 
-logs: { type: stdout, format: pretty, level: trace }
+log: { type: stdout, format: pretty, level: trace }
 
 packages:
   '@*/*':

packages/api/test/integration/config/publish.yaml

@@ -18,7 +18,7 @@ publish:
 
 uplinks:
 
-logs: { type: stdout, format: pretty, level: trace }
+log: { type: stdout, format: pretty, level: trace }
 
 packages:
   '@*/*':

packages/api/test/integration/config/user.yaml

@@ -17,7 +17,7 @@ uplinks:
   npmjs:
     url: https://registry.npmjs.org/
 
-logs: { type: stdout, format: pretty, level: trace }
+log: { type: stdout, format: pretty, level: trace }
 
 packages:
   '@*/*':

packages/api/test/integration/config/whoami.yaml

@@ -17,7 +17,7 @@ uplinks:
   npmjs:
     url: https://registry.npmjs.org/
 
-logs: { type: stdout, format: pretty, level: trace }
+log: { type: stdout, format: pretty, level: trace }
 
 packages:
   '@*/*':

packages/cli/src/commands/FastifyServer.ts

@@ -1,7 +1,6 @@
 import { Command, Option } from 'clipanion';
 
 import { findConfigFile, parseConfigFile } from '@verdaccio/config';
-import { warningUtils } from '@verdaccio/core';
 import server from '@verdaccio/fastify-migration';
 import { logger, setup } from '@verdaccio/logger';
 import { ConfigRuntime } from '@verdaccio/types';
@@ -28,13 +27,13 @@ export class FastifyServer extends Command {
 
   private initLogger(logConfig: ConfigRuntime) {
     try {
-      if (logConfig.logs) {
-        warningUtils.emit(warningUtils.Codes.VERDEP001);
+      if (logConfig.log) {
+        throw Error('logger as array not longer supported');
       }
       // FUTURE: remove fallback when is ready
-      setup(logConfig.log || logConfig.logs);
-    } catch {
-      throw new Error('error on init logger');
+      setup(logConfig.log);
+    } catch (err: any) {
+      throw new Error(err);
     }
   }
 

packages/cli/src/commands/init.ts

@@ -1,8 +1,8 @@
 import { Command, Option } from 'clipanion';
 
 import { findConfigFile, parseConfigFile } from '@verdaccio/config';
-import { warningUtils } from '@verdaccio/core';
 import { logger, setup } from '@verdaccio/logger';
+import { LoggerConfigItem } from '@verdaccio/logger/src/logger';
 import { initServer } from '@verdaccio/node-api';
 import { ConfigRuntime } from '@verdaccio/types';
 
@@ -47,13 +47,13 @@ export class InitCommand extends Command {
 
   private initLogger(logConfig: ConfigRuntime) {
     try {
+      // @ts-expect-error
       if (logConfig.logs) {
-        warningUtils.emit(warningUtils.Codes.VERDEP001);
+        throw Error('logger as array not longer supported');
       }
-      // FUTURE: remove fallback when is ready
-      setup(logConfig.log || logConfig.logs);
-    } catch {
-      throw new Error('error on init logger');
+      setup(logConfig.log as LoggerConfigItem);
+    } catch (err: any) {
+      throw new Error(err);
     }
   }
 

packages/config/src/conf/default.yaml

@@ -10,8 +10,6 @@
 storage: ./storage
 # path to a directory with plugins to include
 plugins: ./plugins
-# print logs
-# logs: ./logs
 
 web:
   title: Verdaccio
@@ -87,7 +85,7 @@ middlewares:
     enabled: true
 
 # log settings
-logs:
+log:
   # Logger as STDOUT
   { type: stdout, format: pretty, level: http }
   # Logger as STDOUT as JSON

packages/config/src/conf/docker.yaml

@@ -72,7 +72,7 @@ middlewares:
 
 # log settings
 # log settings
-logs:
+log:
   # Logger as STDOUT
   { type: stdout, format: pretty, level: http }
   # Logger as STDOUT as JSON

packages/config/test/config.spec.ts

@@ -57,11 +57,11 @@ describe('check basic content parsed file', () => {
     expect(config.middlewares).toBeDefined();
     expect(config.middlewares.audit).toBeDefined();
     expect(config.middlewares.audit.enabled).toBeTruthy();
-    // logs
-    expect(config.logs).toBeDefined();
-    expect(config.logs.type).toEqual('stdout');
-    expect(config.logs.format).toEqual('pretty');
-    expect(config.logs.level).toEqual('http');
+    // log
+    expect(config.log).toBeDefined();
+    expect(config.log.type).toEqual('stdout');
+    expect(config.log.format).toEqual('pretty');
+    expect(config.log.level).toEqual('http');
     // must not be enabled by default
     expect(config.notify).toBeUndefined();
     expect(config.store).toBeUndefined();

packages/config/test/partials/config/js/default.js

@@ -11,5 +11,5 @@ module.exports = {
     vue: { access: '$authenticated', publish: '$authenticated', proxy: 'npmjs' },
     '*': { access: '$all', publish: '$all', proxy: 'npmjs' },
   },
-  logs: [{ type: 'stdout', format: 'pretty', level: 'warn' }],
+  log: { type: 'stdout', format: 'pretty', level: 'warn' },
 };

packages/config/test/partials/config/yaml/storage.yaml

@@ -1,7 +1,4 @@
 ---
 storage: './storage_default_storage'
 
-logs:
-  - type: stdout
-    format: pretty
-    level: warn
+log: { type: stdout, format: pretty, level: warn }

packages/core/core/src/warning-utils.ts

@@ -9,8 +9,7 @@ export enum Codes {
   VERWAR002 = 'VERWAR002',
   VERWAR003 = 'VERWAR003',
   VERWAR004 = 'VERWAR004',
-  VERDEP001 = 'VERDEP001',
-  VERDEP002 = 'VERDEP002',
+  // deprecation warnings
   VERDEP003 = 'VERDEP003',
 }
 
@@ -36,18 +35,6 @@ host:port (e.g. "localhost:4873") or full url '(e.g. "http://localhost:4873/")
 https://verdaccio.org/docs/en/configuration#listen-port`
 );
 
-warningInstance.create(
-  verdaccioDeprecation,
-  Codes.VERDEP001,
-  'config.logs is deprecated, rename configuration to "config.log" in singular'
-);
-
-warningInstance.create(
-  verdaccioDeprecation,
-  Codes.VERDEP002,
-  'deprecate: multiple logger configuration is deprecated, please check the migration guide.'
-);
-
 warningInstance.create(
   verdaccioDeprecation,
   Codes.VERDEP003,

packages/core/types/index.d.ts

@@ -335,10 +335,6 @@ declare module '@verdaccio/types' {
     sync(): void;
   }
 
-  interface LoggerConf {
-    [key: string]: LoggerConfItem;
-  }
-
   interface ListenAddress {
     [key: string]: string;
   }
@@ -420,9 +416,8 @@ declare module '@verdaccio/types' {
     storage?: string | void;
     packages: PackageList;
     uplinks: UpLinksConfList;
-    // @deprecated in favor of log
-    logs?: LoggerConf[];
-    log?: LoggerConf[];
+    // FUTURE: log should be mandatory
+    log?: LoggerConfItem;
     web?: WebConf;
     auth?: AuthConf;
     security: Security;

packages/logger/package.json

@@ -41,6 +41,7 @@
   "dependencies": {
     "@verdaccio/core": "workspace:6.0.0-6-next.4",
     "@verdaccio/logger-prettify": "workspace:6.0.0-6-next.6",
+    "pino-pretty": "7.6.0",
     "debug": "4.3.3",
     "lodash": "4.17.21",
     "pino": "7.6.4"

packages/logger/src/logger.ts

@@ -26,12 +26,12 @@ export type LogFormat = 'json' | 'pretty-timestamped' | 'pretty';
 export function createLogger(
   options = { level: 'http' },
   destination = pino.destination(1),
-  format: LogFormat = DEFAULT_LOG_FORMAT,
   prettyPrintOptions = {
     // we hide warning since the prettifier should not be used in production
     // https://getpino.io/#/docs/pretty?id=prettifier-api
     suppressFlushSyncWarning: true,
-  }
+  },
+  format: LogFormat = DEFAULT_LOG_FORMAT
 ) {
   if (_.isNil(format)) {
     format = DEFAULT_LOG_FORMAT;
@@ -116,19 +116,11 @@ export type LoggerConfigItem = {
   level?: string;
 };
 
-export type LoggerConfig = LoggerConfigItem[];
+export type LoggerConfig = LoggerConfigItem;
 
-export function setup(options: LoggerConfig | LoggerConfigItem = DEFAULT_LOGGER_CONF) {
+export function setup(options: LoggerConfigItem = DEFAULT_LOGGER_CONF) {
   debug('setup logger');
-  const isLegacyConf = Array.isArray(options);
-  if (isLegacyConf) {
-    warningUtils.emit(warningUtils.Codes.VERDEP002);
-  }
-
-  // verdaccio 5 does not allow multiple logger configuration
-  // backward compatible, pick only the first option
-  // next major will thrown an error
-  let loggerConfig = isLegacyConf ? options[0] : options;
+  let loggerConfig = options;
   if (!loggerConfig?.level) {
     loggerConfig = Object.assign(
       {},
@@ -143,13 +135,17 @@ export function setup(options: LoggerConfig | LoggerConfigItem = DEFAULT_LOGGER_
     debug('logging file enabled');
     const destination = pino.destination(loggerConfig.path);
     process.on('SIGUSR2', () => destination.reopen());
+    // @ts-ignore
     logger = createLogger(pinoConfig, destination, loggerConfig.format);
+    // @ts-ignore
   } else if (loggerConfig.type === 'rotating-file') {
     warningUtils.emit(warningUtils.Codes.VERWAR003);
     debug('logging stdout enabled');
+    // @ts-ignore
     logger = createLogger(pinoConfig, pino.destination(1), loggerConfig.format);
   } else {
     debug('logging stdout enabled');
+    // @ts-ignore
     logger = createLogger(pinoConfig, pino.destination(1), loggerConfig.format);
   }
 

packages/logger/test/logger.spec.ts

@@ -1,5 +1,3 @@
-import { warningUtils } from '@verdaccio/core';
-
 import { logger, setup } from '../src';
 
 const mockWarningUtils = jest.fn();
@@ -34,7 +32,7 @@ describe('logger', () => {
     // expect(spyOn).toHaveBeenCalledTimes(2);
   });
 
-  test('throw deprecation warning if multiple loggers configured', () => {
+  test.skip('throw deprecation warning if multiple loggers configured', () => {
     setup([
       {
         level: 'info',
@@ -43,7 +41,7 @@ describe('logger', () => {
         level: 'http',
       },
     ]);
-    expect(mockWarningUtils).toHaveBeenCalledWith(warningUtils.Codes.VERDEP002);
+    // expect(mockWarningUtils).toHaveBeenCalledWith(warningUtils.Codes.VERDEP002);
   });
 
   test('regression: do not throw deprecation warning if no logger config is provided', () => {