feat: api simplification of requestSettings (#27)

awslabs · Jan 5, 2022 · 3d6f458 · 3d6f458
1 parent 08129f1
commit 3d6f458
Show file tree

Hide file tree

Showing 47 changed files with 861 additions and 774 deletions.
diff --git a/packages/components/src/components.d.ts b/packages/components/src/components.d.ts
@@ -5,7 +5,7 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "@stencil/core/internal";
-import { AnyDataStreamQuery, AssetSummaryQuery, AssetTreeSubscription, DataModule, Request, RequestConfig, SiteWiseAssetTreeQuery } from "@iot-app-kit/core";
+import { AnyDataStreamQuery, AssetSummaryQuery, AssetTreeSubscription, DataModule, SiteWiseAssetTreeQuery, TimeSeriesDataRequest, TimeSeriesDataRequestSettings } from "@iot-app-kit/core";
 import { DataStream, MinimalViewPortConfig } from "@synchro-charts/core";
 import { TableProps } from "@awsui/components-react/table";
 import { EmptyStateProps, ITreeNode, UseTreeCollection } from "@iot-app-kit/related-table";
@@ -23,60 +23,60 @@ export namespace Components {
         "appKit": DataModule;
         "isEditing": boolean | undefined;
         "query": AnyDataStreamQuery;
-        "requestConfig": RequestConfig | undefined;
+        "settings": TimeSeriesDataRequestSettings | undefined;
         "viewport": MinimalViewPortConfig;
         "widgetId": string;
     }
     interface IotConnector {
         "appKit": DataModule;
         "query": AnyDataStreamQuery;
         "renderFunc": ({ dataStreams }: { dataStreams: DataStream[] }) => unknown;
-        "requestInfo": Request;
+        "request": TimeSeriesDataRequest;
     }
     interface IotKpi {
         "appKit": DataModule;
         "isEditing": boolean | undefined;
         "query": AnyDataStreamQuery;
-        "requestConfig": RequestConfig | undefined;
+        "settings": TimeSeriesDataRequestSettings | undefined;
         "viewport": MinimalViewPortConfig;
         "widgetId": string;
     }
     interface IotLineChart {
         "appKit": DataModule;
         "isEditing": boolean | undefined;
         "query": AnyDataStreamQuery;
-        "requestConfig": RequestConfig | undefined;
+        "settings": TimeSeriesDataRequestSettings | undefined;
         "viewport": MinimalViewPortConfig;
         "widgetId": string;
     }
     interface IotScatterChart {
         "appKit": DataModule;
         "isEditing": boolean | undefined;
         "query": AnyDataStreamQuery;
-        "requestConfig": RequestConfig | undefined;
+        "settings": TimeSeriesDataRequestSettings | undefined;
         "viewport": MinimalViewPortConfig;
         "widgetId": string;
     }
     interface IotStatusGrid {
         "appKit": DataModule;
         "isEditing": boolean | undefined;
         "query": AnyDataStreamQuery;
-        "requestConfig": RequestConfig | undefined;
+        "settings": TimeSeriesDataRequestSettings | undefined;
         "viewport": MinimalViewPortConfig;
         "widgetId": string;
     }
     interface IotStatusTimeline {
         "appKit": DataModule;
         "isEditing": boolean | undefined;
         "query": AnyDataStreamQuery;
-        "requestConfig": RequestConfig | undefined;
+        "settings": TimeSeriesDataRequestSettings | undefined;
         "viewport": MinimalViewPortConfig;
         "widgetId": string;
     }
     interface IotTable {
         "appKit": DataModule;
         "query": AnyDataStreamQuery;
-        "requestConfig": RequestConfig | undefined;
+        "settings": TimeSeriesDataRequestSettings | undefined;
         "viewport": MinimalViewPortConfig;
         "widgetId": string;
     }
@@ -242,60 +242,60 @@ declare namespace LocalJSX {
         "appKit"?: DataModule;
         "isEditing"?: boolean | undefined;
         "query"?: AnyDataStreamQuery;
-        "requestConfig"?: RequestConfig | undefined;
+        "settings"?: TimeSeriesDataRequestSettings | undefined;
         "viewport"?: MinimalViewPortConfig;
         "widgetId"?: string;
     }
     interface IotConnector {
         "appKit"?: DataModule;
         "query"?: AnyDataStreamQuery;
         "renderFunc"?: ({ dataStreams }: { dataStreams: DataStream[] }) => unknown;
-        "requestInfo"?: Request;
+        "request"?: TimeSeriesDataRequest;
     }
     interface IotKpi {
         "appKit"?: DataModule;
         "isEditing"?: boolean | undefined;
         "query"?: AnyDataStreamQuery;
-        "requestConfig"?: RequestConfig | undefined;
+        "settings"?: TimeSeriesDataRequestSettings | undefined;
         "viewport"?: MinimalViewPortConfig;
         "widgetId"?: string;
     }
     interface IotLineChart {
         "appKit"?: DataModule;
         "isEditing"?: boolean | undefined;
         "query"?: AnyDataStreamQuery;
-        "requestConfig"?: RequestConfig | undefined;
+        "settings"?: TimeSeriesDataRequestSettings | undefined;
         "viewport"?: MinimalViewPortConfig;
         "widgetId"?: string;
     }
     interface IotScatterChart {
         "appKit"?: DataModule;
         "isEditing"?: boolean | undefined;
         "query"?: AnyDataStreamQuery;
-        "requestConfig"?: RequestConfig | undefined;
+        "settings"?: TimeSeriesDataRequestSettings | undefined;
         "viewport"?: MinimalViewPortConfig;
         "widgetId"?: string;
     }
     interface IotStatusGrid {
         "appKit"?: DataModule;
         "isEditing"?: boolean | undefined;
         "query"?: AnyDataStreamQuery;
-        "requestConfig"?: RequestConfig | undefined;
+        "settings"?: TimeSeriesDataRequestSettings | undefined;
         "viewport"?: MinimalViewPortConfig;
         "widgetId"?: string;
     }
     interface IotStatusTimeline {
         "appKit"?: DataModule;
         "isEditing"?: boolean | undefined;
         "query"?: AnyDataStreamQuery;
-        "requestConfig"?: RequestConfig | undefined;
+        "settings"?: TimeSeriesDataRequestSettings | undefined;
         "viewport"?: MinimalViewPortConfig;
         "widgetId"?: string;
     }
     interface IotTable {
         "appKit"?: DataModule;
         "query"?: AnyDataStreamQuery;
-        "requestConfig"?: RequestConfig | undefined;
+        "settings"?: TimeSeriesDataRequestSettings | undefined;
         "viewport"?: MinimalViewPortConfig;
         "widgetId"?: string;
     }

diff --git a/packages/components/src/components/iot-bar-chart/iot-bar-chart.tsx b/packages/components/src/components/iot-bar-chart/iot-bar-chart.tsx
@@ -1,6 +1,6 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
-import { AnyDataStreamQuery, DataModule, Request, RequestConfig } from '@iot-app-kit/core';
+import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 * 60 };
 
@@ -19,27 +19,29 @@ export class IotBarChart {
 
   @Prop() isEditing: boolean | undefined;
 
-  @Prop() requestConfig: RequestConfig | undefined
+  @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
-  requestInfo(): Request {
+  getSettings(): TimeSeriesDataRequestSettings {
     return {
-      viewport: this.viewport,
-      onlyFetchLatestValue: false,
-      requestConfig: this.requestConfig,
+      ...this.settings,
+      fetchFromStartToEnd: true,
     };
   }
 
   render() {
-    const requestInfo = this.requestInfo();
+    const settings = this.getSettings();
     return (
       <iot-connector
         appKit={this.appKit}
         query={this.query}
-        requestInfo={requestInfo}
+        request={{
+          settings,
+          viewport: this.viewport,
+        }}
         renderFunc={({ dataStreams }) => (
           <sc-bar-chart
             dataStreams={dataStreams}
-            viewport={requestInfo.viewport}
+            viewport={this.viewport}
             isEditing={this.isEditing}
             widgetId={this.widgetId}
           />

diff --git a/packages/components/src/components/iot-connector/iot-connector.spec.ts b/packages/components/src/components/iot-connector/iot-connector.spec.ts
@@ -31,7 +31,7 @@ const connectorSpecPage = async (propOverrides: Partial<Components.IotConnector>
       source: 'test-mock',
       assets: [],
     } as SiteWiseDataStreamQuery, // static casting because of legacy sw
-    requestInfo: { viewport, onlyFetchLatestValue: true },
+    request: { viewport, settings: { fetchMostRecentBeforeEnd: true } },
     ...propOverrides,
   };
   update(connector, props);

diff --git a/packages/components/src/components/iot-connector/iot-connector.tsx b/packages/components/src/components/iot-connector/iot-connector.tsx
@@ -1,7 +1,13 @@
 import { Component, Prop, State, Watch } from '@stencil/core';
 import { DataStream } from '@synchro-charts/core';
 import isEqual from 'lodash.isequal';
-import { Request, AnyDataStreamQuery, SubscriptionUpdate, subscribeToDataStreams, DataModule } from '@iot-app-kit/core';
+import {
+  AnyDataStreamQuery,
+  SubscriptionUpdate,
+  subscribeToDataStreams,
+  DataModule,
+  TimeSeriesDataRequest,
+} from '@iot-app-kit/core';
 
 @Component({
   tag: 'iot-connector',
@@ -12,7 +18,7 @@ export class IotConnector {
 
   @Prop() query: AnyDataStreamQuery;
 
-  @Prop() requestInfo: Request;
+  @Prop() request: TimeSeriesDataRequest;
 
   @Prop() renderFunc: ({ dataStreams }: { dataStreams: DataStream[] }) => unknown;
 
@@ -28,7 +34,7 @@ export class IotConnector {
       this.appKit,
       {
         query: this.query,
-        requestInfo: this.requestInfo,
+        request: this.request,
       },
       (dataStreams: DataStream[]) => {
         this.dataStreams = dataStreams;
@@ -47,13 +53,13 @@ export class IotConnector {
   /**
    * Sync subscription to change in queried data
    */
-  @Watch('requestInfo')
+  @Watch('request')
   @Watch('query')
   onUpdateProp(newProp: unknown, oldProp: unknown) {
     if (!isEqual(newProp, oldProp) && this.update != null) {
       this.update({
         query: this.query,
-        requestInfo: this.requestInfo,
+        request: this.request,
       });
     }
   }

diff --git a/packages/components/src/components/iot-kpi/iot-kpi.tsx b/packages/components/src/components/iot-kpi/iot-kpi.tsx
@@ -1,6 +1,6 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
-import { AnyDataStreamQuery, DataModule, RequestConfig } from '@iot-app-kit/core';
+import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 };
 
@@ -19,27 +19,29 @@ export class IotKpi {
 
   @Prop() isEditing: boolean | undefined;
 
-  @Prop() requestConfig: RequestConfig | undefined
+  @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
-  requestInfo() {
+  getSettings(): TimeSeriesDataRequestSettings {
     return {
-      viewport: this.viewport,
-      onlyFetchLatestValue: true,
-      requestConfig: this.requestConfig,
+      ...this.settings,
+      fetchMostRecentBeforeEnd: true,
     };
   }
 
   render() {
-    const requestInfo = this.requestInfo();
+    const settings = this.getSettings();
     return (
       <iot-connector
         appKit={this.appKit}
         query={this.query}
-        requestInfo={requestInfo}
+        request={{
+          settings,
+          viewport: this.viewport,
+        }}
         renderFunc={({ dataStreams }) => (
           <sc-kpi
             dataStreams={dataStreams}
-            viewport={requestInfo.viewport}
+            viewport={this.viewport}
             isEditing={this.isEditing}
             widgetId={this.widgetId}
           />

diff --git a/packages/components/src/components/iot-line-chart/iot-line-chart.tsx b/packages/components/src/components/iot-line-chart/iot-line-chart.tsx
@@ -1,6 +1,6 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
-import { AnyDataStreamQuery, DataModule, Request, RequestConfig } from '@iot-app-kit/core';
+import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 * 60 };
 
@@ -19,27 +19,31 @@ export class IotLineChart {
 
   @Prop() isEditing: boolean | undefined;
 
-  @Prop() requestConfig: RequestConfig | undefined
+  @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
-  requestInfo(): Request {
+  getSettings(): TimeSeriesDataRequestSettings {
     return {
-      viewport: this.viewport,
-      onlyFetchLatestValue: false,
-      requestConfig: this.requestConfig,
+      ...this.settings,
+      fetchFromStartToEnd: true,
+      // Required to be able to draw line from last point visible, to first point before the viewport.
+      fetchMostRecentBeforeStart: true,
     };
   }
 
   render() {
-    const requestInfo = this.requestInfo();
+    const settings = this.getSettings();
     return (
       <iot-connector
         appKit={this.appKit}
         query={this.query}
-        requestInfo={requestInfo}
+        request={{
+          settings,
+          viewport: this.viewport,
+        }}
         renderFunc={({ dataStreams }) => (
           <sc-line-chart
             dataStreams={dataStreams}
-            viewport={requestInfo.viewport}
+            viewport={this.viewport}
             isEditing={this.isEditing}
             widgetId={this.widgetId}
           />

diff --git a/packages/components/src/components/iot-scatter-chart/iot-scatter-chart.tsx b/packages/components/src/components/iot-scatter-chart/iot-scatter-chart.tsx
@@ -1,6 +1,6 @@
 import { Component, Prop, h } from '@stencil/core';
 import { MinimalViewPortConfig } from '@synchro-charts/core';
-import { AnyDataStreamQuery, DataModule, Request, RequestConfig } from '@iot-app-kit/core';
+import { AnyDataStreamQuery, DataModule, TimeSeriesDataRequestSettings } from '@iot-app-kit/core';
 
 const DEFAULT_VIEWPORT = { duration: 10 * 1000 * 60 };
 
@@ -19,27 +19,29 @@ export class IotScatterChart {
 
   @Prop() isEditing: boolean | undefined;
 
-  @Prop() requestConfig: RequestConfig | undefined
+  @Prop() settings: TimeSeriesDataRequestSettings | undefined;
 
-  requestInfo(): Request {
+  getSettings(): TimeSeriesDataRequestSettings {
     return {
-      viewport: this.viewport,
-      onlyFetchLatestValue: false,
-      requestConfig: this.requestConfig,
+      ...this.settings,
+      fetchFromStartToEnd: true,
     };
   }
 
   render() {
-    const requestInfo = this.requestInfo();
+    const settings = this.getSettings();
     return (
       <iot-connector
         appKit={this.appKit}
         query={this.query}
-        requestInfo={requestInfo}
+        request={{
+          settings,
+          viewport: this.viewport,
+        }}
         renderFunc={({ dataStreams }) => (
           <sc-scatter-chart
             dataStreams={dataStreams}
-            viewport={requestInfo.viewport}
+            viewport={this.viewport}
             isEditing={this.isEditing}
             widgetId={this.widgetId}
           />