@verdaccio/loaders 6.0.0-6-next.15 → 6.0.0-6-next.17

package/CHANGELOG.md

@@ -1,5 +1,75 @@
 # @verdaccio/loaders
 
+## 6.0.0-6-next.17
+
+### Major Changes
+
+- 9fc2e796: feat(plugins): improve plugin loader
+
+  ### Changes
+
+  - Add scope plugin support to 6.x https://github.com/verdaccio/verdaccio/pull/3227
+  - Avoid config collisions https://github.com/verdaccio/verdaccio/issues/928
+  - https://github.com/verdaccio/verdaccio/issues/1394
+  - `config.plugins` plugin path validations
+  - Updated algorithm for plugin loader.
+  - improved documentation (included dev)
+
+  ## Features
+
+  - Add scope plugin support to 6.x https://github.com/verdaccio/verdaccio/pull/3227
+  - Custom prefix:
+
+  ```
+  // config.yaml
+  server:
+    pluginPrefix: mycompany
+  middleware:
+    audit:
+        foo: 1
+  ```
+
+  This configuration will look up for `mycompany-audit` instead `Verdaccio-audit`.
+
+  ## Breaking Changes
+
+  ### sinopia plugins
+
+  - `sinopia` fallback support is removed, but can be restored using `pluginPrefix`
+
+  ### plugin filter
+
+  - method rename `filter_metadata`->`filterMetadata`
+
+  ### Plugin constructor does not merge configs anymore https://github.com/verdaccio/verdaccio/issues/928
+
+  The plugin receives as first argument `config`, which represents the config of the plugin. Example:
+
+  ```
+  // config.yaml
+  auth:
+    plugin:
+       foo: 1
+       bar: 2
+
+  export class Plugin<T> {
+    public constructor(config: T, options: PluginOptions) {
+      console.log(config);
+      // {foo:1, bar: 2}
+   }
+  }
+  ```
+
+### Patch Changes
+
+- @verdaccio/logger@6.0.0-6-next.16
+
+## 6.0.0-6-next.16
+
+### Patch Changes
+
+- @verdaccio/logger@6.0.0-6-next.15
+
 ## 6.0.0-6-next.15
 
 ### Patch Changes

package/build/index.d.ts

@@ -1 +1 @@
-export * from './plugin-loader';
+export { asyncLoadPlugin } from './plugin-async-loader';

package/build/index.js

@@ -3,17 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-
-var _pluginLoader = require("./plugin-loader");
-
-Object.keys(_pluginLoader).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _pluginLoader[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _pluginLoader[key];
-    }
-  });
+Object.defineProperty(exports, "asyncLoadPlugin", {
+  enumerable: true,
+  get: function () {
+    return _pluginAsyncLoader.asyncLoadPlugin;
+  }
 });
+
+var _pluginAsyncLoader = require("./plugin-async-loader");
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export * from './plugin-loader';\n"],"mappings":";;;;;;AAAA;;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export { asyncLoadPlugin } from './plugin-async-loader';\n"],"mappings":";;;;;;;;;;;;AAAA"}

package/build/plugin-async-loader.d.ts

@@ -0,0 +1,29 @@
+import { Config, IPlugin, Logger } from '@verdaccio/types';
+export declare type Params = {
+    config: Config;
+    logger: Logger;
+};
+/**
+ * The plugin loader find recursively plugins, if one plugin fails is ignored and report the error to the logger.
+ *
+ * The loader follows the order:
+ * - If the at the `config.yaml` file the  `plugins: ./plugins` is defined
+ *   - If is absolute will use the provided path
+ *   - If is relative, will use the base path of the config file. eg: /root/config.yaml the plugins folder should be
+ *     hosted at /root/plugins
+ * - The next step is find at the node_modules or global based on the `require` native algorithm.
+ * - If the package is scoped eg: @scope/foo, try to load the package `@scope/foo`
+ * - If the package is not scoped, will use the default prefix: verdaccio-foo.
+ * - If a custom prefix is provided, the verdaccio- is replaced by the config.server.pluginPrefix.
+ *
+ * The `sanityCheck` is the validation for the required methods to load the plugin, if the validation fails the plugin won't be loaded.
+ * The `params` is an object that contains the global configuration and the logger.
+ *
+ * @param {*} pluginConfigs the custom plugin section
+ * @param {*} params a set of params to initialize the plugin
+ * @param {*} sanityCheck callback that check the shape that should fulfill the plugin
+ * @param {*} prefix by default is verdaccio but can be override with config.server.pluginPrefix
+ * @return {Array} list of plugins
+ */
+export declare function asyncLoadPlugin<T extends IPlugin<T>>(pluginConfigs: any, params: Params, sanityCheck: any, prefix?: string): Promise<any>;
+export declare function executePlugin(plugin: any, pluginConfig: any, params: Params): any;

package/build/plugin-async-loader.js

@@ -0,0 +1,156 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.asyncLoadPlugin = asyncLoadPlugin;
+exports.executePlugin = executePlugin;
+
+var _debug = _interopRequireDefault(require("debug"));
+
+var _promises = require("fs/promises");
+
+var _path = require("path");
+
+var _logger = require("@verdaccio/logger");
+
+var _utils = require("./utils");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const debug = (0, _debug.default)('verdaccio:plugin:loader:async');
+
+async function isDirectory(pathFolder) {
+  const stat = await (0, _promises.lstat)(pathFolder);
+  return stat.isDirectory();
+}
+
+/**
+ * The plugin loader find recursively plugins, if one plugin fails is ignored and report the error to the logger.
+ *
+ * The loader follows the order:
+ * - If the at the `config.yaml` file the  `plugins: ./plugins` is defined
+ *   - If is absolute will use the provided path
+ *   - If is relative, will use the base path of the config file. eg: /root/config.yaml the plugins folder should be
+ *     hosted at /root/plugins
+ * - The next step is find at the node_modules or global based on the `require` native algorithm.
+ * - If the package is scoped eg: @scope/foo, try to load the package `@scope/foo`
+ * - If the package is not scoped, will use the default prefix: verdaccio-foo.
+ * - If a custom prefix is provided, the verdaccio- is replaced by the config.server.pluginPrefix.
+ *
+ * The `sanityCheck` is the validation for the required methods to load the plugin, if the validation fails the plugin won't be loaded.
+ * The `params` is an object that contains the global configuration and the logger.
+ *
+ * @param {*} pluginConfigs the custom plugin section
+ * @param {*} params a set of params to initialize the plugin
+ * @param {*} sanityCheck callback that check the shape that should fulfill the plugin
+ * @param {*} prefix by default is verdaccio but can be override with config.server.pluginPrefix
+ * @return {Array} list of plugins
+ */
+async function asyncLoadPlugin(pluginConfigs = {}, params, sanityCheck, prefix = 'verdaccio') {
+  const pluginsIds = Object.keys(pluginConfigs);
+  const {
+    config
+  } = params;
+  let plugins = [];
+
+  for (let pluginId of pluginsIds) {
+    debug('plugin %s', pluginId);
+
+    if (typeof config.plugins === 'string') {
+      let pluginsPath = config.plugins;
+      debug('plugin path %s', pluginsPath);
+
+      if (!(0, _path.isAbsolute)(pluginsPath)) {
+        if (typeof config.config_path === 'string' && !config.configPath) {
+          _logger.logger.error('configPath is missing and the legacy config.config_path is not available for loading plugins');
+        }
+
+        if (!config.configPath) {
+          _logger.logger.error('config path property is required for loading plugins');
+
+          continue;
+        }
+
+        pluginsPath = (0, _path.resolve)((0, _path.join)((0, _path.dirname)(config.configPath), pluginsPath));
+      }
+
+      _logger.logger.debug({
+        path: pluginsPath
+      }, 'plugins folder defined, loading plugins from @{path} '); // throws if is nto a directory
+
+
+      try {
+        await isDirectory(pluginsPath);
+        const pluginDir = pluginsPath;
+        const externalFilePlugin = (0, _path.resolve)(pluginDir, `${prefix}-${pluginId}`);
+        let plugin = (0, _utils.tryLoad)(externalFilePlugin);
+
+        if (plugin && (0, _utils.isValid)(plugin)) {
+          plugin = executePlugin(plugin, pluginConfigs[pluginId], params);
+
+          if (!sanityCheck(plugin)) {
+            _logger.logger.error({
+              content: externalFilePlugin
+            }, "@{content} doesn't look like a valid plugin");
+
+            continue;
+          }
+
+          plugins.push(plugin);
+          continue;
+        }
+      } catch (err) {
+        _logger.logger.warn({
+          err: err.message,
+          pluginsPath,
+          pluginId
+        }, '@{err} on loading plugins at @{pluginsPath} for @{pluginId}');
+      }
+    }
+
+    if (typeof pluginId === 'string') {
+      const isScoped = pluginId.startsWith('@') && pluginId.includes('/');
+      debug('is scoped plugin %s', isScoped);
+      const pluginName = isScoped ? pluginId : `${prefix}-${pluginId}`;
+      debug('plugin pkg name %s', pluginName);
+      let plugin = (0, _utils.tryLoad)(pluginName);
+
+      if (plugin && (0, _utils.isValid)(plugin)) {
+        plugin = executePlugin(plugin, pluginConfigs[pluginId], params);
+
+        if (!sanityCheck(plugin)) {
+          _logger.logger.error({
+            content: pluginName
+          }, "@{content} doesn't look like a valid plugin");
+
+          continue;
+        }
+
+        plugins.push(plugin);
+        continue;
+      } else {
+        _logger.logger.error({
+          pluginName
+        }, 'package not found, try to install @{pluginName} with a package manager');
+
+        continue;
+      }
+    }
+  }
+
+  debug('plugin found %s', plugins.length);
+  return plugins;
+}
+
+function executePlugin(plugin, pluginConfig, params) {
+  if ((0, _utils.isES6)(plugin)) {
+    debug('plugin is ES6'); // eslint-disable-next-line new-cap
+
+    return new plugin.default(pluginConfig, params);
+  } else {
+    debug('plugin is commonJS');
+    return plugin(pluginConfig, params);
+  }
+}
+//# sourceMappingURL=plugin-async-loader.js.map

package/build/plugin-async-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-async-loader.js","names":["debug","buildDebug","isDirectory","pathFolder","stat","lstat","asyncLoadPlugin","pluginConfigs","params","sanityCheck","prefix","pluginsIds","Object","keys","config","plugins","pluginId","pluginsPath","isAbsolute","config_path","configPath","logger","error","resolve","join","dirname","path","pluginDir","externalFilePlugin","plugin","tryLoad","isValid","executePlugin","content","push","err","warn","message","isScoped","startsWith","includes","pluginName","length","pluginConfig","isES6","default"],"sources":["../src/plugin-async-loader.ts"],"sourcesContent":["import buildDebug from 'debug';\nimport { lstat } from 'fs/promises';\nimport { dirname, isAbsolute, join, resolve } from 'path';\n\nimport { logger } from '@verdaccio/logger';\nimport { Config, IPlugin, Logger } from '@verdaccio/types';\n\nimport { isES6, isValid, tryLoad } from './utils';\n\nconst debug = buildDebug('verdaccio:plugin:loader:async');\n\nasync function isDirectory(pathFolder) {\n  const stat = await lstat(pathFolder);\n  return stat.isDirectory();\n}\n\nexport type Params = { config: Config; logger: Logger };\n\n/**\n * The plugin loader find recursively plugins, if one plugin fails is ignored and report the error to the logger.\n *\n * The loader follows the order:\n * - If the at the `config.yaml` file the  `plugins: ./plugins` is defined\n *   - If is absolute will use the provided path\n *   - If is relative, will use the base path of the config file. eg: /root/config.yaml the plugins folder should be\n *     hosted at /root/plugins\n * - The next step is find at the node_modules or global based on the `require` native algorithm.\n * - If the package is scoped eg: @scope/foo, try to load the package `@scope/foo`\n * - If the package is not scoped, will use the default prefix: verdaccio-foo.\n * - If a custom prefix is provided, the verdaccio- is replaced by the config.server.pluginPrefix.\n *\n * The `sanityCheck` is the validation for the required methods to load the plugin, if the validation fails the plugin won't be loaded.\n * The `params` is an object that contains the global configuration and the logger.\n *\n * @param {*} pluginConfigs the custom plugin section\n * @param {*} params a set of params to initialize the plugin\n * @param {*} sanityCheck callback that check the shape that should fulfill the plugin\n * @param {*} prefix by default is verdaccio but can be override with config.server.pluginPrefix\n * @return {Array} list of plugins\n */\nexport async function asyncLoadPlugin<T extends IPlugin<T>>(\n  pluginConfigs: any = {},\n  params: Params,\n  sanityCheck: any,\n  prefix: string = 'verdaccio'\n): Promise<any> {\n  const pluginsIds = Object.keys(pluginConfigs);\n  const { config } = params;\n  let plugins: any[] = [];\n  for (let pluginId of pluginsIds) {\n    debug('plugin %s', pluginId);\n    if (typeof config.plugins === 'string') {\n      let pluginsPath = config.plugins;\n      debug('plugin path %s', pluginsPath);\n      if (!isAbsolute(pluginsPath)) {\n        if (typeof config.config_path === 'string' && !config.configPath) {\n          logger.error(\n            'configPath is missing and the legacy config.config_path is not available for loading plugins'\n          );\n        }\n\n        if (!config.configPath) {\n          logger.error('config path property is required for loading plugins');\n          continue;\n        }\n        pluginsPath = resolve(join(dirname(config.configPath), pluginsPath));\n      }\n\n      logger.debug({ path: pluginsPath }, 'plugins folder defined, loading plugins from @{path} ');\n      // throws if is nto a directory\n      try {\n        await isDirectory(pluginsPath);\n        const pluginDir = pluginsPath;\n        const externalFilePlugin = resolve(pluginDir, `${prefix}-${pluginId}`);\n        let plugin = tryLoad(externalFilePlugin);\n        if (plugin && isValid(plugin)) {\n          plugin = executePlugin(plugin, pluginConfigs[pluginId], params);\n          if (!sanityCheck(plugin)) {\n            logger.error(\n              { content: externalFilePlugin },\n              \"@{content} doesn't look like a valid plugin\"\n            );\n            continue;\n          }\n          plugins.push(plugin);\n          continue;\n        }\n      } catch (err: any) {\n        logger.warn(\n          { err: err.message, pluginsPath, pluginId },\n          '@{err} on loading plugins at @{pluginsPath} for @{pluginId}'\n        );\n      }\n    }\n\n    if (typeof pluginId === 'string') {\n      const isScoped: boolean = pluginId.startsWith('@') && pluginId.includes('/');\n      debug('is scoped plugin %s', isScoped);\n      const pluginName = isScoped ? pluginId : `${prefix}-${pluginId}`;\n      debug('plugin pkg name %s', pluginName);\n      let plugin = tryLoad(pluginName);\n      if (plugin && isValid(plugin)) {\n        plugin = executePlugin(plugin, pluginConfigs[pluginId], params);\n        if (!sanityCheck(plugin)) {\n          logger.error({ content: pluginName }, \"@{content} doesn't look like a valid plugin\");\n          continue;\n        }\n        plugins.push(plugin);\n        continue;\n      } else {\n        logger.error(\n          { pluginName },\n          'package not found, try to install @{pluginName} with a package manager'\n        );\n        continue;\n      }\n    }\n  }\n  debug('plugin found %s', plugins.length);\n  return plugins;\n}\n\nexport function executePlugin(plugin, pluginConfig, params: Params) {\n  if (isES6(plugin)) {\n    debug('plugin is ES6');\n    // eslint-disable-next-line new-cap\n    return new plugin.default(pluginConfig, params);\n  } else {\n    debug('plugin is commonJS');\n    return plugin(pluginConfig, params);\n  }\n}\n"],"mappings":";;;;;;;;AAAA;;AACA;;AACA;;AAEA;;AAGA;;;;AAEA,MAAMA,KAAK,GAAG,IAAAC,cAAA,EAAW,+BAAX,CAAd;;AAEA,eAAeC,WAAf,CAA2BC,UAA3B,EAAuC;EACrC,MAAMC,IAAI,GAAG,MAAM,IAAAC,eAAA,EAAMF,UAAN,CAAnB;EACA,OAAOC,IAAI,CAACF,WAAL,EAAP;AACD;;AAID;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,eAAeI,eAAf,CACLC,aAAkB,GAAG,EADhB,EAELC,MAFK,EAGLC,WAHK,EAILC,MAAc,GAAG,WAJZ,EAKS;EACd,MAAMC,UAAU,GAAGC,MAAM,CAACC,IAAP,CAAYN,aAAZ,CAAnB;EACA,MAAM;IAAEO;EAAF,IAAaN,MAAnB;EACA,IAAIO,OAAc,GAAG,EAArB;;EACA,KAAK,IAAIC,QAAT,IAAqBL,UAArB,EAAiC;IAC/BX,KAAK,CAAC,WAAD,EAAcgB,QAAd,CAAL;;IACA,IAAI,OAAOF,MAAM,CAACC,OAAd,KAA0B,QAA9B,EAAwC;MACtC,IAAIE,WAAW,GAAGH,MAAM,CAACC,OAAzB;MACAf,KAAK,CAAC,gBAAD,EAAmBiB,WAAnB,CAAL;;MACA,IAAI,CAAC,IAAAC,gBAAA,EAAWD,WAAX,CAAL,EAA8B;QAC5B,IAAI,OAAOH,MAAM,CAACK,WAAd,KAA8B,QAA9B,IAA0C,CAACL,MAAM,CAACM,UAAtD,EAAkE;UAChEC,cAAA,CAAOC,KAAP,CACE,8FADF;QAGD;;QAED,IAAI,CAACR,MAAM,CAACM,UAAZ,EAAwB;UACtBC,cAAA,CAAOC,KAAP,CAAa,sDAAb;;UACA;QACD;;QACDL,WAAW,GAAG,IAAAM,aAAA,EAAQ,IAAAC,UAAA,EAAK,IAAAC,aAAA,EAAQX,MAAM,CAACM,UAAf,CAAL,EAAiCH,WAAjC,CAAR,CAAd;MACD;;MAEDI,cAAA,CAAOrB,KAAP,CAAa;QAAE0B,IAAI,EAAET;MAAR,CAAb,EAAoC,uDAApC,EAjBsC,CAkBtC;;;MACA,IAAI;QACF,MAAMf,WAAW,CAACe,WAAD,CAAjB;QACA,MAAMU,SAAS,GAAGV,WAAlB;QACA,MAAMW,kBAAkB,GAAG,IAAAL,aAAA,EAAQI,SAAR,EAAoB,GAAEjB,MAAO,IAAGM,QAAS,EAAzC,CAA3B;QACA,IAAIa,MAAM,GAAG,IAAAC,cAAA,EAAQF,kBAAR,CAAb;;QACA,IAAIC,MAAM,IAAI,IAAAE,cAAA,EAAQF,MAAR,CAAd,EAA+B;UAC7BA,MAAM,GAAGG,aAAa,CAACH,MAAD,EAAStB,aAAa,CAACS,QAAD,CAAtB,EAAkCR,MAAlC,CAAtB;;UACA,IAAI,CAACC,WAAW,CAACoB,MAAD,CAAhB,EAA0B;YACxBR,cAAA,CAAOC,KAAP,CACE;cAAEW,OAAO,EAAEL;YAAX,CADF,EAEE,6CAFF;;YAIA;UACD;;UACDb,OAAO,CAACmB,IAAR,CAAaL,MAAb;UACA;QACD;MACF,CAjBD,CAiBE,OAAOM,GAAP,EAAiB;QACjBd,cAAA,CAAOe,IAAP,CACE;UAAED,GAAG,EAAEA,GAAG,CAACE,OAAX;UAAoBpB,WAApB;UAAiCD;QAAjC,CADF,EAEE,6DAFF;MAID;IACF;;IAED,IAAI,OAAOA,QAAP,KAAoB,QAAxB,EAAkC;MAChC,MAAMsB,QAAiB,GAAGtB,QAAQ,CAACuB,UAAT,CAAoB,GAApB,KAA4BvB,QAAQ,CAACwB,QAAT,CAAkB,GAAlB,CAAtD;MACAxC,KAAK,CAAC,qBAAD,EAAwBsC,QAAxB,CAAL;MACA,MAAMG,UAAU,GAAGH,QAAQ,GAAGtB,QAAH,GAAe,GAAEN,MAAO,IAAGM,QAAS,EAA/D;MACAhB,KAAK,CAAC,oBAAD,EAAuByC,UAAvB,CAAL;MACA,IAAIZ,MAAM,GAAG,IAAAC,cAAA,EAAQW,UAAR,CAAb;;MACA,IAAIZ,MAAM,IAAI,IAAAE,cAAA,EAAQF,MAAR,CAAd,EAA+B;QAC7BA,MAAM,GAAGG,aAAa,CAACH,MAAD,EAAStB,aAAa,CAACS,QAAD,CAAtB,EAAkCR,MAAlC,CAAtB;;QACA,IAAI,CAACC,WAAW,CAACoB,MAAD,CAAhB,EAA0B;UACxBR,cAAA,CAAOC,KAAP,CAAa;YAAEW,OAAO,EAAEQ;UAAX,CAAb,EAAsC,6CAAtC;;UACA;QACD;;QACD1B,OAAO,CAACmB,IAAR,CAAaL,MAAb;QACA;MACD,CARD,MAQO;QACLR,cAAA,CAAOC,KAAP,CACE;UAAEmB;QAAF,CADF,EAEE,wEAFF;;QAIA;MACD;IACF;EACF;;EACDzC,KAAK,CAAC,iBAAD,EAAoBe,OAAO,CAAC2B,MAA5B,CAAL;EACA,OAAO3B,OAAP;AACD;;AAEM,SAASiB,aAAT,CAAuBH,MAAvB,EAA+Bc,YAA/B,EAA6CnC,MAA7C,EAA6D;EAClE,IAAI,IAAAoC,YAAA,EAAMf,MAAN,CAAJ,EAAmB;IACjB7B,KAAK,CAAC,eAAD,CAAL,CADiB,CAEjB;;IACA,OAAO,IAAI6B,MAAM,CAACgB,OAAX,CAAmBF,YAAnB,EAAiCnC,MAAjC,CAAP;EACD,CAJD,MAIO;IACLR,KAAK,CAAC,oBAAD,CAAL;IACA,OAAO6B,MAAM,CAACc,YAAD,EAAenC,MAAf,CAAb;EACD;AACF"}

package/build/utils.d.ts

@@ -0,0 +1,10 @@
+import { Config } from '@verdaccio/types';
+export declare function mergeConfig(appConfig: any, pluginConfig: any): Config;
+export declare function isValid(plugin: any): boolean;
+export declare function isES6(plugin: any): boolean;
+/**
+ * Requires a module.
+ * @param {*} path the module's path
+ * @return {Object}
+ */
+export declare function tryLoad(path: string): any;

package/build/utils.js

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isES6 = isES6;
+exports.isValid = isValid;
+exports.mergeConfig = mergeConfig;
+exports.tryLoad = tryLoad;
+
+var _debug = _interopRequireDefault(require("debug"));
+
+var _lodash = _interopRequireDefault(require("lodash"));
+
+var _logger = require("@verdaccio/logger");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const debug = (0, _debug.default)('verdaccio:plugin:loader:utils');
+const MODULE_NOT_FOUND = 'MODULE_NOT_FOUND';
+
+function mergeConfig(appConfig, pluginConfig) {
+  return _lodash.default.merge(appConfig, pluginConfig);
+}
+
+function isValid(plugin) {
+  return _lodash.default.isFunction(plugin) || _lodash.default.isFunction(plugin.default);
+}
+
+function isES6(plugin) {
+  return Object.keys(plugin).includes('default');
+}
+/**
+ * Requires a module.
+ * @param {*} path the module's path
+ * @return {Object}
+ */
+
+
+function tryLoad(path) {
+  try {
+    debug('loading plugin %s', path);
+    return require(path);
+  } catch (err) {
+    if (err.code === MODULE_NOT_FOUND) {
+      debug('plugin %s not found', path);
+      return null;
+    }
+
+    _logger.logger.error({
+      err: err.msg
+    }, 'error loading plugin @{err}');
+
+    throw err;
+  }
+}
+//# sourceMappingURL=utils.js.map

package/build/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","names":["debug","buildDebug","MODULE_NOT_FOUND","mergeConfig","appConfig","pluginConfig","_","merge","isValid","plugin","isFunction","default","isES6","Object","keys","includes","tryLoad","path","require","err","code","logger","error","msg"],"sources":["../src/utils.ts"],"sourcesContent":["import buildDebug from 'debug';\nimport _ from 'lodash';\n\nimport { logger } from '@verdaccio/logger';\nimport { Config } from '@verdaccio/types';\n\nconst debug = buildDebug('verdaccio:plugin:loader:utils');\n\nconst MODULE_NOT_FOUND = 'MODULE_NOT_FOUND';\n\nexport function mergeConfig(appConfig, pluginConfig): Config {\n  return _.merge(appConfig, pluginConfig);\n}\n\nexport function isValid(plugin): boolean {\n  return _.isFunction(plugin) || _.isFunction(plugin.default);\n}\n\nexport function isES6(plugin): boolean {\n  return Object.keys(plugin).includes('default');\n}\n\n/**\n * Requires a module.\n * @param {*} path the module's path\n * @return {Object}\n */\nexport function tryLoad(path: string): any {\n  try {\n    debug('loading plugin %s', path);\n    return require(path);\n  } catch (err: any) {\n    if (err.code === MODULE_NOT_FOUND) {\n      debug('plugin %s not found', path);\n      return null;\n    }\n    logger.error({ err: err.msg }, 'error loading plugin @{err}');\n    throw err;\n  }\n}\n"],"mappings":";;;;;;;;;;AAAA;;AACA;;AAEA;;;;AAGA,MAAMA,KAAK,GAAG,IAAAC,cAAA,EAAW,+BAAX,CAAd;AAEA,MAAMC,gBAAgB,GAAG,kBAAzB;;AAEO,SAASC,WAAT,CAAqBC,SAArB,EAAgCC,YAAhC,EAAsD;EAC3D,OAAOC,eAAA,CAAEC,KAAF,CAAQH,SAAR,EAAmBC,YAAnB,CAAP;AACD;;AAEM,SAASG,OAAT,CAAiBC,MAAjB,EAAkC;EACvC,OAAOH,eAAA,CAAEI,UAAF,CAAaD,MAAb,KAAwBH,eAAA,CAAEI,UAAF,CAAaD,MAAM,CAACE,OAApB,CAA/B;AACD;;AAEM,SAASC,KAAT,CAAeH,MAAf,EAAgC;EACrC,OAAOI,MAAM,CAACC,IAAP,CAAYL,MAAZ,EAAoBM,QAApB,CAA6B,SAA7B,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;;;AACO,SAASC,OAAT,CAAiBC,IAAjB,EAAoC;EACzC,IAAI;IACFjB,KAAK,CAAC,mBAAD,EAAsBiB,IAAtB,CAAL;IACA,OAAOC,OAAO,CAACD,IAAD,CAAd;EACD,CAHD,CAGE,OAAOE,GAAP,EAAiB;IACjB,IAAIA,GAAG,CAACC,IAAJ,KAAalB,gBAAjB,EAAmC;MACjCF,KAAK,CAAC,qBAAD,EAAwBiB,IAAxB,CAAL;MACA,OAAO,IAAP;IACD;;IACDI,cAAA,CAAOC,KAAP,CAAa;MAAEH,GAAG,EAAEA,GAAG,CAACI;IAAX,CAAb,EAA+B,6BAA/B;;IACA,MAAMJ,GAAN;EACD;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/loaders",
-  "version": "6.0.0-6-next.15",
+  "version": "6.0.0-6-next.17",
   "description": "loaders logic",
   "main": "./build/index.js",
   "types": "build/index.d.ts",
@@ -13,14 +13,17 @@
     "url": "https://github.com/verdaccio/verdaccio"
   },
   "dependencies": {
-    "@verdaccio/logger": "6.0.0-6-next.14",
+    "@verdaccio/logger": "6.0.0-6-next.16",
     "debug": "4.3.4",
     "lodash": "4.17.21"
   },
   "devDependencies": {
-    "@verdaccio/core": "6.0.0-6-next.8",
-    "@verdaccio/config": "6.0.0-6-next.17",
-    "@verdaccio/types": "11.0.0-6-next.16"
+    "@verdaccio/core": "6.0.0-6-next.48",
+    "@verdaccio/config": "6.0.0-6-next.48",
+    "@verdaccio/types": "11.0.0-6-next.17",
+    "@verdaccio-scope/verdaccio-auth-foo": "0.0.2",
+    "verdaccio-auth-memory": "11.0.0-6-next.13",
+    "customprefix-auth": "1.0.0-6-next.0"
   },
   "homepage": "https://verdaccio.org",
   "keywords": [

package/src/index.ts

@@ -1 +1 @@
-export * from './plugin-loader';
+export { asyncLoadPlugin } from './plugin-async-loader';

package/src/plugin-async-loader.ts

@@ -0,0 +1,132 @@
+import buildDebug from 'debug';
+import { lstat } from 'fs/promises';
+import { dirname, isAbsolute, join, resolve } from 'path';
+
+import { logger } from '@verdaccio/logger';
+import { Config, IPlugin, Logger } from '@verdaccio/types';
+
+import { isES6, isValid, tryLoad } from './utils';
+
+const debug = buildDebug('verdaccio:plugin:loader:async');
+
+async function isDirectory(pathFolder) {
+  const stat = await lstat(pathFolder);
+  return stat.isDirectory();
+}
+
+export type Params = { config: Config; logger: Logger };
+
+/**
+ * The plugin loader find recursively plugins, if one plugin fails is ignored and report the error to the logger.
+ *
+ * The loader follows the order:
+ * - If the at the `config.yaml` file the  `plugins: ./plugins` is defined
+ *   - If is absolute will use the provided path
+ *   - If is relative, will use the base path of the config file. eg: /root/config.yaml the plugins folder should be
+ *     hosted at /root/plugins
+ * - The next step is find at the node_modules or global based on the `require` native algorithm.
+ * - If the package is scoped eg: @scope/foo, try to load the package `@scope/foo`
+ * - If the package is not scoped, will use the default prefix: verdaccio-foo.
+ * - If a custom prefix is provided, the verdaccio- is replaced by the config.server.pluginPrefix.
+ *
+ * The `sanityCheck` is the validation for the required methods to load the plugin, if the validation fails the plugin won't be loaded.
+ * The `params` is an object that contains the global configuration and the logger.
+ *
+ * @param {*} pluginConfigs the custom plugin section
+ * @param {*} params a set of params to initialize the plugin
+ * @param {*} sanityCheck callback that check the shape that should fulfill the plugin
+ * @param {*} prefix by default is verdaccio but can be override with config.server.pluginPrefix
+ * @return {Array} list of plugins
+ */
+export async function asyncLoadPlugin<T extends IPlugin<T>>(
+  pluginConfigs: any = {},
+  params: Params,
+  sanityCheck: any,
+  prefix: string = 'verdaccio'
+): Promise<any> {
+  const pluginsIds = Object.keys(pluginConfigs);
+  const { config } = params;
+  let plugins: any[] = [];
+  for (let pluginId of pluginsIds) {
+    debug('plugin %s', pluginId);
+    if (typeof config.plugins === 'string') {
+      let pluginsPath = config.plugins;
+      debug('plugin path %s', pluginsPath);
+      if (!isAbsolute(pluginsPath)) {
+        if (typeof config.config_path === 'string' && !config.configPath) {
+          logger.error(
+            'configPath is missing and the legacy config.config_path is not available for loading plugins'
+          );
+        }
+
+        if (!config.configPath) {
+          logger.error('config path property is required for loading plugins');
+          continue;
+        }
+        pluginsPath = resolve(join(dirname(config.configPath), pluginsPath));
+      }
+
+      logger.debug({ path: pluginsPath }, 'plugins folder defined, loading plugins from @{path} ');
+      // throws if is nto a directory
+      try {
+        await isDirectory(pluginsPath);
+        const pluginDir = pluginsPath;
+        const externalFilePlugin = resolve(pluginDir, `${prefix}-${pluginId}`);
+        let plugin = tryLoad(externalFilePlugin);
+        if (plugin && isValid(plugin)) {
+          plugin = executePlugin(plugin, pluginConfigs[pluginId], params);
+          if (!sanityCheck(plugin)) {
+            logger.error(
+              { content: externalFilePlugin },
+              "@{content} doesn't look like a valid plugin"
+            );
+            continue;
+          }
+          plugins.push(plugin);
+          continue;
+        }
+      } catch (err: any) {
+        logger.warn(
+          { err: err.message, pluginsPath, pluginId },
+          '@{err} on loading plugins at @{pluginsPath} for @{pluginId}'
+        );
+      }
+    }
+
+    if (typeof pluginId === 'string') {
+      const isScoped: boolean = pluginId.startsWith('@') && pluginId.includes('/');
+      debug('is scoped plugin %s', isScoped);
+      const pluginName = isScoped ? pluginId : `${prefix}-${pluginId}`;
+      debug('plugin pkg name %s', pluginName);
+      let plugin = tryLoad(pluginName);
+      if (plugin && isValid(plugin)) {
+        plugin = executePlugin(plugin, pluginConfigs[pluginId], params);
+        if (!sanityCheck(plugin)) {
+          logger.error({ content: pluginName }, "@{content} doesn't look like a valid plugin");
+          continue;
+        }
+        plugins.push(plugin);
+        continue;
+      } else {
+        logger.error(
+          { pluginName },
+          'package not found, try to install @{pluginName} with a package manager'
+        );
+        continue;
+      }
+    }
+  }
+  debug('plugin found %s', plugins.length);
+  return plugins;
+}
+
+export function executePlugin(plugin, pluginConfig, params: Params) {
+  if (isES6(plugin)) {
+    debug('plugin is ES6');
+    // eslint-disable-next-line new-cap
+    return new plugin.default(pluginConfig, params);
+  } else {
+    debug('plugin is commonJS');
+    return plugin(pluginConfig, params);
+  }
+}

package/src/utils.ts

@@ -0,0 +1,40 @@
+import buildDebug from 'debug';
+import _ from 'lodash';
+
+import { logger } from '@verdaccio/logger';
+import { Config } from '@verdaccio/types';
+
+const debug = buildDebug('verdaccio:plugin:loader:utils');
+
+const MODULE_NOT_FOUND = 'MODULE_NOT_FOUND';
+
+export function mergeConfig(appConfig, pluginConfig): Config {
+  return _.merge(appConfig, pluginConfig);
+}
+
+export function isValid(plugin): boolean {
+  return _.isFunction(plugin) || _.isFunction(plugin.default);
+}
+
+export function isES6(plugin): boolean {
+  return Object.keys(plugin).includes('default');
+}
+
+/**
+ * Requires a module.
+ * @param {*} path the module's path
+ * @return {Object}
+ */
+export function tryLoad(path: string): any {
+  try {
+    debug('loading plugin %s', path);
+    return require(path);
+  } catch (err: any) {
+    if (err.code === MODULE_NOT_FOUND) {
+      debug('plugin %s not found', path);
+      return null;
+    }
+    logger.error({ err: err.msg }, 'error loading plugin @{err}');
+    throw err;
+  }
+}

package/test/partials/config/custom-prefix-auth.yaml

@@ -0,0 +1,3 @@
+auth:
+  '@verdaccio-scope/verdaccio-auth-foo':
+    enabled: true

package/test/partials/config/npm-plugin-auth.yaml

@@ -0,0 +1,3 @@
+auth:
+  auth-memory:
+    enabled: true

package/test/partials/config/npm-plugin-not-found.yaml

@@ -0,0 +1,3 @@
+auth:
+  not-found:
+    enabled: true

package/test/partials/config/plugins-folder-fake.yaml

@@ -0,0 +1,4 @@
+auth:
+  something:
+    enabled: true
+plugins: /roo/does-not-exist

package/test/partials/config/relative-plugins.yaml

@@ -0,0 +1,4 @@
+plugins: '../test-plugin-storage'
+auth:
+  plugin:
+    enabled: true

package/test/partials/config/scope-auth.yaml

@@ -0,0 +1,3 @@
+auth:
+  '@verdaccio-scope/verdaccio-auth-foo':
+    enabled: true

package/test/partials/config/valid-plugin.yaml

@@ -0,0 +1,3 @@
+auth:
+  plugin:
+    enabled: true

package/test/partials/test-plugin-storage/verdaccio-scope/index.js

@@ -0,0 +1,7 @@
+function ValidScopedVerdaccioPlugin() {
+  return {
+    authenticate: function () {},
+  };
+}
+
+module.exports = ValidVerdaccioPlugin;

package/test/partials/test-plugin-storage/verdaccio-scope/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@verdaccio-scoped/verdaccio-plugin",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC"
+}

package/test/plugin_loader_async.spec.ts

@@ -0,0 +1,168 @@
+import path from 'path';
+
+import { Config, parseConfigFile } from '@verdaccio/config';
+import { logger, setup } from '@verdaccio/logger';
+
+import { asyncLoadPlugin } from '../src/plugin-async-loader';
+
+function getConfig(file: string) {
+  const conPath = path.join(__dirname, './partials/config', file);
+  return new Config(parseConfigFile(conPath));
+}
+
+const authSanitize = function (plugin) {
+  return plugin.authenticate || plugin.allow_access || plugin.allow_publish;
+};
+
+const pluginsPartialsFolder = path.join(__dirname, './partials/test-plugin-storage');
+
+setup();
+
+describe('plugin loader', () => {
+  describe('file plugins', () => {
+    describe('absolute path', () => {
+      test('testing auth valid plugin loader', async () => {
+        const config = getConfig('valid-plugin.yaml');
+        config.plugins = pluginsPartialsFolder;
+        const plugins = await asyncLoadPlugin(config.auth, { config, logger }, authSanitize);
+
+        expect(plugins).toHaveLength(1);
+      });
+
+      test('should handle does not exist plugin folder', async () => {
+        const config = getConfig('plugins-folder-fake.yaml');
+        const plugins = await asyncLoadPlugin(
+          config.auth,
+          { logger: logger, config: config },
+          authSanitize
+        );
+
+        expect(plugins).toHaveLength(0);
+      });
+
+      test('testing load auth npm package invalid method check', async () => {
+        const config = getConfig('valid-plugin.yaml');
+        config.plugins = pluginsPartialsFolder;
+        const plugins = await asyncLoadPlugin(config.auth, { config, logger }, (p) => p.anyMethod);
+
+        expect(plugins).toHaveLength(0);
+      });
+
+      test('should fails if plugins folder is not a directory', async () => {
+        const config = getConfig('plugins-folder-fake.yaml');
+        // force file instead a folder.
+        config.plugins = path.join(__dirname, 'just-a-file.js');
+        const plugins = await asyncLoadPlugin(
+          config.auth,
+          { logger: logger, config: config },
+          authSanitize
+        );
+
+        expect(plugins).toHaveLength(0);
+      });
+    });
+    describe('relative path', () => {
+      test('should resolve plugin based on relative path', async () => {
+        const config = getConfig('relative-plugins.yaml');
+        // force file instead a folder.
+        const plugins = await asyncLoadPlugin(
+          config.auth,
+          { logger: logger, config: config },
+          authSanitize
+        );
+
+        expect(plugins).toHaveLength(1);
+      });
+
+      test('should fails if config path is missing', async () => {
+        const config = getConfig('relative-plugins.yaml');
+        // @ts-expect-error
+        config.configPath = undefined;
+        // @ts-expect-error
+        config.config_path = undefined;
+        // force file instead a folder.
+        const plugins = await asyncLoadPlugin(
+          config.auth,
+          { logger: logger, config: config },
+          authSanitize
+        );
+
+        expect(plugins).toHaveLength(0);
+      });
+
+      // config.config_path is not considered for loading plugins due legacy support
+      test('should fails if config path is missing (only config_path)', async () => {
+        const config = getConfig('relative-plugins.yaml');
+        // @ts-expect-error
+        config.configPath = undefined;
+        // force file instead a folder.
+        const plugins = await asyncLoadPlugin(
+          config.auth,
+          { logger: logger, config: config },
+          authSanitize
+        );
+
+        expect(plugins).toHaveLength(0);
+      });
+    });
+  });
+
+  describe('npm plugins', () => {
+    test('testing load auth npm package', async () => {
+      const config = getConfig('npm-plugin-auth.yaml');
+      const plugins = await asyncLoadPlugin(config.auth, { config, logger }, authSanitize);
+
+      expect(plugins).toHaveLength(1);
+    });
+
+    test('should handle not found installed package', async () => {
+      const config = getConfig('npm-plugin-not-found.yaml');
+      const plugins = await asyncLoadPlugin(config.auth, { config, logger }, (p) => p.anyMethod);
+
+      expect(plugins).toHaveLength(0);
+    });
+
+    test('testing load auth npm package invalid method check', async () => {
+      const config = getConfig('npm-plugin-auth.yaml');
+      const plugins = await asyncLoadPlugin(config.auth, { config, logger }, (p) => p.anyMethod);
+
+      expect(plugins).toHaveLength(0);
+    });
+
+    test('testing load auth npm package custom prefix', async () => {
+      const config = getConfig('custom-prefix-auth.yaml');
+      const plugins = await asyncLoadPlugin(
+        config.auth,
+        { config, logger },
+        authSanitize,
+        'customprefix'
+      );
+
+      expect(plugins).toHaveLength(1);
+    });
+
+    test('testing load auth scope npm package', async () => {
+      const config = getConfig('scope-auth.yaml');
+      const plugins = await asyncLoadPlugin(config.auth, { config, logger }, authSanitize);
+      expect(plugins).toHaveLength(1);
+    });
+  });
+
+  describe('fallback plugins', () => {
+    test('should fallback to npm package if does not find on plugins folder', async () => {
+      const config = getConfig('npm-plugin-auth.yaml');
+      config.plugins = pluginsPartialsFolder;
+      const plugins = await asyncLoadPlugin(config.auth, { config, logger }, authSanitize);
+
+      expect(plugins).toHaveLength(1);
+    });
+
+    test('should fallback to npm package if plugins folder does not exist', async () => {
+      const config = getConfig('npm-plugin-auth.yaml');
+      config.plugins = '/does-not-exist';
+      const plugins = await asyncLoadPlugin(config.auth, { config, logger }, authSanitize);
+
+      expect(plugins).toHaveLength(1);
+    });
+  });
+});

package/build/plugin-loader.d.ts

@@ -1,16 +0,0 @@
-import { Config, IPlugin } from '@verdaccio/types';
-export declare const MODULE_NOT_FOUND = "MODULE_NOT_FOUND";
-/**
- * Load a plugin following the rules
- * - First try to load from the internal directory plugins (which will disappear soon or later).
- * - A second attempt from the external plugin directory
- * - A third attempt from node_modules, in case to have multiple match as for instance
- * verdaccio-ldap
- * and sinopia-ldap. All verdaccio prefix will have preferences.
- * @param {*} config a reference of the configuration settings
- * @param {*} pluginConfigs
- * @param {*} params a set of params to initialize the plugin
- * @param {*} sanityCheck callback that check the shape that should fulfill the plugin
- * @return {Array} list of plugins
- */
-export declare function loadPlugin<T extends IPlugin<T>>(config: Config, pluginConfigs: any, params: any, sanityCheck: any, prefix?: string): any[];

package/build/plugin-loader.js

@@ -1,159 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.MODULE_NOT_FOUND = void 0;
-exports.loadPlugin = loadPlugin;
-
-var _debug = _interopRequireDefault(require("debug"));
-
-var _lodash = _interopRequireDefault(require("lodash"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _logger = require("@verdaccio/logger");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const debug = (0, _debug.default)('verdaccio:plugin:loader');
-const MODULE_NOT_FOUND = 'MODULE_NOT_FOUND';
-/**
- * Requires a module.
- * @param {*} path the module's path
- * @return {Object}
- */
-
-exports.MODULE_NOT_FOUND = MODULE_NOT_FOUND;
-
-function tryLoad(path) {
-  try {
-    return require(path);
-  } catch (err) {
-    if (err.code === MODULE_NOT_FOUND) {
-      return null;
-    }
-
-    throw err;
-  }
-}
-
-function mergeConfig(appConfig, pluginConfig) {
-  return _lodash.default.merge(appConfig, pluginConfig);
-}
-
-function isValid(plugin) {
-  return _lodash.default.isFunction(plugin) || _lodash.default.isFunction(plugin.default);
-}
-
-function isES6(plugin) {
-  return Object.keys(plugin).includes('default');
-} // export type PluginGeneric<R, T extends IPlugin<R> = ;
-
-/**
- * Load a plugin following the rules
- * - First try to load from the internal directory plugins (which will disappear soon or later).
- * - A second attempt from the external plugin directory
- * - A third attempt from node_modules, in case to have multiple match as for instance
- * verdaccio-ldap
- * and sinopia-ldap. All verdaccio prefix will have preferences.
- * @param {*} config a reference of the configuration settings
- * @param {*} pluginConfigs
- * @param {*} params a set of params to initialize the plugin
- * @param {*} sanityCheck callback that check the shape that should fulfill the plugin
- * @return {Array} list of plugins
- */
-
-
-function loadPlugin(config, pluginConfigs = {}, params, sanityCheck, prefix = 'verdaccio') {
-  return Object.keys(pluginConfigs).map(pluginId => {
-    let plugin;
-
-    const localPlugin = _path.default.resolve(__dirname + '/../plugins', pluginId); // try local plugins first
-
-
-    plugin = tryLoad(localPlugin); // try the external plugin directory
-
-    if (plugin === null && config.plugins) {
-      const pluginDir = config.plugins;
-
-      const externalFilePlugin = _path.default.resolve(pluginDir, pluginId);
-
-      plugin = tryLoad(externalFilePlugin); // npm package
-
-      if (plugin === null && pluginId.match(/^[^\.\/]/)) {
-        plugin = tryLoad(_path.default.resolve(pluginDir, `${prefix}-${pluginId}`)); // compatibility for old sinopia plugins
-
-        if (!plugin) {
-          plugin = tryLoad(_path.default.resolve(pluginDir, `sinopia-${pluginId}`));
-        }
-      }
-    } // npm package
-
-
-    if (plugin === null && pluginId.match(/^[^\.\/]/)) {
-      plugin = tryLoad(`${prefix}-${pluginId}`); // compatibility for old sinopia plugins
-
-      if (!plugin) {
-        plugin = tryLoad(`sinopia-${pluginId}`);
-      }
-    }
-
-    if (plugin === null) {
-      plugin = tryLoad(pluginId);
-    } // relative to config path
-
-
-    debug('config path: %s', config.configPath);
-
-    if (plugin === null && pluginId.match(/^\.\.?($|\/)/) && config.configPath) {
-      plugin = tryLoad(_path.default.resolve(_path.default.dirname(config.configPath), pluginId));
-    }
-
-    if (plugin === null) {
-      _logger.logger.error({
-        content: pluginId,
-        prefix
-      }, 'plugin not found. try npm install @{prefix}-@{content}');
-
-      throw Error(`
-        ${prefix}-${pluginId} plugin not found. try "npm install ${prefix}-${pluginId}"`);
-    }
-
-    if (!isValid(plugin)) {
-      _logger.logger.error({
-        content: pluginId
-      }, '@{prefix}-@{content} plugin does not have the right code structure');
-
-      throw Error(`"${pluginId}" plugin does not have the right code structure`);
-    }
-    /* eslint new-cap:off */
-
-
-    try {
-      plugin = isES6(plugin) ? new plugin.default(mergeConfig(config, pluginConfigs[pluginId]), params) : new plugin(pluginConfigs[pluginId], params);
-    } catch (error) {
-      plugin = null;
-
-      _logger.logger.error({
-        error,
-        pluginId
-      }, 'error loading a plugin @{pluginId}: @{error}');
-    }
-    /* eslint new-cap:off */
-
-
-    if (plugin === null || !sanityCheck(plugin)) {
-      _logger.logger.error({
-        content: pluginId,
-        prefix
-      }, "@{prefix}-@{content} doesn't look like a valid plugin");
-
-      throw Error(`sanity check has failed, "${pluginId}" is not a valid plugin`);
-    }
-
-    debug('Plugin successfully loaded: %o-%o', pluginId, prefix);
-    return plugin;
-  });
-}
-//# sourceMappingURL=plugin-loader.js.map

package/build/plugin-loader.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin-loader.js","names":["debug","buildDebug","MODULE_NOT_FOUND","tryLoad","path","require","err","code","mergeConfig","appConfig","pluginConfig","_","merge","isValid","plugin","isFunction","default","isES6","Object","keys","includes","loadPlugin","config","pluginConfigs","params","sanityCheck","prefix","map","pluginId","localPlugin","Path","resolve","__dirname","plugins","pluginDir","externalFilePlugin","match","configPath","dirname","logger","error","content","Error"],"sources":["../src/plugin-loader.ts"],"sourcesContent":["import buildDebug from 'debug';\nimport _ from 'lodash';\nimport Path from 'path';\n\nimport { logger } from '@verdaccio/logger';\nimport { Config, IPlugin } from '@verdaccio/types';\n\nconst debug = buildDebug('verdaccio:plugin:loader');\n\nexport const MODULE_NOT_FOUND = 'MODULE_NOT_FOUND';\n\n/**\n * Requires a module.\n * @param {*} path the module's path\n * @return {Object}\n */\nfunction tryLoad(path: string): any {\n  try {\n    return require(path);\n  } catch (err: any) {\n    if (err.code === MODULE_NOT_FOUND) {\n      return null;\n    }\n    throw err;\n  }\n}\n\nfunction mergeConfig(appConfig, pluginConfig): Config {\n  return _.merge(appConfig, pluginConfig);\n}\n\nfunction isValid(plugin): boolean {\n  return _.isFunction(plugin) || _.isFunction(plugin.default);\n}\n\nfunction isES6(plugin): boolean {\n  return Object.keys(plugin).includes('default');\n}\n\n// export type PluginGeneric<R, T extends IPlugin<R> = ;\n\n/**\n * Load a plugin following the rules\n * - First try to load from the internal directory plugins (which will disappear soon or later).\n * - A second attempt from the external plugin directory\n * - A third attempt from node_modules, in case to have multiple match as for instance\n * verdaccio-ldap\n * and sinopia-ldap. All verdaccio prefix will have preferences.\n * @param {*} config a reference of the configuration settings\n * @param {*} pluginConfigs\n * @param {*} params a set of params to initialize the plugin\n * @param {*} sanityCheck callback that check the shape that should fulfill the plugin\n * @return {Array} list of plugins\n */\nexport function loadPlugin<T extends IPlugin<T>>(\n  config: Config,\n  pluginConfigs: any = {},\n  params: any,\n  sanityCheck: any,\n  prefix: string = 'verdaccio'\n): any[] {\n  return Object.keys(pluginConfigs).map((pluginId: string): IPlugin<T> => {\n    let plugin;\n\n    const localPlugin = Path.resolve(__dirname + '/../plugins', pluginId);\n    // try local plugins first\n    plugin = tryLoad(localPlugin);\n\n    // try the external plugin directory\n    if (plugin === null && config.plugins) {\n      const pluginDir = config.plugins;\n      const externalFilePlugin = Path.resolve(pluginDir, pluginId);\n      plugin = tryLoad(externalFilePlugin);\n\n      // npm package\n      if (plugin === null && pluginId.match(/^[^\\.\\/]/)) {\n        plugin = tryLoad(Path.resolve(pluginDir, `${prefix}-${pluginId}`));\n        // compatibility for old sinopia plugins\n        if (!plugin) {\n          plugin = tryLoad(Path.resolve(pluginDir, `sinopia-${pluginId}`));\n        }\n      }\n    }\n\n    // npm package\n    if (plugin === null && pluginId.match(/^[^\\.\\/]/)) {\n      plugin = tryLoad(`${prefix}-${pluginId}`);\n      // compatibility for old sinopia plugins\n      if (!plugin) {\n        plugin = tryLoad(`sinopia-${pluginId}`);\n      }\n    }\n\n    if (plugin === null) {\n      plugin = tryLoad(pluginId);\n    }\n\n    // relative to config path\n    debug('config path: %s', config.configPath);\n    if (plugin === null && pluginId.match(/^\\.\\.?($|\\/)/) && config.configPath) {\n      plugin = tryLoad(Path.resolve(Path.dirname(config.configPath), pluginId));\n    }\n\n    if (plugin === null) {\n      logger.error(\n        { content: pluginId, prefix },\n        'plugin not found. try npm install @{prefix}-@{content}'\n      );\n      throw Error(`\n        ${prefix}-${pluginId} plugin not found. try \"npm install ${prefix}-${pluginId}\"`);\n    }\n\n    if (!isValid(plugin)) {\n      logger.error(\n        { content: pluginId },\n        '@{prefix}-@{content} plugin does not have the right code structure'\n      );\n      throw Error(`\"${pluginId}\" plugin does not have the right code structure`);\n    }\n\n    /* eslint new-cap:off */\n    try {\n      plugin = isES6(plugin)\n        ? new plugin.default(mergeConfig(config, pluginConfigs[pluginId]), params)\n        : new plugin(pluginConfigs[pluginId], params);\n    } catch (error: any) {\n      plugin = null;\n      logger.error({ error, pluginId }, 'error loading a plugin @{pluginId}: @{error}');\n    }\n    /* eslint new-cap:off */\n\n    if (plugin === null || !sanityCheck(plugin)) {\n      logger.error(\n        { content: pluginId, prefix },\n        \"@{prefix}-@{content} doesn't look like a valid plugin\"\n      );\n      throw Error(`sanity check has failed, \"${pluginId}\" is not a valid plugin`);\n    }\n\n    debug('Plugin successfully loaded: %o-%o', pluginId, prefix);\n    return plugin;\n  });\n}\n"],"mappings":";;;;;;;;AAAA;;AACA;;AACA;;AAEA;;;;AAGA,MAAMA,KAAK,GAAG,IAAAC,cAAA,EAAW,yBAAX,CAAd;AAEO,MAAMC,gBAAgB,GAAG,kBAAzB;AAEP;AACA;AACA;AACA;AACA;;;;AACA,SAASC,OAAT,CAAiBC,IAAjB,EAAoC;EAClC,IAAI;IACF,OAAOC,OAAO,CAACD,IAAD,CAAd;EACD,CAFD,CAEE,OAAOE,GAAP,EAAiB;IACjB,IAAIA,GAAG,CAACC,IAAJ,KAAaL,gBAAjB,EAAmC;MACjC,OAAO,IAAP;IACD;;IACD,MAAMI,GAAN;EACD;AACF;;AAED,SAASE,WAAT,CAAqBC,SAArB,EAAgCC,YAAhC,EAAsD;EACpD,OAAOC,eAAA,CAAEC,KAAF,CAAQH,SAAR,EAAmBC,YAAnB,CAAP;AACD;;AAED,SAASG,OAAT,CAAiBC,MAAjB,EAAkC;EAChC,OAAOH,eAAA,CAAEI,UAAF,CAAaD,MAAb,KAAwBH,eAAA,CAAEI,UAAF,CAAaD,MAAM,CAACE,OAApB,CAA/B;AACD;;AAED,SAASC,KAAT,CAAeH,MAAf,EAAgC;EAC9B,OAAOI,MAAM,CAACC,IAAP,CAAYL,MAAZ,EAAoBM,QAApB,CAA6B,SAA7B,CAAP;AACD,C,CAED;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASC,UAAT,CACLC,MADK,EAELC,aAAkB,GAAG,EAFhB,EAGLC,MAHK,EAILC,WAJK,EAKLC,MAAc,GAAG,WALZ,EAME;EACP,OAAOR,MAAM,CAACC,IAAP,CAAYI,aAAZ,EAA2BI,GAA3B,CAAgCC,QAAD,IAAkC;IACtE,IAAId,MAAJ;;IAEA,MAAMe,WAAW,GAAGC,aAAA,CAAKC,OAAL,CAAaC,SAAS,GAAG,aAAzB,EAAwCJ,QAAxC,CAApB,CAHsE,CAItE;;;IACAd,MAAM,GAAGX,OAAO,CAAC0B,WAAD,CAAhB,CALsE,CAOtE;;IACA,IAAIf,MAAM,KAAK,IAAX,IAAmBQ,MAAM,CAACW,OAA9B,EAAuC;MACrC,MAAMC,SAAS,GAAGZ,MAAM,CAACW,OAAzB;;MACA,MAAME,kBAAkB,GAAGL,aAAA,CAAKC,OAAL,CAAaG,SAAb,EAAwBN,QAAxB,CAA3B;;MACAd,MAAM,GAAGX,OAAO,CAACgC,kBAAD,CAAhB,CAHqC,CAKrC;;MACA,IAAIrB,MAAM,KAAK,IAAX,IAAmBc,QAAQ,CAACQ,KAAT,CAAe,UAAf,CAAvB,EAAmD;QACjDtB,MAAM,GAAGX,OAAO,CAAC2B,aAAA,CAAKC,OAAL,CAAaG,SAAb,EAAyB,GAAER,MAAO,IAAGE,QAAS,EAA9C,CAAD,CAAhB,CADiD,CAEjD;;QACA,IAAI,CAACd,MAAL,EAAa;UACXA,MAAM,GAAGX,OAAO,CAAC2B,aAAA,CAAKC,OAAL,CAAaG,SAAb,EAAyB,WAAUN,QAAS,EAA5C,CAAD,CAAhB;QACD;MACF;IACF,CArBqE,CAuBtE;;;IACA,IAAId,MAAM,KAAK,IAAX,IAAmBc,QAAQ,CAACQ,KAAT,CAAe,UAAf,CAAvB,EAAmD;MACjDtB,MAAM,GAAGX,OAAO,CAAE,GAAEuB,MAAO,IAAGE,QAAS,EAAvB,CAAhB,CADiD,CAEjD;;MACA,IAAI,CAACd,MAAL,EAAa;QACXA,MAAM,GAAGX,OAAO,CAAE,WAAUyB,QAAS,EAArB,CAAhB;MACD;IACF;;IAED,IAAId,MAAM,KAAK,IAAf,EAAqB;MACnBA,MAAM,GAAGX,OAAO,CAACyB,QAAD,CAAhB;IACD,CAlCqE,CAoCtE;;;IACA5B,KAAK,CAAC,iBAAD,EAAoBsB,MAAM,CAACe,UAA3B,CAAL;;IACA,IAAIvB,MAAM,KAAK,IAAX,IAAmBc,QAAQ,CAACQ,KAAT,CAAe,cAAf,CAAnB,IAAqDd,MAAM,CAACe,UAAhE,EAA4E;MAC1EvB,MAAM,GAAGX,OAAO,CAAC2B,aAAA,CAAKC,OAAL,CAAaD,aAAA,CAAKQ,OAAL,CAAahB,MAAM,CAACe,UAApB,CAAb,EAA8CT,QAA9C,CAAD,CAAhB;IACD;;IAED,IAAId,MAAM,KAAK,IAAf,EAAqB;MACnByB,cAAA,CAAOC,KAAP,CACE;QAAEC,OAAO,EAAEb,QAAX;QAAqBF;MAArB,CADF,EAEE,wDAFF;;MAIA,MAAMgB,KAAK,CAAE;AACnB,UAAUhB,MAAO,IAAGE,QAAS,uCAAsCF,MAAO,IAAGE,QAAS,GADrE,CAAX;IAED;;IAED,IAAI,CAACf,OAAO,CAACC,MAAD,CAAZ,EAAsB;MACpByB,cAAA,CAAOC,KAAP,CACE;QAAEC,OAAO,EAAEb;MAAX,CADF,EAEE,oEAFF;;MAIA,MAAMc,KAAK,CAAE,IAAGd,QAAS,iDAAd,CAAX;IACD;IAED;;;IACA,IAAI;MACFd,MAAM,GAAGG,KAAK,CAACH,MAAD,CAAL,GACL,IAAIA,MAAM,CAACE,OAAX,CAAmBR,WAAW,CAACc,MAAD,EAASC,aAAa,CAACK,QAAD,CAAtB,CAA9B,EAAiEJ,MAAjE,CADK,GAEL,IAAIV,MAAJ,CAAWS,aAAa,CAACK,QAAD,CAAxB,EAAoCJ,MAApC,CAFJ;IAGD,CAJD,CAIE,OAAOgB,KAAP,EAAmB;MACnB1B,MAAM,GAAG,IAAT;;MACAyB,cAAA,CAAOC,KAAP,CAAa;QAAEA,KAAF;QAASZ;MAAT,CAAb,EAAkC,8CAAlC;IACD;IACD;;;IAEA,IAAId,MAAM,KAAK,IAAX,IAAmB,CAACW,WAAW,CAACX,MAAD,CAAnC,EAA6C;MAC3CyB,cAAA,CAAOC,KAAP,CACE;QAAEC,OAAO,EAAEb,QAAX;QAAqBF;MAArB,CADF,EAEE,uDAFF;;MAIA,MAAMgB,KAAK,CAAE,6BAA4Bd,QAAS,yBAAvC,CAAX;IACD;;IAED5B,KAAK,CAAC,mCAAD,EAAsC4B,QAAtC,EAAgDF,MAAhD,CAAL;IACA,OAAOZ,MAAP;EACD,CAhFM,CAAP;AAiFD"}

package/src/plugin-loader.ts

@@ -1,143 +0,0 @@
-import buildDebug from 'debug';
-import _ from 'lodash';
-import Path from 'path';
-
-import { logger } from '@verdaccio/logger';
-import { Config, IPlugin } from '@verdaccio/types';
-
-const debug = buildDebug('verdaccio:plugin:loader');
-
-export const MODULE_NOT_FOUND = 'MODULE_NOT_FOUND';
-
-/**
- * Requires a module.
- * @param {*} path the module's path
- * @return {Object}
- */
-function tryLoad(path: string): any {
-  try {
-    return require(path);
-  } catch (err: any) {
-    if (err.code === MODULE_NOT_FOUND) {
-      return null;
-    }
-    throw err;
-  }
-}
-
-function mergeConfig(appConfig, pluginConfig): Config {
-  return _.merge(appConfig, pluginConfig);
-}
-
-function isValid(plugin): boolean {
-  return _.isFunction(plugin) || _.isFunction(plugin.default);
-}
-
-function isES6(plugin): boolean {
-  return Object.keys(plugin).includes('default');
-}
-
-// export type PluginGeneric<R, T extends IPlugin<R> = ;
-
-/**
- * Load a plugin following the rules
- * - First try to load from the internal directory plugins (which will disappear soon or later).
- * - A second attempt from the external plugin directory
- * - A third attempt from node_modules, in case to have multiple match as for instance
- * verdaccio-ldap
- * and sinopia-ldap. All verdaccio prefix will have preferences.
- * @param {*} config a reference of the configuration settings
- * @param {*} pluginConfigs
- * @param {*} params a set of params to initialize the plugin
- * @param {*} sanityCheck callback that check the shape that should fulfill the plugin
- * @return {Array} list of plugins
- */
-export function loadPlugin<T extends IPlugin<T>>(
-  config: Config,
-  pluginConfigs: any = {},
-  params: any,
-  sanityCheck: any,
-  prefix: string = 'verdaccio'
-): any[] {
-  return Object.keys(pluginConfigs).map((pluginId: string): IPlugin<T> => {
-    let plugin;
-
-    const localPlugin = Path.resolve(__dirname + '/../plugins', pluginId);
-    // try local plugins first
-    plugin = tryLoad(localPlugin);
-
-    // try the external plugin directory
-    if (plugin === null && config.plugins) {
-      const pluginDir = config.plugins;
-      const externalFilePlugin = Path.resolve(pluginDir, pluginId);
-      plugin = tryLoad(externalFilePlugin);
-
-      // npm package
-      if (plugin === null && pluginId.match(/^[^\.\/]/)) {
-        plugin = tryLoad(Path.resolve(pluginDir, `${prefix}-${pluginId}`));
-        // compatibility for old sinopia plugins
-        if (!plugin) {
-          plugin = tryLoad(Path.resolve(pluginDir, `sinopia-${pluginId}`));
-        }
-      }
-    }
-
-    // npm package
-    if (plugin === null && pluginId.match(/^[^\.\/]/)) {
-      plugin = tryLoad(`${prefix}-${pluginId}`);
-      // compatibility for old sinopia plugins
-      if (!plugin) {
-        plugin = tryLoad(`sinopia-${pluginId}`);
-      }
-    }
-
-    if (plugin === null) {
-      plugin = tryLoad(pluginId);
-    }
-
-    // relative to config path
-    debug('config path: %s', config.configPath);
-    if (plugin === null && pluginId.match(/^\.\.?($|\/)/) && config.configPath) {
-      plugin = tryLoad(Path.resolve(Path.dirname(config.configPath), pluginId));
-    }
-
-    if (plugin === null) {
-      logger.error(
-        { content: pluginId, prefix },
-        'plugin not found. try npm install @{prefix}-@{content}'
-      );
-      throw Error(`
-        ${prefix}-${pluginId} plugin not found. try "npm install ${prefix}-${pluginId}"`);
-    }
-
-    if (!isValid(plugin)) {
-      logger.error(
-        { content: pluginId },
-        '@{prefix}-@{content} plugin does not have the right code structure'
-      );
-      throw Error(`"${pluginId}" plugin does not have the right code structure`);
-    }
-
-    /* eslint new-cap:off */
-    try {
-      plugin = isES6(plugin)
-        ? new plugin.default(mergeConfig(config, pluginConfigs[pluginId]), params)
-        : new plugin(pluginConfigs[pluginId], params);
-    } catch (error: any) {
-      plugin = null;
-      logger.error({ error, pluginId }, 'error loading a plugin @{pluginId}: @{error}');
-    }
-    /* eslint new-cap:off */
-
-    if (plugin === null || !sanityCheck(plugin)) {
-      logger.error(
-        { content: pluginId, prefix },
-        "@{prefix}-@{content} doesn't look like a valid plugin"
-      );
-      throw Error(`sanity check has failed, "${pluginId}" is not a valid plugin`);
-    }
-
-    debug('Plugin successfully loaded: %o-%o', pluginId, prefix);
-    return plugin;
-  });
-}

package/test/plugin_loader.spec.ts

@@ -1,88 +0,0 @@
-import path from 'path';
-
-import { setup } from '@verdaccio/logger';
-
-import { loadPlugin } from '../src/plugin-loader';
-
-setup([]);
-
-describe('plugin loader', () => {
-  const relativePath = path.join(__dirname, './partials/test-plugin-storage');
-  const buildConf = (name) => {
-    return {
-      config_path: path.join(__dirname, './'),
-      max_users: 0,
-      auth: {
-        [`${relativePath}/${name}`]: {},
-      },
-    };
-  };
-
-  describe('auth plugins', () => {
-    test('testing auth valid plugin loader', () => {
-      const _config = buildConf('verdaccio-plugin');
-      // @ts-ignore
-      const plugins = loadPlugin(_config, _config.auth, {}, function (plugin) {
-        return plugin.authenticate || plugin.allow_access || plugin.allow_publish;
-      });
-
-      expect(plugins).toHaveLength(1);
-    });
-
-    test('testing storage valid plugin loader', () => {
-      const _config = buildConf('verdaccio-es6-plugin');
-      // @ts-ignore
-      const plugins = loadPlugin(_config, _config.auth, {}, function (p) {
-        return p.getPackageStorage;
-      });
-
-      expect(plugins).toHaveLength(1);
-    });
-
-    test('testing auth plugin invalid plugin', () => {
-      const _config = buildConf('invalid-plugin');
-      try {
-        // @ts-ignore
-        loadPlugin(_config, _config.auth, {}, function (p) {
-          return p.authenticate || p.allow_access || p.allow_publish;
-        });
-      } catch (e: any) {
-        expect(e.message).toEqual(
-          `"${relativePath}/invalid-plugin" plugin does not have the right code structure`
-        );
-      }
-    });
-
-    test('testing auth plugin invalid plugin sanityCheck', () => {
-      const _config = buildConf('invalid-plugin-sanity');
-      try {
-        // @ts-ignore
-        loadPlugin(_config, _config.auth, {}, function (plugin) {
-          return plugin.authenticate || plugin.allow_access || plugin.allow_publish;
-        });
-      } catch (err: any) {
-        expect(err.message).toEqual(
-          `sanity check has failed, "${relativePath}/invalid-plugin-sanity" is not a valid plugin`
-        );
-      }
-    });
-
-    test('testing auth plugin no plugins', () => {
-      const _config = buildConf('invalid-package');
-      try {
-        // @ts-ignore
-        loadPlugin(_config, _config.auth, {}, function (plugin) {
-          return plugin.authenticate || plugin.allow_access || plugin.allow_publish;
-        });
-      } catch (e: any) {
-        expect(e.message).toMatch('plugin not found');
-        expect(e.message.replace(/\\/g, '/')).toMatch(
-          '/partials/test-plugin-storage/invalid-package'
-        );
-      }
-    });
-
-    test.todo('test middleware plugins');
-    test.todo('test storage plugins');
-  });
-});