add no query support for timeseries

palantir · Jul 23, 2024 · 9a79ec9 · 9a79ec9
1 parent 8cff4f0
commit 9a79ec9
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 9 deletions.
diff --git a/etc/client.api.report.api.md b/etc/client.api.report.api.md
@@ -719,9 +719,9 @@ export interface TimeSeriesPoint<T extends string | number> {
 // @public (undocumented)
 export interface TimeSeriesProperty<T extends number | string> {
     // (undocumented)
-    asyncIterPoints(query: TimeSeriesQuery): AsyncGenerator<TimeSeriesPoint<T>>;
+    asyncIterPoints(query?: TimeSeriesQuery): AsyncGenerator<TimeSeriesPoint<T>>;
     // (undocumented)
-    getAllPoints(query: TimeSeriesQuery): Promise<Array<TimeSeriesPoint<T>>>;
+    getAllPoints(query?: TimeSeriesQuery): Promise<Array<TimeSeriesPoint<T>>>;
     // (undocumented)
     getFirstPoint(): Promise<TimeSeriesPoint<T>>;
     // (undocumented)

diff --git a/packages/client.api/src/timeseries/timeseries.ts b/packages/client.api/src/timeseries/timeseries.ts
@@ -70,6 +70,6 @@ export interface TimeSeriesPoint<T extends string | number> {
 export interface TimeSeriesProperty<T extends number | string> {
   getFirstPoint(): Promise<TimeSeriesPoint<T>>;
   getLastPoint(): Promise<TimeSeriesPoint<T>>;
-  getAllPoints(query: TimeSeriesQuery): Promise<Array<TimeSeriesPoint<T>>>;
-  asyncIterPoints(query: TimeSeriesQuery): AsyncGenerator<TimeSeriesPoint<T>>;
+  getAllPoints(query?: TimeSeriesQuery): Promise<Array<TimeSeriesPoint<T>>>;
+  asyncIterPoints(query?: TimeSeriesQuery): AsyncGenerator<TimeSeriesPoint<T>>;
 }
diff --git a/packages/client/src/createTimeseriesProperty.ts b/packages/client/src/createTimeseriesProperty.ts
@@ -60,7 +60,7 @@ export function createTimeseriesProperty<T extends number | string>(
         propertyName,
       ) as Promise<TimeSeriesPoint<T>>;
     },
-    async getAllPoints(query: TimeSeriesQuery) {
+    async getAllPoints(query?: TimeSeriesQuery) {
       return getAllTimeSeriesPoints(
         client,
         objectApiName,
@@ -70,7 +70,7 @@ export function createTimeseriesProperty<T extends number | string>(
       );
     },
 
-    asyncIterPoints(query: TimeSeriesQuery) {
+    asyncIterPoints(query?: TimeSeriesQuery) {
       return iterateTimeSeriesPoints(
         client,
         objectApiName,
@@ -87,7 +87,7 @@ async function getAllTimeSeriesPoints<T extends string | number>(
   objectApiName: string,
   primaryKey: any,
   propertyName: string,
-  body: TimeSeriesQuery,
+  body?: TimeSeriesQuery,
 ): Promise<Array<TimeSeriesPoint<T>>> {
   const allPoints: Array<TimeSeriesPoint<T>> = [];
 
@@ -113,7 +113,7 @@ async function* iterateTimeSeriesPoints<T extends string | number>(
   objectApiName: string,
   primaryKey: any,
   propertyName: string,
-  body: TimeSeriesQuery,
+  body?: TimeSeriesQuery,
 ): AsyncGenerator<TimeSeriesPoint<T>, any, unknown> {
   const utf8decoder = new TextDecoder("utf-8");
 
@@ -124,7 +124,7 @@ async function* iterateTimeSeriesPoints<T extends string | number>(
       objectApiName,
       primaryKey,
       propertyName,
-      { range: getTimeRange(body) },
+      body ? { range: getTimeRange(body) } : {},
     );
 
   const reader = streamPointsIterator.stream().getReader();

diff --git a/packages/client/src/object/timeseries.test.ts b/packages/client/src/object/timeseries.test.ts
@@ -109,6 +109,23 @@ describe("Timeseries", () => {
     }, { time: "2014-04-14", value: 30 }]);
   });
 
+  it("getAll points with no query works", async () => {
+    const employee = await client(Employee).fetchOne(50030);
+    expect(employee.$primaryKey).toEqual(50030);
+    const points = await employee.employeeStatus?.getAllPoints();
+    expect(points).toBeDefined();
+    expect(points!).toEqual([
+      { time: "2012-02-12", value: 10 },
+      { time: "2012-02-12", value: 10 },
+      {
+        time: "2013-03-13",
+        value: 20,
+      },
+      { time: "2014-04-14", value: 30 },
+      { time: "2014-04-14", value: 30 },
+    ]);
+  });
+
   it("async iter points with absolute range works", async () => {
     const employee = await client(Employee).fetchOne(50030);
     expect(employee.$primaryKey).toEqual(50030);
@@ -127,4 +144,26 @@ describe("Timeseries", () => {
       value: 20,
     }, { time: "2014-04-14", value: 30 }]);
   });
+
+  it("async iter points with no query", async () => {
+    const employee = await client(Employee).fetchOne(50030);
+    expect(employee.$primaryKey).toEqual(50030);
+    const pointsIter = employee.employeeStatus?.asyncIterPoints();
+
+    const points: TimeSeriesPoint<string>[] = [];
+    for await (const point of pointsIter!) {
+      points.push(point);
+    }
+    expect(points).toBeDefined();
+    expect(points!).toEqual([
+      { time: "2012-02-12", value: 10 },
+      { time: "2012-02-12", value: 10 },
+      {
+        time: "2013-03-13",
+        value: 20,
+      },
+      { time: "2014-04-14", value: 30 },
+      { time: "2014-04-14", value: 30 },
+    ]);
+  });
 });
diff --git a/packages/shared.test/src/stubs/timeseriesRequests.ts b/packages/shared.test/src/stubs/timeseriesRequests.ts
@@ -55,6 +55,8 @@ const noBodyRequest: StreamTimeSeriesPointsRequest = {
   range: { type: "absolute" },
 };
 
+const noRangeRequest: StreamTimeSeriesPointsRequest = {};
+
 const fromBodyRequest: StreamTimeSeriesPointsRequest = {
   range: {
     type: "relative",
@@ -121,6 +123,7 @@ export const streamPointsRequestHandlers: Record<
   StreamTimeSeriesPointsResponse
 > = {
   [stableStringify(noBodyRequest)]: streamPointsNoBody,
+  [stableStringify(noRangeRequest)]: streamPointsNoBody,
   [stableStringify(rangeBodyRequest)]: streamPointsRange,
   [stableStringify(fromBodyRequest)]: streamPointsFrom,
   [stableStringify(afterBodyRequest)]: streamPointsAfter,