@jacebenson/jsn 4.3.7-dev.22 → 4.3.7-dev.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jacebenson/jsn",
-  "version": "4.3.7-dev.22",
+  "version": "4.3.7-dev.24",
   "description": "A command-line interface for ServiceNow that follows the Unix philosophy: simple, composable, and scriptable.",
   "type": "module",
   "bin": {

package/src/commands/midservers.js

@@ -3,7 +3,7 @@ import { confirmDelete, formatRecordForDisplay, getStringField, interactiveList,
 import { FormatAuto } from '../output.js';
 import { declareCapabilities } from '../capabilities.js';
 import { resolveRecord, unwrapSysId } from '../resolve-record.js';
-import { dockerComposeAvailable, installDockerMidServer, validateMidCredentials } from '../midserver-install.js';
+import { detectDocker, installDockerMidServer, validateMidCredentials } from '../midserver-install.js';
 
 const AGENT_TABLE = 'ecc_agent';
 const QUEUE_TABLE = 'ecc_queue';
@@ -235,23 +235,30 @@ export function midserversCmd(wrap) {
             message: 'MID Server name:',
             validate: value => value.trim() ? true : 'MID Server name is required',
           })).trim();
-          const dockerAvailable = dockerComposeAvailable();
+          const dockerStatus = detectDocker();
+          const dockerAvailable = dockerStatus.available;
           const installMethod = argv['install-method'] || await select({
             message: dockerAvailable
-              ? 'Docker and Docker Compose detected. How should the MID Server be installed?'
-              : 'Docker was not detected. How should the MID Server be installed?',
+              ? 'Docker and Docker Compose are ready. How should the MID Server be installed?'
+              : dockerStatus.installed && dockerStatus.compose
+                ? 'Docker is installed, but this user cannot access the Docker daemon. How should the MID Server be installed?'
+                : 'Docker was not detected. How should the MID Server be installed?',
             choices: dockerAvailable
               ? [
                 { name: 'Docker (recommended)', value: 'docker' },
                 { name: 'Direct install (not available yet)', value: 'direct' },
               ]
+              : dockerStatus.installed && dockerStatus.compose
+                ? [
+                  { name: 'Prepare files now, run Docker later', value: 'prepare' },
+                  { name: 'Direct install (not available yet)', value: 'direct' },
+                ]
               : [
-                { name: 'Install Docker first', value: 'install-docker' },
+                { name: 'Prepare files now, run Docker later', value: 'prepare' },
                 { name: 'Direct install (not available yet)', value: 'direct' },
               ],
           });
           if (installMethod === 'direct') throw new Error('Direct MID Server installation is not implemented yet. Choose Docker.');
-          if (installMethod === 'install-docker') throw new Error('Automatic Docker installation is not implemented yet. Install Docker and Compose, then run this command again.');
 
           const installation = await installDockerMidServer({
             instanceURL: app.getEffectiveInstance(),
@@ -260,7 +267,12 @@ export function midserversCmd(wrap) {
             name,
             releaseName: credentials.releaseName,
             directory: argv.directory,
+            runNow: installMethod !== 'prepare',
           });
+          if (installation.prepared) {
+            app.ok(installation, { summary: `Prepared MID Server files in ${installation.installDir}. Run: ${installation.runCommand}` });
+            return;
+          }
           let record;
           try {
             record = await waitForMidServerUp(app, installation.name, Math.max(1, argv['wait-timeout']), Math.max(500, argv['wait-interval']));
@@ -277,14 +289,36 @@ export function midserversCmd(wrap) {
         }),
       })
       .command({
-        command: 'remove <identifier>',
+        command: 'remove [identifier]',
         aliases: ['delete'],
-        describe: 'Remove a MID Server record',
+        describe: 'Remove a MID Server record (interactive when no identifier is given)',
         builder: (b) => b.option('force', { type: 'boolean', default: false, describe: 'Skip confirmation' }),
         handler: wrap(async (argv, app) => {
-          const record = await resolveMidServer(app.sdk, argv.identifier);
+          let record;
+          if (argv.identifier) {
+            record = await resolveMidServer(app.sdk, argv.identifier);
+          } else {
+            if (!canPrompt() || app.output.getFormat() !== FormatAuto) {
+              throw new Error('An identifier is required outside an interactive terminal');
+            }
+            record = await interactiveList({
+              app,
+              table: AGENT_TABLE,
+              singular: 'MID Server',
+              columns: LIST_FIELDS,
+              limit: 50,
+              labelField: 'name',
+              message: 'Select a MID Server to remove',
+              formatLabel: (candidate) => {
+                const name = getStringField(candidate, 'name') || getStringField(candidate, 'sys_id');
+                const status = getStringField(candidate, 'status');
+                return status ? `${name} [${status}]` : name;
+              },
+            });
+            if (!record) return;
+          }
           const sysId = unwrapSysId(record);
-          const name = getStringField(record, 'name') || argv.identifier;
+          const name = getStringField(record, 'name') || argv.identifier || sysId;
           await confirmDelete(app, argv, `Remove MID Server '${name}'`);
           await app.sdk.delete(AGENT_TABLE, sysId);
           app.ok({ name, sys_id: sysId, deleted: true }, { summary: `Removed MID Server '${name}'` });

package/src/midserver-install.js

@@ -63,18 +63,30 @@ export async function validateMidCredentials(instanceURL, username, password, fe
   return { releaseName };
 }
 
+export function detectDocker(run = defaultRun) {
+  const status = { installed: false, compose: false, daemon: false, available: false };
+  try { run('docker', ['--version'], { stdio: 'ignore' }); status.installed = true; } catch { return status; }
+  try { run('docker', ['compose', 'version'], { stdio: 'ignore' }); status.compose = true; } catch { return status; }
+  try { run('docker', ['info'], { stdio: 'ignore' }); status.daemon = true; } catch { return status; }
+  status.available = true;
+  return status;
+}
+
 export function dockerComposeAvailable(run = defaultRun) {
-  try {
-    run('docker', ['info'], { stdio: 'ignore' });
-    run('docker', ['compose', 'version'], { stdio: 'ignore' });
-    return true;
-  } catch {
-    return false;
-  }
+  return detectDocker(run).available;
 }
 
 function composeFile({ serviceName }) {
-  return `services:\n  ${serviceName}:\n    container_name: ${serviceName}\n    image: ${serviceName}:\${MID_RELEASE}\n    restart: unless-stopped\n    volumes:\n      - ./export:/opt/snc_mid_server/agent/export\n    environment:\n      MID_INSTANCE_URL: \${MID_INSTANCE_URL}\n      MID_INSTANCE_USERNAME: \${MID_INSTANCE_USERNAME}\n      MID_INSTANCE_PASSWORD: \${MID_INSTANCE_PASSWORD}\n      MID_SERVER_NAME: \${MID_SERVER_NAME}\n`;
+  return `services:\n  ${serviceName}:\n    container_name: ${serviceName}\n    build: ./recipe\n    image: ${serviceName}:\${MID_RELEASE}\n    restart: unless-stopped\n    volumes:\n      - ./export:/opt/snc_mid_server/agent/export\n    environment:\n      MID_INSTANCE_URL: \${MID_INSTANCE_URL}\n      MID_INSTANCE_USERNAME: \${MID_INSTANCE_USERNAME}\n      MID_INSTANCE_PASSWORD: \${MID_INSTANCE_PASSWORD}\n      MID_SERVER_NAME: \${MID_SERVER_NAME}\n`;
+}
+
+function envFile({ instanceURL, username, password, displayName, releaseName }) {
+  return `MID_RELEASE=${releaseName}\nMID_INSTANCE_URL=${String(instanceURL).replace(/\/$/, '')}/\nMID_INSTANCE_USERNAME=${username}\nMID_INSTANCE_PASSWORD=${password}\nMID_SERVER_NAME=${displayName}\n`;
+}
+
+function instanceName(instanceURL) {
+  const hostname = new URL(instanceURL).hostname;
+  return hostname.replace(/\.service-now\.com$|\.servicenowservices\.com$/i, '').replace(/[^A-Za-z0-9._-]/g, '_');
 }
 
 export async function installDockerMidServer({
@@ -84,17 +96,17 @@ export async function installDockerMidServer({
   name,
   directory,
   releaseName: suppliedReleaseName,
+  runNow = true,
   fetchImpl = fetch,
   run = defaultRun,
 }) {
-  if (!dockerComposeAvailable(run)) {
-    throw new Error('Docker and Docker Compose are required for Docker MID Server installation');
-  }
+  const dockerAvailable = detectDocker(run).available;
   const shortName = normalizeMidName(name);
   const displayName = `mid.server.${shortName}`;
   const releaseName = suppliedReleaseName || (await validateMidCredentials(instanceURL, username, password, fetchImpl)).releaseName;
   const recipeURL = buildMidRecipeUrl(releaseName);
-  const installDir = directory || path.join(os.homedir(), '.local', 'share', 'jsn', 'midservers', shortName);
+  const serviceNowInstance = instanceName(instanceURL);
+  const installDir = directory || path.join(os.homedir(), '.servicenow', 'mids', serviceNowInstance, shortName);
   fs.mkdirSync(installDir, { recursive: true, mode: 0o700 });
   const exportDir = path.join(installDir, 'export');
   fs.mkdirSync(exportDir, { recursive: true, mode: 0o700 });
@@ -107,9 +119,8 @@ export async function installDockerMidServer({
     fs.mkdirSync(recipeDir, { recursive: true, mode: 0o700 });
     run('unzip', ['-q', archive, '-d', recipeDir]);
     const composePath = path.join(installDir, 'docker-compose.yaml');
+    const persistedRecipeDir = path.join(installDir, 'recipe');
     const serviceName = `jsn_mid_${shortName.replace(/[^A-Za-z0-9_.-]/g, '_')}`;
-    run('docker', ['build', '--tag', `${serviceName}:${releaseName}`, recipeDir]);
-    fs.writeFileSync(composePath, composeFile({ serviceName, instanceURL, displayName }), { mode: 0o600 });
     const env = {
       MID_RELEASE: releaseName,
       MID_INSTANCE_URL: `${String(instanceURL).replace(/\/$/, '')}/`,
@@ -117,6 +128,22 @@ export async function installDockerMidServer({
       MID_INSTANCE_PASSWORD: password,
       MID_SERVER_NAME: displayName,
     };
+    fs.rmSync(persistedRecipeDir, { recursive: true, force: true });
+    fs.cpSync(recipeDir, persistedRecipeDir, { recursive: true });
+    fs.writeFileSync(composePath, composeFile({ serviceName }), { mode: 0o600 });
+    fs.writeFileSync(path.join(installDir, '.env'), envFile({ instanceURL, username, password, displayName, releaseName }), { mode: 0o600 });
+    if (!dockerAvailable || !runNow) {
+      return {
+        name: displayName,
+        releaseName,
+        installDir,
+        composePath,
+        serviceName,
+        prepared: true,
+        runCommand: `docker compose -f ${composePath} up -d`,
+      };
+    }
+    run('docker', ['build', '--tag', `${serviceName}:${releaseName}`, persistedRecipeDir]);
     run('docker', ['compose', '-f', composePath, 'up', '-d'], { cwd: installDir, env });
     return {
       name: displayName,