@alwaysai/device-agent 1.3.1 → 1.4.0

package/src/secure-tunneling/spawner-detached.ts

@@ -0,0 +1,123 @@
+import { ChildProcess, spawn } from 'child_process';
+import { JsSpawner } from 'alwaysai/lib/util';
+import { logger } from '../util/logger';
+
+const DEFAULT_TIMEOUT_MS = 5000;
+
+export async function runDetachedProcess(
+  command: string,
+  args: string[],
+  timeoutMs = DEFAULT_TIMEOUT_MS
+): Promise<ChildProcess> {
+  logger.debug('-> runDetachedProcess');
+
+  let isSpawned = false; // Flag to indicate if process has been successfully spawned
+
+  const child = spawn(command, args, {
+    detached: true,
+    stdio: 'ignore'
+  });
+
+  child.unref();
+
+  // Create a promise that resolves after the specified timeout
+  const timeoutPromise = new Promise<ChildProcess>((resolve, reject) => {
+    setTimeout(() => {
+      if (!isSpawned) {
+        logger.error('Timeout spawning off detached process');
+        resolve(child); // Resolve the promise with the child process even if timeout occurs
+      }
+    }, timeoutMs);
+  });
+
+  // Handle 'spawn' event
+  child.once('spawn', () => {
+    isSpawned = true;
+  });
+
+  // Race between the actual process spawning and the timeout
+  await Promise.race([
+    new Promise<ChildProcess>((resolve) => {
+      if (isSpawned) {
+        resolve(child); // Resolve immediately if process has already been spawned
+      } else {
+        child.once('spawn', () => resolve(child));
+      }
+    }),
+    timeoutPromise
+  ]);
+
+  logger.debug('<- runDetachedProcess');
+  return child;
+}
+
+export async function killDetachedProcess(
+  detachedProcess: ChildProcess,
+  processName?: string[],
+  timeoutMs = DEFAULT_TIMEOUT_MS
+): Promise<void> {
+  logger.debug('-> killDetachedProcess');
+  return new Promise<void>((resolve, reject) => {
+    const timeout = setTimeout(() => {
+      if (processName) {
+        killDetachedProcessByName(processName, timeoutMs)
+          .then(() => resolve())
+          .catch((err) => reject(err));
+      } else {
+        reject(new Error('killDetachedProcess timeout'));
+      }
+    }, timeoutMs);
+
+    detachedProcess.on('exit', (code) => {
+      clearTimeout(timeout);
+      logger.debug(`Process exited with code ${code}`);
+      resolve();
+    });
+
+    detachedProcess.on('error', (error) => {
+      clearTimeout(timeout);
+      if (processName) {
+        killDetachedProcessByName(processName, timeoutMs)
+          .then(() => resolve())
+          .catch((err) => reject(err));
+      } else {
+        logger.error('killDetachedProcess error occurred:', error);
+        reject(error);
+      }
+    });
+
+    detachedProcess.kill('SIGTERM');
+    logger.debug('<- killDetachedProcess');
+  });
+}
+
+export async function killDetachedProcessByName(
+  processName: string[],
+  timeoutMs = DEFAULT_TIMEOUT_MS
+): Promise<void> {
+  logger.debug('-> killDetachedProcessByName');
+  return new Promise<void>((resolve, reject) => {
+    const timeout = setTimeout(() => {
+      logger.error('Timeout waiting for process kill by name');
+      reject(new Error('killDetachedProcessByName timeout'));
+    }, timeoutMs);
+
+    JsSpawner()
+      .run({
+        exe: 'pkill',
+        args: processName
+      })
+      .then(() => {
+        clearTimeout(timeout);
+        resolve();
+      })
+      .catch((error) => {
+        clearTimeout(timeout);
+        logger.error('killDetachedProcessByName error occurred:', error);
+        reject(error);
+      })
+      .finally(() => {
+        logger.debug('<- killDetachedProcessByName');
+      });
+  });
+}

package/src/subcommands/app/analytics.ts

@@ -9,6 +9,10 @@ import { DeviceAgentCloudConnection } from '../../cloud-connection/device-agent-
 import sleep from '../../util/sleep';
 import { logger } from '../../util/logger';
 import { assign, merge } from 'lodash';
+import {
+  buildUpdateProjectShadowMessage,
+  getShadowTopic
+} from '@alwaysai/device-agent-schemas';
 
 export const getAnalyticsCfgCliLeaf = CliLeaf({
   name: 'get-analytics-cfg',
@@ -73,21 +77,20 @@ export const setAnalyticsCfgCliLeaf = CliLeaf({
     const appCfg = assign(existingAppCfg, merge(existingAppCfg, newAppCfg));
 
     // Update the shadow as a client
-    const topic = deviceAgent.getShadowTopics().projects.update;
-    const packet = {
-      state: {
-        desired: {
-          [project]: {
-            appConfig: JSON.stringify(appCfg) // Pack app config as string as dictated by schema
-          }
-        }
-      },
-      clientToken: 'client'
+    const toDesire = {
+      [project]: {
+        appConfig: JSON.stringify(appCfg) // Pack app config as string as dictated by schema
+      }
     };
-    logger.debug(
-      `Publishing message:\n${JSON.stringify({ topic, packet }, null, 2)}`
+    deviceAgent.publisher.publish(
+      getShadowTopic(deviceAgent.getClientId(), 'projects', 'update'),
+      JSON.stringify(
+        buildUpdateProjectShadowMessage({
+          clientId: 'client',
+          desired: toDesire
+        })
+      )
     );
-    deviceAgent.publisher.publish(topic, JSON.stringify(packet));
     // Sleep for extra time to ensure time for shadow response
     await sleep(10000);
 

package/src/subcommands/app/env-vars.ts

@@ -8,6 +8,10 @@ import { EnvVars, getAllEnvs } from '../../application-control';
 import { DeviceAgentCloudConnection } from '../../cloud-connection/device-agent-cloud-connection';
 import sleep from '../../util/sleep';
 import { logger } from '../../util/logger';
+import {
+  buildUpdateProjectShadowMessage,
+  getShadowTopic
+} from '@alwaysai/device-agent-schemas';
 
 export const getAllEnvsCliLeaf = CliLeaf({
   name: 'get-all-envs',
@@ -43,7 +47,7 @@ export const setEnvCliLeaf = CliLeaf({
     })
   },
   async action(args, opts) {
-    const { project, service } = opts;
+    const { project: projectId, service } = opts;
     const envVars: EnvVars = { [service]: {} };
     args.forEach((arg: string) => {
       const nameVal = arg.split('=');
@@ -56,26 +60,24 @@ export const setEnvCliLeaf = CliLeaf({
     const deviceAgent = new DeviceAgentCloudConnection();
     await deviceAgent.setupHandlers();
 
-    // Update the shadow as a client
-    const topic = deviceAgent.getShadowTopics().projects.update;
-    const packet = {
-      state: {
-        desired: {
-          [project]: {
-            envVars
-          }
-        }
-      },
-      clientToken: 'client'
+    const toDesire = {
+      [projectId]: {
+        envVars
+      }
     };
-    logger.debug(
-      `Publishing message:\n${JSON.stringify({ topic, packet }, null, 2)}`
+    deviceAgent.publisher.publish(
+      getShadowTopic(deviceAgent.getClientId(), 'projects', 'update'),
+      JSON.stringify(
+        buildUpdateProjectShadowMessage({
+          clientId: 'client',
+          desired: toDesire
+        })
+      )
     );
-    deviceAgent.publisher.publish(topic, JSON.stringify(packet));
     // Sleep for extra time to ensure time for shadow response
     await sleep(10000);
 
-    while (deviceAgent.isCmdInProgress(project)) {
+    while (deviceAgent.isCmdInProgress(projectId)) {
       await sleep(1000);
     }
     await deviceAgent.stop();

package/src/subcommands/app/models.ts

@@ -14,6 +14,11 @@ import {
 import { DeviceAgentCloudConnection } from '../../cloud-connection/device-agent-cloud-connection';
 import sleep from '../../util/sleep';
 import { logger } from '../../util/logger';
+import {
+  buildUpdateProjectShadowMessage,
+  getShadowTopic,
+  validateShadowProjectsUpdateAll
+} from '@alwaysai/device-agent-schemas';
 
 export const showAppModelsCliLeaf = CliLeaf({
   name: 'show-models',
@@ -49,34 +54,33 @@ export const addModelCliLeaf = CliLeaf({
     })
   },
   async action(_, opts) {
-    const { project, model, version } = opts;
+    const { project: projectId, model, version } = opts;
     const deviceAgent = new DeviceAgentCloudConnection();
     await deviceAgent.setupHandlers();
 
     // Update the shadow as a client
-    const topic = deviceAgent.getShadowTopics().projects.update;
 
-    const newAppCfg = await readAppCfgFile({ projectId: project });
+    const newAppCfg = await readAppCfgFile({ projectId: projectId });
     newAppCfg.models[model] = Number(version);
 
-    const packet = {
-      state: {
-        desired: {
-          [project]: {
-            appConfig: JSON.stringify(newAppCfg)
-          }
-        }
-      },
-      clientToken: 'client'
+    const toDesire = {
+      [projectId]: {
+        appConfig: JSON.stringify(newAppCfg)
+      }
     };
-    logger.debug(
-      `Publishing message:\n${JSON.stringify({ topic, packet }, null, 2)}`
+    deviceAgent.publisher.publish(
+      getShadowTopic(deviceAgent.getClientId(), 'projects', 'update'),
+      JSON.stringify(
+        buildUpdateProjectShadowMessage({
+          clientId: 'client',
+          desired: toDesire
+        })
+      )
     );
-    deviceAgent.publisher.publish(topic, JSON.stringify(packet));
     // Sleep for extra time to ensure time for shadow response
     await sleep(10000);
 
-    while (deviceAgent.isCmdInProgress(project)) {
+    while (deviceAgent.isCmdInProgress(projectId)) {
       await sleep(1000);
     }
     await deviceAgent.stop();

package/src/subcommands/device/clean.ts

@@ -36,10 +36,13 @@ export const cleanCliLeaf = CliLeaf({
 
     logger.debug('Checking for alwaysAI applications still running');
     const apps = await AgentConfigFile().getApps();
+    const stopAppPromises: Promise<void>[] = [];
     for (const app of apps) {
       const { projectId } = app;
-      await stopApp({ projectId });
+      stopAppPromises.push(stopApp({ projectId }));
     }
+    await Promise.all(stopAppPromises);
+
     await safeRimraf(LOCAL_CERT_AND_KEY_DIR);
 
     logger.debug(`Removing ${AgentConfigFile().path}`);

package/src/subcommands/device/device.ts

@@ -95,9 +95,13 @@ export const initCliLeaf = CliLeaf({
     const certSpawner = JsSpawner({
       path: BOOTSTRAP_CERTIFICATES_DIR_PATH()
     });
+    const writeCertFilePromises: Promise<void>[] = [];
     for (const key in response.claimCertificate) {
-      await certSpawner.writeFile(key, response.claimCertificate[key]);
+      writeCertFilePromises.push(
+        certSpawner.writeFile(key, response.claimCertificate[key])
+      );
     }
+    await Promise.all(writeCertFilePromises);
 
     logger.info(`Initialized device ${name}: UUID=${response.deviceUuid}`);
   }
@@ -112,15 +116,27 @@ export const getInfoCliLeaf = CliLeaf({
     const diskDetails = await getDiskDetails();
     const memDetails = await getMemDetails();
     const out = {
-      'CPU Utilization': `Used ${cpuDetails.usedPerc.toFixed(
-        2
-      )}%, Temperature ${cpuDetails.temperature} °C`,
-      'Disk Utilization': `${diskDetails.usedGb} GB / ${
-        diskDetails.usedGb + diskDetails.freeGb
-      } GB`,
-      'Memory Utilization': `${memDetails.usedMb} MB / ${
-        memDetails.usedMb + memDetails.freeMb
-      } MB`
+      'CPU Utilization': `${
+        cpuDetails?.usedPerc && cpuDetails.temperature
+          ? `Used ${cpuDetails?.usedPerc?.toFixed(2)}%, Temperature ${
+              cpuDetails?.temperature
+            } °C`
+          : 'Unavailable'
+      }`,
+      'Disk Utilization': `${
+        diskDetails?.usedGb && diskDetails.freeGb
+          ? `${diskDetails?.usedGb} GB / ${
+              diskDetails?.usedGb + diskDetails?.freeGb
+            } GB`
+          : 'Unavailable'
+      }`,
+      'Memory Utilization': `${
+        memDetails?.usedMb && memDetails.freeMb
+          ? `${memDetails.usedMb} MB / ${
+              memDetails.usedMb + memDetails.freeMb
+            } MB`
+          : 'Unavailable'
+      }`
     };
     console.table(out);
     const systemInfo = await getSystemInformation();

package/src/util/cloud-mode-ready.ts

@@ -5,6 +5,42 @@ import {
   DEVICE_CERTIFICATE_FILE_PATH
 } from '../util/directories';
 
+const VALID_AWS_REGIONS = [
+  // 'af-south-1', // Africa (Cape Town)
+  // 'ap-east-1', // Asia Pacific (Hong Kong)
+  // 'ap-south-2', // Asia Pacific (Hyderabad)
+  // 'ap-northeast-1', // Asia Pacific (Tokyo)
+  // 'ap-northeast-2', // Asia Pacific (Seoul)
+  // 'ap-northeast-3', // Asia Pacific (Osaka)
+  // 'ap-south-1', // Asia Pacific (Mumbai)
+  // 'ap-southeast-1', // Asia Pacific (Singapore)
+  // 'ap-southeast-2', // Asia Pacific (Sydney)
+  // 'ap-southeast-3', // Asia Pacific (Jakarta)
+  // 'ap-southeast-4', // Asia Pacific (Melbourne)
+  // 'ca-central-1', // Canada (Central)
+  // 'ca-west-1', // Canada West (Calgary)
+  // 'eu-west-2', // Europe (London)
+  // 'eu-west-3', // Europe (Paris)
+  // 'eu-central-1', // Europe (Frankfurt)
+  // 'eu-central-2', // Europe (Zurich)
+  // 'eu-north-1', // Europe (Stockholm)
+  // 'eu-south-1', // Europe (Milan)
+  // 'eu-south-2', // Europe (Spain)
+  // 'eu-west-1', // Europe (Ireland)
+  // 'il-central-1', // Israel (Tel Aviv)
+  // 'me-south-1', // Middle East (Bahrain)
+  // 'me-central-1', // Middle East (UAE)
+  // 'sa-east-1' // South America (São Paulo)
+  // 'us-east-2', // US East (Ohio)
+  // 'us-east-1', // US East (Virginia)
+  // 'us-west-1', // US West (N. California)
+  'us-west-2' // US West (Oregon)
+];
+
+export function isValidAwsRegion(region: string): boolean {
+  return VALID_AWS_REGIONS.includes(region);
+}
+
 export function cloudModeReady() {
   let ready = true;
   const requiredFiles = [

package/lib/secure-tunneling/index.d.ts

@@ -1,5 +0,0 @@
-export declare function secureTunnelNotifyHandler(message: {
-    clientAccessToken: string;
-    region: string;
-}): Promise<void>;
-//# sourceMappingURL=index.d.ts.map

package/lib/secure-tunneling/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/secure-tunneling/index.ts"],"names":[],"mappings":"AAcA,wBAAsB,yBAAyB,CAAC,OAAO,EAAE;IACvD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB,iBAuBA"}

package/lib/secure-tunneling/index.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.secureTunnelNotifyHandler = void 0;
-const download_file_1 = require("../util/download-file");
-const directories_1 = require("../util/directories");
-const paths_1 = require("alwaysai/lib/paths");
-const util_1 = require("alwaysai/lib/util");
-const path_1 = require("path");
-const logger_1 = require("../util/logger");
-const urls_1 = require("../urls");
-const system_info_1 = require("../util/system-info");
-async function secureTunnelNotifyHandler(message) {
-    const { clientAccessToken, region } = message;
-    await terminateSecureTunnelProcess();
-    await downloadSecureTunnel();
-    logger_1.logger.info('Starting Secure Tunnel');
-    const args = [
-        '--destination-app',
-        '22',
-        '--region',
-        region,
-        '--capath',
-        directories_1.AWS_ROOT_CERTIFICATE_FILE_PATH,
-        '--local-bind-address',
-        '0.0.0.0',
-        '-t',
-        clientAccessToken
-    ];
-    await (0, util_1.JsSpawner)().run({
-        exe: `${directories_1.SECURE_TUNNEL_BIN_PATH}`,
-        args
-    });
-}
-exports.secureTunnelNotifyHandler = secureTunnelNotifyHandler;
-async function downloadSecureTunnel() {
-    const arch = await (0, system_info_1.getArch)();
-    const linuxDistro = await (0, system_info_1.getDistribution)();
-    const osVersion = await (0, system_info_1.getOsVersion)();
-    const url = `${urls_1.aaiArtifactsBucketUrl}/securetunnel/${linuxDistro}/${osVersion}/${arch}/${directories_1.SECURE_TUNNEL_BIN_NAME}`;
-    await (0, util_1.JsSpawner)().mkdirp((0, path_1.join)(paths_1.AAI_DIR, directories_1.SECURE_TUNNEL_BIN_DIR));
-    await (0, download_file_1.downloadFile)({
-        url,
-        path: directories_1.SECURE_TUNNEL_BIN_PATH,
-        errorMessage: `Secure Tunnel bin for ${linuxDistro} ${osVersion} ${arch} not found}`
-    });
-    const spawner = (0, util_1.JsSpawner)();
-    await spawner.run({
-        exe: 'chmod',
-        args: ['+x', directories_1.SECURE_TUNNEL_BIN_PATH]
-    });
-}
-async function terminateSecureTunnelProcess() {
-    const spawner = (0, util_1.JsSpawner)();
-    try {
-        await spawner.run({
-            exe: 'pkill',
-            args: [directories_1.SECURE_TUNNEL_BIN_NAME]
-        });
-    }
-    catch (e) {
-        logger_1.logger.debug('Proccess terminated if status code is 1');
-    }
-}
-//# sourceMappingURL=index.js.map

package/lib/secure-tunneling/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/secure-tunneling/index.ts"],"names":[],"mappings":";;;AAAA,yDAAqD;AACrD,qDAK6B;AAC7B,8CAA6C;AAC7C,4CAA8C;AAC9C,+BAA4B;AAC5B,2CAAwC;AACxC,kCAAgD;AAChD,qDAA6E;AAEtE,KAAK,UAAU,yBAAyB,CAAC,OAG/C;IACC,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC9C,MAAM,4BAA4B,EAAE,CAAC;IACrC,MAAM,oBAAoB,EAAE,CAAC;IAC7B,eAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IAEtC,MAAM,IAAI,GAAG;QACX,mBAAmB;QACnB,IAAI;QACJ,UAAU;QACV,MAAM;QACN,UAAU;QACV,4CAA8B;QAC9B,sBAAsB;QACtB,SAAS;QACT,IAAI;QACJ,iBAAiB;KAClB,CAAC;IAEF,MAAM,IAAA,gBAAS,GAAE,CAAC,GAAG,CAAC;QACpB,GAAG,EAAE,GAAG,oCAAsB,EAAE;QAChC,IAAI;KACL,CAAC,CAAC;AACL,CAAC;AA1BD,8DA0BC;AAED,KAAK,UAAU,oBAAoB;IACjC,MAAM,IAAI,GAAG,MAAM,IAAA,qBAAO,GAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,MAAM,IAAA,6BAAe,GAAE,CAAC;IAC5C,MAAM,SAAS,GAAG,MAAM,IAAA,0BAAY,GAAE,CAAC;IAEvC,MAAM,GAAG,GAAG,GAAG,4BAAqB,iBAAiB,WAAW,IAAI,SAAS,IAAI,IAAI,IAAI,oCAAsB,EAAE,CAAC;IAElH,MAAM,IAAA,gBAAS,GAAE,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,eAAO,EAAE,mCAAqB,CAAC,CAAC,CAAC;IAC/D,MAAM,IAAA,4BAAY,EAAC;QACjB,GAAG;QACH,IAAI,EAAE,oCAAsB;QAC5B,YAAY,EAAE,yBAAyB,WAAW,IAAI,SAAS,IAAI,IAAI,aAAa;KACrF,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,gBAAS,GAAE,CAAC;IAC5B,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,GAAG,EAAE,OAAO;QACZ,IAAI,EAAE,CAAC,IAAI,EAAE,oCAAsB,CAAC;KACrC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,4BAA4B;IACzC,MAAM,OAAO,GAAG,IAAA,gBAAS,GAAE,CAAC;IAC5B,IAAI;QACF,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,GAAG,EAAE,OAAO;YACZ,IAAI,EAAE,CAAC,oCAAsB,CAAC;SAC/B,CAAC,CAAC;KACJ;IAAC,OAAO,CAAC,EAAE;QACV,eAAM,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;KACzD;AACH,CAAC"}

package/src/secure-tunneling/index.ts

@@ -1,74 +0,0 @@
-import { downloadFile } from '../util/download-file';
-import {
-  SECURE_TUNNEL_BIN_DIR,
-  SECURE_TUNNEL_BIN_PATH,
-  SECURE_TUNNEL_BIN_NAME,
-  AWS_ROOT_CERTIFICATE_FILE_PATH
-} from '../util/directories';
-import { AAI_DIR } from 'alwaysai/lib/paths';
-import { JsSpawner } from 'alwaysai/lib/util';
-import { join } from 'path';
-import { logger } from '../util/logger';
-import { aaiArtifactsBucketUrl } from '../urls';
-import { getDistribution, getOsVersion, getArch } from '../util/system-info';
-
-export async function secureTunnelNotifyHandler(message: {
-  clientAccessToken: string;
-  region: string;
-}) {
-  const { clientAccessToken, region } = message;
-  await terminateSecureTunnelProcess();
-  await downloadSecureTunnel();
-  logger.info('Starting Secure Tunnel');
-
-  const args = [
-    '--destination-app',
-    '22',
-    '--region',
-    region,
-    '--capath',
-    AWS_ROOT_CERTIFICATE_FILE_PATH,
-    '--local-bind-address',
-    '0.0.0.0',
-    '-t',
-    clientAccessToken
-  ];
-
-  await JsSpawner().run({
-    exe: `${SECURE_TUNNEL_BIN_PATH}`,
-    args
-  });
-}
-
-async function downloadSecureTunnel() {
-  const arch = await getArch();
-  const linuxDistro = await getDistribution();
-  const osVersion = await getOsVersion();
-
-  const url = `${aaiArtifactsBucketUrl}/securetunnel/${linuxDistro}/${osVersion}/${arch}/${SECURE_TUNNEL_BIN_NAME}`;
-
-  await JsSpawner().mkdirp(join(AAI_DIR, SECURE_TUNNEL_BIN_DIR));
-  await downloadFile({
-    url,
-    path: SECURE_TUNNEL_BIN_PATH,
-    errorMessage: `Secure Tunnel bin for ${linuxDistro} ${osVersion} ${arch} not found}`
-  });
-
-  const spawner = JsSpawner();
-  await spawner.run({
-    exe: 'chmod',
-    args: ['+x', SECURE_TUNNEL_BIN_PATH]
-  });
-}
-
-async function terminateSecureTunnelProcess() {
-  const spawner = JsSpawner();
-  try {
-    await spawner.run({
-      exe: 'pkill',
-      args: [SECURE_TUNNEL_BIN_NAME]
-    });
-  } catch (e) {
-    logger.debug('Proccess terminated if status code is 1');
-  }
-}