@verdaccio/config 7.0.0-next.5 → 7.0.0-next.6

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @verdaccio/config
 
+## 7.0.0-next.6
+
+### Patch Changes
+
+- 4d96324: chore(config): increase test coverage
+  - @verdaccio/core@7.0.0-next.6
+  - @verdaccio/utils@7.0.0-next.6
+
 ## 7.0.0-next.5
 
 ### Minor Changes

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Verdaccio contributors
+Copyright (c) 2024 Verdaccio contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/build/package-access.js

@@ -28,7 +28,7 @@ const PACKAGE_ACCESS = exports.PACKAGE_ACCESS = {
 };
 function normalizeUserList(groupsList) {
   const result = [];
-  if (_lodash.default.isNil(groupsList)) {
+  if (_lodash.default.isNil(groupsList) || _lodash.default.isEmpty(groupsList)) {
     return result;
   }
 

package/build/package-access.js.map

@@ -1 +1 @@
-{"version":3,"file":"package-access.js","names":["_assert","_interopRequireDefault","require","_lodash","_core","obj","__esModule","default","ROLES","exports","$ALL","ALL","$AUTH","$ANONYMOUS","DEPRECATED_ALL","DEPRECATED_AUTH","DEPRECATED_ANONYMOUS","PACKAGE_ACCESS","SCOPE","normalizeUserList","groupsList","result","_","isNil","isString","groupsArray","split","push","Array","isArray","errorUtils","getInternalError","JSON","stringify","flatten","normalisePackageAccess","packages","normalizedPkgs","access","publish","unpublish","proxy","pkg","Object","prototype","hasOwnProperty","call","packageAccess","isInvalid","isObject","assert","isUndefined"],"sources":["../src/package-access.ts"],"sourcesContent":["import assert from 'assert';\nimport _ from 'lodash';\n\nimport { errorUtils } from '@verdaccio/core';\nimport { PackageAccess } from '@verdaccio/types';\n\nexport interface LegacyPackageList {\n  [key: string]: PackageAccess;\n}\n\n// @deprecated use @verdaccio/core:authUtils\nexport const ROLES = {\n  $ALL: '$all',\n  ALL: 'all',\n  $AUTH: '$authenticated',\n  $ANONYMOUS: '$anonymous',\n  DEPRECATED_ALL: '@all',\n  DEPRECATED_AUTH: '@authenticated',\n  DEPRECATED_ANONYMOUS: '@anonymous',\n};\n\n// @deprecated use @verdaccio/core:authUtils\nexport const PACKAGE_ACCESS = {\n  SCOPE: '@*/*',\n  ALL: '**',\n};\n\nexport function normalizeUserList(groupsList: any): any {\n  const result: any[] = [];\n  if (_.isNil(groupsList)) {\n    return result;\n  }\n\n  // if it's a string, split it to array\n  if (_.isString(groupsList)) {\n    const groupsArray = groupsList.split(/\\s+/);\n\n    result.push(groupsArray);\n  } else if (Array.isArray(groupsList)) {\n    result.push(groupsList);\n  } else {\n    throw errorUtils.getInternalError(\n      'CONFIG: bad package acl (array or string expected): ' + JSON.stringify(groupsList)\n    );\n  }\n\n  return _.flatten(result);\n}\n\nexport function normalisePackageAccess(packages: LegacyPackageList): LegacyPackageList {\n  const normalizedPkgs: LegacyPackageList = { ...packages };\n  if (_.isNil(normalizedPkgs['**'])) {\n    normalizedPkgs['**'] = {\n      access: [],\n      publish: [],\n      unpublish: [],\n      proxy: [],\n    };\n  }\n\n  for (const pkg in packages) {\n    if (Object.prototype.hasOwnProperty.call(packages, pkg)) {\n      const packageAccess = packages[pkg];\n      const isInvalid = _.isObject(packageAccess) && _.isArray(packageAccess) === false;\n      assert(isInvalid, `CONFIG: bad \"'${pkg}'\" package description (object expected)`);\n\n      normalizedPkgs[pkg].access = normalizeUserList(packageAccess.access);\n      normalizedPkgs[pkg].publish = normalizeUserList(packageAccess.publish);\n      normalizedPkgs[pkg].proxy = normalizeUserList(packageAccess.proxy);\n      // if unpublish is not defined, we set to false to fallback in publish access\n      normalizedPkgs[pkg].unpublish = _.isUndefined(packageAccess.unpublish)\n        ? false\n        : normalizeUserList(packageAccess.unpublish);\n    }\n  }\n\n  return normalizedPkgs;\n}\n"],"mappings":";;;;;;;;AAAA,IAAAA,OAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAF,sBAAA,CAAAC,OAAA;AAEA,IAAAE,KAAA,GAAAF,OAAA;AAA6C,SAAAD,uBAAAI,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAO7C;AACO,MAAMG,KAAK,GAAAC,OAAA,CAAAD,KAAA,GAAG;EACnBE,IAAI,EAAE,MAAM;EACZC,GAAG,EAAE,KAAK;EACVC,KAAK,EAAE,gBAAgB;EACvBC,UAAU,EAAE,YAAY;EACxBC,cAAc,EAAE,MAAM;EACtBC,eAAe,EAAE,gBAAgB;EACjCC,oBAAoB,EAAE;AACxB,CAAC;;AAED;AACO,MAAMC,cAAc,GAAAR,OAAA,CAAAQ,cAAA,GAAG;EAC5BC,KAAK,EAAE,MAAM;EACbP,GAAG,EAAE;AACP,CAAC;AAEM,SAASQ,iBAAiBA,CAACC,UAAe,EAAO;EACtD,MAAMC,MAAa,GAAG,EAAE;EACxB,IAAIC,eAAC,CAACC,KAAK,CAACH,UAAU,CAAC,EAAE;IACvB,OAAOC,MAAM;EACf;;EAEA;EACA,IAAIC,eAAC,CAACE,QAAQ,CAACJ,UAAU,CAAC,EAAE;IAC1B,MAAMK,WAAW,GAAGL,UAAU,CAACM,KAAK,CAAC,KAAK,CAAC;IAE3CL,MAAM,CAACM,IAAI,CAACF,WAAW,CAAC;EAC1B,CAAC,MAAM,IAAIG,KAAK,CAACC,OAAO,CAACT,UAAU,CAAC,EAAE;IACpCC,MAAM,CAACM,IAAI,CAACP,UAAU,CAAC;EACzB,CAAC,MAAM;IACL,MAAMU,gBAAU,CAACC,gBAAgB,CAC/B,sDAAsD,GAAGC,IAAI,CAACC,SAAS,CAACb,UAAU,CACpF,CAAC;EACH;EAEA,OAAOE,eAAC,CAACY,OAAO,CAACb,MAAM,CAAC;AAC1B;AAEO,SAASc,sBAAsBA,CAACC,QAA2B,EAAqB;EACrF,MAAMC,cAAiC,GAAG;IAAE,GAAGD;EAAS,CAAC;EACzD,IAAId,eAAC,CAACC,KAAK,CAACc,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE;IACjCA,cAAc,CAAC,IAAI,CAAC,GAAG;MACrBC,MAAM,EAAE,EAAE;MACVC,OAAO,EAAE,EAAE;MACXC,SAAS,EAAE,EAAE;MACbC,KAAK,EAAE;IACT,CAAC;EACH;EAEA,KAAK,MAAMC,GAAG,IAAIN,QAAQ,EAAE;IAC1B,IAAIO,MAAM,CAACC,SAAS,CAACC,cAAc,CAACC,IAAI,CAACV,QAAQ,EAAEM,GAAG,CAAC,EAAE;MACvD,MAAMK,aAAa,GAAGX,QAAQ,CAACM,GAAG,CAAC;MACnC,MAAMM,SAAS,GAAG1B,eAAC,CAAC2B,QAAQ,CAACF,aAAa,CAAC,IAAIzB,eAAC,CAACO,OAAO,CAACkB,aAAa,CAAC,KAAK,KAAK;MACjF,IAAAG,eAAM,EAACF,SAAS,EAAG,iBAAgBN,GAAI,0CAAyC,CAAC;MAEjFL,cAAc,CAACK,GAAG,CAAC,CAACJ,MAAM,GAAGnB,iBAAiB,CAAC4B,aAAa,CAACT,MAAM,CAAC;MACpED,cAAc,CAACK,GAAG,CAAC,CAACH,OAAO,GAAGpB,iBAAiB,CAAC4B,aAAa,CAACR,OAAO,CAAC;MACtEF,cAAc,CAACK,GAAG,CAAC,CAACD,KAAK,GAAGtB,iBAAiB,CAAC4B,aAAa,CAACN,KAAK,CAAC;MAClE;MACAJ,cAAc,CAACK,GAAG,CAAC,CAACF,SAAS,GAAGlB,eAAC,CAAC6B,WAAW,CAACJ,aAAa,CAACP,SAAS,CAAC,GAClE,KAAK,GACLrB,iBAAiB,CAAC4B,aAAa,CAACP,SAAS,CAAC;IAChD;EACF;EAEA,OAAOH,cAAc;AACvB"}
+{"version":3,"file":"package-access.js","names":["_assert","_interopRequireDefault","require","_lodash","_core","obj","__esModule","default","ROLES","exports","$ALL","ALL","$AUTH","$ANONYMOUS","DEPRECATED_ALL","DEPRECATED_AUTH","DEPRECATED_ANONYMOUS","PACKAGE_ACCESS","SCOPE","normalizeUserList","groupsList","result","_","isNil","isEmpty","isString","groupsArray","split","push","Array","isArray","errorUtils","getInternalError","JSON","stringify","flatten","normalisePackageAccess","packages","normalizedPkgs","access","publish","unpublish","proxy","pkg","Object","prototype","hasOwnProperty","call","packageAccess","isInvalid","isObject","assert","isUndefined"],"sources":["../src/package-access.ts"],"sourcesContent":["import assert from 'assert';\nimport _ from 'lodash';\n\nimport { errorUtils } from '@verdaccio/core';\nimport { PackageAccess } from '@verdaccio/types';\n\nexport interface LegacyPackageList {\n  [key: string]: PackageAccess;\n}\n\n// @deprecated use @verdaccio/core:authUtils\nexport const ROLES = {\n  $ALL: '$all',\n  ALL: 'all',\n  $AUTH: '$authenticated',\n  $ANONYMOUS: '$anonymous',\n  DEPRECATED_ALL: '@all',\n  DEPRECATED_AUTH: '@authenticated',\n  DEPRECATED_ANONYMOUS: '@anonymous',\n};\n\n// @deprecated use @verdaccio/core:authUtils\nexport const PACKAGE_ACCESS = {\n  SCOPE: '@*/*',\n  ALL: '**',\n};\n\nexport function normalizeUserList(groupsList: any): any {\n  const result: any[] = [];\n  if (_.isNil(groupsList) || _.isEmpty(groupsList)) {\n    return result;\n  }\n\n  // if it's a string, split it to array\n  if (_.isString(groupsList)) {\n    const groupsArray = groupsList.split(/\\s+/);\n\n    result.push(groupsArray);\n  } else if (Array.isArray(groupsList)) {\n    result.push(groupsList);\n  } else {\n    throw errorUtils.getInternalError(\n      'CONFIG: bad package acl (array or string expected): ' + JSON.stringify(groupsList)\n    );\n  }\n\n  return _.flatten(result);\n}\n\nexport function normalisePackageAccess(packages: LegacyPackageList): LegacyPackageList {\n  const normalizedPkgs: LegacyPackageList = { ...packages };\n  if (_.isNil(normalizedPkgs['**'])) {\n    normalizedPkgs['**'] = {\n      access: [],\n      publish: [],\n      unpublish: [],\n      proxy: [],\n    };\n  }\n\n  for (const pkg in packages) {\n    if (Object.prototype.hasOwnProperty.call(packages, pkg)) {\n      const packageAccess = packages[pkg];\n      const isInvalid = _.isObject(packageAccess) && _.isArray(packageAccess) === false;\n      assert(isInvalid, `CONFIG: bad \"'${pkg}'\" package description (object expected)`);\n\n      normalizedPkgs[pkg].access = normalizeUserList(packageAccess.access);\n      normalizedPkgs[pkg].publish = normalizeUserList(packageAccess.publish);\n      normalizedPkgs[pkg].proxy = normalizeUserList(packageAccess.proxy);\n      // if unpublish is not defined, we set to false to fallback in publish access\n      normalizedPkgs[pkg].unpublish = _.isUndefined(packageAccess.unpublish)\n        ? false\n        : normalizeUserList(packageAccess.unpublish);\n    }\n  }\n\n  return normalizedPkgs;\n}\n"],"mappings":";;;;;;;;AAAA,IAAAA,OAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAF,sBAAA,CAAAC,OAAA;AAEA,IAAAE,KAAA,GAAAF,OAAA;AAA6C,SAAAD,uBAAAI,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAO7C;AACO,MAAMG,KAAK,GAAAC,OAAA,CAAAD,KAAA,GAAG;EACnBE,IAAI,EAAE,MAAM;EACZC,GAAG,EAAE,KAAK;EACVC,KAAK,EAAE,gBAAgB;EACvBC,UAAU,EAAE,YAAY;EACxBC,cAAc,EAAE,MAAM;EACtBC,eAAe,EAAE,gBAAgB;EACjCC,oBAAoB,EAAE;AACxB,CAAC;;AAED;AACO,MAAMC,cAAc,GAAAR,OAAA,CAAAQ,cAAA,GAAG;EAC5BC,KAAK,EAAE,MAAM;EACbP,GAAG,EAAE;AACP,CAAC;AAEM,SAASQ,iBAAiBA,CAACC,UAAe,EAAO;EACtD,MAAMC,MAAa,GAAG,EAAE;EACxB,IAAIC,eAAC,CAACC,KAAK,CAACH,UAAU,CAAC,IAAIE,eAAC,CAACE,OAAO,CAACJ,UAAU,CAAC,EAAE;IAChD,OAAOC,MAAM;EACf;;EAEA;EACA,IAAIC,eAAC,CAACG,QAAQ,CAACL,UAAU,CAAC,EAAE;IAC1B,MAAMM,WAAW,GAAGN,UAAU,CAACO,KAAK,CAAC,KAAK,CAAC;IAE3CN,MAAM,CAACO,IAAI,CAACF,WAAW,CAAC;EAC1B,CAAC,MAAM,IAAIG,KAAK,CAACC,OAAO,CAACV,UAAU,CAAC,EAAE;IACpCC,MAAM,CAACO,IAAI,CAACR,UAAU,CAAC;EACzB,CAAC,MAAM;IACL,MAAMW,gBAAU,CAACC,gBAAgB,CAC/B,sDAAsD,GAAGC,IAAI,CAACC,SAAS,CAACd,UAAU,CACpF,CAAC;EACH;EAEA,OAAOE,eAAC,CAACa,OAAO,CAACd,MAAM,CAAC;AAC1B;AAEO,SAASe,sBAAsBA,CAACC,QAA2B,EAAqB;EACrF,MAAMC,cAAiC,GAAG;IAAE,GAAGD;EAAS,CAAC;EACzD,IAAIf,eAAC,CAACC,KAAK,CAACe,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE;IACjCA,cAAc,CAAC,IAAI,CAAC,GAAG;MACrBC,MAAM,EAAE,EAAE;MACVC,OAAO,EAAE,EAAE;MACXC,SAAS,EAAE,EAAE;MACbC,KAAK,EAAE;IACT,CAAC;EACH;EAEA,KAAK,MAAMC,GAAG,IAAIN,QAAQ,EAAE;IAC1B,IAAIO,MAAM,CAACC,SAAS,CAACC,cAAc,CAACC,IAAI,CAACV,QAAQ,EAAEM,GAAG,CAAC,EAAE;MACvD,MAAMK,aAAa,GAAGX,QAAQ,CAACM,GAAG,CAAC;MACnC,MAAMM,SAAS,GAAG3B,eAAC,CAAC4B,QAAQ,CAACF,aAAa,CAAC,IAAI1B,eAAC,CAACQ,OAAO,CAACkB,aAAa,CAAC,KAAK,KAAK;MACjF,IAAAG,eAAM,EAACF,SAAS,EAAG,iBAAgBN,GAAI,0CAAyC,CAAC;MAEjFL,cAAc,CAACK,GAAG,CAAC,CAACJ,MAAM,GAAGpB,iBAAiB,CAAC6B,aAAa,CAACT,MAAM,CAAC;MACpED,cAAc,CAACK,GAAG,CAAC,CAACH,OAAO,GAAGrB,iBAAiB,CAAC6B,aAAa,CAACR,OAAO,CAAC;MACtEF,cAAc,CAACK,GAAG,CAAC,CAACD,KAAK,GAAGvB,iBAAiB,CAAC6B,aAAa,CAACN,KAAK,CAAC;MAClE;MACAJ,cAAc,CAACK,GAAG,CAAC,CAACF,SAAS,GAAGnB,eAAC,CAAC8B,WAAW,CAACJ,aAAa,CAACP,SAAS,CAAC,GAClE,KAAK,GACLtB,iBAAiB,CAAC6B,aAAa,CAACP,SAAS,CAAC;IAChD;EACF;EAEA,OAAOH,cAAc;AACvB"}

package/jest.config.js

@@ -3,8 +3,7 @@ const config = require('../../jest/config');
 module.exports = Object.assign({}, config, {
   coverageThreshold: {
     global: {
-      // FIXME: increase to 90
-      lines: 85,
+      lines: 90,
     },
   },
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/config",
-  "version": "7.0.0-next.5",
+  "version": "7.0.0-next.6",
   "description": "logger",
   "main": "./build/index.js",
   "types": "build/index.d.ts",
@@ -29,8 +29,8 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@verdaccio/core": "7.0.0-next.5",
-    "@verdaccio/utils": "7.0.0-next.5",
+    "@verdaccio/core": "7.0.0-next.6",
+    "@verdaccio/utils": "7.0.0-next.6",
     "debug": "4.3.4",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",

package/src/package-access.ts

@@ -27,7 +27,7 @@ export const PACKAGE_ACCESS = {
 
 export function normalizeUserList(groupsList: any): any {
   const result: any[] = [];
-  if (_.isNil(groupsList)) {
+  if (_.isNil(groupsList) || _.isEmpty(groupsList)) {
     return result;
   }
 

package/test/agent.spec.ts

@@ -0,0 +1,42 @@
+import { getUserAgent } from '../src';
+
+describe('getUserAgent', () => {
+  test('should return custom user agent when customUserAgent is true', () => {
+    const customUserAgent = true;
+    const version = '1.0.0';
+    const name = 'MyAgent';
+
+    const result = getUserAgent(customUserAgent, version, name);
+
+    expect(result).toBe('MyAgent/1.0.0');
+  });
+
+  test('should return custom user agent when customUserAgent is a non-empty string', () => {
+    const customUserAgent = 'CustomAgent/1.0.0';
+    const version = '1.0.0';
+    const name = 'MyAgent';
+
+    const result = getUserAgent(customUserAgent, version, name);
+
+    expect(result).toBe('CustomAgent/1.0.0');
+  });
+
+  test('should return "hidden" when customUserAgent is false', () => {
+    const customUserAgent = false;
+    const version = '1.0.0';
+    const name = 'MyAgent';
+
+    const result = getUserAgent(customUserAgent, version, name);
+
+    expect(result).toBe('hidden');
+  });
+
+  test('should return default user agent when customUserAgent is undefined', () => {
+    const version = '1.0.0';
+    const name = 'MyAgent';
+
+    const result = getUserAgent(undefined, version, name);
+
+    expect(result).toBe('MyAgent/1.0.0');
+  });
+});

package/test/builder.spec.ts

@@ -13,6 +13,7 @@ describe('Config builder', () => {
         proxy: 'some',
       })
       .addLogger({ level: 'info', type: 'stdout', format: 'json' })
+      .addAuth({ htpasswd: { file: '.htpasswd' } })
       .addStorage('/tmp/verdaccio')
       .addSecurity({ api: { legacy: true } });
     expect(config.getConfig()).toEqual({
@@ -21,6 +22,11 @@ describe('Config builder', () => {
           legacy: true,
         },
       },
+      auth: {
+        htpasswd: {
+          file: '.htpasswd',
+        },
+      },
       storage: '/tmp/verdaccio',
       packages: {
         'upstream/*': {

package/test/config.spec.ts

@@ -106,6 +106,20 @@ describe('checkSecretKey', () => {
     const config = new Config(parseConfigFile(resolveConf('default')));
     expect(typeof config.checkSecretKey('') === 'string').toBeTruthy();
   });
+
+  test('with enhanced legacy signature', () => {
+    const config = new Config(parseConfigFile(resolveConf('default')));
+    config.security.enhancedLegacySignature = true;
+    expect(typeof config.checkSecretKey() === 'string').toBeTruthy();
+    expect(config.secret.length).toBe(32);
+  });
+
+  test('without enhanced legacy signature', () => {
+    const config = new Config(parseConfigFile(resolveConf('default')));
+    config.security.enhancedLegacySignature = false;
+    expect(typeof config.checkSecretKey() === 'string').toBeTruthy();
+    expect(config.secret.length).toBe(64);
+  });
 });
 
 describe('getMatchedPackagesSpec', () => {
@@ -159,3 +173,18 @@ describe('VERDACCIO_STORAGE_PATH', () => {
     delete process.env.VERDACCIO_STORAGE_PATH;
   });
 });
+
+describe('configPath', () => {
+  test('should set configPath in config', () => {
+    const defaultConfig = parseConfigFile(resolveConf('default'));
+    const config = new Config(defaultConfig);
+    expect(config.getConfigPath()).toBe(path.join(__dirname, '../src/conf/default.yaml'));
+  });
+
+  test('should throw an error if configPath is not provided', () => {
+    const defaultConfig = parseConfigFile(resolveConf('default'));
+    defaultConfig.configPath = '';
+    defaultConfig.config_path = '';
+    expect(() => new Config(defaultConfig)).toThrow('configPath property is required');
+  });
+});

package/test/package-access.spec.ts

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 
 import { parseConfigFile } from '../src';
-import { PACKAGE_ACCESS, normalisePackageAccess } from '../src/package-access';
+import { PACKAGE_ACCESS, normalisePackageAccess, normalizeUserList } from '../src/package-access';
 import { parseConfigurationFile } from './utils';
 
 describe('Package access utilities', () => {
@@ -123,4 +123,30 @@ describe('Package access utilities', () => {
       expect(_.isArray(all.publish)).toBeTruthy();
     });
   });
+  describe('normaliseUserList', () => {
+    test('should normalize user list', () => {
+      const groupsList = 'admin superadmin';
+      const result = normalizeUserList(groupsList);
+      expect(result).toEqual(['admin', 'superadmin']);
+    });
+
+    test('should normalize empty user list', () => {
+      const groupsList = '';
+      const result = normalizeUserList(groupsList);
+      expect(result).toEqual([]);
+    });
+
+    test('should normalize user list array', () => {
+      const groupsList = ['admin', 'superadmin'];
+      const result = normalizeUserList(groupsList);
+      expect(result).toEqual(['admin', 'superadmin']);
+    });
+
+    test('should throw error for invalid user list', () => {
+      const groupsList = { group: 'admin' };
+      expect(() => {
+        normalizeUserList(groupsList);
+      }).toThrow('CONFIG: bad package acl (array or string expected): {"group":"admin"}');
+    });
+  });
 });