@transitive-sdk/utils-caps 0.3.0 → 0.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transitive-sdk/utils-caps",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Utilities to build and run Transitive capabilities in dev",
   "homepage": "https://transitiverobotics.com",
   "repository": {
@@ -29,6 +29,7 @@
   },
   "dependencies": {
     "@transitive-sdk/utils": "^0.17.2",
-    "esbuild": "^0.28.0"
+    "esbuild": "^0.28.0",
+    "shelljs": "^0.10.0"
   }
 }

package/subScript

@@ -1,62 +1,110 @@
-#!/bin/bash
-
-# This file gets updated by @transitive-sdk/utils-caps. Do not modify!
-
-# Use this script in your wrapper package's script to relay invokation to scripts
-# in the correct subproject.
-
-# Define a mapping from lifecycle events to scripts in sub-project. Note that
-# we *don't* want to map preinstall to preinstall, since in the subproject
-# preinstall will already be executed when running install. Instead we create
-# new script names, preall and postall, that will run before *anything* happens
-# in the subproject, and in particular before npm dependencies are installed.
-declare -A subscripts
-subscripts["preinstall"]="preall"
-subscripts["postinstall"]="postall"
-
-# Known npm command that should be invoked without `run`
-declare -A npmCommands
-npmCommands["install"]=1
-npmCommands["update"]=1
-npmCommands["rebuild"]=1
-
-SUBSCRIPT=${subscripts[$npm_lifecycle_event]:-$npm_lifecycle_event}
-
-if [[ $TRANSITIVE_IS_ROBOT ]]; then
-  SUBPROJECT=robot
-elif [[ $TRANSITIVE_IS_CLOUD ]]; then
-  SUBPROJECT=cloud
-fi;
-
-if [[ $SUBPROJECT ]]; then
-  PREFIX="--prefix $SUBPROJECT"
-else
-  PREFIX=
-fi;
-
-if [[ $SUBSCRIPT == "start" ]]; then
-  # ensure dependencies are installed
-  if [[ $SUBPROJECT ]]; then
-    rm -rf $SUBPROJECT/node_modules/.*-* $SUBPROJECT/node_modules/@*/.*-*
-  fi;
-  npm $PREFIX ls || FORCE_COLOR=0 npm $PREFIX update
-fi;
-
-if [[ $SUBPROJECT ]]; then
-  if [[ ${npmCommands[$npm_lifecycle_event]} ]]; then
-    echo "Invoking $npm_lifecycle_event in $SUBPROJECT"
-
-    if [[ $npm_command == "ci" ]] && [[ $npm_lifecycle_event == "install" ]]; then
-      echo "ci: Removing $SUBPROJECT/node_modules"
-      rm -rf $SUBPROJECT/node_modules
-    fi;
-
-    FORCE_COLOR=0 npm $PREFIX $npm_lifecycle_event
-  else
-    echo "Invoking $SUBSCRIPT in $SUBPROJECT"
-    npm $PREFIX run --if-present $SUBSCRIPT
-  fi;
-else
-  echo "Invoking dev:$SUBSCRIPT"
-  npm run --if-present dev:$SUBSCRIPT
-fi;
+#!/usr/bin/env node
+
+// This file gets updated by @transitive-sdk/utils-caps. Do not modify!
+
+// Use this script in your wrapper package's script to relay invocation to
+// scripts in the correct subproject.
+
+const path = require('path');
+const { spawnSync } = require('child_process');
+const sh = require('shelljs');
+
+sh.config.silent = false; // let npm's own output through
+
+const subProject =
+  process.env.TRANSITIVE_IS_ROBOT ? 'robot'
+  : (process.env.TRANSITIVE_IS_CLOUD ? 'cloud' : undefined);
+
+const npmLifecycleEvent = process.env.npm_lifecycle_event;
+
+/* Define a mapping from lifecycle events to scripts in sub-project. Note that
+we *don't* want to map preinstall to preinstall, since in the subproject
+preinstall will already be executed when running install. Instead we create
+new script names, preall and postall, that will run before *anything* happens
+in the subproject, and in particular before npm dependencies are installed. */
+const subscripts = {
+  preinstall: 'preall',
+  postinstall: 'postall',
+};
+
+const subscript = subscripts[npmLifecycleEvent] || npmLifecycleEvent;
+
+// folder where robot dependencies are cached between installs/upgrades
+const cacheDir =
+  path.join(process.env.npm_config_local_prefix, '.robot_node_modules')
+
+// Hooks to run on robot before the respective commands
+const robotHooks = {
+  install: () => {
+    if (process.env.npm_command === 'ci') {
+      console.log(`ci: Removing ${subProject}/node_modules`);
+      sh.rm('-rf', path.join(subProject, 'node_modules'));
+    }
+  },
+  start: () => {
+    if (!subProject) return;
+
+    // ensure dependencies are installed before starting
+    /* Remove stale .*-* in `node_modules` and `node_modules/@*` */
+    sh.rm('-rf', `${subProject}/node_modules/.*-*`);
+    sh.rm('-rf', `${subProject}/node_modules/@*/.*-*`);
+    npm('ls', {subProject}) == 0 || npm('update', {subProject});
+  },
+  // --- for caching
+  postinstall: () => {
+    console.log('Caching node_modules');
+    sh.rm('-rf', cacheDir);
+    sh.cp('-R', 'robot/node_modules', cacheDir);
+  },
+  preinstall: () => {
+    if (sh.test('-d', cacheDir)) {
+      console.log('Restoring cached node_modules');
+      sh.rm('-rf', 'robot/node_modules');
+      sh.mv(cacheDir, 'robot/node_modules');
+    }
+  }
+  // ---
+}
+
+/** Run npm command, in subProject if given */
+const npm = (cmd, {env = {}, subProject = undefined} = {}) => {
+  console.log(`Invoking ${cmd} ${subProject ? `in ${subProject}` : ''}`);
+
+  const args = [];
+  subProject && args.push('--prefix', subProject);
+
+  if (['install', 'update', 'rebuild', 'ls'].includes(cmd)) {
+    // It's a known npm command that should be invoked without `run`
+    env.FORCE_COLOR = '0'; // force no ascii colors (can lead to crashes in gyp)
+  } else {
+    args.push('run', '--if-present');
+  }
+
+  args.push(cmd);
+
+  // sh.exec can't start tmux (not a terminal); using spawn instead
+  const result = spawnSync('npm', args,
+    { env: {...process.env, ...env},
+      stdio: 'inherit'
+    });
+  return result.status;
+}
+
+
+// --- main --------------------------------------------------------------
+
+let exitCode = 0;
+
+if (!subProject) {
+  exitCode = npm(`dev:${npmLifecycleEvent}`);
+  process.exit(exitCode);
+}
+
+// -------------
+// We are calling a command in a sub project (robot or cloud)
+
+process.env.TRANSITIVE_IS_ROBOT &&
+  robotHooks[npmLifecycleEvent]?.();
+
+exitCode = npm(subscript, {subProject});
+process.exit(exitCode);