Skip to content
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.

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

Add use cases for file tab data visualization #80

Merged
merged 27 commits into from
Aug 25, 2023
Merged
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
4cee748
Stash: getDatasetFiles use case WIP
GPortas Jul 10, 2023
3d915e7
Merge branch '71-pending-integration-tests' into 77-files-display-dat…
GPortas Jul 10, 2023
c9c6fbe
Added: getFilesByDatasetId use case (pending repository impl)
GPortas Jul 11, 2023
cd2039c
Stash: FilesRepository getFilesByDatasetId impl WIP
GPortas Jul 11, 2023
a835cc3
Added: file model attributes
GPortas Jul 11, 2023
d1f2445
Stash: files response transforming WIP
GPortas Jul 12, 2023
0ef3b90
Added: files response transforming
GPortas Jul 17, 2023
7f6d55a
Added: getFilesByDatasetPersistentId use case
GPortas Jul 17, 2023
7cbf2f4
Changed: restricted field payload transform
GPortas Jul 17, 2023
9b305ea
Stash: files repository integration test WIP (now failing)
GPortas Jul 17, 2023
ee2b741
Merge branch 'develop' of github.com:IQSS/dataverse-client-javascript…
GPortas Jul 18, 2023
f4a6bdd
Fixed: file upload via API test helper
GPortas Jul 19, 2023
0111e66
Added: integration tests for FilesRepository
GPortas Jul 20, 2023
7e7730c
Added: GetFileGuestbookResponsesCount use case with repository logic …
GPortas Jul 20, 2023
448909b
Refactor: single GetDatasetFiles use case managing numeric and PID ids
GPortas Jul 20, 2023
bd59020
Refactor: single GetDataset use case managing numeric and PID ids
GPortas Jul 20, 2023
44dab6a
Added: canFileBeDownloaded use case
GPortas Jul 21, 2023
b7ff9d1
Added: getFileThumbnailClass use case
GPortas Jul 21, 2023
93e30d2
Added: getFileDataTables use case (pending repository logic)
GPortas Jul 21, 2023
b008283
Stash: file data table API access logic and model properties WIP
GPortas Jul 21, 2023
f087fc0
Added: file data table models with API access and model transform
GPortas Jul 24, 2023
28a03cd
Fixed: files module exports
GPortas Jul 24, 2023
03746b2
Added: getFileDataTables integration test
GPortas Jul 24, 2023
378cc1e
Changed: more realistic test tab file content
GPortas Jul 25, 2023
1d5fffd
Changed: GetFileDownloadCount renaming
GPortas Aug 9, 2023
76104a1
Removed: GetFileThumbnailClass use case
GPortas Aug 9, 2023
3e0c21e
Added: GetFileUserPermissions use case
GPortas Aug 9, 2023
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
Prev Previous commit
Next Next commit
Added: getFilesByDatasetId use case (pending repository impl)
  • Loading branch information
GPortas committed Jul 11, 2023
commit c9c6fbe8d213d5cb25f6cffa6f15f01023b79107
9 changes: 0 additions & 9 deletions src/datasets/domain/repositories/IDatasetsRepository.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
import { Dataset } from '../models/Dataset';
import { DatasetFileOrderCriteria } from './DatasetFileOrderCriteria';
import { File } from '../../../files';

export interface IDatasetsRepository {
getDatasetSummaryFieldNames(): Promise<string[]>;
@@ -9,11 +7,4 @@ export interface IDatasetsRepository {
getPrivateUrlDataset(token: string): Promise<Dataset>;
getDatasetCitation(datasetId: number, datasetVersionId?: string): Promise<string>;
getPrivateUrlDatasetCitation(token: string): Promise<string>;
getDatasetFiles(
datasetId: string,
datasetVersionId?: string,
limit?: number,
offset?: number,
orderCriteria?: DatasetFileOrderCriteria,
): Promise<File[]>;
}
22 changes: 0 additions & 22 deletions src/datasets/domain/useCases/GetDatasetFiles.ts

This file was deleted.

14 changes: 0 additions & 14 deletions src/datasets/infra/repositories/DatasetsRepository.ts
Original file line number Diff line number Diff line change
@@ -2,8 +2,6 @@ import { ApiRepository } from '../../../core/infra/repositories/ApiRepository';
import { IDatasetsRepository } from '../../domain/repositories/IDatasetsRepository';
import { Dataset } from '../../domain/models/Dataset';
import { transformVersionResponseToDataset } from './transformers/datasetTransformers';
import { File } from '../../../files';
import { DatasetFileOrderCriteria } from '../../domain/repositories/DatasetFileOrderCriteria';

export class DatasetsRepository extends ApiRepository implements IDatasetsRepository {
DATASET_VERSION_LATEST = ':latest';
@@ -66,16 +64,4 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
throw error;
});
}

public async getDatasetFiles(
datasetId: string,
datasetVersionId?: string,
limit?: number,
offset?: number,
orderCriteria?: DatasetFileOrderCriteria,
): Promise<File[]> {
throw new Error(
`Method not implemented. Params: ${datasetId} ${datasetVersionId} ${limit} ${offset} ${orderCriteria}`,
);
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export enum DatasetFileOrderCriteria {
export enum FileOrderCriteria {
NAME_AZ = 'NameAZ',
NAME_ZA = 'NameZA',
NEWEST = 'Newest',
12 changes: 12 additions & 0 deletions src/files/domain/repositories/IFilesRepository.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { FileOrderCriteria } from '../models/FileOrderCriteria';
import { File } from '../models/File';

export interface IFilesRepository {
getFilesByDatasetId(
datasetId: number,
datasetVersionId?: string,
limit?: number,
offset?: number,
orderCriteria?: FileOrderCriteria,
): Promise<File[]>;
}
22 changes: 22 additions & 0 deletions src/files/domain/useCases/GetFilesByDatasetId.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { UseCase } from '../../../core/domain/useCases/UseCase';
import { FileOrderCriteria } from '../models/FileOrderCriteria';
import { IFilesRepository } from '../repositories/IFilesRepository';
import { File } from '../models/File';

export class GetFilesByDatasetId implements UseCase<File[]> {
private filesRepository: IFilesRepository;

constructor(filesRepository: IFilesRepository) {
this.filesRepository = filesRepository;
}

async execute(
datasetId: number,
datasetVersionId?: string,
limit?: number,
offset?: number,
orderCriteria?: FileOrderCriteria,
): Promise<File[]> {
return await this.filesRepository.getFilesByDatasetId(datasetId, datasetVersionId, limit, offset, orderCriteria);
}
}
9 changes: 9 additions & 0 deletions src/files/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
import { GetFilesByDatasetId } from './domain/useCases/GetFilesByDatasetId';
import { FilesRepository } from './infra/repositories/FilesRepository';

const filesRepository = new FilesRepository();
const getFilesByDatasetId = new GetFilesByDatasetId(filesRepository);

export { getFilesByDatasetId };

export { File } from './domain/models/File';
export { FileOrderCriteria } from './domain/models/FileOrderCriteria';
18 changes: 18 additions & 0 deletions src/files/infra/repositories/FilesRepository.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { ApiRepository } from '../../../core/infra/repositories/ApiRepository';
import { IFilesRepository } from '../../domain/repositories/IFilesRepository';
import { FileOrderCriteria } from '../../domain/models/FileOrderCriteria';
import { File } from '../../domain/models/File';

export class FilesRepository extends ApiRepository implements IFilesRepository {
public async getFilesByDatasetId(
datasetId: number,
datasetVersionId?: string,
limit?: number,
offset?: number,
orderCriteria?: FileOrderCriteria,
): Promise<File[]> {
throw new Error(
`Method not implemented. Params: ${datasetId} ${datasetVersionId} ${limit} ${offset} ${orderCriteria}`,
);
}
}
38 changes: 38 additions & 0 deletions test/unit/files/GetFilesByDatasetId.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { GetFilesByDatasetId } from '../../../src/files/domain/useCases/GetFilesByDatasetId';
import { IFilesRepository } from '../../../src/files/domain/repositories/IFilesRepository';
import { assert, createSandbox, SinonSandbox } from 'sinon';
import { ReadError } from '../../../src/core/domain/repositories/ReadError';
import { File } from '../../../src/files/domain/models/File';

describe('execute', () => {
const sandbox: SinonSandbox = createSandbox();

afterEach(() => {
sandbox.restore();
});

test('should return files on repository success', async () => {
const testFiles : File[] = [];
const filesRepositoryStub = <IFilesRepository>{};
const getFilesByDatasetIdStub = sandbox.stub().returns(testFiles);
filesRepositoryStub.getFilesByDatasetId = getFilesByDatasetIdStub;
const sut = new GetFilesByDatasetId(filesRepositoryStub);

const actual = await sut.execute(1);

assert.match(actual, testFiles);
assert.calledWithExactly(getFilesByDatasetIdStub, 1, undefined, undefined, undefined, undefined);
});

test('should return error result on repository error', async () => {
const filesRepositoryStub = <IFilesRepository>{};
const testReadError = new ReadError();
filesRepositoryStub.getFilesByDatasetId = sandbox.stub().throwsException(testReadError);
const sut = new GetFilesByDatasetId(filesRepositoryStub);

let actualError: ReadError = undefined;
await sut.execute(1).catch((e) => (actualError = e));

assert.match(actualError, testReadError);
});
});