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: Handle JSON preferences correctly in dynamic converter

Browse Source
This commit is contained in:
Joachim Van Herwegen 2021-11-05 14:12:49 +01:00
parent c6544fac1d
commit 4d319d2564
2 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/storage/conversion/DynamicJsonToTemplateConverter.ts
View File

@ -24,6 +24,8 @@ import type { RepresentationConverterArgs } from './RepresentationConverter';
* describing the content-type of that template. * describing the content-type of that template.
* *
* The output of the result depends on the content-type matched with the template. * The output of the result depends on the content-type matched with the template.
* In case JSON is the most preferred output type,
* the input representation will be returned unless a JSON template is defined.
*/ */
export class DynamicJsonToTemplateConverter extends RepresentationConverter { export class DynamicJsonToTemplateConverter extends RepresentationConverter {
private readonly templateEngine: TemplateEngine; private readonly templateEngine: TemplateEngine;
@ -51,6 +53,11 @@ export class DynamicJsonToTemplateConverter extends RepresentationConverter {
const typeMap = this.constructTypeMap(identifier, representation); const typeMap = this.constructTypeMap(identifier, representation);
const type = this.findType(typeMap, preferences.type); const type = this.findType(typeMap, preferences.type);
// No conversion needed if JSON is requested and there is no specific JSON template
if (type === APPLICATION_JSON && typeMap[APPLICATION_JSON].length === 0) {
return representation;
}
const json = JSON.parse(await readableToString(representation.data)); const json = JSON.parse(await readableToString(representation.data));
const rendered = await this.templateEngine.render(json, { templateFile: typeMap[type] }); const rendered = await this.templateEngine.render(json, { templateFile: typeMap[type] });
@ -69,6 +76,11 @@ export class DynamicJsonToTemplateConverter extends RepresentationConverter {
.map((quad): Term => quad.object) .map((quad): Term => quad.object)
.filter((term: Term): boolean => term.termType === 'NamedNode') as NamedNode[]; .filter((term: Term): boolean => term.termType === 'NamedNode') as NamedNode[];
// This handler should only cover cases where templates are defined
if (templates.length === 0) {
throw new NotImplementedHttpError('No templates found.');
}
// Maps all content-types to their template // Maps all content-types to their template
const typeMap: Record<string, string> = {}; const typeMap: Record<string, string> = {};
for (const template of templates) { for (const template of templates) {
@ -77,6 +89,12 @@ export class DynamicJsonToTemplateConverter extends RepresentationConverter {
typeMap[type] = template.value; typeMap[type] = template.value;
} }
} }
// Not using a template is always an option unless there is a specific JSON template
if (!typeMap[APPLICATION_JSON]) {
typeMap[APPLICATION_JSON] = '';
}
return typeMap; return typeMap;
} }

23
test/unit/storage/conversion/DynamicJsonToTemplateConverter.test.ts
View File

@ -1,9 +1,11 @@
import { DataFactory } from 'n3'; import { DataFactory } from 'n3';
import { BasicRepresentation } from '../../../../src/http/representation/BasicRepresentation'; import { BasicRepresentation } from '../../../../src/http/representation/BasicRepresentation';
import type { Representation } from '../../../../src/http/representation/Representation'; import type { Representation } from '../../../../src/http/representation/Representation';
import { RepresentationMetadata } from '../../../../src/http/representation/RepresentationMetadata';
import type { RepresentationPreferences } from '../../../../src/http/representation/RepresentationPreferences'; import type { RepresentationPreferences } from '../../../../src/http/representation/RepresentationPreferences';
import { DynamicJsonToTemplateConverter } from '../../../../src/storage/conversion/DynamicJsonToTemplateConverter'; import { DynamicJsonToTemplateConverter } from '../../../../src/storage/conversion/DynamicJsonToTemplateConverter';
import type { RepresentationConverterArgs } from '../../../../src/storage/conversion/RepresentationConverter'; import type { RepresentationConverterArgs } from '../../../../src/storage/conversion/RepresentationConverter';
import { NotImplementedHttpError } from '../../../../src/util/errors/NotImplementedHttpError';
import { readableToString } from '../../../../src/util/StreamUtil'; import { readableToString } from '../../../../src/util/StreamUtil';
import type { TemplateEngine } from '../../../../src/util/templates/TemplateEngine'; import type { TemplateEngine } from '../../../../src/util/templates/TemplateEngine';
import { CONTENT_TYPE_TERM, SOLID_META } from '../../../../src/util/Vocabularies'; import { CONTENT_TYPE_TERM, SOLID_META } from '../../../../src/util/Vocabularies';
@ -50,6 +52,12 @@ describe('A DynamicJsonToTemplateConverter', (): void => {
await expect(converter.canHandle(input)).resolves.toBeUndefined(); await expect(converter.canHandle(input)).resolves.toBeUndefined();
}); });
it('rejects JSON input if no templates are defined.', async(): Promise<void> => {
preferences.type = { 'application/json': 1 };
representation.metadata = new RepresentationMetadata('application/json');
await expect(converter.canHandle(input)).rejects.toThrow(NotImplementedHttpError);
});
it('uses the input JSON as parameters for the matching template.', async(): Promise<void> => { it('uses the input JSON as parameters for the matching template.', async(): Promise<void> => {
const result = await converter.handle(input); const result = await converter.handle(input);
await expect(readableToString(result.data)).resolves.toBe('<html>'); await expect(readableToString(result.data)).resolves.toBe('<html>');
@ -64,4 +72,19 @@ describe('A DynamicJsonToTemplateConverter', (): void => {
const result = await converter.handle(input); const result = await converter.handle(input);
await expect(readableToString(result.data)).resolves.toBe('<html>'); await expect(readableToString(result.data)).resolves.toBe('<html>');
}); });
it('returns the input representation if JSON is preferred.', async(): Promise<void> => {
input.preferences.type = { 'application/json': 1, 'text/html': 0.5 };
await expect(converter.handle(input)).resolves.toBe(input.representation);
});
it('still converts if JSON is preferred but there is a JSON template.', async(): Promise<void> => {
input.preferences.type = { 'application/json': 1 };
const templateNode = namedNode(templateFile);
representation.metadata.add(SOLID_META.terms.template, templateNode);
representation.metadata.addQuad(templateNode, CONTENT_TYPE_TERM, 'application/json');
const result = await converter.handle(input);
await expect(readableToString(result.data)).resolves.toBe('<html>');
expect(result.metadata.contentType).toBe('application/json');
});
}); });