Add multi-property query support (#105)

Co-authored-by: Xinyi Xu <xinyxu@amazon.com>
awslabs · Sep 14, 2022 · 9020c2f · 9020c2f
1 parent a0668e5
commit 9020c2f
Show file tree

Hide file tree

Showing 4 changed files with 330 additions and 95 deletions.
diff --git a/...e-iottwinmaker/src/time-series-data/client/getPropertyValueHistoryByComponentType.spec.ts b/...e-iottwinmaker/src/time-series-data/client/getPropertyValueHistoryByComponentType.spec.ts
@@ -21,6 +21,12 @@ describe('getPropertyValueHistoryByComponentType', () => {
     componentName: 'comp-1',
     propertyName: 'prop-1',
   };
+  const streamIdComponents3: TwinMakerDataStreamIdComponent = {
+    workspaceId: 'ws-1',
+    entityId: 'entity-2',
+    componentName: 'comp-1',
+    propertyName: 'prop-2',
+  };
   const mockEntityRef1 = {
     propertyName: streamIdComponents1.propertyName,
     externalIdProperty: {
@@ -34,6 +40,12 @@ describe('getPropertyValueHistoryByComponentType', () => {
     },
   };
   const mockEntityRef3 = {
+    propertyName: streamIdComponents3.propertyName,
+    externalIdProperty: {
+      extid: 'ext-id-2',
+    },
+  };
+  const mockEntityRef4 = {
     propertyName: streamIdComponents1.propertyName,
     externalIdProperty: {
       extid: 'ext-id-3',
@@ -57,6 +69,13 @@ describe('getPropertyValueHistoryByComponentType', () => {
       end,
       meta: { componentTypeId: 'comp-type-1' },
     },
+    {
+      id: toDataStreamId(streamIdComponents3),
+      resolution: '0',
+      start,
+      end,
+      meta: { componentTypeId: 'comp-type-1' },
+    },
   ];
   const tmClient = new IoTTwinMakerClient({});
   const twinMakerMetadataModule = new TwinMakerMetadataModule('workspace-id', tmClient);
@@ -105,6 +124,11 @@ describe('getPropertyValueHistoryByComponentType', () => {
                 isExternalId: false,
               },
             },
+            'prop-2': {
+              definition: {
+                isExternalId: false,
+              },
+            },
           },
         },
         'comp-2': {
@@ -150,7 +174,7 @@ describe('getPropertyValueHistoryByComponentType', () => {
         ],
       },
       {
-        entityPropertyReference: mockEntityRef3,
+        entityPropertyReference: mockEntityRef4,
         values: [
           {
             value: {
@@ -187,6 +211,17 @@ describe('getPropertyValueHistoryByComponentType', () => {
           },
         ],
       },
+      {
+        entityPropertyReference: mockEntityRef3,
+        values: [
+          {
+            value: {
+              integerValue: 44,
+            },
+            time: new Date(2022, 1, 4).toISOString(),
+          },
+        ],
+      },
     ],
   };
 
@@ -282,13 +317,14 @@ describe('getPropertyValueHistoryByComponentType', () => {
       requestInformations: [
         { ...mockRequestInfos[0], fetchFromStartToEnd: true },
         { ...mockRequestInfos[1], fetchFromStartToEnd: true },
+        { ...mockRequestInfos[2], fetchFromStartToEnd: true },
       ],
       client: tmClient,
     });
 
     await flushPromises();
 
-    expect(onSuccess).toBeCalledTimes(3);
+    expect(onSuccess).toBeCalledTimes(4);
     expect(onSuccess).toHaveBeenNthCalledWith(
       1,
       [
@@ -355,6 +391,28 @@ describe('getPropertyValueHistoryByComponentType', () => {
       start,
       end
     );
+    expect(onSuccess).toHaveBeenNthCalledWith(
+      4,
+      [
+        expect.objectContaining({
+          id: mockRequestInfos[2].id,
+          data: [
+            {
+              x: new Date(2022, 1, 4).getTime(),
+              y: 44,
+            },
+          ],
+          meta: {
+            entityId: streamIdComponents3.entityId,
+            componentName: streamIdComponents3.componentName,
+            propertyName: streamIdComponents3.propertyName,
+          },
+        }),
+      ],
+      { ...mockRequestInfos[2], fetchFromStartToEnd: true },
+      start,
+      end
+    );
   });
 
   it('should trigger onSuccess with correct dataStream response for fetchMostRecentBeforeEnd case', async () => {

diff --git a/...source-iottwinmaker/src/time-series-data/client/getPropertyValueHistoryByComponentType.ts b/...source-iottwinmaker/src/time-series-data/client/getPropertyValueHistoryByComponentType.ts
@@ -9,7 +9,7 @@ import { toDataPoint, isDefined, toDataStream, toDataType } from '../utils/value
 export const getPropertyValueHistoryByComponentTypeRequest = async ({
   workspaceId,
   componentTypeId,
-  propertyName,
+  propertyNames,
   requestInformations,
   entities,
   onSuccess,
@@ -20,7 +20,7 @@ export const getPropertyValueHistoryByComponentTypeRequest = async ({
 }: {
   workspaceId: string;
   componentTypeId: string;
-  propertyName: string;
+  propertyNames: string[];
   requestInformations: Record<string, RequestInformationAndRange>;
   entities: GetEntityResponse[];
   onError: ErrorCallback;
@@ -51,7 +51,7 @@ export const getPropertyValueHistoryByComponentTypeRequest = async ({
       new GetPropertyValueHistoryCommand({
         workspaceId,
         componentTypeId,
-        selectedProperties: [propertyName],
+        selectedProperties: propertyNames,
         orderByTime: fetchMostRecent ? 'DESCENDING' : 'ASCENDING',
         startTime: start.toISOString(),
         endTime: end.toISOString(),
@@ -70,7 +70,8 @@ export const getPropertyValueHistoryByComponentTypeRequest = async ({
           Object.values(components || {}).forEach((comp) => {
             if (
               comp.componentTypeId === componentTypeId &&
-              values.entityPropertyReference?.propertyName === propertyName &&
+              values.entityPropertyReference?.propertyName &&
+              propertyNames.includes(values.entityPropertyReference?.propertyName) &&
               values.entityPropertyReference.externalIdProperty &&
               comp.componentName
             ) {
@@ -97,8 +98,9 @@ export const getPropertyValueHistoryByComponentTypeRequest = async ({
           return isMatch;
         });
         const entityId = matchingEntity?.entityId;
+        const propertyName = values.entityPropertyReference.propertyName;
 
-        if (!entityId || isEmpty(matchingComponentName)) return;
+        if (!entityId || isEmpty(matchingComponentName) || !propertyName) return;
 
         const streamId = toDataStreamId({
           workspaceId,
@@ -147,7 +149,7 @@ export const getPropertyValueHistoryByComponentTypeRequest = async ({
         getPropertyValueHistoryByComponentTypeRequest({
           workspaceId,
           componentTypeId,
-          propertyName,
+          propertyNames,
           requestInformations,
           entities,
           onError,
@@ -188,12 +190,12 @@ export const getPropertyValueHistoryByComponentType = async ({
 }): Promise<void> => {
   // Group same component type API call into one
   const requestInputs: {
-    params: { componentTypeId: string; propertyName: string; workspaceId: string };
+    params: { componentTypeId: string; workspaceId: string };
+    propertyNames: string[];
     requestInfos: Record<string, RequestInformationAndRange>;
     entities: GetEntityResponse[];
   }[] = [];
 
-  // TODO: May bundle the requests for the same component type, but different properties into the same call
   requestInformations.forEach(async (info) => {
     const { workspaceId, propertyName } = fromDataStreamId(info.id);
     const componentTypeId =
@@ -219,13 +221,16 @@ export const getPropertyValueHistoryByComponentType = async ({
 
     if (inputIndex >= 0) {
       requestInputs[inputIndex].requestInfos[info.id] = info;
+      if (!requestInputs[inputIndex].propertyNames.includes(propertyName)) {
+        requestInputs[inputIndex].propertyNames.push(propertyName);
+      }
     } else {
       requestInputs.push({
         params: {
           componentTypeId: componentTypeId,
-          propertyName: propertyName,
           workspaceId: workspaceId,
         },
+        propertyNames: [propertyName],
         requestInfos: { [info.id]: info },
         entities: [],
       });
@@ -240,7 +245,7 @@ export const getPropertyValueHistoryByComponentType = async ({
     return getPropertyValueHistoryByComponentTypeRequest({
       workspaceId: input.params.workspaceId,
       componentTypeId: input.params.componentTypeId,
-      propertyName: input.params.propertyName,
+      propertyNames: input.propertyNames,
       requestInformations: input.requestInfos,
       entities,
       onSuccess,