@saltcorn/cli 0.7.2-beta.5 → 0.7.2-beta.9

package/src/commands/delete-tenants.js

@@ -27,27 +27,31 @@ class DeleteTenantsCommand extends Command {
 
     for (const ten of tensExamine) {
       let nusers, ntables, nviews, npages;
-      await db.runWithTenant(ten.subdomain, async () => {
-        nusers = await db.count("users");
-        ntables = await db.count("_sc_tables");
-        nviews = await db.count("_sc_views");
-        npages = await db.count("_sc_pages");
-      });
-      if (nusers < 2 && ntables < 2 && nviews < 1 && npages < 1) {
-        console.log("deleting ", ten.subdomain, {
-          nusers,
-          ntables,
-          nviews,
-          npages,
-        });
-        await deleteTenant(ten.subdomain);
-      } else {
-        console.log("leaving", ten.subdomain, {
-          nusers,
-          ntables,
-          nviews,
-          npages,
+      try {
+        await db.runWithTenant(ten.subdomain, async () => {
+          nusers = await db.count("users");
+          ntables = await db.count("_sc_tables");
+          nviews = await db.count("_sc_views");
+          npages = await db.count("_sc_pages");
         });
+        if (nusers < 2 && ntables < 2 && nviews < 1 && npages < 1) {
+          console.log("deleting ", ten.subdomain, {
+            nusers,
+            ntables,
+            nviews,
+            npages,
+          });
+          await deleteTenant(ten.subdomain);
+        } else {
+          console.log("leaving", ten.subdomain, {
+            nusers,
+            ntables,
+            nviews,
+            npages,
+          });
+        }
+      } catch (e) {
+        console.error("Error in tenant", ten.subdomain, e);
       }
     }
     this.exit(0);

package/src/commands/delete-user.js

@@ -0,0 +1,105 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/delete-user
+ */
+
+// todo support for  users without emails (using user.id)
+const { Command, flags } = require("@oclif/command");
+const { cli } = require("cli-ux");
+const { maybe_as_tenant } = require("../common");
+
+
+/**
+ * DeleteUserCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
+class DeleteUserCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
+  async run() {
+
+    const User = require("@saltcorn/data/models/user");
+
+    const { args } = this.parse(DeleteUserCommand);
+    const { flags } = this.parse(DeleteUserCommand);
+
+
+    // run function as specified tenant
+    await maybe_as_tenant(flags.tenant, async () => {
+        // try to find user
+        const u = await User.findOne({email: args.user_email});
+        if (u === null) {
+          console.error(`Error: User ${args.user_email} is not found`);
+          this.exit(1);
+        }
+        if (!u instanceof User) {
+          console.error(`Error: ${u.error}`);
+          this.exit(1);
+        }
+
+        // make changes
+        // todo handle errors
+        if (!flags.force) {
+          const ans = await cli.confirm(
+            `This will delete user ${args.user_email} ${
+              typeof flags.tenant !== "undefined" ? "from " + flags.tenant : ""
+            }.\nContinue (y/n)?`);
+          if (!ans) {
+            console.log(`Success: Command execution canceled`);
+            this.exit(1);
+          }
+
+        }
+
+        // delete user
+        await u.delete();
+        console.log(`Success: User ${args.user_email} deleted  ${
+          typeof flags.tenant !== "undefined" ? "from " + flags.tenant : ""
+          }`);
+
+      }
+
+    );
+    this.exit(0);
+  }
+}
+
+/**
+ * @type {object}
+ */
+DeleteUserCommand.args = [
+  { name: "user_email", required: true, description: "User to delete" },
+];
+
+/**
+ * @type {string}
+ */
+DeleteUserCommand.description = `Delete user.
+
+Command deletes the user specified by USER_EMAIL.
+
+`;
+
+/**
+ * @type {string}
+ */
+DeleteUserCommand.help = `Delete user.
+
+Command deletes the user specified by USER_EMAIL.
+
+`;
+
+/**
+ * @type {object}
+ */
+DeleteUserCommand.flags = {
+  force: flags.boolean({ char: "f", description: "force command execution" }),
+  tenant: flags.string({
+    char: "t",
+    description: "tenant",
+  }),
+};
+
+module.exports = DeleteUserCommand;

package/src/commands/modify-user.js

@@ -0,0 +1,163 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/modify-user
+ */
+
+// todo support for  users without emails (using user.id)
+const { Command, flags } = require("@oclif/command");
+const { cli } = require("cli-ux");
+const { maybe_as_tenant, init_some_tenants } = require("../common");
+
+
+/**
+ * ModifyUserCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
+class ModifyUserCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
+  async run() {
+
+    const User = require("@saltcorn/data/models/user");
+
+    const { args } = this.parse(ModifyUserCommand);
+    const { flags } = this.parse(ModifyUserCommand);
+
+    if (flags.admin && flags.role && flags.role !== "admin") {
+      console.error("Error: specify at most one of admin and role");
+      this.exit(1);
+    }
+
+    // init tenant
+    await init_some_tenants(flags.tenant);
+
+    // run function as specified tenant
+    await maybe_as_tenant(flags.tenant, async () => {
+      // role_id
+      let role_id; // = flags.admin ? 1 : 8;
+      if (flags.admin) role_id = 1;
+      else if (flags.role) {
+        const roles = await User.get_roles();
+        const role = roles.find((r) => r.role === flags.role);
+        if (!role) {
+          console.error(`Error: role ${flags.role} not found`);
+          this.exit(1);
+        }
+        role_id = role.id;
+      }
+      // email
+      let email;
+      if (flags.email) email = flags.email;
+      else if (flags.imode) email = await cli.prompt("New Email address", { default : args.user_email });
+      if(email === args.user_email) email = undefined; // little trick - we won't update email if it already same
+      if (email)
+        if (!User.valid_email(email)){
+          console.error(`Error: Email is invalid`);
+          this.exit(1);
+        }
+
+      // password
+      // todo check for repeated passwords
+      let password;
+      if (flags.password) password = flags.password;
+      else if (flags.imode) password = await cli.prompt("New Password", { type: "hide" });
+      if (password)
+        if (User.unacceptable_password_reason(password)){
+          console.error(`Error: ${User.unacceptable_password_reason(password)}`);
+          this.exit(1);
+        }
+      // check that user with new email does not exists
+      const u_new_email = await User.findOne({ email });
+      if(u_new_email !== null&&args.user_email!==email){
+        console.error(`Error: Cannot change email from ${args.user_email} to ${email}. User with email ${email} exists`);
+        this.exit(1);
+      }
+      // try to find user
+      const u = await User.findOne({ email: args.user_email });
+      if(u === null){
+        console.error(`Error: User ${args.user_email} is not found`);
+        this.exit(1);
+      }
+      if(!u instanceof User){
+        console.error(`Error: ${u.error}`);
+        this.exit(1);
+      }
+
+      // make changes
+      if (email && role_id)
+        await u.update({ email, role_id });
+      else if(email)
+        await u.update({ email });
+      else if(role_id)
+        await u.update({ role_id });
+
+      if (password)
+        await u.changePasswordTo(password, false);
+
+      console.log(`Success: User ${email?email:args.user_email} updated successfully ${
+          typeof flags.tenant !== "undefined" ? "in tenant " + flags.tenant : ""
+        }`);
+
+    });
+    this.exit(0);
+  }
+}
+
+/**
+ * @type {object}
+ */
+ModifyUserCommand.args = [
+  { name: "user_email", required: true, description: "User to modify" },
+];
+
+/**
+ * @type {string}
+ */
+ModifyUserCommand.description = `Modify (update) user.
+
+Command changes the user specified by USER_EMAIL.
+
+You can change the user group, password and email.
+
+NOTE that -a and -r role (--role=role) can give conflict.
+`;
+
+/**
+ * @type {string}
+ */
+ModifyUserCommand.help = `Modify (update) user.
+
+Command changes the user specified by USER_EMAIL.
+
+You can change the user group, password and email.
+
+NOTE that -a and -r role (--role=role) can give conflict.
+`;
+
+/**
+ * @type {object}
+ */
+ModifyUserCommand.flags = {
+  admin: flags.boolean({ char: "a", description: "make user be Admin" }),
+  tenant: flags.string({
+    char: "t",
+    description: "tenant",
+  }),
+  email: flags.string({
+    char: "e",
+    description: "new email",
+  }),
+  role: flags.string({
+    char: "r",
+    description: "new role (can conflict with -a option)",
+  }),
+  password: flags.string({
+    char: "p",
+    description: "new password",
+  }),
+  imode: flags.boolean({ char: "i", description: "interactive mode" }),
+};
+
+module.exports = ModifyUserCommand;

package/src/commands/release.js

@@ -39,29 +39,37 @@ class ReleaseCommand extends Command {
       //"saltcorn-cli", publish: true},
       "@saltcorn/markup": { dir: "saltcorn-markup", publish: true },
       "@saltcorn/mobile-app": { dir: "saltcorn-mobile-app", publish: true },
-      "@saltcorn/mobile-builder": { dir: "saltcorn-mobile-builder", publish: true },
+      "@saltcorn/mobile-builder": {
+        dir: "saltcorn-mobile-builder",
+        publish: true,
+      },
       "@saltcorn/sbadmin2": { dir: "saltcorn-sbadmin2", publish: true },
     };
 
+    const updateDependencies = (json, dpkgnm, version) => {
+      if (json.dependencies && json.dependencies[dpkgnm])
+        json.dependencies[dpkgnm] = version;
+      if (json.devDependencies && json.devDependencies[dpkgnm])
+        json.devDependencies[dpkgnm] = version;
+      if (json.optionalDependencies && json.optionalDependencies[dpkgnm])
+        json.optionalDependencies[dpkgnm] = version;
+    };
+
     const updatePkgJson = (dir) => {
       const json = require(`../../../${dir}/package.json`);
       json.version = version;
       if (json.dependencies || json.devDependencies)
         Object.keys(pkgs).forEach((dpkgnm) => {
-          if (json.dependencies && json.dependencies[dpkgnm])
-            json.dependencies[dpkgnm] = version;
-          if (json.devDependencies && json.devDependencies[dpkgnm])
-            json.devDependencies[dpkgnm] = version;
-          if (json.optionalDependencies && json.optionalDependencies[dpkgnm])
-            json.optionalDependencies[dpkgnm] = version;
+          updateDependencies(json, dpkgnm, version);
         });
+      updateDependencies(json, "@saltcorn/cli", version);
       fs.writeFileSync(
         `packages/${dir}/package.json`,
         JSON.stringify(json, null, 2)
       );
     };
     const compileTsFiles = () => {
-      spawnSync("npm", ["install","--legacy-peer-deps"], {
+      spawnSync("npm", ["install", "--legacy-peer-deps"], {
         stdio: "inherit",
         cwd: ".",
       });

package/src/commands/reset-schema.js

@@ -17,7 +17,7 @@ class ResetCommand extends Command {
    */
   async run() {
     const reset = require("@saltcorn/data/db/reset_schema");
-    const db = require("@saltcorn/data/db/");
+    const db = require("@saltcorn/data/db");
     const { flags } = this.parse(ResetCommand);
     await maybe_as_tenant(flags.tenant, async () => {
       const schema = db.getTenantSchema();
@@ -32,6 +32,7 @@ class ResetCommand extends Command {
         if (ans) await reset(false, schema);
       }
     });
+    console.log(`Success: Command execution successfully`);
     this.exit(0);
   }
 }
@@ -44,11 +45,19 @@ ResetCommand.description = `Reset the database
 This will delete all existing information
 `;
 
+/**
+ * @type {string}
+ */
+ResetCommand.help = `Reset the database
+...
+This will delete all existing information
+`;
+
 /**
  * @type {object}
  */
 ResetCommand.flags = {
-  force: flags.boolean({ char: "f", description: "force" }),
+  force: flags.boolean({ char: "f", description: "force command execution" }),
   tenant: flags.string({
     char: "t",
     description: "tenant",

package/src/commands/restore.js

@@ -91,6 +91,11 @@ RestoreCommand.args = [
  */
 RestoreCommand.description = `Restore a previously backed up database (zip or sqlc format)`;
 
+/**
+ * @type {string}
+ */
+RestoreCommand.help = `Restore a previously backed up database (zip or sqlc format)`;
+
 /**
  * @type {object}
  */

package/src/commands/rm-tenant.js

@@ -3,6 +3,7 @@
  * @module commands/rm-tenant
  */
 const { Command, flags } = require("@oclif/command");
+const {cli} = require("cli-ux");
 
 /**
  * RmTenantCommand Class
@@ -14,9 +15,23 @@ class RmTenantCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { args } = this.parse(RmTenantCommand);
+
+
+    const { flags } = this.parse(RmTenantCommand);
+
     const { deleteTenant } = require("@saltcorn/admin-models/models/tenant");
-    await deleteTenant(args.tenant);
+
+    if (!flags.force) {
+      const ans = await cli.confirm(
+        `This will delete tenant ${flags.tenant}. Attention! All tenant data will be lost!\nContinue (y/n)?`);
+      if (!ans) {
+        console.log(`Success: Command execution canceled`);
+        this.exit(1);
+      }
+    }
+    // make changes
+    await deleteTenant(flags.tenant);
+
     this.exit(0);
   }
 }
@@ -24,18 +39,36 @@ class RmTenantCommand extends Command {
 /**
  * @type {object}
  */
-RmTenantCommand.args = [
+RmTenantCommand.args = []; /*[
   { name: "tenant", required: true, description: "Tenant to remove" },
 ];
-
+*/
 /**
  * @type {string}
  */
-RmTenantCommand.description = `Remove a tenant`;
+RmTenantCommand.description = `Remove a tenant.
+Attention! All tenant data will be lost!
+It recommended to make backup of tenant before perform this command.
+`;
+
+/**
+ * @type {object}
+ */
+RmTenantCommand.help = `Remove a tenant.
+Attention! All tenant data will be lost!
+It recommended to make backup of tenant before perform this command.
+`;
 
 /**
  * @type {object}
  */
-RmTenantCommand.flags = {};
+RmTenantCommand.flags = {
+  force: flags.boolean({ char: "f", description: "force command execution" }),
+  tenant: flags.string({
+    char: "t",
+    description: "tenant",
+    required: true,
+  }),
+};
 
 module.exports = RmTenantCommand;

package/src/commands/run-tests.js

@@ -156,11 +156,12 @@ class RunTestsCommand extends Command {
       const cwd = "packages/" + args.package;
       await this.do_test("npm", ["run", "test", ...jestParams], env, cwd);
     } else {
-      const lerna = process.platform === "win32" ? "lerna.cmd" : "lerna";
+      const cwd = ".";
       await this.do_test(
-        lerna,
-        ["run", "test", "--stream", ...jestParams],
-        env
+        "npm",
+        ["--workspaces", "run", "test", ...jestParams],
+        env,
+        cwd
       );
       //await this.e2etest(env);
     }

package/src/commands/setup.js

@@ -1,4 +1,5 @@
 /**
+ * Set up new saltcorn configuration
  * @category saltcorn-cli
  * @module commands/setup
  */
@@ -20,20 +21,25 @@ const sudo = require("sudo");
 const crypto = require("crypto");
 
 /**
- *
+ * Generate password for user
  * @returns {string}
  */
+// todo deduplicate code - the same function in User
 const gen_password = () => {
   const s = is.str.generate().replace(" ", "");
   if (s.length > 7) return s;
   else return gen_password();
 };
-
+/**
+ * Generate jwt secret
+ * @returns {string}
+ */
 const genJwtSecret = () => {
   return crypto.randomBytes(64).toString("hex");
 };
 
 /**
+ * Ask for platform run mode (dev - run manually, server - run as system service)
  *
  * @returns {Promise<object>}
  */
@@ -63,7 +69,7 @@ const askDevServer = async () => {
 };
 
 /**
- *
+ * Unload module
  * @param {*} mod
  */
 const unloadModule = (mod) => {
@@ -72,6 +78,7 @@ const unloadModule = (mod) => {
 };
 
 /**
+ * Set up platform run mode (dev - run manually, server - run as system service)
  * @returns {Promise<void>}
  */
 const setupDevMode = async () => {
@@ -95,6 +102,8 @@ const setupDevMode = async () => {
 };
 
 /**
+ * Check for locally running database (ip 127.0.0.1, port 5432)
+ *
  * @returns {Promise<void>}
  */
 const check_db = async () => {
@@ -125,7 +134,7 @@ const check_db = async () => {
 };
 
 /**
- *
+ * Execute Linux commands
  * @param {*} args
  * @returns {Promise<void>}
  */
@@ -146,7 +155,7 @@ const asyncSudo = (args) => {
 };
 
 /**
- *
+ * Execute Postgres commands
  * @param {*} args
  * @returns {Promise<void>}
  */
@@ -155,7 +164,7 @@ const asyncSudoPostgres = (args) => {
 };
 
 /**
- *
+ * Ask for passworf
  * @param {string} for_who
  * @returns {Promise<string>}
  */
@@ -173,6 +182,7 @@ const get_password = async (for_who) => {
 };
 
 /**
+ * Install Database
  * @returns {Promise<void>}
  */
 const install_db = async () => {
@@ -228,7 +238,7 @@ const install_db = async () => {
 };
 
 /**
- *
+ * Ask for Database parameters
  * @returns {Promise<object>}
  */
 const prompt_connection = async () => {
@@ -262,6 +272,7 @@ const prompt_connection = async () => {
 };
 
 /**
+ * Write platform config
  * @returns {Promise<void>}
  */
 const setup_connection_config = async () => {
@@ -310,10 +321,10 @@ const setup_connection = async () => {
  * @returns {Promise<boolean>}
  */
 const table_exists = async (db, tblname) => {
-  const { rows } = await db.query(`SELECT EXISTS 
+  const { rows } = await db.query(`SELECT EXISTS
     (
         SELECT 1
-        FROM information_schema.tables 
+        FROM information_schema.tables
         WHERE table_schema = 'public'
         AND table_name = '${tblname}'
     );`);
@@ -381,7 +392,7 @@ class SetupCommand extends Command {
  */
 SetupCommand.description = `Set up a new system
 ...
-This will attempt to install or connect a database, and set up a 
+This will attempt to install or connect a database, and set up a
 configuration file
 `;
 

package/src/common.js

@@ -2,10 +2,11 @@
  * @category saltcorn-cli
  * @module common
  */
-
+// todo need to be reorganized
 /**
- * @param {object} ten
- * @param {function} f
+ * Execute function for specified tenant
+ * @param {object} ten - specified tenant
+ * @param {function} f  - function
  * @returns {Promise<void>}
  */
 const maybe_as_tenant = async (ten, f) => {
@@ -13,7 +14,11 @@ const maybe_as_tenant = async (ten, f) => {
   const db = require("@saltcorn/data/db");
   return await db.runWithTenant(ten, f);
 };
-
+/**
+ * Init specified tenant
+ * @param tenant - specified tenant
+ * @returns {Promise<void>}
+ */
 const init_some_tenants = async (tenant) => {
   const { loadAllPlugins } = require("@saltcorn/server/load_plugins");
   const { init_multi_tenant } = require("@saltcorn/data/db/state");
@@ -24,6 +29,7 @@ const init_some_tenants = async (tenant) => {
 };
 
 /**
+ * parse JSON or String
  * @param {string} s
  * @returns {object}
  */
@@ -36,12 +42,14 @@ const parseJSONorString = (s) => {
 };
 
 /**
- * @param {numer} ms
+ * Sleep ms miliseconds
+ * @param {number} ms
  * @returns {Promise<void>}
  */
 function sleep(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
+
 module.exports = {
   maybe_as_tenant,
   parseJSONorString,