Skip to content

CONSULT-1797-implement-FileUpload-on-the-typescript-SDK #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 1, 2025
Merged

CONSULT-1797-implement-FileUpload-on-the-typescript-SDK #642

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef8acb0
CONSULT-1797-implement-FileUpload-on-the-typescript-SDK
nicksanford Sep 30, 2025
143c0d1
Update streaming file upload
njooma Sep 30, 2025
a1794fe
Apply PR comments
njooma Oct 1, 2025
9fbed6f
Test chunking logic
njooma Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 73 additions & 67 deletions src/app/data-client.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { BSON } from 'bsonfy';
import { Struct, Timestamp, type JsonValue } from '@bufbuild/protobuf';
import { createRouterTransport, type Transport } from '@connectrpc/connect';
import { BSON } from 'bsonfy';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { DataService } from '../gen/app/data/v1/data_connect';
import {
Expand Down Expand Up @@ -33,6 +33,8 @@ import {
Filter,
GetDatabaseConnectionRequest,
GetDatabaseConnectionResponse,
GetLatestTabularDataRequest,
GetLatestTabularDataResponse,
RemoveBinaryDataFromDatasetByIDsRequest,
RemoveBinaryDataFromDatasetByIDsResponse,
RemoveBoundingBoxFromImageByIDRequest,
Expand All @@ -50,9 +52,23 @@ import {
TagsByFilterRequest,
TagsByFilterResponse,
TagsFilter,
GetLatestTabularDataRequest,
GetLatestTabularDataResponse,
} from '../gen/app/data/v1/data_pb';
import { DataPipelinesService } from '../gen/app/datapipelines/v1/data_pipelines_connect';
import {
CreateDataPipelineRequest,
CreateDataPipelineResponse,
DataPipeline,
DataPipelineRun,
DataPipelineRunStatus,
DeleteDataPipelineRequest,
DeleteDataPipelineResponse,
GetDataPipelineRequest,
GetDataPipelineResponse,
ListDataPipelineRunsRequest,
ListDataPipelineRunsResponse,
ListDataPipelinesRequest,
ListDataPipelinesResponse,
} from '../gen/app/datapipelines/v1/data_pipelines_pb';
import { DatasetService } from '../gen/app/dataset/v1/dataset_connect';
import {
CreateDatasetRequest,
Expand All @@ -72,36 +88,25 @@ import {
DataCaptureUploadRequest,
DataCaptureUploadResponse,
DataType,
FileData,
FileUploadRequest,
FileUploadResponse,
SensorData,
SensorMetadata,
UploadMetadata,
} from '../gen/app/datasync/v1/data_sync_pb';
import { DataClient, type FilterOptions } from './data-client';
import {
DataPipeline,
ListDataPipelinesRequest,
ListDataPipelinesResponse,
GetDataPipelineRequest,
GetDataPipelineResponse,
CreateDataPipelineRequest,
CreateDataPipelineResponse,
DeleteDataPipelineRequest,
DeleteDataPipelineResponse,
DataPipelineRun,
DataPipelineRunStatus,
ListDataPipelineRunsRequest,
ListDataPipelineRunsResponse,
} from '../gen/app/datapipelines/v1/data_pipelines_pb';
import { DataPipelinesService } from '../gen/app/datapipelines/v1/data_pipelines_connect';
DataClient,
type FileUploadOptions,
type FilterOptions,
} from './data-client';
vi.mock('../gen/app/data/v1/data_pb_service');

let mockTransport: Transport;
const subject = () => new DataClient(mockTransport);

describe('DataClient tests', () => {
const filter = subject().createFilter({
const filter = DataClient.createFilter({
componentName: 'testComponentName',
componentType: 'testComponentType',
});
Expand Down Expand Up @@ -1037,13 +1042,13 @@ describe('DataClient tests', () => {

describe('createFilter tests', () => {
it('create empty filter', () => {
const testFilter = subject().createFilter({});
const testFilter = DataClient.createFilter({});
expect(testFilter).toEqual(new Filter());
});

it('create filter', () => {
const opts = { componentName: 'camera' };
const testFilter = subject().createFilter(opts);
const testFilter = DataClient.createFilter(opts);

const expectedFilter = new Filter({
componentName: 'camera',
Expand Down Expand Up @@ -1091,7 +1096,7 @@ describe('DataClient tests', () => {
endTime,
tags: tagsList,
};
const testFilter = subject().createFilter(opts);
const testFilter = DataClient.createFilter(opts);
expect(testFilter.componentType).toEqual('testComponentType');

const expectedFilter = new Filter({
Expand Down Expand Up @@ -1721,14 +1726,19 @@ describe('DataPipelineClient tests', () => {

describe('fileUpload tests', () => {
const partId = 'testPartId';
const fileExtension = '.png';
const tags = ['testTag1', 'testTag2'];
const datasetIds = ['dataset1', 'dataset2'];
const binaryData = new Uint8Array([1, 2, 3, 4, 5]);
const dataRequestTimes: [Date, Date] = [
new Date('2025-03-19T10:00:00Z'),
new Date('2025-03-19T10:00:01Z'),
];
const options: FileUploadOptions = {
componentType: 'componentType',
componentName: 'componentName',
methodName: 'methodName',
fileName: 'fileName',
fileExtension: '.png',
tags: ['testTag1', 'testTag2'],
datasetIds: ['dataset1', 'dataset2'],
};

const expectedFileId = 'testFileId';
const expectedBinaryDataId = 'testBinaryDataId';

let capturedRequests: FileUploadRequest[];

Expand All @@ -1741,69 +1751,65 @@ describe('fileUpload tests', () => {
capturedRequests.push(request);
}
return new FileUploadResponse({
fileId: 'testFileId',
binaryDataId: 'testBinaryDataId',
fileId: expectedFileId,
binaryDataId: expectedBinaryDataId,
});
},
});
});
});

it('uploads file with metadata and file contents', async () => {
const result = await subject().fileUpload(
binaryData,
partId,
fileExtension,
dataRequestTimes,
tags,
datasetIds
);
const result = await subject().fileUpload(binaryData, partId, options);

expect(result).toBe('testBinaryDataId');
expect(result).toBe(expectedBinaryDataId);
expect(capturedRequests).toHaveLength(2);

// Check metadata request
const metadataRequest = capturedRequests[0]!;
expect(metadataRequest.uploadPacket.case).toBe('metadata');
if (metadataRequest.uploadPacket.case === 'metadata') {
const metadata = metadataRequest.uploadPacket.value;
expect(metadata.partId).toBe(partId);
expect(metadata.type).toBe(DataType.BINARY_SENSOR);
expect(metadata.tags).toEqual(tags);
expect(metadata.fileExtension).toBe(fileExtension);
expect(metadata.datasetIds).toEqual(datasetIds);
}
const metadata = metadataRequest.uploadPacket.value as UploadMetadata;
expect(metadata.partId).toBe(partId);
expect(metadata.type).toBe(DataType.FILE);
expect(metadata.componentType).toBe(options.componentType);
expect(metadata.componentName).toBe(options.componentName);
expect(metadata.methodName).toBe(options.methodName);
expect(metadata.fileName).toBe(options.fileName);
expect(metadata.fileExtension).toBe(options.fileExtension);
expect(metadata.tags).toStrictEqual(options.tags);
expect(metadata.datasetIds).toStrictEqual(options.datasetIds);

// Check file contents request
const fileContentsRequest = capturedRequests[1]!;
expect(fileContentsRequest.uploadPacket.case).toBe('fileContents');
if (fileContentsRequest.uploadPacket.case === 'fileContents') {
const fileData = fileContentsRequest.uploadPacket.value;
expect(fileData.data).toEqual(binaryData);
}
const fileContents = fileContentsRequest.uploadPacket.value as FileData;
expect(fileContents.data).toEqual(binaryData);
});

it('uploads file without optional parameters', async () => {
const result = await subject().fileUpload(
binaryData,
partId,
fileExtension,
dataRequestTimes
);
const result = await subject().fileUpload(binaryData, partId);

expect(result).toBe('testBinaryDataId');
expect(capturedRequests).toHaveLength(2);

// Check metadata request
const metadataRequest = capturedRequests[0]!;
expect(metadataRequest.uploadPacket.case).toBe('metadata');
if (metadataRequest.uploadPacket.case === 'metadata') {
const metadata = metadataRequest.uploadPacket.value;
expect(metadata.partId).toBe(partId);
expect(metadata.type).toBe(DataType.BINARY_SENSOR);
expect(metadata.tags).toEqual([]);
expect(metadata.fileExtension).toBe(fileExtension);
expect(metadata.datasetIds).toEqual([]);
}
const metadata = metadataRequest.uploadPacket.value as UploadMetadata;
expect(metadata.partId).toBe(partId);
expect(metadata.type).toBe(DataType.FILE);
expect(metadata.componentType).toBe('');
expect(metadata.componentName).toBe('');
expect(metadata.methodName).toBe('');
expect(metadata.fileName).toBe('');
expect(metadata.fileExtension).toBe('');
expect(metadata.tags).toStrictEqual([]);
expect(metadata.datasetIds).toStrictEqual([]);

// Check file contents request
const fileContentsRequest = capturedRequests[1]!;
expect(fileContentsRequest.uploadPacket.case).toBe('fileContents');
const fileContents = fileContentsRequest.uploadPacket.value as FileData;
expect(fileContents.data).toEqual(binaryData);
});
});
Loading