feat: Integrate MetadataSerializer

This commit is contained in:
Joachim Van Herwegen
2020-10-27 17:07:52 +01:00
parent aebccd45c0
commit 4e4d7a7a39
8 changed files with 105 additions and 18 deletions

View File

@@ -11,20 +11,22 @@ import type {
OperationHandler,
} from '../../index';
import {
AcceptPreferenceParser,
AcceptPreferenceParser, AllVoidCompositeHandler,
BasicMetadataExtractor,
BasicRequestParser,
BasicResponseWriter,
BasicTargetExtractor,
FirstCompositeHandler,
ContentTypeParser,
DataAccessorBasedStore,
DeleteOperationHandler,
ErrorResponseWriter,
FirstCompositeHandler,
GetOperationHandler,
HeadOperationHandler,
InMemoryDataAccessor,
LinkRelMetadataWriter,
LinkTypeParser,
MappedMetadataWriter,
MetadataController,
PatchingStore,
PatchOperationHandler,
@@ -39,6 +41,7 @@ import {
UrlContainerManager,
WebAclAuthorizer,
} from '../../index';
import { CONTENT_TYPE, HTTP, RDF } from '../../src/util/UriConstants';
export const BASE = 'http://test.com';
@@ -118,12 +121,23 @@ export const getOperationHandler = (store: ResourceStore): OperationHandler => {
return new FirstCompositeHandler<Operation, ResponseDescription>(handlers);
};
export const getResponseWriter = (): ResponseWriter =>
new FirstCompositeHandler<{ response: HttpResponse; result: ResponseDescription | Error }, void>([
new ErrorResponseWriter(),
new BasicResponseWriter(),
export const getResponseWriter = (): ResponseWriter => {
const serializer = new AllVoidCompositeHandler([
new MappedMetadataWriter({
[CONTENT_TYPE]: 'content-type',
[HTTP.location]: 'location',
}),
new LinkRelMetadataWriter({
[RDF.type]: 'type',
}),
]);
return new FirstCompositeHandler<{ response: HttpResponse; result: ResponseDescription | Error }, void>([
new ErrorResponseWriter(),
new BasicResponseWriter(serializer),
]);
};
/**
* Creates a BasicMetadataExtractor with parsers for content-type, slugs and link types.
*/

View File

@@ -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';
@@ -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', {}, []);
@@ -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([
@@ -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([

View File

@@ -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';
@@ -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);
@@ -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);

View File

@@ -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';
@@ -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);
@@ -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');
@@ -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);
@@ -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);
@@ -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);
@@ -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);

View File

@@ -3,22 +3,33 @@ import type { MockResponse } from 'node-mocks-http';
import { createResponse } from 'node-mocks-http';
import streamifyArray from 'streamify-array';
import { BasicResponseWriter } from '../../../../src/ldp/http/BasicResponseWriter';
import type { MetadataWriter } from '../../../../src/ldp/http/metadata/MetadataWriter';
import type { ResponseDescription } from '../../../../src/ldp/http/response/ResponseDescription';
import { RepresentationMetadata } from '../../../../src/ldp/representation/RepresentationMetadata';
import { INTERNAL_QUADS } from '../../../../src/util/ContentTypes';
import { UnsupportedHttpError } from '../../../../src/util/errors/UnsupportedHttpError';
import { CONTENT_TYPE } from '../../../../src/util/UriConstants';
import { StaticAsyncHandler } from '../../../util/StaticAsyncHandler';
describe('A BasicResponseWriter', (): void => {
const writer = new BasicResponseWriter();
let metadataWriter: MetadataWriter;
let writer: BasicResponseWriter;
let response: MockResponse<any>;
let result: ResponseDescription;
beforeEach(async(): Promise<void> => {
metadataWriter = new StaticAsyncHandler(true, undefined);
writer = new BasicResponseWriter(metadataWriter);
response = createResponse({ eventEmitter: EventEmitter });
result = { statusCode: 201 };
});
it('requires the input to be a ResponseDescription.', async(): Promise<void> => {
it('requires the input to be a binary ResponseDescription.', async(): Promise<void> => {
await expect(writer.canHandle({ response, result: new Error('error') }))
.rejects.toThrow(UnsupportedHttpError);
const metadata = new RepresentationMetadata({ [CONTENT_TYPE]: INTERNAL_QUADS });
await expect(writer.canHandle({ response, result: { statusCode: 201, metadata }}))
.rejects.toThrow(UnsupportedHttpError);
await expect(writer.canHandle({ response, result }))
.resolves.toBeUndefined();
});
@@ -45,4 +56,14 @@ describe('A BasicResponseWriter', (): void => {
await writer.handle({ response, result });
await end;
});
it('serializes metadata if there is metadata.', async(): Promise<void> => {
result = { statusCode: 201, metadata: new RepresentationMetadata() };
metadataWriter.handle = jest.fn();
await writer.handle({ response, result });
expect(metadataWriter.handle).toHaveBeenCalledTimes(1);
expect(metadataWriter.handle).toHaveBeenLastCalledWith({ response, metadata: result.metadata });
expect(response._isEndCalled()).toBeTruthy();
expect(response._getStatusCode()).toBe(201);
});
});