@alwaysai/device-agent 1.3.1 → 1.4.0

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

@@ -4,6 +4,7 @@ import { Publisher } from './publisher';
 import { ShadowHandler } from './shadow-handler';
 import { Logger } from 'winston';
 import { logger } from '../util/logger';
+import { getShadowTopic } from '@alwaysai/device-agent-schemas';
 
 jest.mock('../application-control');
 jest.mock('./publisher');
@@ -24,8 +25,8 @@ describe('Test Shadow Handler', () => {
   test.skip('reject buffer payload', async () => {
     //FIXME: Invalid input is silently ignored, need input validation
     expect(async () => {
-      await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.updateAccepted,
+      await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
         payload: Buffer.from('test-payload'),
         clientToken: ''
       });
@@ -57,8 +58,8 @@ describe('Test Shadow Handler', () => {
       }
     };
 
-    const updates = await shadowHandler.handleShadowTopic({
-      topic: shadowHandler.shadowTopics.projects.updateAccepted,
+    const updates = await shadowHandler.handleProjectShadow({
+      topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
       payload,
       clientToken: clientId
     });
@@ -72,8 +73,8 @@ describe('Test Shadow Handler', () => {
       }
     };
 
-    const updates = await shadowHandler.handleShadowTopic({
-      topic: shadowHandler.shadowTopics.projects.updateAccepted,
+    const updates = await shadowHandler.handleProjectShadow({
+      topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
       payload,
       clientToken: ''
     });
@@ -102,15 +103,17 @@ describe('Test Shadow Handler', () => {
       };
 
       const payload = {
-        delta: {
-          [projectId1]: {
-            appConfig: JSON.stringify(appCfg1)
+        state: {
+          desired: {
+            [projectId1]: {
+              appConfig: JSON.stringify(appCfg1)
+            }
           }
         }
       };
 
-      const updates = await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.getAccepted,
+      const updates = await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
         payload,
         clientToken: ''
       });
@@ -149,15 +152,17 @@ describe('Test Shadow Handler', () => {
       };
 
       const payload = {
-        desired: {
-          [projectId1]: {
-            appConfig: JSON.stringify(appCfg1)
+        state: {
+          desired: {
+            [projectId1]: {
+              appConfig: JSON.stringify(appCfg1)
+            }
           }
         }
       };
 
-      const updates = await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.updateAccepted,
+      const updates = await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
         payload,
         clientToken: ''
       });
@@ -214,18 +219,20 @@ describe('Test Shadow Handler', () => {
         }
       };
       const payload = {
-        desired: {
-          [projectId1]: {
-            appConfig: JSON.stringify(appCfg1)
-          },
-          [projectId2]: {
-            appConfig: JSON.stringify(appCfg2)
+        state: {
+          desired: {
+            [projectId1]: {
+              appConfig: JSON.stringify(appCfg1)
+            },
+            [projectId2]: {
+              appConfig: JSON.stringify(appCfg2)
+            }
           }
         }
       };
 
-      const updates = await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.updateAccepted,
+      const updates = await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
         payload,
         clientToken: ''
       });
@@ -273,15 +280,17 @@ describe('Test Shadow Handler', () => {
       };
 
       const payload = {
-        desired: {
-          [projectId1]: {
-            appConfig: JSON.stringify(appCfg1)
+        state: {
+          desired: {
+            [projectId1]: {
+              appConfig: JSON.stringify(appCfg1)
+            }
           }
         }
       };
 
-      const updates = await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.updateAccepted,
+      const updates = await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
         payload,
         clientToken: ''
       });
@@ -317,15 +326,17 @@ describe('Test Shadow Handler', () => {
       };
 
       const payload = {
-        desired: {
-          [projectId1]: {
-            appConfig: JSON.stringify(appCfg1)
+        state: {
+          desired: {
+            [projectId1]: {
+              appConfig: JSON.stringify(appCfg1)
+            }
           }
         }
       };
 
-      const updates = await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.updateAccepted,
+      const updates = await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
         payload,
         clientToken: ''
       });
@@ -353,9 +364,11 @@ describe('Test Shadow Handler', () => {
       };
 
       const payload = {
-        desired: {
-          [projectId1]: {
-            appConfig: appCfg1 // This is missing JSON.stringify() making this an unparsable object.
+        state: {
+          desired: {
+            [projectId1]: {
+              appConfig: appCfg1 // This is missing JSON.stringify() making this an unparsable object.
+            }
           }
         }
       };
@@ -364,61 +377,59 @@ describe('Test Shadow Handler', () => {
         .spyOn(logger, 'error')
         .mockReturnValue({} as unknown as Logger);
 
-      const updates = await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.updateAccepted,
+      const updates = await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
         payload,
         clientToken: ''
       });
 
       expect(updates.length).toBe(0);
       expect(loggerSpy).toHaveBeenCalledWith(
-        expect.stringContaining('Could not parse the appConfig')
+        expect.stringContaining('Error validating shadow update')
       );
     });
   });
 
   describe('handle project shadow env vars', () => {
-    test('handle project shadow env vars get response with delta', async () => {
+    test('handle a response from the getAccepted from the cloud', async () => {
       const envVars1 = {
         VAR0: 'value0'
       };
       const payload = {
-        delta: {
-          [projectId1]: {
-            envVars: envVars1
+        state: {
+          reported: {
+            [projectId1]: {
+              envVars: { service: envVars1 }
+            }
           }
         }
       };
 
-      const updates = await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.getAccepted,
+      const updates = await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'get/accepted'),
         payload,
-        clientToken: ''
-      });
-      expect(updates.length).toBe(1);
-      expect(updates[0]).toEqual({
-        projectId: projectId1,
-        txId: expect.any(String),
-        envVarUpdate: {
-          envVars: envVars1
-        }
+        clientToken: clientId
       });
+      expect(updates.length).toBe(0);
     });
-
     test('handle project shadow env vars update delta', async () => {
       const envVars1 = {
         VAR1: 'value1'
       };
       const payload = {
-        desired: {
-          [projectId1]: {
-            envVars: envVars1
+        state: {
+          desired: {
+            [projectId1]: {
+              envVars: {
+                service: envVars1
+              }
+            }
           }
         }
       };
 
-      const updates = await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.updateAccepted,
+      const updates = await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
         payload,
         clientToken: ''
       });
@@ -427,31 +438,36 @@ describe('Test Shadow Handler', () => {
         projectId: projectId1,
         txId: expect.any(String),
         envVarUpdate: {
-          envVars: envVars1
+          envVars: { service: envVars1 }
         }
       });
     });
 
     test('handle project shadow env vars update delta for two projects', async () => {
-      const envVars1 = {
+      const service1 = {
         VAR1: 'value1'
       };
-      const envVars2 = {
-        VAR2: null
+      const service2 = {
+        VAR2: 'value2'
       };
+
       const payload = {
-        desired: {
-          [projectId1]: {
-            envVars: envVars1
-          },
-          [projectId2]: {
-            envVars: envVars2
+        state: {
+          desired: {
+            [projectId1]: {
+              envVars: {
+                service: service1
+              }
+            },
+            [projectId2]: {
+              envVars: { service: service2 }
+            }
           }
         }
       };
 
-      const updates = await shadowHandler.handleShadowTopic({
-        topic: shadowHandler.shadowTopics.projects.updateAccepted,
+      const updates = await shadowHandler.handleProjectShadow({
+        topic: getShadowTopic(clientId, 'projects', 'update/accepted'),
         payload,
         clientToken: ''
       });
@@ -460,34 +476,35 @@ describe('Test Shadow Handler', () => {
         projectId: projectId1,
         txId: expect.any(String),
         envVarUpdate: {
-          envVars: envVars1
+          envVars: { service: service1 }
         }
       });
       expect(updates[1]).toEqual({
         projectId: projectId2,
         txId: expect.any(String),
         envVarUpdate: {
-          envVars: envVars2
+          envVars: { service: service2 }
         }
       });
     });
   });
 
   test('clear project shadow', async () => {
-    shadowHandler.clearAppConfig(projectId1);
+    await shadowHandler.clearProjectShadow(projectId1);
+    // The order of reported and desired in the packet does not matter for the device agent, but the test is checking literal equality of expected output, and therefore the order matters here with reported being first.
     const packet = {
+      clientToken: clientId,
       state: {
-        desired: {
+        reported: {
           [projectId1]: null
         },
-        reported: {
+        desired: {
           [projectId1]: null
         }
-      },
-      clientToken: clientId
+      }
     };
     expect(jest.mocked(publisher.publish)).toBeCalledWith(
-      shadowHandler.shadowTopics.projects.update,
+      getShadowTopic(clientId, 'projects', 'update'),
       JSON.stringify(packet)
     );
   });
@@ -513,15 +530,15 @@ describe('Test Shadow Handler', () => {
       clientToken: clientId
     };
     expect(jest.mocked(publisher.publish)).toBeCalledWith(
-      shadowHandler.shadowTopics.projects.update,
+      getShadowTopic(clientId, 'projects', 'update'),
       JSON.stringify(packet)
     );
   });
 
   test('get shadow updates', async () => {
-    shadowHandler.getShadowUpdates();
+    shadowHandler.getProjectShadowUpdates();
     expect(jest.mocked(publisher.publish)).toBeCalledWith(
-      shadowHandler.shadowTopics.projects.get,
+      getShadowTopic(clientId, 'projects', 'get'),
       JSON.stringify({
         clientToken: clientId
       })