Change return type to a list #DATA-3446

viamrobotics · Dec 17, 2024 · fb4307f · fb4307f
1 parent eb93448
commit fb4307f
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 20 deletions.
diff --git a/lib/src/app/data.dart b/lib/src/app/data.dart
@@ -165,17 +165,17 @@ class DataClient {
 
   /// Obtain unified tabular data and metadata from the specified data source.
   ///
-  /// Returns a stream of data points.
+  /// Returns a list of data points.
   ///
   /// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
-  Stream<TabularDataPoint> exportTabularData(
+  Future<List<TabularDataPoint>> exportTabularData(
     String partId,
     String resourceName,
     String resourceSubtype,
     String methodName,
     DateTime? startTime,
     DateTime? endTime,
-  ) {
+  ) async {
     final interval = CaptureInterval();
     if (startTime != null) {
       interval.start = Timestamp.fromDateTime(startTime);
@@ -191,21 +191,24 @@ class DataClient {
       ..methodName = methodName
       ..interval = interval;
 
-    return _dataClient.exportTabularData(request).map((response) => TabularDataPoint(
-          partId: response.partId,
-          resourceName: response.resourceName,
-          resourceSubtype: response.resourceSubtype,
-          methodName: response.methodName,
-          timeCaptured: response.timeCaptured.toDateTime(),
-          organizationId: response.organizationId,
-          locationId: response.locationId,
-          robotName: response.robotName,
-          robotId: response.robotId,
-          partName: response.partName,
-          methodParameters: response.methodParameters.toMap(),
-          tags: response.tags,
-          payload: response.payload.toMap(),
-        ));
+    return _dataClient
+        .exportTabularData(request)
+        .map((response) => TabularDataPoint(
+              partId: response.partId,
+              resourceName: response.resourceName,
+              resourceSubtype: response.resourceSubtype,
+              methodName: response.methodName,
+              timeCaptured: response.timeCaptured.toDateTime(),
+              organizationId: response.organizationId,
+              locationId: response.locationId,
+              robotName: response.robotName,
+              robotId: response.robotId,
+              partName: response.partName,
+              methodParameters: response.methodParameters.toMap(),
+              tags: response.tags,
+              payload: response.payload.toMap(),
+            ))
+        .toList();
   }
 
   /// Delete tabular data older than a provided number of days from an organization.

diff --git a/test/unit_test/app/data_client_test.dart b/test/unit_test/app/data_client_test.dart
@@ -254,9 +254,9 @@ void main() {
               ),
             ]));
 
-        final response = dataClient.exportTabularData('partId1', 'resourceName1', 'resourceSubtype1', 'methodName', null, null);
+        final response = await dataClient.exportTabularData('partId1', 'resourceName1', 'resourceSubtype1', 'methodName', null, null);
         var index = 0;
-        await for (final point in response) {
+        for (final point in response) {
           expect(point.partId, equals(data[index].partId));
           expect(point.resourceName, equals(data[index].resourceName));
           expect(point.resourceSubtype, equals(data[index].resourceSubtype));