@alwaysai/device-agent 0.1.0 → 0.1.2

package/src/cloud-connection/shadow-handler.ts

@@ -2,7 +2,7 @@ import {
   AppConfig,
   validateAppConfig
 } from '@alwaysai/app-configuration-schemas';
-import { readAppCfgFile } from '../application-control';
+import { EnvVars, getAllEnvs, readAppCfgFile } from '../application-control';
 import { logger } from '../util/logger';
 import { Publisher } from './publisher';
 import { AppConfigModels, getAppCfgModelsDiff } from './shadow';
@@ -21,11 +21,20 @@ export interface ShadowTopics {
 }
 
 export type AppConfigUpdate = {
-  projectId: string;
   newAppCfg: AppConfig;
   updatedModels?: AppConfigModels;
 };
 
+export type EnvVarUpdate = {
+  envVars: EnvVars;
+};
+
+export type ShadowUpdate = {
+  projectId: string;
+  appCfgUpdate?: AppConfigUpdate;
+  envVarUpdate?: EnvVarUpdate;
+};
+
 export class ShadowHandler {
   private clientId: string;
   private publisher: Publisher;
@@ -54,13 +63,14 @@ export class ShadowHandler {
     delta
   }: {
     delta: any;
-  }): Promise<AppConfigUpdate[]> {
-    const appConfigUpdates: AppConfigUpdate[] = [];
+  }): Promise<ShadowUpdate[]> {
+    const updates: ShadowUpdate[] = [];
 
     const deltaKeys = Object.keys(delta);
 
     for (const projectId of deltaKeys) {
       const projectShadow = delta[projectId];
+      const shadowUpdate: ShadowUpdate = { projectId };
 
       if (projectShadow.appConfig) {
         const newAppCfg = JSON.parse(projectShadow.appConfig);
@@ -81,17 +91,29 @@ export class ShadowHandler {
         });
 
         if (updatedModels && Object.keys(updatedModels).length) {
-          appConfigUpdates.push({ projectId, newAppCfg, updatedModels });
+          shadowUpdate.appCfgUpdate = { newAppCfg, updatedModels };
         } else {
-          appConfigUpdates.push({ projectId, newAppCfg });
+          shadowUpdate.appCfgUpdate = { newAppCfg };
         }
       } else {
-        logger.warn(
-          `Ignoring shadow update for ${projectId} due to no app config`
+        logger.info(
+          `Ignoring app config shadow update for ${projectId} due to no delta`
         );
       }
+
+      if (projectShadow.envVars) {
+        const envVars = projectShadow.envVars;
+        shadowUpdate.envVarUpdate = { envVars };
+      } else {
+        logger.info(
+          `Ignoring app environment variable shadow update for ${projectId} due to no delta`
+        );
+      }
+      if (shadowUpdate.appCfgUpdate || shadowUpdate.envVarUpdate) {
+        updates.push(shadowUpdate);
+      }
     }
-    return appConfigUpdates;
+    return updates;
   }
 
   // Public interface
@@ -104,7 +126,7 @@ export class ShadowHandler {
     topic: string;
     payload: any;
     clientToken: string;
-  }): Promise<AppConfigUpdate[]> {
+  }): Promise<ShadowUpdate[]> {
     // TODO: make use a function like the other topic getters
     const shadowName = topic.split('/')[5];
     switch (topic) {
@@ -141,12 +163,16 @@ export class ShadowHandler {
     return [];
   }
 
-  public async publishAppConfig(projectId: string) {
+  public async updateProjectShadow(projectId: string) {
     const appCfg = await readAppCfgFile({ projectId });
+    const envVars = await getAllEnvs({ projectId });
     const packet = {
       state: {
         reported: {
-          [projectId]: { appConfig: JSON.stringify(appCfg) }
+          [projectId]: {
+            appConfig: JSON.stringify(appCfg),
+            envVars
+          }
         }
       },
       clientToken: this.clientId

package/src/cloud-connection/shadow.ts

@@ -43,7 +43,7 @@ export const getAppCfgModelsDiff = async ({
         newScripts[scriptName] = shadowScripts[scriptName];
       });
   } catch (e) {
-    logger.error('Error parsing app config update: ', e.message);
+    logger.error(`Error parsing app config update: ${e.message}`);
   }
 
   return { scripts: newScripts, updatedModels, untouchedModels };

package/src/environment.ts

@@ -13,6 +13,8 @@ export const ALWAYSAI_LOG_TO_CONSOLE = process.env.ALWAYSAI_LOG_TO_CONSOLE;
 export const ALWAYSAI_ANALYTICS_PASSTHROUGH = parseBoolean(
   process.env.ALWAYSAI_ANALYTICS_PASSTHROUGH
 );
+export const ALWAYSAI_LIVE_UPDATES_TIMEOUT_MS =
+  process.env.ALWAYSAI_LIVE_UPDATES_TIMEOUT_MS;
 
 function parseOsPlatform(str: string | undefined): NodeJS.Platform {
   switch (str) {

package/src/infrastructure/agent-config.ts

@@ -70,7 +70,7 @@ export interface AgentJsonFileReturnType
   setAppInstalling;
   setAppInstalled;
   setAppUninstalled;
-  getAppVersion;
+  getAppVersion: (props: { projectId: string }) => Promise<string>;
   setAppBackup;
   getAppBackup;
 }

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

@@ -1,10 +1,12 @@
 import {
   CliLeaf,
   CliStringArrayInput,
-  CliStringInput
+  CliStringInput,
+  CliTerseError
 } from '@alwaysai/alwayscli';
-import { getAllEnvs, setEnv } from '../../application-control';
-import { logger } from '../../util/logger';
+import { EnvVars, getAllEnvs } from '../../application-control';
+import { DeviceAgentCloudConnection } from '../../cloud-connection/device-agent-cloud-connection';
+import sleep from '../../util/sleep';
 
 export const getAllEnvsCliLeaf = CliLeaf({
   name: 'get-all-envs',
@@ -17,7 +19,8 @@ export const getAllEnvsCliLeaf = CliLeaf({
   },
   async action(_, opts) {
     const { project } = opts;
-    logger.info(await getAllEnvs({ projectId: project }));
+    const envVars = await getAllEnvs({ projectId: project });
+    console.log(JSON.stringify(envVars, null, 2));
   }
 });
 
@@ -34,13 +37,40 @@ export const setEnvCliLeaf = CliLeaf({
       required: true
     }),
     service: CliStringInput({
-      description:
-        'The name of the docker-compose service to apply environment variable to',
-      required: false
+      description: 'Docker compose service to set environment variables for',
+      required: true
     })
   },
   async action(args, opts) {
     const { project, service } = opts;
-    await setEnv({ projectId: project, vars: args, service });
+    const envVars: EnvVars = { [service]: {} };
+    args.forEach((arg: string) => {
+      const nameVal = arg.split('=');
+      if (nameVal.length !== 2) {
+        throw new CliTerseError(`Invalid argument: ${arg}`);
+      }
+      envVars[service][nameVal[0]] = nameVal[1];
+    });
+    const deviceAgent = new DeviceAgentCloudConnection();
+    await deviceAgent.setupHandlers();
+
+    const topic = deviceAgent.getShadowTopics().projects.updateDelta;
+
+    const message = {
+      version: 3,
+      timestamp: 0,
+      state: {
+        [project]: {
+          envVars
+        }
+      },
+      clientToken: 'not-self'
+    };
+
+    await deviceAgent.handleMessage(topic, message);
+    while (deviceAgent.isCmdInProgress(project)) {
+      await sleep(1000);
+    }
+    await deviceAgent.stop();
   }
 });

package/src/subcommands/app/index.ts

@@ -20,6 +20,7 @@ import {
   uninstallAppCliLeaf,
   rollbackAppCliLeaf
 } from './version';
+import { getShadowCliLeaf, updateShadowCliLeaf } from './shadow';
 
 export const appCliBranch = CliBranch({
   name: 'app',
@@ -40,6 +41,8 @@ export const appCliBranch = CliBranch({
     replaceModelsCliLeaf,
     updateModelsCliLeaf,
     getAllEnvsCliLeaf,
-    setEnvCliLeaf
+    setEnvCliLeaf,
+    getShadowCliLeaf,
+    updateShadowCliLeaf
   ]
 });

package/src/subcommands/app/models.ts

@@ -71,7 +71,7 @@ export const addModelCliLeaf = CliLeaf({
     while (deviceAgent.isCmdInProgress(project)) {
       await sleep(1000);
     }
-    deviceAgent.stop();
+    await deviceAgent.stop();
   }
 });
 
@@ -90,6 +90,7 @@ export const removeModelCliLeaf = CliLeaf({
   },
   async action(_, opts) {
     const { project, model } = opts;
+    // TODO: Replace with handleMessage()
     await removeModel({ projectId: project, modelId: model });
   }
 });
@@ -107,8 +108,12 @@ export const replaceModelsCliLeaf = CliLeaf({
       required: true
     })
   },
+  hidden: true,
   async action(_, opts) {
     const { project, models } = opts;
+    console.log(
+      'This command is deprecated and will be removed in a future release'
+    );
     await replaceModels({ projectId: project, modelIds: models });
   }
 });
@@ -122,8 +127,12 @@ export const updateModelsCliLeaf = CliLeaf({
       required: true
     })
   },
+  hidden: true,
   async action(_, opts) {
     const { project } = opts;
+    console.log(
+      'This command is deprecated and will be removed in a future release'
+    );
     await updateModels({ projectId: project });
   }
 });

package/src/subcommands/app/shadow.ts

@@ -0,0 +1,48 @@
+import { CliLeaf, CliStringInput } from '@alwaysai/alwayscli';
+import { DeviceAgentCloudConnection } from '../../cloud-connection/device-agent-cloud-connection';
+import sleep from '../../util/sleep';
+
+export const getShadowCliLeaf = CliLeaf({
+  name: 'get-shadow',
+  description: 'Get the current shadow',
+  namedInputs: {
+    project: CliStringInput({
+      description: 'Project Id',
+      required: true
+    })
+  },
+  async action(_, opts) {
+    const { project } = opts;
+    const deviceAgent = new DeviceAgentCloudConnection();
+    await deviceAgent.setupHandlers();
+
+    // The Device Agent always gets the latest shadow and updates
+    // itself. 5 seconds should cover the initial response wait time
+    await sleep(5000);
+    while (deviceAgent.isCmdInProgress(project)) {
+      await sleep(1000);
+    }
+    await deviceAgent.stop();
+  }
+});
+
+export const updateShadowCliLeaf = CliLeaf({
+  name: 'update-shadow',
+  description: 'Update the shadow with the current application configuration',
+  namedInputs: {
+    project: CliStringInput({
+      description: 'Project Id',
+      required: true
+    })
+  },
+  async action(_, opts) {
+    const { project } = opts;
+    const deviceAgent = new DeviceAgentCloudConnection();
+    await deviceAgent.setupHandlers();
+    await deviceAgent.updateProjectShadow(project);
+
+    // 5 seconds should cover the response wait time
+    await sleep(5000);
+    await deviceAgent.stop();
+  }
+});

package/src/subcommands/app/version.ts

@@ -49,7 +49,7 @@ export const installAppCliLeaf = CliLeaf({
     while (deviceAgent.isCmdInProgress(project)) {
       await sleep(1000);
     }
-    deviceAgent.stop();
+    await deviceAgent.stop();
   }
 });
 
@@ -82,7 +82,7 @@ export const uninstallAppCliLeaf = CliLeaf({
     while (deviceAgent.isCmdInProgress(project)) {
       await sleep(1000);
     }
-    deviceAgent.stop();
+    await deviceAgent.stop();
   }
 });
 

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

@@ -0,0 +1,23 @@
+import { existsSync } from 'fs';
+import {
+  AWS_ROOT_CERTIFICATE_FILE_PATH,
+  DEVICE_PRIVATE_KEY_FILE_PATH,
+  DEVICE_CERTIFICATE_FILE_PATH
+} from '../util/directories';
+
+export function cloudModeReady() {
+  let ready = true;
+  const requiredFiles = [
+    DEVICE_CERTIFICATE_FILE_PATH,
+    DEVICE_PRIVATE_KEY_FILE_PATH,
+    AWS_ROOT_CERTIFICATE_FILE_PATH
+  ];
+
+  for (const path of requiredFiles) {
+    if (!existsSync(path)) {
+      ready = false;
+      break;
+    }
+  }
+  return ready;
+}