@saltcorn/plugins-loader 1.5.0-beta.14 → 1.5.0-beta.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saltcorn/plugins-loader",
-  "version": "1.5.0-beta.14",
+  "version": "1.5.0-beta.16",
   "description": "Saltcorn plugin loader",
   "homepage": "https://saltcorn.com",
   "scripts": {
@@ -9,7 +9,7 @@
     "clean": "echo 'No TypeScript build'"
   },
   "dependencies": {
-    "@saltcorn/data": "1.5.0-beta.14",
+    "@saltcorn/data": "1.5.0-beta.16",
     "env-paths": "^2.2.1",
     "npm-registry-fetch": "17.1.0",
     "https-proxy-agent": "^7.0.6"

package/plugin_installer.js

@@ -9,6 +9,7 @@ const {
   removeTarball,
 } = require("./download_utils");
 const { getState } = require("@saltcorn/data/db/state");
+const Plugin = require("@saltcorn/data/models/plugin");
 const { rm, rename, cp, readFile, readdir } = require("fs").promises;
 const envPaths = require("env-paths");
 const semver = require("semver");
@@ -20,11 +21,12 @@ const staticDeps = [
   "@saltcorn/postgres",
   "jest",
 ];
-const fixedPlugins = ["@saltcorn/base-plugin", "@saltcorn/sbadmin2"];
 
 const isGitCheckout = async () => {
-  const gitPath = join(__dirname, "..", "..", "Dockerfile.release");
-  return await pathExists(gitPath);
+  return (
+    (await pathExists(join(__dirname, "..", "..", "Dockerfile.release"))) ||
+    (await pathExists(join(__dirname, "..", "..", ".git")))
+  );
 };
 
 const readPackageJson = async (filePath) => {
@@ -53,6 +55,9 @@ const npmInstallNeeded = (oldPckJSON, newPckJSON) => {
 
 const defaultRootFolder = envPaths("saltcorn", { suffix: "plugins" }).data;
 
+/**
+ * PluginInstaller class
+ */
 class PluginInstaller {
   constructor(plugin, opts = Object.create(null)) {
     this.plugin = plugin;
@@ -83,100 +88,52 @@ class PluginInstaller {
   }
 
   /**
-   * check if the host supports the plugin and return a warning if not
-   * @param pckJSON
+   *
+   * @param {boolean} force
+   * @param {boolean} preInstall Only npm install without loading the module
    * @returns
    */
-  checkEngineWarning(pckJSON) {
-    const scEngine = pckJSON.engines?.saltcorn;
-    if (
-      this.scVersion &&
-      scEngine &&
-      !semver.satisfies(this.scVersion, scEngine)
-    ) {
-      const warnMsg = `Plugin ${this.plugin.name} requires Saltcorn version ${scEngine} but running ${this.scVersion}`;
-      getState().log(4, warnMsg);
-      return warnMsg;
-    }
-    return null;
-  }
-
-  async install(force) {
+  async install(force = false, preInstall = false) {
     getState().log(5, `loading plugin ${this.plugin.name}`);
-    await this.ensurePluginsRootFolders();
-    if (fixedPlugins.includes(this.plugin.location))
+    await this._ensurePluginsRootFolders();
+    if (Plugin.is_fixed_plugin(this.plugin.location))
       return {
         location: path.join(require.resolve(this.plugin.location), ".."),
         plugin_module: require(this.plugin.location),
       };
     const msgs = [];
-    let pckJSON = await readPackageJson(this.pckJsonPath);
-    const installer = async () => {
-      if (await this.prepPluginsFolder(force, pckJSON)) {
-        const tmpPckJSON = await this.removeDependencies(
-          await readPackageJson(this.tempPckJsonPath),
-          true
-        );
-        let wasInstalled = false;
-        if (
-          !pckJSON ||
-          npmInstallNeeded(await this.removeDependencies(pckJSON), tmpPckJSON)
-        ) {
-          wasInstalled = true;
-          await this.npmInstall(tmpPckJSON);
-        }
-        await this.movePlugin(wasInstalled);
-        if (await tarballExists(this.rootFolder, this.plugin))
-          await removeTarball(this.rootFolder, this.plugin);
-        pckJSON = await readPackageJson(this.pckJsonPath);
-        const msg = this.checkEngineWarning(pckJSON);
-        if (msg && !msgs.includes(msg)) msgs.push(msg);
-      }
-    };
-    await installer();
     let module = null;
     let loadedWithReload = false;
-    try {
-      module = await this.loadMainFile(pckJSON);
-    } catch (e) {
-      if (e.code === "MODULE_NOT_FOUND") {
-        getState().log(5, `corrupt plugin dir: ${this.pluginDir}`);
-        const files = await readdir(this.pluginDir);
-        getState().log(5, `files in plugin dir: ${JSON.stringify(files)}`);
-        if (files.includes("node_modules")) {
-          const nodeModuleFiles = await readdir(
-            join(this.pluginDir, "node_modules")
+    let pckJSON = await this._installHelper(force, msgs);
+    if (!preInstall) {
+      try {
+        module = await this._loadMainFile(pckJSON);
+      } catch (e) {
+        if (e.code === "MODULE_NOT_FOUND") await this._dumpNodeMoules();
+        if (force) {
+          // remove and try again
+          // could happen when there is a directory with a package.json
+          // but without a valid node modules folder
+          getState().log(
+            2,
+            `Error loading plugin ${this.plugin.name}. Removing and trying again.`
           );
+          await this.remove();
+          pckJSON = await this._installHelper(force, msgs);
+        } else {
           getState().log(
-            5,
-            `node_modules files: ${JSON.stringify(nodeModuleFiles)}`
+            2,
+            `Error loading plugin ${this.plugin.name}. Trying again with reload flag. ` +
+              "A server restart may be required."
           );
-        } else getState().log(5, `no node_modules in plugin dir`);
-      }
-      if (force) {
-        // remove and try again
-        // could happen when there is a directory with a package.json
-        // but without a valid node modules folder
-        getState().log(
-          2,
-          `Error loading plugin ${this.plugin.name}. Removing and trying again.`
-        );
-        await this.remove();
-        pckJSON = null;
-        await installer();
-      } else {
-        getState().log(
-          2,
-          `Error loading plugin ${this.plugin.name}. Trying again with reload flag. ` +
-            "A server restart may be required."
-        );
-      }
+        }
 
-      module = await this.loadMainFile(pckJSON, true);
-      loadedWithReload = true;
+        module = await this._loadMainFile(pckJSON, true);
+        loadedWithReload = true;
+      }
     }
     return {
-      version: pckJSON.version,
+      version: this.plugin.version === "latest" ? "latest" : pckJSON.version,
       plugin_module: module,
       location: this.pluginDir,
       name: this.plugin.name,
@@ -185,18 +142,81 @@ class PluginInstaller {
     };
   }
 
+  /**
+   * remove plugin directory
+   */
   async remove() {
     if (await pathExists(this.pluginDir))
       await rm(this.pluginDir, { recursive: true });
   }
 
-  async prepPluginsFolder(force, pckJSON) {
+  // -- private methods --
+
+  /**
+   * prepare the plugin folder and npm install if needed
+   * @param {*} force
+   * @param {*} pckJSON
+   * @param {*} msgs
+   */
+  async _installHelper(force, msgs) {
+    const airgap = getState().getConfig("airgap", false);
+    let pckJSON = await readPackageJson(this.pckJsonPath);
+    if (airgap) return pckJSON;
+    else if (await this._prepPluginsFolder(force, pckJSON)) {
+      const tmpPckJSON = await this._removeDependencies(
+        await readPackageJson(this.tempPckJsonPath),
+        true
+      );
+      let wasInstalled = false;
+      if (
+        !pckJSON ||
+        npmInstallNeeded(await this._removeDependencies(pckJSON), tmpPckJSON)
+      ) {
+        wasInstalled = true;
+        await this._npmInstall(tmpPckJSON);
+      }
+      await this._movePlugin(wasInstalled);
+      if (await tarballExists(this.rootFolder, this.plugin))
+        await removeTarball(this.rootFolder, this.plugin);
+      pckJSON = await readPackageJson(this.pckJsonPath);
+      const msg = this._checkEngineWarning(pckJSON);
+      if (msg && !msgs.includes(msg)) msgs.push(msg);
+    }
+    return pckJSON;
+  }
+
+  /**
+   * check if the host supports the plugin and return a warning if not
+   * @param pckJSON
+   * @returns
+   */
+  _checkEngineWarning(pckJSON) {
+    const scEngine = pckJSON.engines?.saltcorn;
+    if (
+      this.scVersion &&
+      scEngine &&
+      !semver.satisfies(this.scVersion, scEngine)
+    ) {
+      const warnMsg = `Plugin ${this.plugin.name} requires Saltcorn version ${scEngine} but running ${this.scVersion}`;
+      getState().log(4, warnMsg);
+      return warnMsg;
+    }
+    return null;
+  }
+
+  /**
+   * helper to prepare the plugin folder
+   * @param {*} force
+   * @param {*} pckJSON
+   * @returns
+   */
+  async _prepPluginsFolder(force, pckJSON) {
     let wasLoaded = false;
     const folderExists = await pathExists(this.pluginDir);
     switch (this.plugin.source) {
       case "npm":
         if (
-          (force && !(await this.versionIsInstalled(pckJSON))) ||
+          (force && !(await this._versionIsInstalled(pckJSON))) ||
           !folderExists
         ) {
           getState().log(6, "downloading from npm");
@@ -237,7 +257,7 @@ class PluginInstaller {
     return wasLoaded;
   }
 
-  async ensurePluginsRootFolders() {
+  async _ensurePluginsRootFolders() {
     const isWindows = process.platform === "win32";
     const ensureFn = async (folder) => {
       const pluginsFolder = join(this.rootFolder, folder);
@@ -254,12 +274,12 @@ class PluginInstaller {
       await ensureFn(folder);
   }
 
-  isFixedVersion() {
+  _isFixedVersion() {
     return !!this.plugin.version && this.plugin.version !== "latest";
   }
 
-  async versionIsInstalled(pckJSON) {
-    if (!pckJSON || !this.isFixedVersion()) return false;
+  async _versionIsInstalled(pckJSON) {
+    if (!pckJSON || !this._isFixedVersion()) return false;
     else {
       const vInstalled = pckJSON.version;
       if (vInstalled === this.plugin.version) return true;
@@ -267,7 +287,7 @@ class PluginInstaller {
     }
   }
 
-  async loadMainFile(pckJSON, reload) {
+  async _loadMainFile(pckJSON, reload) {
     const isWindows = process.platform === "win32";
     if (process.env.NODE_ENV === "test") {
       // in jest, downgrad to require
@@ -281,7 +301,7 @@ class PluginInstaller {
     }
   }
 
-  async removeDependencies(tmpPckJSON, writeToDisk) {
+  async _removeDependencies(tmpPckJSON, writeToDisk) {
     const pckJSON = { ...tmpPckJSON };
     const oldDepsLength = Object.keys(pckJSON.dependencies || {}).length;
     const oldDevDepsLength = Object.keys(pckJSON.devDependencies || {}).length;
@@ -304,7 +324,7 @@ class PluginInstaller {
     return pckJSON;
   }
 
-  async npmInstall(pckJSON) {
+  async _npmInstall(pckJSON) {
     const isWindows = process.platform === "win32";
     if (
       Object.keys(pckJSON.dependencies || {}).length > 0 ||
@@ -343,7 +363,7 @@ class PluginInstaller {
     }
   }
 
-  async movePlugin(wasInstalled) {
+  async _movePlugin(wasInstalled) {
     const isWindows = process.platform === "win32";
     const copyMove = async () => {
       await cp(this.tempDir, this.pluginDir, { recursive: true, force: true });
@@ -366,6 +386,21 @@ class PluginInstaller {
       } else await copyMove();
     } else await copyMove();
   }
+
+  async _dumpNodeMoules() {
+    getState().log(5, `corrupt plugin dir: ${this.pluginDir}`);
+    const files = await readdir(this.pluginDir);
+    getState().log(5, `files in plugin dir: ${JSON.stringify(files)}`);
+    if (files.includes("node_modules")) {
+      const nodeModuleFiles = await readdir(
+        join(this.pluginDir, "node_modules")
+      );
+      getState().log(
+        5,
+        `node_modules files: ${JSON.stringify(nodeModuleFiles)}`
+      );
+    } else getState().log(5, `no node_modules in plugin dir`);
+  }
 }
 
 module.exports = PluginInstaller;