Release CLI

config.js

@@ -14,7 +14,8 @@ export default {
     CROWDBOTICS_FILE: ".crowdbotics.json",
     COOKIECUTTER_PACKAGE: "cookiecutter==1.7.3",
     REACT_NATIVE_SCAFFOLD_REPO_ORIGIN:
-      "https://github.com/crowdbotics/react-native-scaffold"
+      "https://github.com/crowdbotics/react-native-scaffold",
+    DJANGO_SCAFFOLD_REPO_ORIGIN: "https://github.com/crowdbotics/django-scaffold"
   },
   scaffold: {
     directory: SCAFFOLD_DIRECTORY

index.js

@@ -28,7 +28,7 @@ import { info } from "./scripts/info.js";
 import { removeModules } from "./scripts/remove.js";
 import { commitModules } from "./scripts/commit-module.js";
 import { upgradeScaffold } from "./scripts/upgrade.js";
-import { valid, invalid, section, isUserEnvironment } from "./utils.js";
+import { valid, invalid, section, isUserEnvironment, isLoginNotReqCommand } from "./utils.js";
 import { createModule } from "./scripts/create.js";
 import { login } from "./scripts/login.js";
 import { configFile } from "./scripts/utils/configFile.js";
@@ -41,11 +41,20 @@ import {
   EnvironmentDependency
 } from "./scripts/utils/environment.js";
 import { analytics } from "./scripts/analytics/wrapper.js";
-import { HAS_ASKED_OPT_IN_NAME } from "./scripts/analytics/config.js";
+import {
+  HAS_ASKED_OPT_IN_NAME,
+  OPT_IN_NAME
+} from "./scripts/analytics/config.js";
 import { EVENT } from "./scripts/analytics/constants.js";
-import { askOptIn } from "./scripts/analytics/scripts.js";
+import { configureInitialLogin } from "./scripts/analytics/scripts.js";
 import { sentryMonitoring } from "./scripts/utils/sentry.js";
 import { setModuleDetails } from "./scripts/setModuleDetails.js";
+import { isUserLoggedIn } from "./scripts/utils/auth.js";
+import { logger, prettyPrintShellOutput } from "./scripts/utils/logger.js";
+
+const GLOBAL_ARGS = {
+  "--verbose": Boolean
+};
 
 const gitRoot = () => {
   try {
@@ -61,12 +70,19 @@ Visit our official documentation for more information and try again: https://doc
 async function dispatcher() {
   const useDefaults = process.env.npm_config_yes;
 
-  // check config if they have been asked opted in or out of amplitude
-  const hasAskedOptIn = configFile.get(HAS_ASKED_OPT_IN_NAME) || false;
-  if (!hasAskedOptIn && isUserEnvironment && !useDefaults) {
-    await askOptIn();
+  // check config if the inital login has been done
+  const isInitialLogin = configFile.get(HAS_ASKED_OPT_IN_NAME) || false;
+  if (!isInitialLogin && isUserEnvironment && !useDefaults) {
+    await configureInitialLogin();
   }
 
+  // Compulsory dependencies check on each command
+  // Note: This is a forced check, so no cache is used
+  // consider performance implications when adding new dependencies
+  validateEnvironmentDependencies([
+    EnvironmentDependency.CLI
+  ], true, false);
+
   const command = process.argv[2];
 
   if (!command) {
@@ -79,6 +95,13 @@ async function dispatcher() {
 
   sentryMonitoring.registerCommandName(command);
 
+  const isLoggedIn = isUserLoggedIn();
+
+  if (!isLoggedIn && !isLoginNotReqCommand(command)) {
+    section("We see you are not logged in. Please log in to run Crowdbotics commands");
+    await login();
+  }
+
   await commands[command]();
 
   if (!analytics.event.name && !useDefaults) {
@@ -93,16 +116,20 @@ async function dispatcher() {
 }
 
 const commands = {
-  demo: () => {
-    validateEnvironmentDependencies([
-      EnvironmentDependency.Python,
-      EnvironmentDependency.PipEnv
-    ]);
-    createDemo(path.join(gitRoot(), "demo"));
+  demo: async () => {
+    const args = arg({
+      ...GLOBAL_ARGS,
+      "--source": String
+    });
+
+    const { "--source": source = "master" } = args;
+
+    await createDemo(path.join(gitRoot(), "demo"), source);
     valid("demo app successfully generated");
   },
   parse: () => {
     const args = arg({
+      ...GLOBAL_ARGS,
       "--source": String,
       "--write": String
     });
@@ -130,6 +157,7 @@ const commands = {
     ]);
 
     const args = arg({
+      ...GLOBAL_ARGS,
       "--source": String,
       "--project": String
     });
@@ -143,6 +171,7 @@ const commands = {
     validateEnvironmentDependencies([EnvironmentDependency.Yarn]);
 
     const args = arg({
+      ...GLOBAL_ARGS,
       "--source": String,
       "--project": String
     });
@@ -153,12 +182,10 @@ const commands = {
     removeModules(modules, args["--source"], args["--project"], gitRoot());
   },
   create: () => {
-    validateEnvironmentDependencies([
-      EnvironmentDependency.Python,
-      EnvironmentDependency.CookieCutter
-    ]);
+    validateEnvironmentDependencies([EnvironmentDependency.Python]);
 
     const args = arg({
+      ...GLOBAL_ARGS,
       "--name": String,
       "--type": String,
       "--target": String,
@@ -182,6 +209,7 @@ const commands = {
   },
   commit: () => {
     const args = arg({
+      ...GLOBAL_ARGS,
       "--source": String
     });
     const modules = args._.slice(1);
@@ -194,12 +222,16 @@ const commands = {
     validateEnvironmentDependencies([EnvironmentDependency.Git]);
 
     const args = arg({
+      ...GLOBAL_ARGS,
       "--name": String
     });
     if (!args["--name"]) {
       invalid("missing required argument: --name");
     }
     const baseDir = path.join(process.cwd(), args["--name"]);
+
+    logger.verbose("init base dir", baseDir);
+
     const git = spawnSync("git init", [args["--name"]], {
       cwd: process.cwd(),
       shell: true
@@ -220,17 +252,23 @@ demo`;
     fs.mkdirSync(path.join(baseDir, "modules"));
     fs.writeFileSync(path.join(baseDir, ".gitignore"), gitignore, "utf8");
     fs.writeFileSync(path.join(baseDir, "modules", ".keep"), "", "utf8");
-    spawnSync("git add .gitignore modules", [], {
+    const gitAddResult = spawnSync("git add .gitignore modules", [], {
       cwd: baseDir,
       shell: true
     });
-    spawnSync("git commit -m 'Initial commit'", [], {
+
+    logger.verbose("init git add", prettyPrintShellOutput(gitAddResult));
+
+    const gitCommitResult = spawnSync("git commit -m 'Initial commit'", [], {
       cwd: baseDir,
       shell: true
     });
+
+    logger.verbose("init git commit", prettyPrintShellOutput(gitCommitResult));
   },
   upgrade: () => {
     const args = arg({
+      ...GLOBAL_ARGS,
       "--version": String
     });
     analytics.sendEvent({ name: EVENT.UPGRADE });
@@ -246,7 +284,9 @@ demo`;
     info();
   },
   config: () => {
-    const args = arg({});
+    const args = arg({
+      ...GLOBAL_ARGS
+    });
 
     const action = args._[1];
     const key = args._[2];
@@ -284,6 +324,7 @@ demo`;
 
   modules: async () => {
     const args = arg({
+      ...GLOBAL_ARGS,
       "--search": String,
       "--visibility": String,
       "--status": String,
@@ -336,7 +377,8 @@ demo`;
           );
         }
 
-        await setModuleDetails(id,
+        await setModuleDetails(
+          id,
           args["--name"],
           args["--description"],
           args["--acceptance-criteria"],
@@ -382,7 +424,9 @@ demo`;
   },
 
   feedback: () => {
-    const args = arg({});
+    const args = arg({
+      ...GLOBAL_ARGS
+    });
     const action = args._[1];
 
     if (!action) {
@@ -407,7 +451,24 @@ demo`;
         sendFeedback(action);
     }
   },
-
+  optout: () => {
+    if (!configFile.get(OPT_IN_NAME)) {
+      console.log("You are already opted out for analytics");
+      return;
+    }
+    configFile.set(OPT_IN_NAME, false);
+    configFile.save();
+    valid("Successfully opted out of analytics");
+  },
+  optin: () => {
+    if (configFile.get(OPT_IN_NAME)) {
+      console.log("You are already opted in for analytics");
+      return;
+    }
+    configFile.set(OPT_IN_NAME, true);
+    configFile.save();
+    valid("Successfully opted in of analytics");
+  },
   help: () => {
     console.log(`usage: cb <command>
 
@@ -429,6 +490,8 @@ Commands available:
   logout   Logout of your Crowdbotics account
   publish  Publish your modules to your organization's private catalog
   modules  Manage modules for your organization
+  optin    Opt in for Crowdbotics analytics
+  optout   Opt out for Crowdbotics analytics
 
 Parse and validate your modules:
   cb parse --source <path>
@@ -486,7 +549,11 @@ Glossary:
 };
 
 try {
-  dispatcher();
+  dispatcher().catch((error) => {
+    sentryMonitoring.captureException(error);
+    invalid(error);
+  });
 } catch (err) {
+  sentryMonitoring.captureException(err);
   invalid(err);
 }

package.json

@@ -50,7 +50,9 @@
     "js-yaml": "^4.1.0",
     "node-fetch": "^3.3.2",
     "ora": "^7.0.1",
-    "prettier": "^2.6.2"
+    "prettier": "^2.6.2",
+    "semver": "^7.6.0",
+    "unzip-stream": "^0.3.4"
   },
   "resolutions": {
     "shell-quote": "1.7.3"

scripts/add.js

@@ -3,6 +3,7 @@ import fse from "fs-extra";
 import path from "path";
 import find from "find";
 import { execSync } from "child_process";
+import { logger } from "./utils/logger.js";
 
 const IGNORED_ENTRIES = ["meta.json", "node_modules"];
 
@@ -25,12 +26,15 @@ const getPkgJsonDeps = (pkgJson) => {
 };
 
 function installPipPackage(file, moduleDir, appDir, metaRoot) {
+  logger.verbose("installing pip package", file, moduleDir);
+
   const packagePath = path
     .join(metaRoot, path.dirname(file).replace(moduleDir, ""))
     .replace(/^\/backend/, "");
 
   process.chdir(path.join(appDir, "backend"));
   const command = `pipenv install -e ./${packagePath}`;
+
   try {
     execSync(command);
   } catch (err) {
@@ -39,6 +43,8 @@ function installPipPackage(file, moduleDir, appDir, metaRoot) {
 }
 
 function installNpmPackage(file, moduleDir, appDir, metaRoot) {
+  logger.verbose("installing npm package", file, moduleDir);
+
   const pkgJson = JSON.parse(fs.readFileSync(file, "utf8"));
   const yarnPath = path.join(
     "file:.",
@@ -47,8 +53,11 @@ function installNpmPackage(file, moduleDir, appDir, metaRoot) {
   );
   const packages = [yarnPath, ...getPkgJsonDeps(pkgJson)].join(" ");
 
+  logger.verbose("installing npm packages", packages, yarnPath);
+
   process.chdir(appDir);
   const command = `yarn add ${packages}`;
+
   try {
     execSync(command);
   } catch (err) {
@@ -71,12 +80,20 @@ export function addModules(modules, source, dir, gitRoot) {
     dir = path.join(gitRoot, "demo");
   }
 
+  logger.verbose("add source", source, "dir", dir);
+
   modules.forEach((module) => {
     process.chdir(gitRoot);
     const originModuleDir = path.join(source, module);
+
+    logger.verbose("add module", module, originModuleDir);
+
     const meta = JSON.parse(
       fs.readFileSync(path.join(originModuleDir, "meta.json"), "utf8")
     );
+
+    logger.verbose("add module meta", meta);
+
     const targetModuleDir = path.join(dir, meta.root);
 
     // cleanup node_modules

scripts/analytics/config.js

@@ -5,8 +5,8 @@ import {
   PRODUCTION_SEGMENT_KEY
 } from "./constants.js";
 
-export const HAS_ASKED_OPT_IN_NAME = "has-asked-opt-in";
-export const OPT_IN_NAME = "opt-in";
+export const HAS_ASKED_OPT_IN_NAME = "has-asked-opt-in-default";
+export const OPT_IN_NAME = "opted-in-default";
 
 export const SEGMENT_API_KEY =
   configFile.get(HOST_CONFIG_NAME) === DEFAULT_HOST

scripts/analytics/scripts.js

@@ -1,25 +1,8 @@
-import inquirer from "inquirer";
-import { section } from "../../utils.js";
 import { configFile } from "../utils/configFile.js";
 import { HAS_ASKED_OPT_IN_NAME, OPT_IN_NAME } from "./config.js";
 
-export const askOptIn = async () => {
-  const { optInStatus } = await inquirer.prompt({
-    message: "Send diagnostics & usage to Crowdbotics (y/n):",
-    name: "optInStatus",
-    type: "input"
-  });
-
-  const optedIn = optInStatus.trim().toLowerCase() === "y";
-
-  if (!optedIn) {
-    section("Thanks for your response. We will not send diagnostics & usage.");
-    configFile.set(OPT_IN_NAME, false);
-  } else {
-    section("Thanks for your response. We will send diagnostics & usage.");
-    configFile.set(OPT_IN_NAME, true);
-  }
+export const configureInitialLogin = async () => {
+  configFile.set(OPT_IN_NAME, true);
   configFile.set(HAS_ASKED_OPT_IN_NAME, true);
   configFile.save();
-  return optedIn;
 };