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

feat: Update RepresentationConvertingStore to convert incoming data

Browse Source
This commit is contained in:
Joachim Van Herwegen
2020-10-21 11:09:59 +02:00
parent 9f7c246104
commit 712a690904
3 changed files with 89 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
src/storage/RepresentationConvertingStore.ts
View File

@@ -9,9 +9,15 @@ import { PassthroughStore } from './PassthroughStore';
import type { ResourceStore } from './ResourceStore';
/**
* Store that overrides the `getRepresentation` function.
* Tries to convert the {@link Representation} it got from the source store
* so it matches one of the given type preferences.
* Store that overrides all functions that take or output a {@link Representation},
* so `getRepresentation`, `addResource`, and `setRepresentation`.
*
* For incoming representations, they will be converted if an incoming converter and preferences have been set.
* The converted Representation will be passed along.
*
* For outgoing representations, they will be converted if there is an outgoing converter.
*
* Conversions will only happen if required and will not happen if the Representation is already in the correct format.
*
* In the future this class should take the preferences of the request into account.
* Even if there is a match with the output from the store,
@@ -20,21 +26,44 @@ import type { ResourceStore } from './ResourceStore';
export class RepresentationConvertingStore<T extends ResourceStore = ResourceStore> extends PassthroughStore<T> {
protected readonly logger = getLoggerFor(this);
private readonly converter: RepresentationConverter;
private readonly inConverter?: RepresentationConverter;
private readonly outConverter?: RepresentationConverter;
public constructor(source: T, converter: RepresentationConverter) {
private readonly inPreferences?: RepresentationPreferences;
public constructor(source: T, options: {
outConverter?: RepresentationConverter;
inConverter?: RepresentationConverter;
inPreferences?: RepresentationPreferences;
}) {
super(source);
this.converter = converter;
this.inConverter = options.inConverter;
this.outConverter = options.outConverter;
this.inPreferences = options.inPreferences;
}
public async getRepresentation(identifier: ResourceIdentifier, preferences: RepresentationPreferences,
conditions?: Conditions): Promise<Representation> {
const representation = await super.getRepresentation(identifier, preferences, conditions);
if (this.matchesPreferences(representation, preferences)) {
if (!this.outConverter || this.matchesPreferences(representation, preferences)) {
return representation;
}
this.logger.info(`Convert ${identifier.path} from ${representation.metadata.contentType} to ${preferences.type}`);
return this.converter.handleSafe({ identifier, representation, preferences });
return this.outConverter.handleSafe({ identifier, representation, preferences });
}
public async addResource(container: ResourceIdentifier, representation: Representation,
conditions?: Conditions): Promise<ResourceIdentifier> {
// We can potentially run into problems here if we convert a turtle document where the base IRI is required,
// since we don't know the resource IRI yet at this point.
representation = await this.convertRepresentation(container, representation);
return this.source.addResource(container, representation, conditions);
}
public async setRepresentation(identifier: ResourceIdentifier, representation: Representation,
conditions?: Conditions): Promise<void> {
representation = await this.convertRepresentation(identifier, representation);
return this.source.setRepresentation(identifier, representation, conditions);
}
private matchesPreferences(representation: Representation, preferences: RepresentationPreferences): boolean {
@@ -49,4 +78,12 @@ export class RepresentationConvertingStore<T extends ResourceStore = ResourceSto
matchingMediaType(type.value, contentType)),
);
}
private async convertRepresentation(identifier: ResourceIdentifier, representation: Representation):
Promise<Representation> {
if (!this.inPreferences || !this.inConverter || this.matchesPreferences(representation, this.inPreferences)) {
return representation;
}
return this.inConverter.handleSafe({ identifier, representation, preferences: this.inPreferences });
}
}