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: Have PATCH/POST/PUT operations handlers check content-type

Browse Source
This commit is contained in:
Joachim Van Herwegen 2021-01-14 11:53:56 +01:00
parent ecf8f4d4bb
commit b642393a15
6 changed files with 54 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/ldp/operations/PatchOperationHandler.ts
View File

@ -1,4 +1,6 @@
import { getLoggerFor } from '../../logging/LogUtil';
import type { ResourceStore } from '../../storage/ResourceStore';
import { BadRequestHttpError } from '../../util/errors/BadRequestHttpError';
import { NotImplementedHttpError } from '../../util/errors/NotImplementedHttpError';
import type { Patch } from '../http/Patch';
import { ResetResponseDescription } from '../http/response/ResetResponseDescription';
@ -6,7 +8,13 @@ import type { ResponseDescription } from '../http/response/ResponseDescription';
import type { Operation } from './Operation';
import { OperationHandler } from './OperationHandler';
/**
* Handles PATCH {@link Operation}s.
* Calls the modifyResource function from a {@link ResourceStore}.
*/
export class PatchOperationHandler extends OperationHandler {
protected readonly logger = getLoggerFor(this);
private readonly store: ResourceStore;
public constructor(store: ResourceStore) {
@ -21,6 +29,13 @@ export class PatchOperationHandler extends OperationHandler {
}
public async handle(input: Operation): Promise<ResponseDescription> {
// Solid, §2.1: "A Solid server MUST reject PUT, POST and PATCH requests
// without the Content-Type header with a status code of 400."
// https://solid.github.io/specification/protocol#http-server
if (!input.body?.metadata.contentType) {
this.logger.warn('No Content-Type header specified on PATCH request');
throw new BadRequestHttpError('No Content-Type header specified on PATCH request');
}
await this.store.modifyResource(input.target, input.body as Patch);
return new ResetResponseDescription();
}

9
src/ldp/operations/PostOperationHandler.ts
View File

@ -28,9 +28,12 @@ export class PostOperationHandler extends OperationHandler {
}
public async handle(input: Operation): Promise<ResponseDescription> {
if (!input.body) {
this.logger.warn('POST operations require a body');
throw new BadRequestHttpError('POST operations require a body');
// Solid, §2.1: "A Solid server MUST reject PUT, POST and PATCH requests
// without the Content-Type header with a status code of 400."
// https://solid.github.io/specification/protocol#http-server
if (!input.body?.metadata.contentType) {
this.logger.warn('No Content-Type header specified on POST request');
throw new BadRequestHttpError('No Content-Type header specified on POST request');
}
const identifier = await this.store.addResource(input.target, input.body);
return new CreatedResponseDescription(identifier);

9
src/ldp/operations/PutOperationHandler.ts
View File

@ -28,9 +28,12 @@ export class PutOperationHandler extends OperationHandler {
}
public async handle(input: Operation): Promise<ResponseDescription> {
if (typeof input.body !== 'object') {
this.logger.warn('No body specified on PUT request');
throw new BadRequestHttpError('PUT operations require a body');
// Solid, §2.1: "A Solid server MUST reject PUT, POST and PATCH requests
// without the Content-Type header with a status code of 400."
// https://solid.github.io/specification/protocol#http-server
if (!input.body?.metadata.contentType) {
this.logger.warn('No Content-Type header specified on PUT request');
throw new BadRequestHttpError('No Content-Type header specified on PUT request');
}
await this.store.setRepresentation(input.target, input.body);
return new ResetResponseDescription();

13
test/unit/ldp/operations/PatchOperationHandler.test.ts
View File

@ -1,6 +1,8 @@
import type { Operation } from '../../../../src/ldp/operations/Operation';
import { PatchOperationHandler } from '../../../../src/ldp/operations/PatchOperationHandler';
import { RepresentationMetadata } from '../../../../src/ldp/representation/RepresentationMetadata';
import type { ResourceStore } from '../../../../src/storage/ResourceStore';
import { BadRequestHttpError } from '../../../../src/util/errors/BadRequestHttpError';
import { NotImplementedHttpError } from '../../../../src/util/errors/NotImplementedHttpError';
describe('A PatchOperationHandler', (): void => {
@ -15,10 +17,17 @@ describe('A PatchOperationHandler', (): void => {
await expect(handler.canHandle({ method: 'GET' } as Operation)).rejects.toThrow(NotImplementedHttpError);
});
it('errors if there is no body or content-type.', async(): Promise<void> => {
await expect(handler.handle({ } as Operation)).rejects.toThrow(BadRequestHttpError);
await expect(handler.handle({ body: { metadata: new RepresentationMetadata() }} as Operation))
.rejects.toThrow(BadRequestHttpError);
});
it('deletes the resource from the store and returns the correct response.', async(): Promise<void> => {
const result = await handler.handle({ target: { path: 'url' }, body: { binary: false }} as Operation);
const metadata = new RepresentationMetadata('text/turtle');
const result = await handler.handle({ target: { path: 'url' }, body: { metadata }} as Operation);
expect(store.modifyResource).toHaveBeenCalledTimes(1);
expect(store.modifyResource).toHaveBeenLastCalledWith({ path: 'url' }, { binary: false });
expect(store.modifyResource).toHaveBeenLastCalledWith({ path: 'url' }, { metadata });
expect(result.statusCode).toBe(205);
expect(result.metadata).toBeUndefined();
expect(result.data).toBeUndefined();

9
test/unit/ldp/operations/PostOperationHandler.test.ts
View File

@ -20,12 +20,15 @@ describe('A PostOperationHandler', (): void => {
.rejects.toThrow(NotImplementedHttpError);
});
it('errors if there is no body.', async(): Promise<void> => {
await expect(handler.handle({ method: 'POST' } as Operation)).rejects.toThrow(BadRequestHttpError);
it('errors if there is no body or content-type.', async(): Promise<void> => {
await expect(handler.handle({ } as Operation)).rejects.toThrow(BadRequestHttpError);
await expect(handler.handle({ body: { metadata: new RepresentationMetadata() }} as Operation))
.rejects.toThrow(BadRequestHttpError);
});
it('adds the given representation to the store and returns the correct response.', async(): Promise<void> => {
const result = await handler.handle({ method: 'POST', body: { }} as Operation);
const metadata = new RepresentationMetadata('text/turtle');
const result = await handler.handle({ method: 'POST', body: { metadata }} as Operation);
expect(result.statusCode).toBe(201);
expect(result.metadata).toBeInstanceOf(RepresentationMetadata);
expect(result.metadata?.get(HTTP.location)?.value).toBe('newPath');

16
test/unit/ldp/operations/PutOperationHandler.test.ts
View File

@ -1,5 +1,6 @@
import type { Operation } from '../../../../src/ldp/operations/Operation';
import { PutOperationHandler } from '../../../../src/ldp/operations/PutOperationHandler';
import { RepresentationMetadata } from '../../../../src/ldp/representation/RepresentationMetadata';
import type { ResourceStore } from '../../../../src/storage/ResourceStore';
import { BadRequestHttpError } from '../../../../src/util/errors/BadRequestHttpError';
import { NotImplementedHttpError } from '../../../../src/util/errors/NotImplementedHttpError';
@ -17,16 +18,19 @@ describe('A PutOperationHandler', (): void => {
await expect(handler.canHandle({ method: 'PUT' } as Operation)).resolves.toBeUndefined();
});
it('errors if there is no body or content-type.', async(): Promise<void> => {
await expect(handler.handle({ } as Operation)).rejects.toThrow(BadRequestHttpError);
await expect(handler.handle({ body: { metadata: new RepresentationMetadata() }} as Operation))
.rejects.toThrow(BadRequestHttpError);
});
it('sets the representation in the store and returns the correct response.', async(): Promise<void> => {
const result = await handler.handle({ target: { path: 'url' }, body: {}} as Operation);
const metadata = new RepresentationMetadata('text/turtle');
const result = await handler.handle({ target: { path: 'url' }, body: { metadata }} as Operation);
expect(store.setRepresentation).toHaveBeenCalledTimes(1);
expect(store.setRepresentation).toHaveBeenLastCalledWith({ path: 'url' }, {});
expect(store.setRepresentation).toHaveBeenLastCalledWith({ path: 'url' }, { metadata });
expect(result.statusCode).toBe(205);
expect(result.metadata).toBeUndefined();
expect(result.data).toBeUndefined();
});
it('errors when there is no body.', async(): Promise<void> => {
await expect(handler.handle({ method: 'PUT' } as Operation)).rejects.toThrow(BadRequestHttpError);
});
});