@verdaccio/loaders 6.0.0-6-next.16 → 6.0.0-6-next.18

package/CHANGELOG.md

@@ -1,5 +1,75 @@
 # @verdaccio/loaders
 
+## 6.0.0-6-next.18
+
+### Patch Changes
+
+- @verdaccio/logger@6.0.0-6-next.17
+
+## 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

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,31 @@
+import { pluginUtils } from '@verdaccio/core';
+import { Config, Logger } from '@verdaccio/types';
+import { PluginType } from './utils';
+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 pluginUtils.Plugin<T>>(pluginConfigs: any, params: Params, sanityCheck: (plugin: PluginType<T>) => boolean, prefix?: string): Promise<PluginType<T>[]>;
+export declare function executePlugin<T>(plugin: PluginType<T>, pluginConfig: unknown, params: Params): PluginType<T>;

package/build/plugin-async-loader.js

@@ -0,0 +1,163 @@
+"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();
+}
+
+// type Plugins<T> =
+//   | pluginUtils.Auth<T>
+//   | pluginUtils.Storage<T>
+//   | pluginUtils.ExpressMiddleware<T, unknown, unknown>;
+
+/**
+ * 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'); // @ts-expect-error no relevant for the code
+    // eslint-disable-next-line new-cap
+
+    return new plugin.default(pluginConfig, params);
+  } else {
+    debug('plugin is commonJS'); // @ts-expect-error improve this type
+
+    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 { pluginUtils } from '@verdaccio/core';\nimport { logger } from '@verdaccio/logger';\nimport { Config, Logger } from '@verdaccio/types';\n\nimport { PluginType, isES6, isValid, tryLoad } from './utils';\n\nconst debug = buildDebug('verdaccio:plugin:loader:async');\n\nasync function isDirectory(pathFolder: string) {\n  const stat = await lstat(pathFolder);\n  return stat.isDirectory();\n}\n\nexport type Params = { config: Config; logger: Logger };\n\n// type Plugins<T> =\n//   | pluginUtils.Auth<T>\n//   | pluginUtils.Storage<T>\n//   | pluginUtils.ExpressMiddleware<T, unknown, unknown>;\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 pluginUtils.Plugin<T>>(\n  pluginConfigs: any = {},\n  params: Params,\n  sanityCheck: (plugin: PluginType<T>) => boolean,\n  prefix: string = 'verdaccio'\n): Promise<PluginType<T>[]> {\n  const pluginsIds = Object.keys(pluginConfigs);\n  const { config } = params;\n  let plugins: PluginType<T>[] = [];\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<T>(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<T>(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<T>(\n  plugin: PluginType<T>,\n  pluginConfig: unknown,\n  params: Params\n): PluginType<T> {\n  if (isES6(plugin)) {\n    debug('plugin is ES6');\n    // @ts-expect-error no relevant for the code\n    // eslint-disable-next-line new-cap\n    return new plugin.default(pluginConfig, params) as Plugin;\n  } else {\n    debug('plugin is commonJS');\n    // @ts-expect-error improve this type\n    return plugin(pluginConfig, params) as PluginType<T>;\n  }\n}\n"],"mappings":";;;;;;;;AAAA;;AACA;;AACA;;AAGA;;AAGA;;;;AAEA,MAAMA,KAAK,GAAG,IAAAC,cAAA,EAAW,+BAAX,CAAd;;AAEA,eAAeC,WAAf,CAA2BC,UAA3B,EAA+C;EAC7C,MAAMC,IAAI,GAAG,MAAM,IAAAC,eAAA,EAAMF,UAAN,CAAnB;EACA,OAAOC,IAAI,CAACF,WAAL,EAAP;AACD;;AAID;AACA;AACA;AACA;;AAEA;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,EAKqB;EAC1B,MAAMC,UAAU,GAAGC,MAAM,CAACC,IAAP,CAAYN,aAAZ,CAAnB;EACA,MAAM;IAAEO;EAAF,IAAaN,MAAnB;EACA,IAAIO,OAAwB,GAAG,EAA/B;;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,EAAWF,kBAAX,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,EAAWW,UAAX,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,CACLH,MADK,EAELc,YAFK,EAGLnC,MAHK,EAIU;EACf,IAAI,IAAAoC,YAAA,EAAMf,MAAN,CAAJ,EAAmB;IACjB7B,KAAK,CAAC,eAAD,CAAL,CADiB,CAEjB;IACA;;IACA,OAAO,IAAI6B,MAAM,CAACgB,OAAX,CAAmBF,YAAnB,EAAiCnC,MAAjC,CAAP;EACD,CALD,MAKO;IACLR,KAAK,CAAC,oBAAD,CAAL,CADK,CAEL;;IACA,OAAO6B,MAAM,CAACc,YAAD,EAAenC,MAAf,CAAb;EACD;AACF"}

package/build/utils.d.ts

@@ -0,0 +1,10 @@
+import { pluginUtils } from '@verdaccio/core';
+export declare type PluginType<T> = T extends pluginUtils.Plugin<T> ? T : never;
+export declare function isValid<T>(plugin: PluginType<T>): boolean;
+export declare function isES6<T>(plugin: PluginType<T>): boolean;
+/**
+ * Requires a module.
+ * @param {*} path the module's path
+ * @return {Object}
+ */
+export declare function tryLoad<T>(path: string): PluginType<T> | null;

package/build/utils.js

@@ -0,0 +1,53 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isES6 = isES6;
+exports.isValid = isValid;
+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 isValid(plugin) {
+  // @ts-expect-error default not relevant
+  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","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 { pluginUtils } from '@verdaccio/core';\nimport { logger } from '@verdaccio/logger';\n\nconst debug = buildDebug('verdaccio:plugin:loader:utils');\nconst MODULE_NOT_FOUND = 'MODULE_NOT_FOUND';\n\nexport type PluginType<T> = T extends pluginUtils.Plugin<T> ? T : never;\n\nexport function isValid<T>(plugin: PluginType<T>): boolean {\n  // @ts-expect-error default not relevant\n  return _.isFunction(plugin) || _.isFunction(plugin.default);\n}\n\nexport function isES6<T>(plugin: PluginType<T>): 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<T>(path: string): PluginType<T> | null {\n  try {\n    debug('loading plugin %s', path);\n    return require(path) as PluginType<T>;\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;;AAGA;;;;AAEA,MAAMA,KAAK,GAAG,IAAAC,cAAA,EAAW,+BAAX,CAAd;AACA,MAAMC,gBAAgB,GAAG,kBAAzB;;AAIO,SAASC,OAAT,CAAoBC,MAApB,EAAoD;EACzD;EACA,OAAOC,eAAA,CAAEC,UAAF,CAAaF,MAAb,KAAwBC,eAAA,CAAEC,UAAF,CAAaF,MAAM,CAACG,OAApB,CAA/B;AACD;;AAEM,SAASC,KAAT,CAAkBJ,MAAlB,EAAkD;EACvD,OAAOK,MAAM,CAACC,IAAP,CAAYN,MAAZ,EAAoBO,QAApB,CAA6B,SAA7B,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;;;AACO,SAASC,OAAT,CAAoBC,IAApB,EAAwD;EAC7D,IAAI;IACFb,KAAK,CAAC,mBAAD,EAAsBa,IAAtB,CAAL;IACA,OAAOC,OAAO,CAACD,IAAD,CAAd;EACD,CAHD,CAGE,OAAOE,GAAP,EAAiB;IACjB,IAAIA,GAAG,CAACC,IAAJ,KAAad,gBAAjB,EAAmC;MACjCF,KAAK,CAAC,qBAAD,EAAwBa,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.16",
+  "version": "6.0.0-6-next.18",
   "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.15",
+    "@verdaccio/logger": "6.0.0-6-next.17",
     "debug": "4.3.4",
     "lodash": "4.17.21"
   },
   "devDependencies": {
-    "@verdaccio/core": "6.0.0-6-next.47",
-    "@verdaccio/config": "6.0.0-6-next.47",
-    "@verdaccio/types": "11.0.0-6-next.16"
+    "@verdaccio/core": "6.0.0-6-next.49",
+    "@verdaccio/config": "6.0.0-6-next.49",
+    "@verdaccio/types": "11.0.0-6-next.17",
+    "@verdaccio-scope/verdaccio-auth-foo": "0.0.2",
+    "verdaccio-auth-memory": "11.0.0-6-next.14",
+    "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,144 @@
+import buildDebug from 'debug';
+import { lstat } from 'fs/promises';
+import { dirname, isAbsolute, join, resolve } from 'path';
+
+import { pluginUtils } from '@verdaccio/core';
+import { logger } from '@verdaccio/logger';
+import { Config, Logger } from '@verdaccio/types';
+
+import { PluginType, isES6, isValid, tryLoad } from './utils';
+
+const debug = buildDebug('verdaccio:plugin:loader:async');
+
+async function isDirectory(pathFolder: string) {
+  const stat = await lstat(pathFolder);
+  return stat.isDirectory();
+}
+
+export type Params = { config: Config; logger: Logger };
+
+// type Plugins<T> =
+//   | pluginUtils.Auth<T>
+//   | pluginUtils.Storage<T>
+//   | pluginUtils.ExpressMiddleware<T, unknown, unknown>;
+
+/**
+ * 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 pluginUtils.Plugin<T>>(
+  pluginConfigs: any = {},
+  params: Params,
+  sanityCheck: (plugin: PluginType<T>) => boolean,
+  prefix: string = 'verdaccio'
+): Promise<PluginType<T>[]> {
+  const pluginsIds = Object.keys(pluginConfigs);
+  const { config } = params;
+  let plugins: PluginType<T>[] = [];
+  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<T>(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<T>(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<T>(
+  plugin: PluginType<T>,
+  pluginConfig: unknown,
+  params: Params
+): PluginType<T> {
+  if (isES6(plugin)) {
+    debug('plugin is ES6');
+    // @ts-expect-error no relevant for the code
+    // eslint-disable-next-line new-cap
+    return new plugin.default(pluginConfig, params) as Plugin;
+  } else {
+    debug('plugin is commonJS');
+    // @ts-expect-error improve this type
+    return plugin(pluginConfig, params) as PluginType<T>;
+  }
+}

package/src/utils.ts

@@ -0,0 +1,38 @@
+import buildDebug from 'debug';
+import _ from 'lodash';
+
+import { pluginUtils } from '@verdaccio/core';
+import { logger } from '@verdaccio/logger';
+
+const debug = buildDebug('verdaccio:plugin:loader:utils');
+const MODULE_NOT_FOUND = 'MODULE_NOT_FOUND';
+
+export type PluginType<T> = T extends pluginUtils.Plugin<T> ? T : never;
+
+export function isValid<T>(plugin: PluginType<T>): boolean {
+  // @ts-expect-error default not relevant
+  return _.isFunction(plugin) || _.isFunction(plugin.default);
+}
+
+export function isES6<T>(plugin: PluginType<T>): boolean {
+  return Object.keys(plugin).includes('default');
+}
+
+/**
+ * Requires a module.
+ * @param {*} path the module's path
+ * @return {Object}
+ */
+export function tryLoad<T>(path: string): PluginType<T> | null {
+  try {
+    debug('loading plugin %s', path);
+    return require(path) as PluginType<T>;
+  } 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;