Skip to content

Commit

Permalink
feat: Integrate MetadataSerializer
Browse files Browse the repository at this point in the history
  • Loading branch information
@joachimvh
joachimvh committed Oct 28, 2020
1 parent e86e1b9 commit 1f90089
Show file tree
Hide file tree
Showing 10 changed files with 110 additions and 71 deletions.
33 changes: 32 additions & 1 deletion config/presets/ldp/response-writer.json
View file
@@ -1,6 +1,34 @@
{
"@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld",
"@graph": [
{
"@id": "urn:solid-server:default:MetadataSerializer",
"@type": "BasicMetadataSerializer",
"BasicMetadataSerializer:_writers": [
{
"@type": "MappedMetadataWriter",
"MappedMetadataWriter:_headerMap": [
{
"MappedMetadataWriter:_headerMap_key": "http://www.w3.org/ns/ma-ont#format",
"MappedMetadataWriter:_headerMap_value": "content-type"
},
{
"MappedMetadataWriter:_headerMap_key": "urn:solid:http:location",
"MappedMetadataWriter:_headerMap_value": "location"
}
]
},
{
"@type": "LinkRelMetadataWriter",
"LinkRelMetadataWriter:_headerMap": [
{
"LinkRelMetadataWriter:_headerMap_key": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type",
"LinkRelMetadataWriter:_headerMap_value": "type"
}
]
}
]
},
{
"@id": "urn:solid-server:default:ResponseWriter",
"@type": "CompositeAsyncHandler",
Expand All @@ -9,7 +37,10 @@
"@type": "ErrorResponseWriter"
},
{
"@type": "BasicResponseWriter"
"@type": "BasicResponseWriter",
"BasicResponseWriter:_serializer": {
"@id": "urn:solid-server:default:MetadataSerializer"
}
}
]
}
Expand Down
5 changes: 5 additions & 0 deletions index.ts
View file
Expand Up @@ -16,10 +16,15 @@ export * from './src/init/Setup';

// LDP/HTTP/Metadata
export * from './src/ldp/http/metadata/BasicMetadataExtractor';
export * from './src/ldp/http/metadata/BasicMetadataSerializer';
export * from './src/ldp/http/metadata/ContentTypeParser';
export * from './src/ldp/http/metadata/LinkRelMetadataWriter';
export * from './src/ldp/http/metadata/LinkTypeParser';
export * from './src/ldp/http/metadata/MappedMetadataWriter';
export * from './src/ldp/http/metadata/MetadataExtractor';
export * from './src/ldp/http/metadata/MetadataParser';
export * from './src/ldp/http/metadata/MetadataSerializer';
export * from './src/ldp/http/metadata/MetadataWriter';
export * from './src/ldp/http/metadata/SlugParser';

// LDP/HTTP/Response
Expand Down
57 changes: 3 additions & 54 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Expand Up @@ -98,7 +98,7 @@
"@types/supertest": "^2.0.10",
"@typescript-eslint/eslint-plugin": "^4.1.1",
"@typescript-eslint/parser": "^4.1.1",
"componentjs-generator": "^1.1.0",
"componentjs-generator": "^1.2.0",
"coveralls": "^3.1.0",
"eslint": "^7.9.0",
"eslint-config-es": "^3.20.3",
Expand Down
16 changes: 10 additions & 6 deletions src/ldp/http/BasicResponseWriter.ts
View file
Expand Up @@ -2,7 +2,7 @@ import { getLoggerFor } from '../../logging/LogUtil';
import type { HttpResponse } from '../../server/HttpResponse';
import { INTERNAL_QUADS } from '../../util/ContentTypes';
import { UnsupportedHttpError } from '../../util/errors/UnsupportedHttpError';
import { HTTP } from '../../util/UriConstants';
import type { MetadataSerializer } from './metadata/MetadataSerializer';
import type { ResponseDescription } from './response/ResponseDescription';
import { ResponseWriter } from './ResponseWriter';

Expand All @@ -11,6 +11,12 @@ import { ResponseWriter } from './ResponseWriter';
*/
export class BasicResponseWriter extends ResponseWriter {
protected readonly logger = getLoggerFor(this);
private readonly serializer: MetadataSerializer;

public constructor(serializer: MetadataSerializer) {
super();
this.serializer = serializer;
}

public async canHandle(input: { response: HttpResponse; result: ResponseDescription | Error }): Promise<void> {
if (input.result instanceof Error || input.result.metadata?.contentType === INTERNAL_QUADS) {
Expand All @@ -20,13 +26,11 @@ export class BasicResponseWriter extends ResponseWriter {
}

public async handle(input: { response: HttpResponse; result: ResponseDescription }): Promise<void> {
const location = input.result.metadata?.get(HTTP.location);
if (location) {
input.response.setHeader('location', location.value);
if (input.result.metadata) {
await this.serializer.handleSafe({ response: input.response, metadata: input.result.metadata });
}

if (input.result.data) {
const contentType = input.result.metadata?.contentType ?? 'text/plain';
input.response.setHeader('content-type', contentType);
input.result.data.pipe(input.response);
}

Expand Down
24 changes: 18 additions & 6 deletions test/configs/Util.ts
View file
Expand Up @@ -11,7 +11,7 @@ import type {
} from '../../index';
import {
AcceptPreferenceParser,
BasicMetadataExtractor,
BasicMetadataExtractor, BasicMetadataSerializer,
BasicRequestParser,
BasicResponseWriter,
BasicTargetExtractor,
Expand All @@ -22,8 +22,8 @@ import {
ErrorResponseWriter,
GetOperationHandler,
HeadOperationHandler,
InMemoryDataAccessor,
LinkTypeParser,
InMemoryDataAccessor, LinkRelMetadataWriter,
LinkTypeParser, MappedMetadataWriter,
MetadataController,
PatchingStore,
PatchOperationHandler,
Expand All @@ -38,6 +38,7 @@ import {
UrlContainerManager,
WebAclAuthorizer,
} from '../../index';
import { CONTENT_TYPE, HTTP, RDF } from '../../src/util/UriConstants';

export const BASE = 'http://test.com';

Expand Down Expand Up @@ -112,11 +113,22 @@ export const getOperationHandler = (store: ResourceStore): CompositeAsyncHandler
return new CompositeAsyncHandler<Operation, ResponseDescription>(handlers);
};

export const getResponseWriter = (): ResponseWriter =>
new CompositeAsyncHandler<{ response: HttpResponse; result: ResponseDescription | Error }, void>([
export const getResponseWriter = (): ResponseWriter => {
const serializer = new BasicMetadataSerializer([
new MappedMetadataWriter({
[CONTENT_TYPE]: 'content-type',
[HTTP.location]: 'location',
}),
new LinkRelMetadataWriter({
[RDF.type]: 'type',
}),
]);

return new CompositeAsyncHandler<{ response: HttpResponse; result: ResponseDescription | Error }, void>([
new ErrorResponseWriter(),
new BasicResponseWriter(),
new BasicResponseWriter(serializer),
]);
};

/**
* Creates a BasicMetadataExtractor with parsers for content-type, slugs and link types.
Expand Down
4 changes: 4 additions & 0 deletions test/integration/AuthenticatedLdpHandler.test.ts
View file
Expand Up @@ -2,6 +2,7 @@ import * as url from 'url';
import { namedNode, quad } from '@rdfjs/data-model';
import { Parser } from 'n3';
import type { MockResponse } from 'node-mocks-http';
import { LDP } from '../../src/util/UriConstants';
import { BasicConfig } from '../configs/BasicConfig';
import { BasicHandlersConfig } from '../configs/BasicHandlersConfig';
import { call } from '../util/Util';
Expand Down Expand Up @@ -38,6 +39,7 @@ describe('An integrated AuthenticatedLdpHandler', (): void => {
expect(response._getData()).toContain(
'<http://test.com/s> <http://test.com/p> <http://test.com/o>.',
);
expect(response.getHeaders().link).toBe(`<${LDP.Resource}>; rel="type"`);

// DELETE
response = await call(handler, requestUrl, 'DELETE', {}, []);
Expand Down Expand Up @@ -104,6 +106,7 @@ describe('An integrated AuthenticatedLdpHandler', (): void => {
expect(response._getBuffer().toString()).toContain(
'<http://test.com/s2> <http://test.com/p2> <http://test.com/o2>.',
);
expect(response.getHeaders().link).toBe(`<${LDP.Resource}>; rel="type"`);
const parser = new Parser();
const triples = parser.parse(response._getBuffer().toString());
expect(triples).toBeRdfIsomorphic([
Expand Down Expand Up @@ -164,6 +167,7 @@ describe('An integrated AuthenticatedLdpHandler', (): void => {
[],
);
expect(response.statusCode).toBe(200);
expect(response.getHeaders().link).toBe(`<${LDP.Resource}>; rel="type"`);
const parser = new Parser();
const triples = parser.parse(response._getData());
expect(triples).toBeRdfIsomorphic([
Expand Down
4 changes: 3 additions & 1 deletion test/integration/FullConfig.acl.test.ts
View file
Expand Up @@ -6,7 +6,7 @@ import { FileDataAccessor } from '../../src/storage/accessors/FileDataAccessor';
import { InMemoryDataAccessor } from '../../src/storage/accessors/InMemoryDataAccessor';
import { ExtensionBasedMapper } from '../../src/storage/ExtensionBasedMapper';
import { MetadataController } from '../../src/util/MetadataController';
import { CONTENT_TYPE } from '../../src/util/UriConstants';
import { CONTENT_TYPE, LDP } from '../../src/util/UriConstants';
import { ensureTrailingSlash } from '../../src/util/Util';
import { AuthenticatedDataAccessorBasedConfig } from '../configs/AuthenticatedDataAccessorBasedConfig';
import type { ServerConfig } from '../configs/ServerConfig';
Expand Down Expand Up @@ -67,6 +67,7 @@ describe.each([ dataAccessorStore, inMemoryDataAccessorStore ])('A server using
response = await fileHelper.getFile(id);
expect(response.statusCode).toBe(200);
expect(response._getBuffer().toString()).toContain('TESTFILE2');
expect(response.getHeaders().link).toBe(`<${LDP.Resource}>; rel="type"`);

// DELETE file
await fileHelper.deleteResource(id);
Expand Down Expand Up @@ -95,6 +96,7 @@ describe.each([ dataAccessorStore, inMemoryDataAccessorStore ])('A server using
// GET permanent file
response = await fileHelper.getFile('http://test.com/permanent.txt');
expect(response._getBuffer().toString()).toContain('TEST');
expect(response.getHeaders().link).toBe(`<${LDP.Resource}>; rel="type"`);

// Try to delete permanent file
response = await fileHelper.deleteResource('http://test.com/permanent.txt', true);
Expand Down
11 changes: 11 additions & 0 deletions test/integration/FullConfig.noAuth.test.ts
View file
Expand Up @@ -5,6 +5,7 @@ import { FileDataAccessor } from '../../src/storage/accessors/FileDataAccessor';
import { InMemoryDataAccessor } from '../../src/storage/accessors/InMemoryDataAccessor';
import { ExtensionBasedMapper } from '../../src/storage/ExtensionBasedMapper';
import { MetadataController } from '../../src/util/MetadataController';
import { LDP } from '../../src/util/UriConstants';
import { DataAccessorBasedConfig } from '../configs/DataAccessorBasedConfig';
import type { ServerConfig } from '../configs/ServerConfig';
import { BASE, getRootFilePath } from '../configs/Util';
Expand Down Expand Up @@ -52,6 +53,7 @@ describe.each(configs)('A server using a %s', (name, configFn): void => {
response = await fileHelper.getFile(id);
expect(response.statusCode).toBe(200);
expect(response._getBuffer().toString()).toContain('TESTFILE0');
expect(response.getHeaders().link).toBe(`<${LDP.Resource}>; rel="type"`);

// DELETE
await fileHelper.deleteResource(id);
Expand All @@ -66,6 +68,7 @@ describe.each(configs)('A server using a %s', (name, configFn): void => {
response = await fileHelper.getFile(id);
expect(response.statusCode).toBe(200);
expect(response._getBuffer().toString()).toContain('TESTFILE0');
expect(response.getHeaders().link).toBe(`<${LDP.Resource}>; rel="type"`);

// PUT
response = await fileHelper.overwriteFile('../assets/testfile1.txt', id, 'text/plain');
Expand All @@ -74,6 +77,7 @@ describe.each(configs)('A server using a %s', (name, configFn): void => {
response = await fileHelper.getFile(id);
expect(response.statusCode).toBe(200);
expect(response._getBuffer().toString()).toContain('TESTFILE1');
expect(response.getHeaders().link).toBe(`<${LDP.Resource}>; rel="type"`);

// DELETE
await fileHelper.deleteResource(id);
Expand All @@ -88,6 +92,9 @@ describe.each(configs)('A server using a %s', (name, configFn): void => {
// GET
response = await fileHelper.getFolder(id);
expect(response.statusCode).toBe(200);
expect(response.getHeaders().link).toEqual(
[ `<${LDP.Container}>; rel="type"`, `<${LDP.BasicContainer}>; rel="type"`, `<${LDP.Resource}>; rel="type"` ],
);

// DELETE
await fileHelper.deleteResource(id);
Expand All @@ -105,6 +112,7 @@ describe.each(configs)('A server using a %s', (name, configFn): void => {
// GET File
response = await fileHelper.getFile(id);
expect(response.statusCode).toBe(200);
expect(response.getHeaders().link).toBe(`<${LDP.Resource}>; rel="type"`);

// DELETE
await fileHelper.deleteResource(id);
Expand Down Expand Up @@ -171,6 +179,9 @@ describe.each(configs)('A server using a %s', (name, configFn): void => {
expect(response.statusCode).toBe(200);
expect(response._getBuffer().toString()).toContain('<http://www.w3.org/ns/ldp#contains> <http://test.com/testfolder3/subfolder0/> .');
expect(response._getBuffer().toString()).toContain('<http://www.w3.org/ns/ldp#contains> <http://test.com/testfolder3/testfile0.txt> .');
expect(response.getHeaders().link).toEqual(
[ `<${LDP.Container}>; rel="type"`, `<${LDP.BasicContainer}>; rel="type"`, `<${LDP.Resource}>; rel="type"` ],
);

// DELETE
await fileHelper.deleteResource(fileId);
Expand Down

0 comments on commit 1f90089

Please sign in to comment.