@saltcorn/server 0.6.1 → 0.6.2-beta.0

package/auth/index.js

@@ -2,6 +2,19 @@
 /**
  *
  * @category server
- * @module auth/inde
+ * @module auth/index
  * @subcategory auth
- */
+ */
+
+/**
+ * All files in the auth module.
+ * @namespace auth_overview
+ * @property {module:auth/admin} admin
+ * @property {module:auth/resetpw} resetpw
+ * @property {module:auth/roleadmin} roleadmin
+ * @property {module:auth/routes} routes
+ * @property {module:auth/testhelp} testhelp
+ * 
+ * @category server
+ * @subcategory auth
+ */

package/index.js

@@ -3,4 +3,20 @@
  *
  * @category server
  * @module server/index
- */
+ */
+
+/**
+ * All files and sub-modules in the saltcorn-markup package.
+ * @namespace server_overview
+ * @property {module:auth/index~auth_overview} auth
+ * @property {module:markup/index~markup_overview} markup
+ * @property {module:routes/index~routes_overview} routes
+ * 
+ * @property {module:app} app
+ * @property {module:errors} errors
+ * @property {module:load_plugins} load_plugins
+ * @property {module:serve} serve
+ * @property {module:systemd} systemd
+ * @property {module:wrapper} wrapper
+ * @category server
+ */

package/markup/index.js

@@ -4,4 +4,17 @@
  * @category server
  * @module markup/index
  * @subcategory markup
- */
+ */
+
+/**
+ * All files in the auth module.
+ * @namespace markup_overview
+ * @property {module:markup/admin} admin
+ * @property {module:markup/blockly} blockly
+ * @property {module:markup/expression_blurb} expression_blurb
+ * @property {module:markup/forms} forms
+ * @property {module:markup/plugin-store} plugin-store
+ * 
+ * @category server
+ * @subcategory markup
+ */

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@saltcorn/server",
-  "version": "0.6.1",
+  "version": "0.6.2-beta.0",
   "description": "Server app for Saltcorn, open-source no-code platform",
   "homepage": "https://saltcorn.com",
   "main": "index.js",
   "license": "MIT",
   "dependencies": {
-    "@saltcorn/base-plugin": "0.6.1",
-    "@saltcorn/builder": "0.6.1",
-    "@saltcorn/data": "0.6.1",
+    "@saltcorn/base-plugin": "0.6.2-beta.0",
+    "@saltcorn/builder": "0.6.2-beta.0",
+    "@saltcorn/data": "0.6.2-beta.0",
     "greenlock-express": "^4.0.3",
-    "@saltcorn/markup": "0.6.1",
-    "@saltcorn/sbadmin2": "0.6.1",
+    "@saltcorn/markup": "0.6.2-beta.0",
+    "@saltcorn/sbadmin2": "0.6.2-beta.0",
     "@socket.io/cluster-adapter": "^0.1.0",
     "@socket.io/sticky": "^1.0.1",
     "connect-flash": "^0.1.1",
@@ -33,6 +33,7 @@
     "live-plugin-manager": "^0.16.0",
     "moment": "^2.27.0",
     "node-fetch": "2.6.2",
+    "node-watch": "^0.7.2",
     "passport": "^0.4.1",
     "passport-custom": "^1.1.1",
     "passport-http-bearer": "^1.0.1",
@@ -51,7 +52,9 @@
   },
   "scripts": {
     "dev": "nodemon index.js",
-    "test": "jest --runInBand"
+    "test": "jest --runInBand",
+    "tsc": "echo \"Error: no TypeScript support yet\"",
+    "clean": "echo \"Error: no TypeScript support yet\""
   },
   "jest": {
     "testEnvironment": "node",
@@ -62,7 +65,10 @@
     "coveragePathIgnorePatterns": [
       "/node_modules/",
       "/plugin_packages/"
-    ]
+    ],
+    "moduleNameMapper": {
+      "@saltcorn/sqlite/(.*)": "@saltcorn/sqlite/dist/$1"
+    }
   },
   "publishConfig": {
     "access": "public"

package/public/saltcorn.js

@@ -306,6 +306,18 @@ function select_id(id) {
 function set_state_field(key, value) {
   pjax_to(updateQueryStringParameter(window.location.href, key, value));
 }
+
+function check_state_field(that) {
+  const checked = that.checked;
+  const name = that.name;
+  const value = that.value;
+  var separator = window.location.href.indexOf("?") !== -1 ? "&" : "?";
+  let dest;
+  if (checked) dest = window.location.href + `${separator}${name}=${value}`;
+  else dest = window.location.href.replace(`${name}=${value}`, "");
+  pjax_to(dest.replace("&&", "&").replace("?&", "?"));
+}
+
 function set_state_fields(kvs) {
   var newhref = window.location.href;
   Object.entries(kvs).forEach((kv) => {

package/restart_watcher.js

@@ -0,0 +1,146 @@
+/**
+ * @category server
+ * @module restart_watcher
+ */
+
+const path = require("path");
+const { spawnSync } = require("child_process");
+const watch = require("node-watch");
+const Plugin = require("@saltcorn/data/models/plugin");
+
+/**
+ * packages that should trigger a server re-start
+ */
+const relevantPackages = [
+  "db-common",
+  "postgres",
+  "saltcorn-data",
+  "saltcorn-markup",
+  "server",
+  "sqlite",
+];
+
+/**
+ * excluded directories or file name patterns
+ */
+const excludePatterns = [
+  /\/node_modules/,
+  /\/public/,
+  /\.git/,
+  /\.docs/,
+  /\.docs/,
+  /\migrations/,
+  /.*test.js/,
+];
+
+/**
+ * get the root directory of the saltcorn project
+ * @returns {string} project root path
+ */
+const getProjectRoot = () => {
+  return path.normalize(`${__dirname}/../../`);
+};
+
+/**
+ * get the packages directory of the saltcorn project
+ * @returns {string} packages path
+ */
+const getPackagesDirectory = () => {
+  return `${getProjectRoot()}/packages`;
+};
+
+/**
+ * get all package directories that should trigger a server re-start
+ * @returns {string[]} list of paths to relevant directories
+ */
+const getRelevantPackages = () => {
+  const packagesDir = getPackagesDirectory();
+  return relevantPackages.map((packageName) => `${packagesDir}/${packageName}`);
+};
+
+/**
+ * get all plugin directories that should trigger a server re-start
+ * @returns {string[]} list of paths to relevant directories
+ */
+const getPluginDirectories = async () => {
+  const local_plugins = await Plugin.find({ source: "local" });
+  return local_plugins.map((p) => p.location);
+};
+
+const projectRoot = getProjectRoot();
+
+const watchCfg = {
+  recursive: true,
+  filter(file, skip) {
+    for (const excludePattern of excludePatterns) {
+      if (excludePattern.test(file)) return skip;
+    }
+    return /(\.js|\.ts)$/.test(file);
+  },
+};
+
+let activeWatchers = [];
+
+/**
+ * close all open file watchers
+ */
+const closeWatchers = () => {
+  for (const activeWatcher of activeWatchers) {
+    if (!activeWatcher.isClosed()) {
+      activeWatcher.close();
+    }
+  }
+};
+
+/**
+ * register many file change listener and do re-starts on changes
+ * The listener calls process.exit() and assumes
+ * that pm2 does the actual re-start.
+ * @param {string[]} projectDirs package paths that should trigger re-starts.
+ * @param {string[]} pluginDirs plugin paths that should trigger re-starts.
+ */
+const listenForChanges = (projectDirs, pluginDirs) => {
+  // watch project dirs
+  for (const projectDir of projectDirs) {
+    activeWatchers.push(
+      watch(
+        projectDir,
+        watchCfg,
+        // event is either 'update' or 'remove'
+        (event, file) => {
+          console.log("'%s' changed \n re-starting now", file);
+          closeWatchers();
+          spawnSync("npm", ["run", "tsc"], {
+            stdio: "inherit",
+            cwd: projectRoot,
+          });
+          process.exit();
+        }
+      )
+    );
+  }
+  // watch plugin dirs
+  for (const pluginDir of pluginDirs) {
+    activeWatchers.push(
+      watch(
+        pluginDir,
+        watchCfg,
+        // event is either 'update' or 'remove'
+        (event, file) => {
+          console.log("'%s' changed \n re-starting now", file);
+          closeWatchers();
+          process.exit();
+        }
+      )
+    );
+  }
+};
+
+module.exports = {
+  listenForChanges,
+  getProjectRoot,
+  getPackagesDirectory,
+  getRelevantPackages,
+  getPluginDirectories,
+  closeWatchers,
+};

package/routes/fields.js

@@ -38,11 +38,11 @@ const router = new Router();
 module.exports = router;
 
 /**
- * @param {object} req 
- * @param {*} fkey_opts 
- * @param {*} existing_names 
- * @param {*} id 
- * @param {*} hasData 
+ * @param {object} req
+ * @param {*} fkey_opts
+ * @param {*} existing_names
+ * @param {*} id
+ * @param {*} hasData
  * @returns {Promise<Form>}
  */
 const fieldForm = async (req, fkey_opts, existing_names, id, hasData) => {
@@ -137,7 +137,7 @@ const fieldForm = async (req, fkey_opts, existing_names, id, hasData) => {
 };
 
 /**
- * @param {string} ctxType 
+ * @param {string} ctxType
  * @returns {object}
  */
 const calcFieldType = (ctxType) =>
@@ -146,8 +146,8 @@ const calcFieldType = (ctxType) =>
     : { type: ctxType };
 
 /**
- * @param {*} attrs 
- * @param {object} req 
+ * @param {*} attrs
+ * @param {object} req
  * @returns {*}
  */
 const translateAttributes = (attrs, req) =>
@@ -156,8 +156,8 @@ const translateAttributes = (attrs, req) =>
     : attrs;
 
 /**
- * @param {*} attr 
- * @param {*} req 
+ * @param {*} attr
+ * @param {*} req
  * @returns {object}
  */
 const translateAttribute = (attr, req) => {
@@ -167,7 +167,7 @@ const translateAttribute = (attr, req) => {
 };
 
 /**
- * @param {*} req 
+ * @param {*} req
  * @returns {Workflow}
  */
 const fieldFlow = (req) =>
@@ -697,12 +697,12 @@ router.post(
     if (!fv && field.type === "Key" && fieldview === "select")
       res.send("<select disabled></select>");
     else if (!fv) res.send("");
-    else if (fv.isEdit)
+    else if (fv.isEdit || fv.isFilter)
       res.send(
         fv.run(
           field.name,
           undefined,
-          { disabled: true, ...configuration },
+          { disabled: true, ...configuration, ...(field.attributes || {}) },
           "",
           false,
           field

package/routes/index.js

@@ -4,6 +4,43 @@
  * @module routes/index
  * @subcategory routes
  */
+
+/**
+ * All files in the routes module.
+ * @namespace routes_overview
+ * @property {module:routes/actions} actions
+ * @property {module:routes/admin} admin
+ * @property {module:routes/api} api
+ * @property {module:routes/config} config
+ * @property {module:routes/crashlog} crashlog
+ * @property {module:routes/delete} delete
+ * @property {module:routes/edit} edit
+ * @property {module:routes/eventlog} eventlog
+ * @property {module:routes/events} events
+ * @property {module:routes/fields} fields
+ * @property {module:routes/files} files
+ * @property {module:routes/homepage} homepage
+ * @property {module:routes/infoarch} infoarch
+ * @property {module:routes/library} library
+ * @property {module:routes/list} list
+ * @property {module:routes/menu} menu
+ * @property {module:routes/packs} packs
+ * @property {module:routes/page} page
+ * @property {module:routes/pageedit} pageedit
+ * @property {module:routes/plugins} plugins
+ * @property {module:routes/scapi} scapi
+ * @property {module:routes/search} search
+ * @property {module:routes/settings} settings
+ * @property {module:routes/tables} tables
+ * @property {module:routes/tenant} tenant
+ * @property {module:routes/utils} utils
+ * @property {module:routes/view} view
+ * @property {module:routes/viewedit} viewedit
+ * 
+ * @category server
+ * @subcategory routes
+ */
+
 const table = require("./tables");
 const field = require("./fields");
 const list = require("./list");

package/routes/view.js

@@ -68,7 +68,7 @@ router.get(
         what: req.__("View"),
         url: `/viewedit/edit/${encodeURIComponent(view.name)}`,
         contents,
-        req
+        req,
       })
     );
   })
@@ -92,18 +92,18 @@ router.post(
       res.send("");
       return;
     }
-    let query = {};
+    let query = req.body || {};
     let row;
     let table;
     const sfs = await view.get_state_fields();
     for (const sf of sfs) {
-      if (sf.required) {
+      if (sf.required && !query[sf.name]) {
         if (!row) {
           if (!table)
             table = await Table.findOne(view.table_id || view.exttable_name);
           row = await table.getRow({});
         }
-        if(row) query[sf.name] = row[sf.name];
+        if (row) query[sf.name] = row[sf.name];
       }
     }
     const contents = await view.run(query, { req, res });

package/serve.js

@@ -33,11 +33,14 @@ const { setTenant, getSessionStore } = require("./routes/utils");
 const passport = require("passport");
 const { authenticate } = require("passport");
 const View = require("@saltcorn/data/models/view");
+const {
+  listenForChanges,
+  getRelevantPackages,
+  getPluginDirectories,
+} = require("./restart_watcher");
 
 // helpful https://gist.github.com/jpoehls/2232358
-
 /**
- * @param {object} opts
  * @param {object} opts
  * @param {boolean} opts.disableMigrate
  * @param {boolean} [useClusterAdaptor = true]
@@ -146,6 +149,7 @@ module.exports =
    * @param {boolean} opts.watchReaper
    * @param {boolean} opts.disableScheduler
    * @param {number} opts.defaultNCPUs
+   * @param {boolean} opts.dev
    * @param {...*} opts.appargs
    * @returns {Promise<void>}
    */
@@ -154,8 +158,12 @@ module.exports =
     watchReaper,
     disableScheduler,
     defaultNCPUs,
+    dev,
     ...appargs
   } = {}) => {
+    if (dev && cluster.isMaster) {
+      listenForChanges(getRelevantPackages(), await getPluginDirectories());
+    }
     const useNCpus = process.env.SALTCORN_NWORKERS
       ? +process.env.SALTCORN_NWORKERS
       : defaultNCPUs;