Skip to content

Commit

Permalink
fix: add instance id support to files API (#1166)
Browse files Browse the repository at this point in the history 
fix: add instance id support to files API

* Add support to query for files by instance ID on relevant methods
* Add instance ID to response type for files methods
* Simplify update types for timeseries update
  • Loading branch information
@roligheten
roligheten authored Oct 24, 2024
1 parent 070dbb3 commit a188294
Show file tree
Hide file tree
Showing 3 changed files with 148 additions and 49 deletions.
116 changes: 95 additions & 21 deletions packages/stable/src/__tests__/api/files.int.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import type {
FileGeoLocation,
FileInfo,
LabelDefinition,
NodeWrite,
} from '../../types';
import {
getFileCreateArgs,
Expand All @@ -20,11 +21,39 @@ import {

const testfile = join(__dirname, '../test3dFile.fbx');

describe.skip('Files integration test', () => {
describe('Files integration test', () => {
let client: CogniteClient;
let asset: Asset;
let label: LabelDefinition;

const testSpace = {
space: 'test_data_space',
name: 'test_data_space',
description: 'Instance space used for integration tests.',
};

const fileCdmInstance: NodeWrite = {
externalId: `external_${randomInt()}`,
space: testSpace.space,
instanceType: 'node',
sources: [
{
source: {
externalId: 'CogniteFile',
space: 'cdf_cdm',
type: 'view',
version: 'v1',
},
properties: {},
},
],
};

const fileCdmInstanceId = {
externalId: fileCdmInstance.externalId,
space: fileCdmInstance.space,
};

beforeAll(async () => {
client = setupLoggedInClient();
[asset] = await client.assets.create([
Expand All @@ -39,11 +68,22 @@ describe.skip('Files integration test', () => {
description: 'test label',
},
]);
await client.spaces.upsert([testSpace]);
await client.instances.upsert({
items: [fileCdmInstance],
});
});

afterAll(async () => {
await client.assets.delete([{ id: asset.id }]);
await client.labels.delete([{ externalId: label.externalId }]);
await client.instances.delete([
{
instanceType: 'node',
externalId: fileCdmInstance.externalId,
space: fileCdmInstance.space,
},
]);
});

const geoLocation: FileGeoLocation = {
Expand Down Expand Up @@ -78,30 +118,64 @@ describe.skip('Files integration test', () => {
expect(file.geoLocation).toEqual(localFileMeta.geoLocation);
});

test('validate directoryPrefix format against CDF', async () => {
test.skip('validate directoryPrefix format against CDF', async () => {
await client.files.list({
filter: {
directoryPrefix: '/test',
},
});
});

test('retrieve', async () => {
test.skip('retrieve', async () => {
const [retrievedFile] = await client.files.retrieve([{ id: file.id }]);
expect(retrievedFile.mimeType).toBe(localFileMeta.mimeType);
expect(retrievedFile.uploaded).toBeTruthy();
expect(retrievedFile.sourceCreatedTime).toEqual(sourceCreatedTime);
expect(retrievedFile.directory).toEqual('/test/testing');
});

test('retrieve with non-existent id', async () => {
test('retrieve by instance id', async () => {
// Syncing from instance to files API is eventually consistant
await runTestWithRetryWhenFailing(async () => {
const [retrievedFile] = await client.files.retrieve([
{ instanceId: fileCdmInstanceId },
]);
expect(retrievedFile.instanceId).toEqual(fileCdmInstanceId);
});
});

test('update by instance id', async () => {
// Syncing from instance to files API is eventually consistant
await runTestWithRetryWhenFailing(async () => {
const testMetadata = { testKey: 'testVal' };
const [retrievedFile] = await client.files.update([
{
instanceId: fileCdmInstanceId,
update: { metadata: { set: testMetadata } },
},
]);
expect(retrievedFile.instanceId).toEqual(fileCdmInstanceId);
expect(retrievedFile.metadata).toEqual(testMetadata);
});
});

test('download by instance id', async () => {
// Syncing from instance to files API is eventually consistant
await runTestWithRetryWhenFailing(async () => {
expect(
client.files.getDownloadUrls([{ instanceId: fileCdmInstanceId }])
).rejects.toThrow(/Files not uploaded/);
});
});

test.skip('retrieve with non-existent id', async () => {
const res = await client.files.retrieve([{ id: 1 }], {
ignoreUnknownIds: true,
});
expect(res.length).toBe(0);
});

test('count aggregate', async () => {
test.skip('count aggregate', async () => {
const aggregates = await client.files.aggregate({
filter: {
name: file.name,
Expand All @@ -111,7 +185,7 @@ describe.skip('Files integration test', () => {
expect(aggregates[0].count).toBeDefined();
});

test('count aggregate by label', async () => {
test.skip('count aggregate by label', async () => {
const aggregates = await client.files.aggregate({
filter: {
labels: {
Expand All @@ -124,7 +198,7 @@ describe.skip('Files integration test', () => {
expect(aggregates[0].count).toBeDefined();
});

test('count aggregate by geoLocation', async () => {
test.skip('count aggregate by geoLocation', async () => {
const aggregates = await client.files.aggregate({
filter: {
geoLocation: {
Expand All @@ -141,7 +215,7 @@ describe.skip('Files integration test', () => {
expect(aggregates[0].count).toBeDefined();
});

test('download', async () => {
test.skip('download', async () => {
const [{ downloadUrl }] = await client.files.getDownloadUrls([
{ id: file.id },
]);
Expand All @@ -152,7 +226,7 @@ describe.skip('Files integration test', () => {
expect(response.data).toBe(fileContent);
});

test('update', async () => {
test.skip('update', async () => {
const newAssetIds = [asset.id];
const newSecurityCategories = [123];
const newSource = 'def';
Expand Down Expand Up @@ -186,7 +260,7 @@ describe.skip('Files integration test', () => {
expect(updatedFiles[0].geoLocation).toEqual(location);
});

test('list rootAssetIds filter', async () => {
test.skip('list rootAssetIds filter', async () => {
runTestWithRetryWhenFailing(async () => {
const { items } = await client.files.list({
filter: {
Expand All @@ -198,7 +272,7 @@ describe.skip('Files integration test', () => {
});
});

test('list assetSubtreeIds filter', async () => {
test.skip('list assetSubtreeIds filter', async () => {
const { items } = await client.files.list({
filter: {
assetSubtreeIds: [{ id: asset.id }],
Expand All @@ -208,11 +282,11 @@ describe.skip('Files integration test', () => {
expect(items).toBeInstanceOf(Array); // cannot check exact response because of [CDF-1614] bug
});

test('upload with overwrite', async () => {
test.skip('upload with overwrite', async () => {
await client.files.upload(localFileMeta, fileContent, true, true);
});

test('list geoLocation filter', async () => {
test.skip('list geoLocation filter', async () => {
runTestWithRetryWhenFailing(async () => {
const items = await client.files
.list({
Expand All @@ -237,13 +311,13 @@ describe.skip('Files integration test', () => {
});
});

test('list', async () => {
test.skip('list', async () => {
const response = await client.files.list().autoPagingToArray({ limit: 10 });
expect(response.length).toBeGreaterThan(0);
expect(response[0].id).toBeDefined();
});

test('search', async () => {
test.skip('search', async () => {
const result = await client.files.search({
search: {
name: 'filename_',
Expand All @@ -253,7 +327,7 @@ describe.skip('Files integration test', () => {
expect(result.length).toBeGreaterThan(0);
});

describe('binary file', () => {
describe.skip('binary file', () => {
const binaryFileMeta = {
name: `filename_1_${postfix}`,
mimeType: 'application/octet-stream',
Expand All @@ -270,7 +344,7 @@ describe.skip('Files integration test', () => {
);
});

test('download', async () => {
test.skip('download', async () => {
const [{ downloadUrl }] = await client.files.getDownloadUrls([
{ id: binaryFile.id },
]);
Expand All @@ -282,7 +356,7 @@ describe.skip('Files integration test', () => {
});
});

test('list by label', async () => {
test.skip('list by label', async () => {
const { items } = await client.files.list({
filter: {
labels: {
Expand All @@ -295,7 +369,7 @@ describe.skip('Files integration test', () => {
expect(items[0].id).toBe(file.id);
});

test('update file by removing label', async () => {
test.skip('update file by removing label', async () => {
const [updatedFile] = await client.files.update([
{
id: file.id,
Expand All @@ -310,7 +384,7 @@ describe.skip('Files integration test', () => {
expect(updatedFile.labels).toBe(undefined);
});

test('update file by removing geoLocation', async () => {
test.skip('update file by removing geoLocation', async () => {
const [updatedFile] = await client.files.update([
{
id: file.id,
Expand All @@ -323,7 +397,7 @@ describe.skip('Files integration test', () => {
expect(updatedFile.geoLocation).toBe(undefined);
});

test('delete', async () => {
test.skip('delete', async () => {
const response = await client.files.delete([{ id: file.id }]);
expect(response).toEqual({});
});
Expand Down
16 changes: 8 additions & 8 deletions packages/stable/src/api/files/filesApi.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
BaseResourceAPI,
type CursorAndAsyncIterator,
type HttpHeaders,
type IdEitherWithInstance,
sleepPromise,
} from '@cognite/sdk-core';
import type {
Expand Down Expand Up @@ -103,7 +104,7 @@ export class FilesAPI extends BaseResourceAPI<FileInfo> {
* ```
*/
public retrieve = (
ids: IdEither[],
ids: IdEitherWithInstance[],
params: FileRetrieveParams = {}
): Promise<FileInfo[]> => {
return super.retrieveEndpoint(ids, params);
Expand Down Expand Up @@ -162,8 +163,8 @@ export class FilesAPI extends BaseResourceAPI<FileInfo> {
* ```
*/
public getDownloadUrls = (
ids: IdEither[]
): Promise<(FileLink & IdEither)[]> => {
ids: IdEitherWithInstance[]
): Promise<(FileLink & IdEitherWithInstance)[]> => {
return this.getDownloadUrlsEndpoint(ids);
};

Expand Down Expand Up @@ -225,12 +226,11 @@ export class FilesAPI extends BaseResourceAPI<FileInfo> {
throw Error(`File never marked as 'uploaded'`);
}

private async getDownloadUrlsEndpoint(items: IdEither[]) {
private async getDownloadUrlsEndpoint(items: IdEitherWithInstance[]) {
const path = this.url('downloadlink');
const response = await this.post<ItemsWrapper<(FileLink & IdEither)[]>>(
path,
{ data: { items } }
);
const response = await this.post<
ItemsWrapper<(FileLink & IdEitherWithInstance)[]>
>(path, { data: { items } });
return this.addToMapAndReturn(response.data.items, response);
}
}
Expand Down
Loading

0 comments on commit a188294

Please sign in to comment.