feat: customizable resolutions (#23)

* added customizable resolutions for sitewise data source which means we can specify a resolution per asset property * refactored resolutionMapping to resolution and allowed to pass string if we want a specific resolution for all queries Co-authored-by: Norbert Nader <nnader@amazon.com>
awslabs · Dec 21, 2021 · 0ffd474 · 0ffd474
1 parent 8f26b58
commit 0ffd474
Show file tree

Hide file tree

Showing 22 changed files with 619 additions and 99 deletions.
diff --git a/packages/components/src/components/iot-bar-chart/iot-bar-chart.spec.ts b/packages/components/src/components/iot-bar-chart/iot-bar-chart.spec.ts
@@ -29,7 +29,7 @@ const barChartSpecPage = async (propOverrides: Partial<Components.IotBarChart> =
     isEditing: false,
     query: {
       source: 'test-mock',
-      assets: [{ assetId: 'some-asset-id', propertyIds: ['some-property-id'] }],
+      assets: [{ assetId: 'some-asset-id', properties: [{ propertyId: 'some-property-id' }] }],
     } as SiteWiseDataStreamQuery,
     viewport,
     ...propOverrides,

diff --git a/packages/components/src/components/iot-connector/iot-connector.spec.ts b/packages/components/src/components/iot-connector/iot-connector.spec.ts
@@ -58,7 +58,7 @@ it('provides data streams', async () => {
     renderFunc,
     query: {
       source: 'test-mock',
-      assets: [{ assetId, propertyIds: [propertyId] }],
+      assets: [{ assetId, properties: [{ propertyId }] }],
     } as SiteWiseDataStreamQuery,
   });
 
@@ -87,7 +87,7 @@ it('updates with new query', async () => {
 
   connector.query = {
     source: 'test-mock',
-    assets: [{ assetId, propertyIds: [propertyId] }],
+    assets: [{ assetId, properties: [{ propertyId }] }],
   } as SiteWiseDataStreamQuery;
 
   await page.waitForChanges();

diff --git a/packages/components/src/components/iot-kpi/iot-kpi.spec.ts b/packages/components/src/components/iot-kpi/iot-kpi.spec.ts
@@ -29,7 +29,7 @@ const kpiSpecPage = async (propOverrides: Partial<Components.IotKpi> = {}) => {
     isEditing: false,
     query: {
       source: 'test-mock',
-      assets: [{ assetId: 'some-asset-id', propertyIds: ['some-property-id'] }],
+      assets: [{ assetId: 'some-asset-id', properties: [{ propertyId: 'some-property-id' }] }],
     } as SiteWiseDataStreamQuery, // static casting because of legacy sw
     viewport,
     ...propOverrides,

diff --git a/packages/components/src/components/iot-line-chart/iot-line-chart.spec.ts b/packages/components/src/components/iot-line-chart/iot-line-chart.spec.ts
@@ -30,7 +30,7 @@ const lineChartSpecPage = async (propOverrides: Partial<Components.IotKpi> = {})
     isEditing: false,
     query: {
       source: 'test-mock',
-      assets: [{ assetId: 'some-asset-id', propertyIds: ['some-property-id'] }],
+      assets: [{ assetId: 'some-asset-id', properties: [{ propertyId: 'some-property-id' }] }],
     } as SiteWiseDataStreamQuery, // static casting because of legacy sw
     viewport,
     ...propOverrides,

diff --git a/packages/components/src/components/iot-scatter-chart/iot-scatter-chart.spec.ts b/packages/components/src/components/iot-scatter-chart/iot-scatter-chart.spec.ts
@@ -29,7 +29,7 @@ const scatterChartSpecPage = async (propOverrides: Partial<Components.IotScatter
     isEditing: false,
     query: {
       source: 'test-mock',
-      assets: [{ assetId: 'some-asset-id', propertyIds: ['some-property-id'] }],
+      assets: [{ assetId: 'some-asset-id', properties: [{ propertyId: 'some-property-id' }] }],
     } as SiteWiseDataStreamQuery, // static casting because of legacy sw
     viewport,
     ...propOverrides,

diff --git a/packages/components/src/components/iot-status-grid/iot-status-grid.spec.ts b/packages/components/src/components/iot-status-grid/iot-status-grid.spec.ts
@@ -29,7 +29,7 @@ const statusGridSpecPage = async (propOverrides: Partial<Components.IotKpi> = {}
     isEditing: false,
     query: {
       source: 'test-mock',
-      assets: [{ assetId: 'some-asset-id', propertyIds: ['some-property-id'] }],
+      assets: [{ assetId: 'some-asset-id', properties: [{ propertyId: 'some-property-id' }] }],
     } as SiteWiseDataStreamQuery, // static casting because of legacy sw
     viewport,
     ...propOverrides,

diff --git a/packages/components/src/components/iot-status-timeline/iot-status-timeline.spec.ts b/packages/components/src/components/iot-status-timeline/iot-status-timeline.spec.ts
@@ -31,7 +31,7 @@ const statusTimelineSpecPage = async (propOverrides: Partial<Components.IotStatu
     isEditing: false,
     query: {
       source: 'test-mock',
-      assets: [{ assetId: 'some-asset-id', propertyIds: ['some-property-id'] }],
+      assets: [{ assetId: 'some-asset-id', properties: [{ propertyId: 'some-property-id' }] }],
     } as SiteWiseDataStreamQuery, // static casting because of legacy sw
     viewport,
     ...propOverrides,

diff --git a/packages/components/src/components/iot-table/iot-table.spec.ts b/packages/components/src/components/iot-table/iot-table.spec.ts
@@ -29,7 +29,7 @@ const tableSpecPage = async (propOverrides: Partial<Components.IotKpi> = {}) =>
     isEditing: false,
     query: {
       source: 'test-mock',
-      assets: [{ assetId: 'some-asset-id', propertyIds: ['some-property-id'] }],
+      assets: [{ assetId: 'some-asset-id', properties: [{ propertyId: 'some-property-id' }] }],
     } as SiteWiseDataStreamQuery, // static casting because of legacy sw
     viewport,
     ...propOverrides,

diff --git a/packages/components/src/testing/createMockSource.ts b/packages/components/src/testing/createMockSource.ts
@@ -5,7 +5,7 @@ import { toDataStreamId } from './dataStreamId';
 
 const dataStreamIds = (query: SiteWiseDataStreamQuery) =>
   query.assets
-    .map(({ assetId, propertyIds }) => propertyIds.map((propertyId) => toDataStreamId({ assetId, propertyId })))
+    .map(({ assetId, properties }) => properties.map(({ propertyId }) => toDataStreamId({ assetId, propertyId })))
     .flat();
 
 export const createMockSource = (dataStreams: DataStream[]): DataSource => ({

diff --git a/packages/components/src/testing/testing-ground/siteWiseQueries.ts b/packages/components/src/testing/testing-ground/siteWiseQueries.ts
@@ -10,7 +10,7 @@ export const DEMO_TURBINE_ASSET_1_PROPERTY_4 = '8d9ed440-a8dd-48bd-a35f-70db6f2e
 
 export const STRING_QUERY = {
   source: 'site-wise',
-  assets: [{ assetId: STRING_ASSET_ID, propertyIds: [STRING_PROPERTY_ID] }],
+  assets: [{ assetId: STRING_ASSET_ID, properties: [{ propertyId: STRING_PROPERTY_ID }] }],
 };
 
 export const ASSET_DETAILS_QUERY = {
@@ -22,17 +22,24 @@ export const NUMBER_QUERY = {
   assets: [
     {
       assetId: DEMO_TURBINE_ASSET_1,
-      propertyIds: [DEMO_TURBINE_ASSET_1_PROPERTY_1, DEMO_TURBINE_ASSET_1_PROPERTY_4],
+      properties: [{ propertyId: DEMO_TURBINE_ASSET_1_PROPERTY_1 }, { propertyId: DEMO_TURBINE_ASSET_1_PROPERTY_4 }],
     },
   ],
 };
 
 const AGGREGATED_DATA_ASSET = '099b1330-83ff-4fec-b165-c7186ec8eb23';
 const AGGREGATED_DATA_PROPERTY = '05c5c47f-fd92-4823-828e-09ce63b90569';
+const AGGREGATED_DATA_PROPERTY_2 = '11d2599a-2547-451d-ab79-a47f878dbbe3';
 
 export const AGGREGATED_DATA_QUERY = {
   source: 'site-wise',
-  assets: [{ assetId: AGGREGATED_DATA_ASSET, propertyIds: [AGGREGATED_DATA_PROPERTY] }],
+  assets: [{
+    assetId: AGGREGATED_DATA_ASSET,
+    properties: [
+      { propertyId: AGGREGATED_DATA_PROPERTY },
+      { propertyId: AGGREGATED_DATA_PROPERTY_2, resolution: '1m' }
+    ]
+  }],
 };
 
 // From demo turbine asset, found at https://p-rlvy2rj8.app.iotsitewise.aws/

diff --git a/packages/components/src/testing/testing-ground/testing-ground.tsx b/packages/components/src/testing/testing-ground/testing-ground.tsx
@@ -1,5 +1,5 @@
-import { Component, h } from '@stencil/core';
-import { initialize, DataModule } from '@iot-app-kit/core';
+import { Component, State, h } from '@stencil/core';
+import { initialize, DataModule, ResolutionConfig } from '@iot-app-kit/core';
 import {
   ASSET_DETAILS_QUERY,
   DEMO_TURBINE_ASSET_1,
@@ -15,7 +15,7 @@ const VIEWPORT = { duration: '5m' };
 
 const THREE_MINUTES = 1000 * 60 * 3;
 
-const resolutionMapping = {
+const DEFAULT_RESOLUTION_MAPPING = {
   [THREE_MINUTES]: '1m',
 }
 
@@ -24,10 +24,30 @@ const resolutionMapping = {
   styleUrl: 'testing-ground.css',
 })
 export class TestingGround {
+  @State() resolution: ResolutionConfig = DEFAULT_RESOLUTION_MAPPING;
+  @State() viewport: { duration: string } = VIEWPORT;
   private dataModule: DataModule;
 
   componentWillLoad() {
-    this.dataModule = initialize({ awsCredentials: getEnvCredentials(), awsRegion: 'us-west-2' });
+    this.dataModule = initialize({ awsCredentials: getEnvCredentials(), awsRegion: 'us-east-1' });
+  }
+
+  private changeResolution = (ev: Event) => {
+    const resolution = (ev.target as HTMLSelectElement)?.value;
+
+    if (resolution === 'auto'){
+      this.resolution = DEFAULT_RESOLUTION_MAPPING;
+    } else if (resolution === '0') {
+      this.resolution = {};
+    } else {
+      this.resolution = resolution;
+    }
+  }
+
+  private changeDuration = (ev: Event) => {
+    const duration = `${(ev.target as HTMLSelectElement)?.value}m`;
+
+    this.viewport = { duration };
   }
 
   render() {
@@ -86,12 +106,22 @@ export class TestingGround {
             />
           </div>
         </div>
+        resolution: <select onChange={this.changeResolution}>
+          <option value={'0'}>raw</option>
+          <option value={'1m'}>1m</option>
+          <option selected value={'auto'}>auto</option>
+        </select>
+        viewport: <select onChange={this.changeDuration}>
+          <option value={'1'}>1 minute</option>
+          <option value={'3'}>3 minutes</option>
+          <option selected value={'5'}>5 minutes</option>
+        </select>
         <div style={{ width: '400px', height: '500px' }}>
           <iot-line-chart
             appKit={this.dataModule}
             query={AGGREGATED_DATA_QUERY}
-            viewport={VIEWPORT}
-            requestConfig={{ resolutionMapping, fetchAggregatedData: true }}
+            viewport={this.viewport}
+            requestConfig={{ resolution: this.resolution, fetchAggregatedData: true }}
           />
         </div>
         <iot-asset-details query={ASSET_DETAILS_QUERY} />

diff --git a/packages/core/src/data-module/IotAppKitDataModule.spec.ts b/packages/core/src/data-module/IotAppKitDataModule.spec.ts
@@ -25,7 +25,7 @@ const DATA_STREAM_QUERY: SiteWiseDataStreamQuery = {
   assets: [
     {
       assetId: ASSET_ID,
-      propertyIds: [PROPERTY_ID],
+      properties: [{ propertyId: PROPERTY_ID }],
     },
   ],
 };
@@ -39,8 +39,8 @@ const createMockSiteWiseDataSource = (
   initiateRequest: jest.fn(({ onSuccess }: DataSourceRequest<SiteWiseDataStreamQuery>) => onSuccess(dataStreams)),
   getRequestsFromQuery: ({ query }) =>
     query.assets
-      .map(({ assetId, propertyIds }) =>
-        propertyIds.map((propertyId) => ({
+      .map(({ assetId, properties }) =>
+        properties.map(({ propertyId }) => ({
           id: toDataStreamId({ assetId, propertyId }),
           resolution,
         }))
@@ -183,7 +183,7 @@ it('subscribes to a single data stream', async () => {
         assets: [
           {
             assetId,
-            propertyIds: [propertyId],
+            properties: [{ propertyId }],
           },
         ],
       },
@@ -233,7 +233,7 @@ it('requests data from a custom data source', () => {
   dataModule.subscribeToDataStreams(
     {
       query: {
-        assets: [{ assetId, propertyIds: [propertyId] }],
+        assets: [{ assetId, properties: [{ propertyId }] }],
         source: customSource.name,
       },
       requestInfo: {
@@ -778,3 +778,4 @@ it('requests data range with buffer', () => {
 
   unsubscribe();
 });
+
diff --git a/packages/core/src/data-module/data-cache/requestTypes.ts b/packages/core/src/data-module/data-cache/requestTypes.ts
@@ -26,13 +26,15 @@ export type OnRequestData = (opts: {
   dataStreamId: string;
 }) => void;
 
-export type ResolutionMapping ={
+export type ResolutionMapping = {
   [viewportDuration: number]: number | string;
 };
 
+export type ResolutionConfig = ResolutionMapping | string;
+
 export interface RequestConfig {
   fetchMostRecentBeforeStart?: boolean;
   requestBuffer?: number;
   fetchAggregatedData?: boolean;
-  resolutionMapping?: ResolutionMapping;
+  resolution?: ResolutionConfig;
 }
diff --git a/packages/core/src/data-module/subscription-store/subscriptionStore.spec.ts b/packages/core/src/data-module/subscription-store/subscriptionStore.spec.ts
@@ -39,7 +39,7 @@ it('updates subscription', () => {
 
   const query = {
     source: SITEWISE_DATA_SOURCE,
-    assets: [{ assetId: '123', propertyIds: ['prop1', 'prop2'] }],
+    assets: [{ assetId: '123', properties: [{ propertyId: 'prop1' }, { propertyId: 'prop2' }] }],
   };
 
   subscriptionStore.addSubscription(SUBSCRIPTION_ID, MOCK_SUBSCRIPTION);

diff --git a/packages/core/src/data-sources/site-wise/client/client.spec.ts b/packages/core/src/data-sources/site-wise/client/client.spec.ts
@@ -25,7 +25,7 @@ describe('getHistoricalPropertyDataPoints', () => {
     const onError = jest.fn();
     const query: SiteWiseDataStreamQuery = {
       source: SITEWISE_DATA_SOURCE,
-      assets: [{ assetId, propertyIds: [propertyId] }],
+      assets: [{ assetId, properties: [{ propertyId }] }],
     };
 
     const client = new SiteWiseClient(createSiteWiseSDK({ getAssetPropertyValueHistory }));
@@ -47,7 +47,7 @@ describe('getHistoricalPropertyDataPoints', () => {
     const onError = jest.fn();
     const query: SiteWiseDataStreamQuery = {
       source: SITEWISE_DATA_SOURCE,
-      assets: [{ assetId, propertyIds: [propertyId] }],
+      assets: [{ assetId, properties: [{ propertyId }] }],
     };
 
     const client = new SiteWiseClient(createSiteWiseSDK({ getAssetPropertyValueHistory }));
@@ -91,7 +91,7 @@ describe('getLatestPropertyDataPoint', () => {
     const onError = jest.fn();
     const query: SiteWiseDataStreamQuery = {
       source: SITEWISE_DATA_SOURCE,
-      assets: [{ assetId, propertyIds: [propertyId] }],
+      assets: [{ assetId, properties: [{ propertyId }] }],
     };
 
     const client = new SiteWiseClient(createSiteWiseSDK({ getAssetPropertyValue }));
@@ -126,7 +126,7 @@ describe('getLatestPropertyDataPoint', () => {
     const onError = jest.fn();
     const query: SiteWiseDataStreamQuery = {
       source: SITEWISE_DATA_SOURCE,
-      assets: [{ assetId, propertyIds: [propertyId] }],
+      assets: [{ assetId, properties: [{ propertyId }] }],
     };
 
     await client.getLatestPropertyDataPoint({ query, onSuccess, onError });
@@ -147,7 +147,7 @@ describe('getAggregatedPropertyDataPoints', () => {
     const onError = jest.fn();
     const query: SiteWiseDataStreamQuery = {
       source: SITEWISE_DATA_SOURCE,
-      assets: [{ assetId, propertyIds: [propertyId] }],
+      assets: [{ assetId, properties: [{ propertyId }] }],
     };
 
     const client = new SiteWiseClient(createSiteWiseSDK({ getAssetPropertyAggregates }));
@@ -170,6 +170,34 @@ describe('getAggregatedPropertyDataPoints', () => {
     expect(onError).toBeCalled();
   });
 
+  it('throws error when no resolution specified', async () => {
+    const getAssetPropertyAggregates = jest.fn().mockResolvedValue(AGGREGATE_VALUES);
+    const assetId = 'some-asset-id';
+    const propertyId = 'some-property-id';
+
+    const onSuccess = jest.fn();
+    const onError = jest.fn();
+    const query: SiteWiseDataStreamQuery = {
+      source: SITEWISE_DATA_SOURCE,
+      assets: [{ assetId, properties: [{ propertyId }] }],
+    };
+
+    const client = new SiteWiseClient(createSiteWiseSDK({ getAssetPropertyAggregates }));
+
+    const startDate = new Date(2000, 0, 0);
+    const endDate = new Date(2001, 0, 0);
+    const aggregateTypes = [AggregateType.AVERAGE];
+
+    await expect(async () => { await client.getAggregatedPropertyDataPoints({
+      query,
+      onSuccess,
+      onError,
+      start: startDate,
+      end: endDate,
+      aggregateTypes,
+    })}).rejects.toThrowError();
+  });
+
   it('returns data point on success', async () => {
     const assetId = 'some-asset-id';
     const propertyId = 'some-property-id';
@@ -178,7 +206,7 @@ describe('getAggregatedPropertyDataPoints', () => {
     const onError = jest.fn();
     const query: SiteWiseDataStreamQuery = {
       source: SITEWISE_DATA_SOURCE,
-      assets: [{ assetId, propertyIds: [propertyId] }],
+      assets: [{ assetId, properties: [{ propertyId }] }],
     };
     const getAssetPropertyAggregates = jest.fn().mockResolvedValue(AGGREGATE_VALUES);
 

diff --git a/packages/core/src/data-sources/site-wise/client/client.ts b/packages/core/src/data-sources/site-wise/client/client.ts
@@ -35,10 +35,10 @@ export class SiteWiseClient {
     query: SiteWiseDataStreamQuery;
     start: Date;
     end: Date;
-    resolution: string;
+    resolution?: string;
     aggregateTypes: AggregateType[];
     maxResults?: number;
-    onError: Function;
+    onError: ErrorCallback;
     onSuccess: DataStreamCallback;
   }): Promise<void> {
     return getAggregatedPropertyDataPoints({ client: this.siteWiseSdk, ...options });