fix(configuration): configuration option enabled changed to `metric…

…sEnabled`

Rename configuration property `enabled` to `metricsEnabled` to avoid collision with other plugin
configurations that are merged into the configuration object passed to the plugin.

BREAKING CHANGE: configuration option `enabled` changed to `metricsEnabled`

README.md

@@ -29,7 +29,7 @@ Complete configuration example:
 middlewares:
   metrics:
     ## Optional. Defaults to `false` so make sure to set this to `true` if you want to collect metrics.
-    enabled: true
+    metricsEnabled: true
 
     ## Optional. Defaults to `/-/metrics`.
     metricsPath: /custom/path/metrics
@@ -64,7 +64,7 @@ Given the following example configuration:
 # Verdaccio config file
 middlewares:
   metrics:
-    enabled: true
+    metricsEnabled: true
     packageGroups:
       '@babel[/]plugin': 'babel-plugin'
       'babel[-]plugin': 'babel-plugin'

src/metrics.ts

@@ -27,7 +27,7 @@ export default class VerdaccioMiddlewarePlugin implements IPluginMiddleware<Metr
   private requestsCounter = new Counter(REQUEST_COUNTER_OPTIONS);
 
   public constructor(config: MetricsConfig, options: PluginOptions<MetricsConfig>) {
-    this.metricsEnabled = [true, 'true'].includes(config.enabled);
+    this.metricsEnabled = [true, 'true'].includes(config.metricsEnabled);
     this.metricsPath = config.metricsPath || '/-/metrics';
     this.packageGroups = config.packageGroups || [];
     this.logger = options.logger;

src/types/index.ts

@@ -1,7 +1,7 @@
 import { Config } from '@verdaccio/types';
 
 export interface MetricsConfig extends Config {
-  enabled: boolean;
+  metricsEnabled: boolean;
   metricsPath: string;
   packageGroups: Record<string, string>;
 }

tests/metrics.spec.ts

@@ -30,7 +30,7 @@ describe('Metrics Plugin', () => {
     beforeAll(() => {
       register.clear();
       const metricsPlugin = new MetricsPlugin(
-        { enabled: true } as MetricsConfig,
+        { metricsEnabled: true } as MetricsConfig,
         { logger } as PluginOptions<MetricsConfig>
       );
       metricsPlugin.register_middlewares(app, {} as IBasicAuth<MetricsConfig>, {} as IStorageManager<MetricsConfig>);
@@ -48,7 +48,7 @@ describe('Metrics Plugin', () => {
     beforeAll(() => {
       register.clear();
       const metricsPlugin = new MetricsPlugin(
-        { enabled: false } as MetricsConfig,
+        { metricsEnabled: false } as MetricsConfig,
         { logger } as PluginOptions<MetricsConfig>
       );
       metricsPlugin.register_middlewares(app, {} as IBasicAuth<MetricsConfig>, {} as IStorageManager<MetricsConfig>);
@@ -69,7 +69,7 @@ describe('Metrics Plugin', () => {
     beforeAll(() => {
       register.clear();
       const metricsPlugin = new MetricsPlugin(
-        { enabled: true } as MetricsConfig,
+        { metricsEnabled: true } as MetricsConfig,
         { logger: getLogger() } as PluginOptions<MetricsConfig>
       );
       metricsPlugin.collectMetrics(req, res, next);
@@ -111,7 +111,7 @@ describe('Metrics Plugin', () => {
     beforeAll(() => {
       register.clear();
       metricsPlugin = new MetricsPlugin(
-        { enabled: true } as MetricsConfig,
+        { metricsEnabled: true } as MetricsConfig,
         { logger: getLogger() } as PluginOptions<MetricsConfig>
       );
       expressMocks.forEach(({ req, res, next }) => metricsPlugin.collectMetrics(req, res, next));
@@ -163,7 +163,7 @@ describe('Metrics Plugin', () => {
     beforeAll(() => {
       register.clear();
       metricsPlugin = new MetricsPlugin(
-        { enabled: true, packageGroups } as MetricsConfig,
+        { metricsEnabled: true, packageGroups } as MetricsConfig,
         { logger: getLogger() } as PluginOptions<MetricsConfig>
       );
       expressMocks.forEach(({ req, res, next }) => metricsPlugin.collectMetrics(req, res, next));