@plone/volto 18.0.0-alpha.3 → 18.0.0-alpha.5

package/packages/registry/addon-registry.js

@@ -1,603 +0,0 @@
-/* eslint no-console: 0 */
-const glob = require('glob').sync;
-const path = require('path');
-const fs = require('fs');
-const debug = require('debug')('shadowing');
-const { map } = require('lodash');
-const { DepGraph } = require('dependency-graph');
-
-const excludedCompilerOptionsPaths = [
-  '@plone/volto/*',
-  '@plone/volto-slate/*',
-  '@plone/registry/*',
-  '@plone/registry',
-  '@plone/types/*',
-  '@root/*',
-];
-
-function getPackageBasePath(base) {
-  while (!fs.existsSync(`${base}/package.json`)) {
-    base = path.join(base, '../');
-  }
-  return path.resolve(base);
-}
-
-function fromEntries(pairs) {
-  const res = {};
-  pairs.forEach((p) => {
-    res[p[0]] = p[1];
-  });
-  return res;
-}
-
-function buildDependencyGraph(addons, extractDependency) {
-  // getAddonsLoaderChain
-  const graph = new DepGraph({ circular: true });
-  graph.addNode('@root');
-
-  const seen = ['@root'];
-  const stack = [['@root', addons]];
-
-  while (stack.length > 0) {
-    const [pkgName, addons] = stack.shift();
-    if (!graph.hasNode(pkgName)) {
-      graph.addNode(pkgName, []);
-    }
-
-    if (!seen.includes(pkgName)) {
-      stack.push([pkgName, extractDependency(pkgName)]);
-      seen.push(pkgName);
-    }
-
-    addons.forEach((loaderString) => {
-      const [name, extra] = loaderString.split(':');
-      if (!graph.hasNode(name)) {
-        graph.addNode(name, []);
-      }
-
-      const data = graph.getNodeData(name) || [];
-      if (extra) {
-        extra.split(',').forEach((funcName) => {
-          if (!data.includes(funcName)) data.push(funcName);
-        });
-      }
-      graph.setNodeData(name, data);
-
-      graph.addDependency(pkgName, name);
-
-      if (!seen.includes(name)) {
-        stack.push([name, extractDependency(name)]);
-      }
-    });
-  }
-
-  return graph;
-}
-
-/**
- * Given an addons loader string, it generates an addons loader string with
- * a resolved chain of dependencies
- */
-function getAddonsLoaderChain(graph) {
-  return graph.dependenciesOf('@root').map((name) => {
-    const extras = graph.getNodeData(name) || [].join(',');
-    return extras.length ? `${name}:${extras}` : name;
-  });
-}
-
-/**
- * A registry to discover and publish information about the structure of Volto
- * projects and their addons.
- *
- * The registry builds information about both addons and other development
- * packages, structured as an object with the following information:
- *
- * - name
- * - isPublishedPackage (just for info, to distinguish addons from other Javascript development packages)
- * - modulePath (the path that would be resolved from Javascript package name)
- * - packageJson (the path to the addon's package.json file)
- * - extraConfigLoaders (names for extra functions to be loaded from the addon
- *   for configuration purposes)
- * - razzleExtender (the path to the addon's razzle.extend.js path, to allow
- *   addons to customize the webpack configuration)
- *
- */
-class AddonConfigurationRegistry {
-  constructor(projectRootPath) {
-    const packageJson = (this.packageJson = require(
-      path.join(projectRootPath, 'package.json'),
-    ));
-    // Loads the dynamic config, if any
-    if (fs.existsSync(path.join(projectRootPath, 'volto.config.js'))) {
-      this.voltoConfigJS = require(
-        path.join(projectRootPath, 'volto.config.js'),
-      );
-    } else {
-      this.voltoConfigJS = [];
-    }
-
-    this.projectRootPath = projectRootPath;
-    this.voltoPath =
-      packageJson.name === '@plone/volto'
-        ? `${projectRootPath}`
-        : `${projectRootPath}/node_modules/@plone/volto`;
-
-    this.packagesFolderAddons =
-      packageJson.name === '@plone/volto'
-        ? packageJson.packagesFolderAddons || {}
-        : require(`${getPackageBasePath(this.voltoPath)}/package.json`)
-            .packagesFolderAddons || {};
-
-    this.resultantMergedAddons = [
-      ...(packageJson.addons || []),
-      ...(this.voltoConfigJS.addons || []),
-    ];
-
-    this.addonNames = this.resultantMergedAddons.map((s) => s.split(':')[0]);
-    this.packages = {};
-    this.customizations = new Map();
-
-    // Theme from a package.json key, from volto.config.js or from an ENV VAR
-    // Programatically via volto.config.js wins or the ENV VAR if present
-    this.theme =
-      packageJson.theme || this.voltoConfigJS.theme || process.env.THEME;
-
-    this.initDevelopmentPackages();
-    this.initPublishedPackages();
-    this.initAddonsFromEnvVar();
-
-    this.dependencyGraph = buildDependencyGraph(
-      [
-        ...(Object.keys(this.packagesFolderAddons).map(
-          (key) => this.packagesFolderAddons[key].package,
-        ) || []),
-        ...this.resultantMergedAddons,
-        ...(process.env.ADDONS ? process.env.ADDONS.split(';') : []),
-      ],
-      (name) => {
-        this.initPublishedPackage(name);
-        return this.packages[name].addons || [];
-      },
-    );
-
-    this.initAddonExtenders();
-  }
-
-  /**
-   * Use tsconfig.json or jsconfig.json to get paths for "development" packages/addons
-   * (coming from mrs.developer.json)
-   * Not all of these packages have to be Volto addons.
-   */
-  initDevelopmentPackages() {
-    let configFile;
-    if (fs.existsSync(`${this.projectRootPath}/tsconfig.json`))
-      configFile = `${this.projectRootPath}/tsconfig.json`;
-    else if (fs.existsSync(`${this.projectRootPath}/jsconfig.json`))
-      configFile = `${this.projectRootPath}/jsconfig.json`;
-
-    if (configFile) {
-      const jsConfig = require(configFile).compilerOptions;
-      const pathsConfig = jsConfig.paths;
-
-      Object.keys(pathsConfig).forEach((name) => {
-        const packagePath = `${this.projectRootPath}/${jsConfig.baseUrl}/${pathsConfig[name][0]}`;
-        const packageJsonPath = `${getPackageBasePath(
-          packagePath,
-        )}/package.json`;
-        const innerAddons = require(packageJsonPath).addons || [];
-        const innerAddonsNormalized = innerAddons.map((s) => s.split(':')[0]);
-        if (
-          this.addonNames.includes(name) &&
-          innerAddonsNormalized.length > 0
-        ) {
-          innerAddonsNormalized.forEach((name) => {
-            if (!this.addonNames.includes(name)) this.addonNames.push(name);
-          });
-        }
-        const pkg = {
-          modulePath: packagePath,
-          packageJson: packageJsonPath,
-          version: require(packageJsonPath).version,
-          isPublishedPackage: false,
-          isRegisteredAddon: this.addonNames.includes(name),
-          name,
-          addons: require(packageJsonPath).addons || [],
-        };
-
-        // Removed excluded paths from CompilerOptions
-        if (!excludedCompilerOptionsPaths.includes(name)) {
-          this.packages[name] = Object.assign(this.packages[name] || {}, pkg);
-        }
-      });
-    }
-    this.initPackagesFolder();
-  }
-
-  initPackagesFolder() {
-    const registerPackageFolder = (packageFolderName, packageInfo) => {
-      const packageName = packageInfo.package;
-      if (this.packages[packageName]) return;
-
-      const packagePath = path.normalize(
-        `${this.voltoPath}/packages/${packageFolderName}/src`,
-      );
-      const packageJsonPath = path.normalize(
-        `${this.voltoPath}/packages/${packageFolderName}/package.json`,
-      );
-
-      // some tests set the root in a location that doesn't have the packages
-      if (!fs.existsSync(packagePath)) return;
-
-      this.packages[packageName] = {
-        modulePath: packagePath,
-        packageJson: packageJsonPath,
-        version: require(packageJsonPath).version,
-        isPublishedPackage: false,
-        isRegisteredAddon: false,
-        name: packageName,
-        addons: [],
-      };
-      this.addonNames.push(packageName);
-    };
-
-    Object.keys(this.packagesFolderAddons).forEach((packageFolderName) => {
-      registerPackageFolder(
-        packageFolderName,
-        this.packagesFolderAddons[packageFolderName],
-      );
-    });
-  }
-
-  /**
-   * Add path to the "src" of npm-released packages. These packages can
-   * release their source code in src, or transpile. The "main" of their
-   * package.json needs to point to the module that exports `applyConfig` as
-   * default.
-   */
-  initPublishedPackages() {
-    this.addonNames.forEach(this.initPublishedPackage.bind(this));
-  }
-
-  initPublishedPackage(name) {
-    if (!Object.keys(this.packages).includes(name)) {
-      const resolved = require.resolve(name, { paths: [this.projectRootPath] });
-      const basePath = getPackageBasePath(resolved);
-      const packageJson = path.join(basePath, 'package.json');
-      const pkg = require(packageJson);
-      const main = pkg.main || 'src/index.js';
-      const modulePath = path.dirname(require.resolve(`${basePath}/${main}`));
-      const innerAddons = pkg.addons || [];
-      const innerAddonsNormalized = innerAddons.map((s) => s.split(':')[0]);
-      if (this.addonNames.includes(name) && innerAddonsNormalized.length > 0) {
-        innerAddonsNormalized.forEach((name) => {
-          if (!this.addonNames.includes(name)) this.addonNames.push(name);
-        });
-      }
-      this.packages[name] = {
-        name,
-        version: pkg.version,
-        isPublishedPackage: true,
-        isRegisteredAddon: this.addonNames.includes(name),
-        modulePath,
-        packageJson,
-        addons: pkg.addons || [],
-      };
-    }
-  }
-
-  initAddonsFromEnvVar() {
-    if (process.env.ADDONS) {
-      process.env.ADDONS.split(';').forEach(
-        this.initAddonFromEnvVar.bind(this),
-      );
-    }
-  }
-
-  initAddonFromEnvVar(name) {
-    // First lookup in the packages folder, local to the root (either vanilla Volto or project)
-    const normalizedAddonName = name.split(':')[0];
-    const testingPackagePath = `${this.projectRootPath}/packages/${normalizedAddonName}/src`;
-    if (fs.existsSync(testingPackagePath)) {
-      const basePath = getPackageBasePath(testingPackagePath);
-      const packageJson = path.join(basePath, 'package.json');
-
-      if (!this.addonNames.includes(normalizedAddonName))
-        this.addonNames.push(normalizedAddonName);
-      const pkg = {
-        modulePath: testingPackagePath,
-        version: require(packageJson).version,
-        packageJson: packageJson,
-        isPublishedPackage: false,
-        isRegisteredAddon: this.addonNames.includes(name),
-        name: normalizedAddonName,
-        addons: require(packageJson).addons || [],
-      };
-
-      this.packages[normalizedAddonName] = Object.assign(
-        this.packages[normalizedAddonName] || {},
-        pkg,
-      );
-    } else {
-      // Fallback in case the addon is released (not in packages folder nor in development, but in node_modules)
-      const normalizedAddonName = name.split(':')[0];
-      this.initPublishedPackage(normalizedAddonName);
-    }
-  }
-
-  /**
-   * Allow addons to provide various extenders.
-   *
-   * The razzle.extend.js modules (named razzle.extend.js) needs to provide
-   * two functions:
-   * `plugins(defaultPlugins) => plugins` and
-   * `modify(...) => config`
-   *
-   * The eslint.extend.js
-   */
-  initAddonExtenders() {
-    this.getAddons().forEach((addon) => {
-      const base = path.dirname(addon.packageJson);
-      const razzlePath = path.resolve(`${base}/razzle.extend.js`);
-      if (fs.existsSync(razzlePath)) {
-        addon.razzleExtender = razzlePath;
-      }
-      const eslintPath = path.resolve(`${base}/eslint.extend.js`);
-      if (fs.existsSync(eslintPath)) {
-        addon.eslintExtender = eslintPath;
-      }
-    });
-  }
-
-  /**
-   * Returns the addon records, respects order from package.json:addons
-   */
-  getAddons() {
-    return this.dependencyGraph
-      .dependenciesOf('@root')
-      .map((name) => this.packages[name]);
-  }
-
-  getAddonExtenders() {
-    return this.getAddons()
-      .map((o) => o.razzleExtender)
-      .filter((e) => e);
-  }
-
-  getEslintExtenders() {
-    return this.getAddons()
-      .map((o) => o.eslintExtender)
-      .filter((e) => e);
-  }
-
-  getCustomThemeAddons() {
-    const customThemeAddonsInfo = {
-      variables: [],
-      main: [],
-    };
-
-    this.getAddonDependencies().forEach((addon) => {
-      const normalizedAddonName = addon.split(':')[0];
-      // We have two possible insertion points, variables and main
-
-      const customThemeVariables = `${this.packages[normalizedAddonName].modulePath}/theme/_variables.scss`;
-      const customThemeMain = `${this.packages[normalizedAddonName].modulePath}/theme/_main.scss`;
-      if (
-        fs.existsSync(customThemeVariables) &&
-        normalizedAddonName !== this.theme
-      ) {
-        customThemeAddonsInfo.variables.push(normalizedAddonName);
-      }
-      if (
-        fs.existsSync(customThemeMain) &&
-        normalizedAddonName !== this.theme
-      ) {
-        customThemeAddonsInfo.main.push(normalizedAddonName);
-      }
-    });
-
-    return customThemeAddonsInfo;
-  }
-
-  /**
-   * Returns a mapping name:diskpath to be uses in webpack's resolve aliases
-   */
-  getResolveAliases() {
-    const pairs = [
-      ...Object.keys(this.packages).map((o) => [
-        o,
-        this.packages[o].modulePath,
-      ]),
-    ];
-
-    return fromEntries(pairs);
-  }
-
-  /**
-   * Retrieves a mapping (to be used in resolve aliases) of module name to
-   * filestype paths, to be used as customization paths.
-   *
-   * There are two styles of customizations: "classic style" and "addons style"
-   *
-   * In the classic style, the customization folders are only used to customize
-   * Volto itself, so inside it we'll find a mirror of the Volto project
-   * structure.
-   *
-   * In the "addons style" customization folder, we allow customization of
-   * addons along with Volto customization, so we need separate folders. By
-   * convention, we use a folder called "volto" inside customizations folder
-   * and separate folder for each addon, identified by its addon (package) name.
-   */
-  getCustomizationPaths(packageJson, rootPath) {
-    const aliases = {};
-    let { customizationPaths } = packageJson;
-    if (!customizationPaths) {
-      customizationPaths = ['src/customizations'];
-    }
-    customizationPaths.forEach((customizationPath) => {
-      customizationPath = customizationPath.endsWith('/')
-        ? customizationPath.slice(0, customizationPath.length - 1)
-        : customizationPath;
-      const base = path.join(rootPath, customizationPath);
-      const reg = [];
-
-      // All registered addon packages (in tsconfig.json/jsconfig.json and package.json:addons)
-      // can be customized
-      Object.values(this.packages).forEach((addon) => {
-        const { name, modulePath } = addon;
-        if (fs.existsSync(path.join(base, name))) {
-          reg.push({
-            customPath: path.join(base, name),
-            sourcePath: modulePath,
-            name,
-          });
-        }
-      });
-
-      // allow customization of modules in the `@root` namespace from addons,
-      // by creating a folder called `@root`.
-      const rootBase = path.join(base, '@root');
-      if (fs.existsSync(rootBase))
-        reg.push({
-          customPath: rootBase,
-          sourcePath: `${this.projectRootPath}/src`,
-          name: '@root',
-        });
-
-      reg.push(
-        fs.existsSync(path.join(base, 'volto'))
-          ? {
-              // new style (addons) customizations
-              customPath: path.join(base, 'volto'),
-              sourcePath: `${this.voltoPath}/src/`,
-              name: '@plone/volto',
-            }
-          : {
-              // old style, customizations directly in folder
-              customPath: base,
-              sourcePath: `${this.voltoPath}/src/`,
-              name: '@plone/volto',
-            },
-      );
-
-      reg.forEach(({ customPath, name, sourcePath }) => {
-        map(
-          glob(
-            `${customPath}/**/*.*(svg|png|jpg|jpeg|gif|ico|less|js|jsx|ts|tsx)`,
-          ),
-          (filename) => {
-            const targetPath = filename.replace(customPath, sourcePath);
-            if (fs.existsSync(targetPath)) {
-              aliases[
-                filename
-                  .replace(customPath, name)
-                  .replace(/\.(js|jsx|ts|tsx)$/, '')
-              ] = path.resolve(filename);
-            } else {
-              debug(
-                `The file ${filename} doesn't exist in the ${name} (${targetPath}), unable to customize.`,
-              );
-            }
-          },
-        );
-      });
-    });
-
-    return aliases;
-  }
-
-  getProjectCustomizationPaths() {
-    return this.getCustomizationPaths(this.packageJson, this.projectRootPath);
-  }
-
-  /**
-   * Allow addons to customize Volto and other addons.
-   *
-   * We follow the same logic for overriding as the main `package.json:addons`.
-   * First declared addon gets overridden by subsequent declared addons. That
-   * means: customization in volto-addonA will potentially be rewritten by
-   * customizations in volto-addonB if the declaration in package.json is like:
-   * `addons:volto-addonA,volto-addonB`
-   */
-  getAddonCustomizationPaths() {
-    let aliases = {};
-    this.getAddons().forEach((addon) => {
-      aliases = {
-        ...aliases,
-        ...this.getCustomizationPaths(
-          require(addon.packageJson),
-          getPackageBasePath(addon.modulePath),
-        ),
-      };
-    });
-    return aliases;
-  }
-
-  /**
-   * Allow packages from addons set in env vars to customize Volto and other addons.
-   *
-   * Same as the above one, but specific for Volto addons coming from env vars
-   */
-  getAddonsFromEnvVarCustomizationPaths() {
-    let aliases = {};
-    if (process.env.ADDONS) {
-      process.env.ADDONS.split(';').forEach((addon) => {
-        const normalizedAddonName = addon.split(':')[0];
-        const testingPackagePath = `${this.projectRootPath}/packages/${normalizedAddonName}/src`;
-        if (fs.existsSync(testingPackagePath)) {
-          const basePath = getPackageBasePath(testingPackagePath);
-          const packageJson = path.join(basePath, 'package.json');
-          aliases = {
-            ...aliases,
-            ...this.getCustomizationPaths(require(packageJson), basePath),
-          };
-        }
-      });
-
-      return aliases;
-    } else {
-      return [];
-    }
-  }
-
-  /**
-   * Returns an agregated, dependency-resolved list of addon loader strings
-   */
-  getAddonDependencies() {
-    return getAddonsLoaderChain(this.dependencyGraph);
-  }
-
-  getDotDependencyGraph() {
-    const seen = new Set();
-    let out = `digraph {
-  layout="fdp"
-  beautify=true
-  sep="+10"
-  splines=curved
-
-  "@root" [color = red fillcolor=yellow style=filled]
-`;
-    let queue = ['@root'];
-    let name;
-
-    while (queue.length > 0) {
-      name = queue.pop();
-
-      const deps = this.dependencyGraph.directDependenciesOf(name);
-      for (let i = 0; i < deps.length; i++) {
-        const dep = deps[i];
-
-        if (!seen.has(dep)) {
-          seen.add(dep);
-          queue.push(dep);
-        }
-        out += `    "${name}" -> "${dep}"\n`;
-      }
-    }
-    out += '}';
-    return out;
-  }
-}
-
-module.exports = AddonConfigurationRegistry;
-module.exports.getAddonsLoaderChain = getAddonsLoaderChain;
-module.exports.buildDependencyGraph = buildDependencyGraph;

package/packages/registry/create-addons-loader.js

@@ -1,116 +0,0 @@
-const fs = require('fs');
-const tmp = require('tmp');
-const cryptoRandomString = require('crypto-random-string');
-
-const titleCase = (w) => w.slice(0, 1).toUpperCase() + w.slice(1, w.length);
-
-/*
- * Transforms a package name to javascript variable name
- */
-function nameFromPackage(name) {
-  name =
-    name.replace(/[@~./\\:\s]/gi, '') ||
-    cryptoRandomString({ length: 10, characters: 'abcdefghijk' });
-  return name
-    .split('-')
-    .map((w, i) => (i > 0 ? titleCase(w) : w))
-    .join('');
-}
-
-/*
- * Creates a static file with code necessary to load the addons configuration
- *
- */
-function getAddonsLoaderCode(addons = [], addonsInfo) {
-  let buf = `/*
-This file is autogenerated. Don't change it directly.
-Instead, change the "addons" setting in your package.json file.
-*/
-
-const projectConfigLoader = require('@root/config');
-`;
-  let configsToLoad = [],
-    counter = 0;
-
-  addons.forEach((addonConfigString) => {
-    let extras = [];
-    const addonConfigLoadInfo = addonConfigString.split(':');
-    const pkgName = addonConfigLoadInfo[0];
-    const defaultImport = nameFromPackage(pkgName);
-    if (addonConfigLoadInfo.length > 1) {
-      extras = addonConfigLoadInfo[1].split(',');
-    }
-    extras = extras.map((name) => [name, `${name}${counter++}`]);
-
-    const line = `import ${defaultImport}${
-      extras.length
-        ? `, { ${extras
-            .map((ex) => {
-              return `${ex[0]} as ${ex[1]}`;
-            })
-            .join(', ')} }`
-        : ''
-    } from '${pkgName}';\n`;
-    buf += line;
-    configsToLoad = [
-      ...configsToLoad,
-      defaultImport,
-      ...extras.map((ex) => ex[1]),
-    ];
-  });
-
-  buf += `
-${
-  addonsInfo
-    ? `const addonsInfo = ${JSON.stringify(addonsInfo)}`
-    : 'const addonsInfo = {}'
-};
-export { addonsInfo };
-`;
-
-  buf += `
-const safeWrapper = (func) => (config) => {
-  const res = func(config);
-  if (typeof res === 'undefined') {
-    throw new Error("Configuration function doesn't return config");
-  }
-  return res;
-}
-
-const projectConfig = (config) => {
-  return typeof projectConfigLoader.default === "function" ? projectConfigLoader.default(config) : config;
-}
-
-const load = (config) => {
-  const addonLoaders = [${configsToLoad.join(', ')}];
-  if(!addonLoaders.every((el) => typeof el === "function")) {
-    throw new TypeError(
-      'Each addon has to provide a function applying its configuration to the projects configuration.',
-    );
-  }
-  return projectConfig(addonLoaders.reduce((acc, apply) => safeWrapper(apply)(acc), config));
-};
-export default load;
-`;
-
-  return buf;
-}
-
-module.exports = (addons, addonsInfo, { tempInProject } = {}) => {
-  // Some frameworks do not allow to load code from outside the project.
-  // the `tempInProject` allows to place it inside
-  let addonsLoaderPath;
-  if (tempInProject) {
-    const path = require('path');
-    addonsLoaderPath = path.join(process.cwd(), 'src', '.addons-loader.js');
-  } else {
-    addonsLoaderPath = tmp.tmpNameSync({ postfix: '.js' });
-  }
-
-  const code = getAddonsLoaderCode(addons, addonsInfo);
-  fs.writeFileSync(addonsLoaderPath, Buffer.from(code));
-  return addonsLoaderPath;
-};
-
-module.exports.getAddonsLoaderCode = getAddonsLoaderCode;
-module.exports.nameFromPackage = nameFromPackage;