Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: Prevent errors during migration for invalid JSON

Browse Source
This commit is contained in:
Joachim Van Herwegen 2023-11-17 15:35:49 +01:00
parent 01623e0b5c
commit 2f928bd2d4
4 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/init/migration/SingleContainerJsonStorage.ts
View File

@ -1,5 +1,6 @@
import type { ResourceIdentifier } from '../../http/representation/ResourceIdentifier';
import { JsonResourceStorage } from '../../storage/keyvalue/JsonResourceStorage';
import { createErrorMessage } from '../../util/errors/ErrorUtil';
import { isContainerIdentifier } from '../../util/PathUtil';
import { readableToString } from '../../util/StreamUtil';
import { LDP } from '../../util/Vocabularies';
@ -34,9 +35,14 @@ export class SingleContainerJsonStorage<T> extends JsonResourceStorage<T> {
continue;
}
const json = JSON.parse(await readableToString(document.data)) as T;
const key = this.identifierToKey(documentId);
try {
const json = JSON.parse(await readableToString(document.data)) as T;
yield [ key, json ];
} catch (error: unknown) {
this.logger.error(`Unable to parse ${path}. You should probably delete this resource manually. Error: ${
createErrorMessage(error)}`);
}
}
}
}

1
test/assets/migration/v6/.internal/setup/aW52YWxpZFJlc291cmNl$.json Normal file
View File

@ -0,0 +1 @@
this is not valid JSON

2
test/integration/V6Migration.test.ts
View File

@ -63,6 +63,8 @@ describe('A server migrating from v6', (): void => {
// Setup resources should have been migrated
const setupDir = await readdir(joinFilePath(rootFilePath, '.internal/setup/'));
expect(setupDir).toEqual([
// Invalid JSON file was not deleted, only error was logged. Just in case its data needs to be saved.
'aW52YWxpZFJlc291cmNl$.json',
'current-base-url$.json',
'current-server-version$.json',
'setupCompleted-2.0$.json',

17
test/unit/init/migration/SingleContainerJsonStorage.test.ts
View File

@ -19,6 +19,7 @@ describe('A SingleContainerJsonStorage', (): void => {
if (isContainerIdentifier(id)) {
const metadata = new RepresentationMetadata(id);
metadata.add(LDP.terms.contains, 'http://example.com/.internal/accounts/foo');
metadata.add(LDP.terms.contains, 'http://example.com/.internal/accounts/bad');
metadata.add(LDP.terms.contains, 'http://example.com/.internal/accounts/bar/');
metadata.add(LDP.terms.contains, 'http://example.com/.internal/accounts/baz');
metadata.add(LDP.terms.contains, 'http://example.com/.internal/accounts/unknown');
@ -27,14 +28,17 @@ describe('A SingleContainerJsonStorage', (): void => {
if (id.path.endsWith('unknown')) {
throw new NotFoundHttpError();
}
return new BasicRepresentation(`{ "id": "${id.path}" }`, 'text/plain');
if (id.path.endsWith('bad')) {
return new BasicRepresentation(`invalid JSON`, 'application/json');
}
return new BasicRepresentation(`{ "id": "${id.path}" }`, 'application/json');
}),
} satisfies Partial<ResourceStore> as any;
storage = new SingleContainerJsonStorage(store, baseUrl, container);
});
it('only iterates over the documents in the base container.', async(): Promise<void> => {
it('only iterates over the valid documents in the base container.', async(): Promise<void> => {
const entries = [];
for await (const entry of storage.entries()) {
entries.push(entry);
@ -43,7 +47,7 @@ describe('A SingleContainerJsonStorage', (): void => {
[ 'foo', { id: 'http://example.com/.internal/accounts/foo' }],
[ 'baz', { id: 'http://example.com/.internal/accounts/baz' }],
]);
expect(store.getRepresentation).toHaveBeenCalledTimes(4);
expect(store.getRepresentation).toHaveBeenCalledTimes(5);
expect(store.getRepresentation).toHaveBeenNthCalledWith(
1,
{ path: 'http://example.com/.internal/accounts/' },
@ -56,11 +60,16 @@ describe('A SingleContainerJsonStorage', (): void => {
);
expect(store.getRepresentation).toHaveBeenNthCalledWith(
3,
{ path: 'http://example.com/.internal/accounts/baz' },
{ path: 'http://example.com/.internal/accounts/bad' },
{ type: { 'application/json': 1 }},
);
expect(store.getRepresentation).toHaveBeenNthCalledWith(
4,
{ path: 'http://example.com/.internal/accounts/baz' },
{ type: { 'application/json': 1 }},
);
expect(store.getRepresentation).toHaveBeenNthCalledWith(
5,
{ path: 'http://example.com/.internal/accounts/unknown' },
{ type: { 'application/json': 1 }},
);