@alwaysai/device-agent 0.1.6 → 1.0.0-pre-release

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@alwaysai/device-agent",
   "description": "The alwaysAI Device Agent",
-  "version": "0.1.6",
+  "version": "1.0.0-pre-release",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "publishConfig": {
@@ -37,9 +37,9 @@
     "@alwaysai/alwayscli": "0.3.2",
     "@alwaysai/app-configuration-schemas": "0.1.0",
     "@alwaysai/config-nodejs": "0.3.0",
-    "@alwaysai/device-agent-schemas": "1.2.0",
+    "@alwaysai/device-agent-schemas": "2.1.2",
     "ajv": "8.11.0",
-    "alwaysai": "2.1.0",
+    "alwaysai": "2.2.0",
     "amqplib": "0.10.3",
     "aws-iot-device-sdk": "2.2.12",
     "docker-compose": "0.23.17",
@@ -91,5 +91,6 @@
     "name": "alwaysAI, Inc.",
     "email": "contact@alwaysai.co"
   },
-  "homepage": "https://alwaysai.co"
+  "homepage": "https://alwaysai.co",
+  "license": "SEE LICENSE IN LICENSE"
 }

package/readme.md

@@ -63,7 +63,7 @@ Where:
   devices page of the alwaysAI Dashboard. If a device name is not provided, one
   will be generated for you and logged to the console for reference.
 
-**Important note**: If your password contains one or more special characters and you receive an error message that your password does not match your username but you are sure that it is correctly entered, please try enclosing your password with double quotes and re-running the provisioning command. You can also reset your password at https://console.alwaysai.co/dashboard by logging out, navigating to the sign in page, and clicking '`Forgot Password?`'.
+**Important note**: If your password contains one or more special characters and you receive an error message that your password does not match your username but you are sure that it is correctly entered, please try preceding every special character in your password with a backslash, and re-running the provisioning command. You can also reset your password at https://console.alwaysai.co/dashboard by logging out, navigating to the sign in page, and clicking '`Forgot Password?`'.
 
 Confirm the Device Agent is running with the following command:
 
@@ -379,3 +379,32 @@ service run the following command on the device:
 ```bash
 $ aai-agent app set-env TEST_ENV=1 --project <project_id> --service alwaysai
 ```
+## Device Cleaning and Uninstalling
+In order to fully clean the device and uninstall the agent, use the following steps:
+
+### 1. Stop PM2 instance of the device agent
+Using `pm2 list`, display the list of current pm2 instances. The output should look like this:
+```bash
+$ pm2 list
+┌────┬────────────────────┬──────────┬──────┬───────────┬──────────┬──────────┐
+│ id │ name               │ mode     │ ↺    │ status    │ cpu      │ memory   │
+├────┼────────────────────┼──────────┼──────┼───────────┼──────────┼──────────┤
+│ 0  │ aai-agent          │ fork     │ 15   │ online    │ 0%       │ 2.8mb    │
+└────┴────────────────────┴──────────┴──────┴───────────┴──────────┴──────────┘
+```
+Start with `pm2 stop <id>` where `<id>` is the id of the aai-agent.
+Then, run `pm2 delete 0`.
+Follow it with these two commands:
+`pm2 flush`, `pm2 unstartup`
+
+### 2. Remove alwaysAI Provisioned Device
+Open a new terminal.
+Run `aai-agent device clean`
+
+### 3. Uninstall aai Device Agent from the device
+Run `sudo npm uninstall -g @alwaysai/device-agent`
+Verify successful removal by running `aai-agent`. You should see a response similar to `-bash: /usr/bin/aai-agent: No such file or directory`.
+
+### 4. Remove the device from the aai Dashboard
+Go to https://console.alwaysai.co/dashboard/devices, Go to Devices, find the device in question, and remove the device using the trashcan icon.
+

package/src/application-control/config.ts

@@ -121,6 +121,10 @@ export async function writeDockerCompose(props: {
   const spawner = JsSpawner({ path: appDir });
   const composeOutput = stringify(dockerCompose);
   // Validate new contents
-  await compose.config({ cwd: appDir, configAsString: composeOutput });
+  try {
+    await compose.config({ cwd: appDir, configAsString: composeOutput });
+  } catch (e) {
+    logger.error(JSON.stringify(e));
+  }
   await spawner.writeFile('docker-compose.yaml', composeOutput);
 }

package/src/application-control/index.ts

@@ -2,7 +2,7 @@ import { readAppCfgFile, updateAppCfg } from './config';
 import { installApp, uninstallApp } from './install';
 import { rollbackApp } from './backup';
 import {
-  getAppStatus,
+  getAppState,
   startApp,
   getAppLogs,
   stopApp,
@@ -17,7 +17,7 @@ export {
   installApp,
   uninstallApp,
   rollbackApp,
-  getAppStatus,
+  getAppState,
   startApp,
   getAppLogs,
   stopApp,

package/src/application-control/install.ts

@@ -4,9 +4,9 @@ import * as path from 'path';
 import { buildDockerImage } from 'alwaysai/lib/util/docker';
 import { JsSpawner, Spawner } from 'alwaysai/lib/util';
 import { getAppDir, downloadPackageUsingPresignedUrl, buildApp } from './utils';
-import { AppDetailsPacket } from '@alwaysai/device-agent-schemas';
+import { AppDetails } from '@alwaysai/device-agent-schemas';
 import { BACKUP_EXT } from './backup';
-import { startApp, stopApp } from './status';
+import { startApp, stopApp, isAppStarted } from './status';
 import { AgentConfigFile } from '../infrastructure/agent-config';
 import { ProjectJsonFile } from 'alwaysai/lib/core/project';
 import {
@@ -22,6 +22,12 @@ import { DOCKER_IMAGE_ID_INITIAL_VALUE } from 'alwaysai/lib/constants';
 import { runInDir } from '../util/run-in-dir';
 import { installModelsWithPresignedURLs } from './models';
 import { logger } from '../util/logger';
+import { updateAppCfgFile } from './config';
+import {
+  LOCAL_CONNECTION_HOST,
+  LOCAL_CONNECTION_PORT,
+  LOCAL_CONNECTION_ROUTING_KEY
+} from '../local-connection/constants';
 import { DOCKERFILE, PYTHON_REQUIREMENTS_FILE_NAME } from 'alwaysai/lib/paths';
 
 type SignedUrlPayloadType = {
@@ -35,9 +41,9 @@ type SignedUrlPayloadType = {
   }[];
 };
 
-export async function getInstalledApps(): Promise<AppDetailsPacket[]> {
+export async function getInstalledApps(): Promise<AppDetails[]> {
   const apps = await AgentConfigFile().getApps();
-  const appDetails: AppDetailsPacket[] = [];
+  const appDetails: AppDetails[] = [];
   for (const app of apps) {
     const { projectId, version } = app;
     appDetails.push({ projectId, version });
@@ -60,6 +66,19 @@ export async function installApp(props: {
       throw new Error('Application already has installation in progress!');
     }
     logger.info('Application is already installed, updating');
+
+    // make sure the app is stopped if it's running, to clear the docker container.
+    if (await isAppStarted({ projectId })) {
+      logger.info('Application currently running. Stopping...');
+      try {
+        await stopApp({ projectId });
+      } catch (error) {
+        logger.error(
+          'Could not stop the application. Old container might still be present after installation.'
+        );
+      }
+    }
+
     await AgentConfigFile().setAppInstalling({
       projectId,
       version: appReleaseHash
@@ -91,6 +110,9 @@ export async function installApp(props: {
   // NOTE: this process no longer checks project collaboration
   await checkValidProjectFiles({ appDir });
 
+  const DACfg = await createAppCfgDeviceAgentConnection();
+  await updateAppCfgFile({ projectId, newAppCfg: DACfg });
+
   await installAppBuildReqs({ appDir });
   await installModelsWithPresignedURLs(
     signedUrlsPayload.modelsInstallPayload,
@@ -109,6 +131,16 @@ export async function installApp(props: {
   logger.info(`Completed installing ${projectId}:${appReleaseHash}`);
 }
 
+async function createAppCfgDeviceAgentConnection() {
+  return {
+    device_agent_connection: {
+      host: `${LOCAL_CONNECTION_HOST}`,
+      port: LOCAL_CONNECTION_PORT,
+      routing_key: `${LOCAL_CONNECTION_ROUTING_KEY}`
+    }
+  };
+}
+
 async function installAppBuildReqs(props: { appDir: string }) {
   const { appDir } = props;
   const targetJsonFile = TargetJsonFile(appDir);

package/src/application-control/status.ts

@@ -4,23 +4,24 @@ import { JsSpawner } from 'alwaysai/lib/util';
 import { runDockerLogin } from '../docker/docker-cmd';
 import { getAppDir, requireAppInstalled, requireAppReady } from './utils';
 import {
-  ServiceStatusPacket,
-  AppStatePacket,
   keyMirrors,
-  AppStateValue
+  AppStateValue,
+  AppDetails,
+  AppState,
+  ServiceStatus
 } from '@alwaysai/device-agent-schemas';
 import { AgentConfigFile } from '../infrastructure/agent-config';
 import { logger } from '../util/logger';
 
-export async function getAppStatus(props: {
+export async function getAppState(props: {
   projectId: string;
-}): Promise<AppStatePacket> {
+}): Promise<AppState> {
   const { projectId } = props;
   if (!(await AgentConfigFile().isAppPresent({ projectId }))) {
     throw new Error('Application is not installed');
   }
 
-  const appDetails = {
+  const appDetails: AppDetails = {
     projectId,
     version: await AgentConfigFile().getAppVersion({ projectId })
   };
@@ -43,7 +44,7 @@ export async function getAppStatus(props: {
     );
   }
 
-  const services: ServiceStatusPacket[] = [];
+  const services: ServiceStatus[] = [];
   const spawner = JsSpawner({ path: appDir });
   for (const name of composeServices.data.services) {
     // Get container name for service
@@ -101,7 +102,7 @@ export async function isAppStarted(props: {
   projectId: string;
 }): Promise<boolean> {
   const { projectId } = props;
-  const appStatus = await getAppStatus({ projectId });
+  const appStatus = await getAppState({ projectId });
   if (appStatus.services.length === 0) {
     // Services list will be empty if app has not yet been started.
     // NOTE: This depends on internal handling in getAppStatus()