@saltcorn/server 0.6.1-beta.0 → 0.6.1

package/routes/viewedit.js

@@ -1,6 +1,8 @@
 /**
  * View Edit Router
- *
+ * @category server
+ * @module routes/viewedit
+ * @subcategory routes
  */
 
 const Router = require("express-promise-router");
@@ -40,9 +42,22 @@ const Page = require("@saltcorn/data/models/page");
 const { add_to_menu } = require("@saltcorn/data/models/pack");
 const { editRoleForm } = require("../markup/forms.js");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace vieweditRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @param {object} view 
+ * @param {object[]} roles 
+ * @param {object} req 
+ * @returns {Form}
+ */
 const editViewRoleForm = (view, roles, req) =>
   editRoleForm({
     url: `/viewedit/setrole/${view.id}`,
@@ -51,6 +66,11 @@ const editViewRoleForm = (view, roles, req) =>
     req,
   });
 
+/**
+ * @param {object} view 
+ * @param {object} req 
+ * @returns {div}
+ */
 const view_dropdown = (view, req) =>
   settingsDropdown(`dropdownMenuButton${view.id}`, [
     a(
@@ -86,6 +106,13 @@ const view_dropdown = (view, req) =>
       view.name
     ),
   ]);
+
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,
@@ -190,9 +217,22 @@ router.get(
   })
 );
 
+/**
+ * @param {object} o 
+ * @param {function} f 
+ * @returns {object}
+ */
 const mapObjectValues = (o, f) =>
   Object.fromEntries(Object.entries(o).map(([k, v]) => [k, f(v)]));
 
+/**
+ * @param {object} req 
+ * @param {object} tableOptions 
+ * @param {object[]} roles 
+ * @param {object[]} pages 
+ * @param {object} values 
+ * @returns {Form}
+ */
 const viewForm = (req, tableOptions, roles, pages, values) => {
   const isEdit =
     values && values.id && !getState().getConfig("development_mode", false);
@@ -279,6 +319,13 @@ const viewForm = (req, tableOptions, roles, pages, values) => {
     values,
   });
 };
+
+/**
+ * @name get/edit/:viewname
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.get(
   "/edit/:viewname",
   setTenant,
@@ -321,6 +368,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/new
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.get(
   "/new",
   setTenant,
@@ -353,6 +406,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/save
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.post(
   "/save",
   setTenant,
@@ -423,6 +482,15 @@ router.post(
     }
   })
 );
+
+/**
+ * @param {object} view 
+ * @param {Workflow} wf 
+ * @param {object} wfres 
+ * @param {object} req 
+ * @param {object} res 
+ * @returns {void}
+ */
 const respondWorkflow = (view, wf, wfres, req, res) => {
   const wrap = (contents, noCard) => ({
     above: [
@@ -455,6 +523,13 @@ const respondWorkflow = (view, wf, wfres, req, res) => {
     );
   } else res.redirect(wfres.redirect);
 };
+
+/**
+ * @name get/config/:name
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.get(
   "/config/:name",
   setTenant,
@@ -482,6 +557,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/config/:name
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.post(
   "/config/:name",
   setTenant,
@@ -495,6 +576,13 @@ router.post(
     respondWorkflow(view, configFlow, wfres, req, res);
   })
 );
+
+/**
+ * @name post/add-to-menu/:id
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.post(
   "/add-to-menu/:id",
   setTenant,
@@ -519,6 +607,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/clone/:id
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.post(
   "/clone/:id",
   setTenant,
@@ -535,6 +629,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/delete/:id
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.post(
   "/delete/:id",
   setTenant,
@@ -547,6 +647,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/savebuilder/:id
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.post(
   "/savebuilder/:id",
   setTenant,
@@ -564,6 +670,13 @@ router.post(
     }
   })
 );
+
+/**
+ * @name post/setrole/:id
+ * @function
+ * @memberof module:routes/viewedit~vieweditRouter
+ * @function
+ */
 router.post(
   "/setrole/:id",
   setTenant,

package/serve.js

@@ -1,8 +1,9 @@
 /**
  * Serve is Saltcorn server starter
  *
+ * @category server
+ * @module serve
  */
-
 const runScheduler = require("@saltcorn/data/models/scheduler");
 const User = require("@saltcorn/data/models/user");
 const Plugin = require("@saltcorn/data/models/plugin");
@@ -35,6 +36,12 @@ const View = require("@saltcorn/data/models/view");
 
 // helpful https://gist.github.com/jpoehls/2232358
 
+/**
+ * @param {object} opts
+ * @param {object} opts
+ * @param {boolean} opts.disableMigrate
+ * @param {boolean} [useClusterAdaptor = true]
+ */
 const initMaster = async ({ disableMigrate }, useClusterAdaptor = true) => {
   let sql_log;
   try {
@@ -66,6 +73,12 @@ const initMaster = async ({ disableMigrate }, useClusterAdaptor = true) => {
   if (useClusterAdaptor) setupPrimary();
 };
 
+/**
+ * @param {object} opts
+ * @param {object} opts.tenant
+ * @param {...*} opts.msg
+ * @returns {void}
+ */
 const workerDispatchMsg = ({ tenant, ...msg }) => {
   if (tenant) {
     db.runWithTenant(tenant, () => workerDispatchMsg(msg));
@@ -77,14 +90,29 @@ const workerDispatchMsg = ({ tenant, ...msg }) => {
     });
   }
   if (msg.refresh) getState()[`refresh_${msg.refresh}`](true);
-  if (msg.createTenant)
+  if (msg.createTenant) {
     create_tenant(msg.createTenant, loadAllPlugins, "", true);
+    db.runWithTenant(msg.createTenant, async () => {
+      getState().refresh(true);
+    });
+  }
   if (msg.installPlugin) {
     loadAndSaveNewPlugin(msg.installPlugin, msg.force, true);
   }
   if (msg.restart_tenant) restart_tenant(loadAllPlugins);
   if (msg.removePlugin) getState().remove_plugin(msg.removePlugin, true);
 };
+
+/**
+ *
+ * @param {*} masterState
+ * @param {object} opts
+ * @param {string} opts.port
+ * @param {boolean} opts.watchReaper
+ * @param {boolean} opts.disableScheduler
+ * @param {number} opts.pid
+ * @returns {function}
+ */
 const onMessageFromWorker = (
   masterState,
   { port, watchReaper, disableScheduler, pid }
@@ -109,105 +137,122 @@ const onMessageFromWorker = (
   }
 };
 
-module.exports = async ({
-  port = 3000,
-  watchReaper,
-  disableScheduler,
-  defaultNCPUs,
-  ...appargs
-} = {}) => {
-  const useNCpus = process.env.SALTCORN_NWORKERS
-    ? +process.env.SALTCORN_NWORKERS
-    : defaultNCPUs;
+module.exports =
+  /**
+   * @function
+   * @name "module.exports function"
+   * @param {object} [opts = {}]
+   * @param {number} [opts.port = 3000]
+   * @param {boolean} opts.watchReaper
+   * @param {boolean} opts.disableScheduler
+   * @param {number} opts.defaultNCPUs
+   * @param {...*} opts.appargs
+   * @returns {Promise<void>}
+   */
+  async ({
+    port = 3000,
+    watchReaper,
+    disableScheduler,
+    defaultNCPUs,
+    ...appargs
+  } = {}) => {
+    const useNCpus = process.env.SALTCORN_NWORKERS
+      ? +process.env.SALTCORN_NWORKERS
+      : defaultNCPUs;
 
-  const letsEncrypt = await getConfig("letsencrypt", false);
-  const masterState = {
-    started: false,
-    listeningTo: new Set([]),
-  };
+    const letsEncrypt = await getConfig("letsencrypt", false);
+    const masterState = {
+      started: false,
+      listeningTo: new Set([]),
+    };
 
-  const addWorker = (worker) => {
-    worker.on(
-      "message",
-      onMessageFromWorker(masterState, {
-        port,
-        watchReaper,
-        disableScheduler,
-        pid: worker.process.pid,
-      })
-    );
-  };
+    const addWorker = (worker) => {
+      worker.on(
+        "message",
+        onMessageFromWorker(masterState, {
+          port,
+          watchReaper,
+          disableScheduler,
+          pid: worker.process.pid,
+        })
+      );
+    };
 
-  if (port === 80 && letsEncrypt) {
-    const admin_users = await User.find({ role_id: 1 }, { orderBy: "id" });
-    const file_store = db.connectObj.file_store;
-    const Greenlock = require("greenlock");
-    const greenlock = Greenlock.create({
-      packageRoot: __dirname,
-      configDir: path.join(file_store, "greenlock.d"),
-      maintainerEmail: admin_users[0].email,
-    });
-    const certs = await greenlock._find({});
-    console.log("Certificates:", certs);
+    if (port === 80 && letsEncrypt) {
+      const admin_users = await User.find({ role_id: 1 }, { orderBy: "id" });
+      const file_store = db.connectObj.file_store;
+      const Greenlock = require("greenlock");
+      const greenlock = Greenlock.create({
+        packageRoot: __dirname,
+        configDir: path.join(file_store, "greenlock.d"),
+        maintainerEmail: admin_users[0].email,
+      });
+      const certs = await greenlock._find({});
+      console.log("Certificates:", certs);
 
-    if (certs && certs.length > 0) {
-      const app = await getApp(appargs);
-      const timeout = +getState().getConfig("timeout", 120);
-      const initMasterListeners = () => {
-        Object.entries(cluster.workers).forEach(([id, w]) => {
-          if (!masterState.listeningTo.has(id)) {
-            addWorker(w);
-            masterState.listeningTo.add(id);
-          }
-        });
-        if (masterState.listeningTo.size < useNCpus)
-          setTimeout(initMasterListeners, 250);
-      };
-      require("greenlock-express")
-        .init({
-          packageRoot: __dirname,
-          configDir: path.join(file_store, "greenlock.d"),
-          maintainerEmail: admin_users[0].email,
-          cluster: true,
-          workers: useNCpus,
-        })
-        .ready((glx) => {
-          const httpsServer = glx.httpsServer();
-          setupSocket(httpsServer);
-          httpsServer.setTimeout(timeout * 1000);
-          process.on("message", workerDispatchMsg);
-          glx.serveApp(app);
-          process.send && process.send("Start");
-        })
-        .master(() => {
-          initMaster(appargs).then(initMasterListeners);
-        });
+      if (certs && certs.length > 0) {
+        const app = await getApp(appargs);
+        const timeout = +getState().getConfig("timeout", 120);
+        const initMasterListeners = () => {
+          Object.entries(cluster.workers).forEach(([id, w]) => {
+            if (!masterState.listeningTo.has(id)) {
+              addWorker(w);
+              masterState.listeningTo.add(id);
+            }
+          });
+          if (masterState.listeningTo.size < useNCpus)
+            setTimeout(initMasterListeners, 250);
+        };
+        require("greenlock-express")
+          .init({
+            packageRoot: __dirname,
+            configDir: path.join(file_store, "greenlock.d"),
+            maintainerEmail: admin_users[0].email,
+            cluster: true,
+            workers: useNCpus,
+          })
+          .ready((glx) => {
+            const httpsServer = glx.httpsServer();
+            setupSocket(httpsServer);
+            httpsServer.setTimeout(timeout * 1000);
+            process.on("message", workerDispatchMsg);
+            glx.serveApp(app);
+            process.send && process.send("Start");
+          })
+          .master(() => {
+            initMaster(appargs).then(initMasterListeners);
+          });
 
-      return; // none of stuff below will execute
+        return; // none of stuff below will execute
+      }
     }
-  }
-  // No greenlock!
+    // No greenlock!
 
-  if (cluster.isMaster) {
-    const forkAnyWorkers = useNCpus > 1 && process.platform !== "win32";
-    await initMaster(appargs, forkAnyWorkers);
+    if (cluster.isMaster) {
+      const forkAnyWorkers = useNCpus > 1 && process.platform !== "win32";
+      await initMaster(appargs, forkAnyWorkers);
 
-    if (forkAnyWorkers) {
-      for (let i = 0; i < useNCpus; i++) addWorker(cluster.fork());
+      if (forkAnyWorkers) {
+        for (let i = 0; i < useNCpus; i++) addWorker(cluster.fork());
 
-      cluster.on("exit", (worker, code, signal) => {
-        console.log(`worker ${worker.process.pid} died`);
-        addWorker(cluster.fork());
-      });
+        cluster.on("exit", (worker, code, signal) => {
+          console.log(`worker ${worker.process.pid} died`);
+          addWorker(cluster.fork());
+        });
+      } else {
+        await nonGreenlockWorkerSetup(appargs, port);
+      }
+      Trigger.emitEvent("Startup");
     } else {
       await nonGreenlockWorkerSetup(appargs, port);
     }
-    Trigger.emitEvent("Startup");
-  } else {
-    await nonGreenlockWorkerSetup(appargs, port);
-  }
-};
+  };
 
+/**
+ * @param {*} appargs
+ * @param {*} port
+ * @returns {Promise<void>}
+ */
 const nonGreenlockWorkerSetup = async (appargs, port) => {
   process.send && process.on("message", workerDispatchMsg);
 
@@ -251,6 +296,11 @@ const nonGreenlockWorkerSetup = async (appargs, port) => {
   }
   process.send && process.send("Start");
 };
+
+/**
+ *
+ * @param  {...*} servers
+ */
 const setupSocket = (...servers) => {
   // https://socket.io/docs/v4/middlewares/
   const wrap = (middleware) => (socket, next) =>

package/systemd.js

@@ -1,5 +1,16 @@
+/**
+ * @category server
+ * @module systemd
+ */
 const fetch = require("node-fetch");
 
+/**
+ * @param {number} interval 
+ * @param {object} notify 
+ * @param {object} opts 
+ * @param {string} opts.port
+ * @returns {void}
+ */
 const watchDog = (interval, notify, { port }) => {
   //we want to do a request / db check every 5 mins
   const pings_per_5_min = (5 * 60000) / interval;
@@ -37,7 +48,13 @@ const watchDog = (interval, notify, { port }) => {
   }
 };
 
-module.exports = (opts) => {
+module.exports = 
+/**
+ * @function
+ * @name "module.exports function"
+ * @param {object} opts 
+ */
+(opts) => {
   try {
     const notify = require("sd-notify");
     notify.ready();

package/wrapper.js

@@ -1,3 +1,7 @@
+/**
+ * @category server
+ * @module wrapper
+ */
 const { getState } = require("@saltcorn/data/db/state");
 const db = require("@saltcorn/data/db");
 const { ul, li, h3, div, small } = require("@saltcorn/markup/tags");