@saltcorn/server 0.9.5-beta.2 → 0.9.5-beta.4

package/load_plugins.js

@@ -6,59 +6,10 @@
  * @module load_plugins
  */
 const db = require("@saltcorn/data/db");
-const { PluginManager } = require("live-plugin-manager");
 const { getState, getRootState } = require("@saltcorn/data/db/state");
 const Plugin = require("@saltcorn/data/models/plugin");
-const fs = require("fs");
-const proc = require("child_process");
-const tmp = require("tmp-promise");
 
-const staticDependencies = {
-  "@saltcorn/markup": require("@saltcorn/markup"),
-  "@saltcorn/markup/tags": require("@saltcorn/markup/tags"),
-  "@saltcorn/markup/layout": require("@saltcorn/markup/layout"),
-  "@saltcorn/markup/helpers": require("@saltcorn/markup/helpers"),
-  "@saltcorn/markup/layout_utils": require("@saltcorn/markup/layout_utils"),
-  "@saltcorn/data": require("@saltcorn/data"),
-  "@saltcorn/data/db": require("@saltcorn/data/db"),
-  "@saltcorn/data/utils": require("@saltcorn/data/utils"),
-  "@saltcorn/data/db/state": require("@saltcorn/data/db/state"),
-  "@saltcorn/data/plugin-helper": require("@saltcorn/data/plugin-helper"),
-  "@saltcorn/data/plugin-testing": require("@saltcorn/data/plugin-testing"),
-  "@saltcorn/data/models/field": require("@saltcorn/data/models/field"),
-  "@saltcorn/data/models/fieldrepeat": require("@saltcorn/data/models/fieldrepeat"),
-  "@saltcorn/data/models/table": require("@saltcorn/data/models/table"),
-  "@saltcorn/data/models/form": require("@saltcorn/data/models/form"),
-  "@saltcorn/data/models/discovery": require("@saltcorn/data/models/discovery"),
-  "@saltcorn/data/models/config": require("@saltcorn/data/models/config"),
-  "@saltcorn/data/models/library": require("@saltcorn/data/models/library"),
-  "@saltcorn/data/models/model": require("@saltcorn/data/models/model"),
-  "@saltcorn/data/models/model_instance": require("@saltcorn/data/models/model_instance"),
-  "@saltcorn/data/models/notification": require("@saltcorn/data/models/notification"),
-  "@saltcorn/data/models/role": require("@saltcorn/data/models/role"),
-  "@saltcorn/data/models/tag": require("@saltcorn/data/models/tag"),
-  "@saltcorn/data/models/tag_entry": require("@saltcorn/data/models/tag_entry"),
-  "@saltcorn/data/models/view": require("@saltcorn/data/models/view"),
-  "@saltcorn/data/models/page": require("@saltcorn/data/models/page"),
-  "@saltcorn/data/models/file": require("@saltcorn/data/models/file"),
-  "@saltcorn/data/models/user": require("@saltcorn/data/models/user"),
-  "@saltcorn/data/models/layout": require("@saltcorn/data/models/layout"),
-  "@saltcorn/data/models/expression": require("@saltcorn/data/models/expression"),
-  "@saltcorn/data/models/workflow": require("@saltcorn/data/models/workflow"),
-  imapflow: require("imapflow"),
-  "node-fetch": require("node-fetch"),
-};
-
-/**
- * Create plugin manager with default list of core plugins
- * @type {PluginManager}
- */
-const defaultManager = new PluginManager({
-  staticDependencies: {
-    contractis: require("contractis"),
-    ...staticDependencies,
-  },
-});
+const PluginInstaller = require("@saltcorn/plugins-loader/plugin_installer");
 
 /**
  * Load one plugin
@@ -68,7 +19,8 @@ const defaultManager = new PluginManager({
  */
 const loadPlugin = async (plugin, force) => {
   // load plugin
-  const res = await requirePlugin(plugin, force);
+  const loader = new PluginInstaller(plugin);
+  const res = await loader.install(force);
   const configuration =
     typeof plugin.configuration === "string"
       ? JSON.parse(plugin.configuration)
@@ -91,105 +43,42 @@ const loadPlugin = async (plugin, force) => {
   return res;
 };
 
-/**
- * Git pull or clone
- * @param plugin
- */
-const gitPullOrClone = async (plugin) => {
-  await fs.promises.mkdir("git_plugins", { recursive: true });
-  let keyfnm,
-    setKey = `-c core.sshCommand="ssh -oBatchMode=yes -o 'StrictHostKeyChecking no'" `;
-  if (plugin.deploy_private_key) {
-    keyfnm = await tmp.tmpName();
-    await fs.promises.writeFile(
-      keyfnm,
-      plugin.deploy_private_key.replace(/[\r]+/g, "") + "\n",
-      {
-        mode: 0o600,
-        encoding: "ascii",
-      }
-    );
-    setKey = `-c core.sshCommand="ssh -oBatchMode=yes -o 'StrictHostKeyChecking no' -i ${keyfnm}" `;
-  }
-  const dir = `git_plugins/${plugin.name}`;
-  if (fs.existsSync(dir)) {
-    proc.execSync(`git ${setKey} -C ${dir} pull`);
-  } else {
-    proc.execSync(`git ${setKey} clone ${plugin.location} ${dir}`);
-  }
-  if (plugin.deploy_private_key) await fs.promises.unlink(keyfnm);
-  return dir;
-};
 /**
  * Install plugin
  * @param plugin - plugin name
  * @param force - force flag
- * @param manager - plugin manager
  * @returns {Promise<{plugin_module: *}|{plugin_module: any}>}
  */
-const requirePlugin = async (plugin, force, manager = defaultManager) => {
-  const installed_plugins = (await manager.list()).map((p) => p.name);
-  // todo as idea is to make list of mandatory plugins configurable
-  if (
-    ["@saltcorn/base-plugin", "@saltcorn/sbadmin2"].includes(plugin.location)
-  ) {
-    return { plugin_module: require(plugin.location) };
-  } else if (plugin.source === "npm") {
-    if (force || !installed_plugins.includes(plugin.location)) {
-      const plinfo = await manager.install(plugin.location, plugin.version);
-      return { plugin_module: manager.require(plugin.location), ...plinfo };
-    } else {
-      const plinfo = manager.getInfo(plugin.location);
-      return { plugin_module: manager.require(plugin.location), ...plinfo };
-    }
-  } else if (plugin.source === "local") {
-    const plinfo = await manager.installFromPath(plugin.location, {
-      force: true,
-    });
-    return { plugin_module: manager.require(plugin.name), ...plinfo };
-  } else if (plugin.source === "git") {
-    const loc = await gitPullOrClone(plugin);
-    const plinfo = await manager.installFromPath(loc, {
-      force: true,
-    });
-    return { plugin_module: manager.require(plugin.name), ...plinfo };
-  } else if (plugin.source === "github") {
-    if (force || !installed_plugins.includes(plugin.location)) {
-      const plinfo = await manager.installFromGithub(plugin.location, {
-        force: true,
-      });
-      return { plugin_module: manager.require(plugin.name), ...plinfo };
-    } else {
-      const plinfo = manager.getInfo(plugin.location);
-      return { plugin_module: manager.require(plugin.location), ...plinfo };
-    }
-  } else throw new Error("Unknown plugin source: " + plugin.source);
+const requirePlugin = async (plugin, force) => {
+  const loader = new PluginInstaller(plugin);
+  return await loader.install(force);
 };
+
 /**
  * Load all plugins
  * @returns {Promise<void>}
  */
-const loadAllPlugins = async () => {
+const loadAllPlugins = async (force) => {
   await getState().refresh(true);
   const plugins = await db.select("_sc_plugins");
   for (const plugin of plugins) {
     try {
-      await loadPlugin(plugin);
+      await loadPlugin(plugin, force);
     } catch (e) {
       console.error(e);
     }
   }
   await getState().refresh(true);
 };
+
 /**
  * Load Plugin and its dependencies and save into local installation
  * @param plugin
  * @param force
  * @param noSignalOrDB
- * @param manager - optional plugin manager
  * @returns {Promise<void>}
  */
-const loadAndSaveNewPlugin = async (plugin, force, noSignalOrDB, manager) => {
+const loadAndSaveNewPlugin = async (plugin, force, noSignalOrDB) => {
   const tenants_unsafe_plugins = getRootState().getConfig(
     "tenants_unsafe_plugins",
     false
@@ -215,11 +104,8 @@ const loadAndSaveNewPlugin = async (plugin, force, noSignalOrDB, manager) => {
       return;
     }
   }
-  const { version, plugin_module, location } = await requirePlugin(
-    plugin,
-    force,
-    manager
-  );
+  const loader = new PluginInstaller(plugin);
+  const { version, plugin_module, location } = await loader.install(force);
 
   // install dependecies
   for (const loc of plugin_module.dependencies || []) {
@@ -252,7 +138,7 @@ const loadAndSaveNewPlugin = async (plugin, force, noSignalOrDB, manager) => {
     getState().processSend({
       installPlugin: plugin,
       tenant: db.getTenantSchema(),
-      force,
+      force: false, // okay ??
     });
   }
 };
@@ -262,5 +148,4 @@ module.exports = {
   loadAllPlugins,
   loadPlugin,
   requirePlugin,
-  staticDependencies,
 };

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "@saltcorn/server",
-  "version": "0.9.5-beta.2",
+  "version": "0.9.5-beta.4",
   "description": "Server app for Saltcorn, open-source no-code platform",
   "homepage": "https://saltcorn.com",
   "main": "index.js",
   "license": "MIT",
   "dependencies": {
     "@aws-sdk/client-s3": "^3.451.0",
-    "@saltcorn/base-plugin": "0.9.5-beta.2",
-    "@saltcorn/builder": "0.9.5-beta.2",
-    "@saltcorn/data": "0.9.5-beta.2",
-    "@saltcorn/admin-models": "0.9.5-beta.2",
-    "@saltcorn/filemanager": "0.9.5-beta.2",
-    "@saltcorn/markup": "0.9.5-beta.2",
-    "@saltcorn/sbadmin2": "0.9.5-beta.2",
+    "@saltcorn/base-plugin": "0.9.5-beta.4",
+    "@saltcorn/builder": "0.9.5-beta.4",
+    "@saltcorn/data": "0.9.5-beta.4",
+    "@saltcorn/admin-models": "0.9.5-beta.4",
+    "@saltcorn/filemanager": "0.9.5-beta.4",
+    "@saltcorn/markup": "0.9.5-beta.4",
+    "@saltcorn/plugins-loader": "0.9.5-beta.4",
+    "@saltcorn/sbadmin2": "0.9.5-beta.4",
     "@socket.io/cluster-adapter": "^0.2.1",
     "@socket.io/sticky": "^1.0.1",
     "adm-zip": "0.5.10",
@@ -37,7 +38,6 @@
     "i18n": "^0.15.1",
     "imapflow": "1.0.123",
     "jsonwebtoken": "^9.0.0",
-    "live-plugin-manager": "^0.17.1",
     "markdown-it": "^13.0.2",
     "moment": "^2.29.4",
     "multer": "1.4.5-lts.1",
@@ -70,8 +70,8 @@
   },
   "repository": "github:saltcorn/saltcorn",
   "devDependencies": {
-    "jest": "26.6.3",
-    "jest-environment-jsdom": "^26.6.2",
+    "jest": "^28.1.3",
+    "jest-environment-jsdom": "28.1.3",
     "supertest": "^6.3.3"
   },
   "scripts": {
@@ -84,11 +84,13 @@
     "testEnvironment": "node",
     "testPathIgnorePatterns": [
       "/node_modules/",
-      "/plugin_packages/"
+      "/plugin_packages/",
+      "/plugins_folder/"
     ],
     "coveragePathIgnorePatterns": [
       "/node_modules/",
-      "/plugin_packages/"
+      "/plugin_packages/",
+      "/plugins_folder/"
     ],
     "moduleNameMapper": {
       "@saltcorn/sqlite/(.*)": "<rootDir>/../sqlite/dist/$1",

package/routes/plugins.js

@@ -57,6 +57,7 @@ const { flash_restart } = require("../markup/admin.js");
 const { sleep, removeNonWordChars } = require("@saltcorn/data/utils");
 const { loadAllPlugins } = require("../load_plugins");
 const npmFetch = require("npm-registry-fetch");
+const PluginInstaller = require("@saltcorn/plugins-loader/plugin_installer");
 
 /**
  * @type {object}
@@ -1178,6 +1179,7 @@ router.post(
       getState().getConfig("development_mode", false)
     ) {
       await plugin.delete();
+      await new PluginInstaller(plugin).remove();
       req.flash("success", req.__(`Module %s removed.`, plugin.name));
     } else {
       req.flash(

package/serve.js

@@ -105,7 +105,7 @@ const initMaster = async ({ disableMigrate }, useClusterAdaptor = true) => {
   // migrate database
   if (!disableMigrate) await migrate(db.connectObj.default_schema, true);
   // load all plugins
-  await loadAllPlugins();
+  await loadAllPlugins(true);
   // switch on sql logging - but it was initiated before???
   if (getState().getConfig("log_sql", false)) db.set_sql_logging();
   if (db.is_it_multi_tenant()) {