Skip to content

Commit 4b27c58

Browse files
ChengShi-1ChengShi-1
committed
fix: test errors
1 parent ad571e5 commit 4b27c58

File tree

4 files changed

+76
-42
lines changed

4 files changed

+76
-42
lines changed

‎docs/useCases.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -872,7 +872,7 @@ The `DatasetPreviewSubset`returned instance contains a property called `totalDat
872872

873873
#### Get Dataset Versions Summaries
874874

875-
Returns an array of [DatasetVersionSummaryInfo](../src/datasets/domain/models/DatasetVersionSummaryInfo.ts) that contains information about what changed in every specific version.
875+
Returns the total count of versions and an array of [DatasetVersionSummaryInfo](../src/datasets/domain/models/DatasetVersionSummaryInfo.ts) that contains information about what changed in every specific version.
876876

877877
##### Example call:
878878

@@ -885,7 +885,7 @@ const datasetId = 'doi:10.77777/FK2/AAAAAA'
885885

886886
getDatasetVersionsSummaries
887887
.execute(datasetId)
888-
.then((datasetVersionsSummaries: DatasetVersionSummaryInfo[]) => {
888+
.then((datasetVersionsSummaries: DatasetVersionSummarySubset) => {
889889
/* ... */
890890
})
891891

@@ -2002,7 +2002,7 @@ The `fileId` parameter can be a string, for persistent identifiers, or a number,
20022002

20032003
#### Get File Version Summaries
20042004

2005-
Get the file versions summaries, return a list of summaries for each version
2005+
Get the file versions summaries, return a total count of versions and a list of summaries for each version
20062006

20072007
##### Example call:
20082008

@@ -2013,7 +2013,7 @@ import { getFileVersionSummaries } from '@iqss/dataverse-client-javascript'
20132013

20142014
const fileId = 1
20152015

2016-
getFileVersionSummaries.execute(fileId).then((fileVersionSummaries: fileVersionSummaryInfo[]) => {
2016+
getFileVersionSummaries.execute(fileId).then((fileVersionSummaries: fileVersionSummarySubset) => {
20172017
/* ... */
20182018
})
20192019

‎test/integration/datasets/DatasetsRepository.test.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ import {
4242
createCollectionViaApi,
4343
deleteCollectionViaApi,
4444
publishCollectionViaApi,
45-
ROOT_COLLECTION_ALIAS
45+
ROOT_COLLECTION_ALIAS,
46+
setStorageDriverViaApi
4647
} from '../../testHelpers/collections/collectionHelper'
4748
import {
4849
calculateBlobChecksum,
@@ -1291,6 +1292,7 @@ describe('DatasetsRepository', () => {
12911292
beforeAll(async () => {
12921293
await createCollectionViaApi(testDatasetVersionsCollectionAlias)
12931294
await publishCollectionViaApi(testDatasetVersionsCollectionAlias)
1295+
await setStorageDriverViaApi(testDatasetVersionsCollectionAlias, 'LocalStack')
12941296
})
12951297

12961298
afterAll(async () => {

‎test/unit/datasets/DatasetsRepository.test.ts‎

Lines changed: 69 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ import {
1212
createUpdateDatasetRequestPayload
1313
} from '../../testHelpers/datasets/datasetHelper'
1414
import { TestConstants } from '../../testHelpers/TestConstants'
15-
import { DatasetNotNumberedVersion, DatasetPreviewSubset } from '../../../src/datasets'
15+
import {
16+
DatasetNotNumberedVersion,
17+
DatasetPreviewSubset,
18+
DatasetVersionSummarySubset
19+
} from '../../../src/datasets'
1620
import { createDatasetUserPermissionsModel } from '../../testHelpers/datasets/datasetUserPermissionsHelper'
1721
import {
1822
createDatasetLockModel,
@@ -1050,13 +1054,16 @@ describe('DatasetsRepository', () => {
10501054
})
10511055

10521056
describe('getDatasetVersionSummaries', () => {
1053-
const testDatasetVersionSummaries = createDatasetVersionSummaryModel()
1057+
const testDatasetVersionSummariesSubset: DatasetVersionSummarySubset = {
1058+
summaries: [createDatasetVersionSummaryModel()],
1059+
totalCount: 1
1060+
}
10541061

10551062
const testDatasetVersionSummariesResponse = {
10561063
data: {
10571064
status: 'OK',
1058-
data: [testDatasetVersionSummaries],
1059-
totalCount: 1
1065+
data: testDatasetVersionSummariesSubset.summaries,
1066+
totalCount: testDatasetVersionSummariesSubset.totalCount
10601067
}
10611068
}
10621069

@@ -1069,28 +1076,37 @@ describe('DatasetsRepository', () => {
10691076
// API Key auth
10701077
let actual = await sut.getDatasetVersionsSummaries(testDatasetModel.id)
10711078

1072-
expect(axios.get).toHaveBeenCalledWith(
1079+
const expectedRequestParams = new URLSearchParams()
1080+
1081+
const expectedRequestConfigApiKey = {
1082+
params: expectedRequestParams,
1083+
headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY.headers
1084+
}
1085+
1086+
expect(axios.get).toHaveBeenNthCalledWith(
1087+
1,
10731088
expectedApiEndpoint,
1074-
TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
1089+
expectedRequestConfigApiKey
10751090
)
1076-
expect(actual).toStrictEqual({
1077-
summaries: [testDatasetVersionSummaries],
1078-
totalCount: 1
1079-
})
1091+
expect(actual).toStrictEqual(testDatasetVersionSummariesSubset)
10801092

10811093
// Session cookie auth
10821094
ApiConfig.init(TestConstants.TEST_API_URL, DataverseApiAuthMechanism.SESSION_COOKIE)
10831095

10841096
actual = await sut.getDatasetVersionsSummaries(testDatasetModel.id)
10851097

1086-
expect(axios.get).toHaveBeenCalledWith(
1098+
const expectedRequestConfigSessionCookie = {
1099+
params: expectedRequestParams,
1100+
headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE.headers,
1101+
withCredentials: true
1102+
}
1103+
1104+
expect(axios.get).toHaveBeenNthCalledWith(
1105+
2,
10871106
expectedApiEndpoint,
1088-
TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE
1107+
expectedRequestConfigSessionCookie
10891108
)
1090-
expect(actual).toStrictEqual({
1091-
summaries: [testDatasetVersionSummaries],
1092-
totalCount: 1
1093-
})
1109+
expect(actual).toStrictEqual(testDatasetVersionSummariesSubset)
10941110
})
10951111

10961112
test('should return error result on error response', async () => {
@@ -1099,10 +1115,14 @@ describe('DatasetsRepository', () => {
10991115
let error = undefined as unknown as ReadError
11001116
await sut.getDatasetVersionsSummaries(testDatasetModel.id).catch((e) => (error = e))
11011117

1102-
expect(axios.get).toHaveBeenCalledWith(
1103-
expectedApiEndpoint,
1104-
TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
1105-
)
1118+
const expectedRequestParams = new URLSearchParams()
1119+
1120+
const expectedRequestConfigApiKey = {
1121+
params: expectedRequestParams,
1122+
headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY.headers
1123+
}
1124+
1125+
expect(axios.get).toHaveBeenCalledWith(expectedApiEndpoint, expectedRequestConfigApiKey)
11061126
expect(error).toBeInstanceOf(ReadError)
11071127
})
11081128
})
@@ -1116,28 +1136,37 @@ describe('DatasetsRepository', () => {
11161136
// API Key auth
11171137
let actual = await sut.getDatasetVersionsSummaries(TestConstants.TEST_DUMMY_PERSISTENT_ID)
11181138

1119-
expect(axios.get).toHaveBeenCalledWith(
1139+
const expectedRequestParams = new URLSearchParams()
1140+
1141+
const expectedRequestConfigApiKey = {
1142+
params: expectedRequestParams,
1143+
headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY.headers
1144+
}
1145+
1146+
expect(axios.get).toHaveBeenNthCalledWith(
1147+
1,
11201148
expectedApiEndpoint,
1121-
TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
1149+
expectedRequestConfigApiKey
11221150
)
1123-
expect(actual).toStrictEqual({
1124-
summaries: [testDatasetVersionSummaries],
1125-
totalCount: 1
1126-
})
1151+
expect(actual).toStrictEqual(testDatasetVersionSummariesSubset)
11271152

11281153
// Session cookie auth
11291154
ApiConfig.init(TestConstants.TEST_API_URL, DataverseApiAuthMechanism.SESSION_COOKIE)
11301155

11311156
actual = await sut.getDatasetVersionsSummaries(TestConstants.TEST_DUMMY_PERSISTENT_ID)
11321157

1133-
expect(axios.get).toHaveBeenCalledWith(
1158+
const expectedRequestConfigSessionCookie = {
1159+
params: expectedRequestParams,
1160+
headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE.headers,
1161+
withCredentials: true
1162+
}
1163+
1164+
expect(axios.get).toHaveBeenNthCalledWith(
1165+
2,
11341166
expectedApiEndpoint,
1135-
TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE
1167+
expectedRequestConfigSessionCookie
11361168
)
1137-
expect(actual).toStrictEqual({
1138-
summaries: [testDatasetVersionSummaries],
1139-
totalCount: 1
1140-
})
1169+
expect(actual).toStrictEqual(testDatasetVersionSummariesSubset)
11411170
})
11421171

11431172
test('should return error result on error response', async () => {
@@ -1148,10 +1177,14 @@ describe('DatasetsRepository', () => {
11481177
.getDatasetVersionsSummaries(TestConstants.TEST_DUMMY_PERSISTENT_ID)
11491178
.catch((e) => (error = e))
11501179

1151-
expect(axios.get).toHaveBeenCalledWith(
1152-
expectedApiEndpoint,
1153-
TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
1154-
)
1180+
const expectedRequestParams = new URLSearchParams()
1181+
1182+
const expectedRequestConfigApiKey = {
1183+
params: expectedRequestParams,
1184+
headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY.headers
1185+
}
1186+
1187+
expect(axios.get).toHaveBeenCalledWith(expectedApiEndpoint, expectedRequestConfigApiKey)
11551188
expect(error).toBeInstanceOf(ReadError)
11561189
})
11571190
})

‎test/unit/files/GetFileVersionSummaries.test.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ describe('execute', () => {
77
test('should return file on repository success when passing numeric id', async () => {
88
const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
99
const fileVersionSummariesSubset: FileVersionSummarySubset = {
10-
totalCount: 1,
1110
summaries: [
1211
{
1312
datasetVersion: '1.0',

0 commit comments

Comments
 (0)