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: Set default templates for ErrorToTemplateConverter

Browse Source
This commit is contained in:
Joachim Van Herwegen
2021-07-28 13:14:19 +02:00
parent 523390e444
commit a926839216
3 changed files with 67 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
test/unit/storage/conversion/ErrorToTemplateConverter.test.ts
View File

@@ -7,7 +7,10 @@ import type { TemplateEngine } from '../../../../src/util/templates/TemplateEngi
describe('An ErrorToTemplateConverter', (): void => {
const identifier = { path: 'http://test.com/error' };
const templatePath = '/templates/codes';
const mainTemplatePath = '/templates/main.html';
const codeTemplatesPath = '/templates/codes';
const extension = '.html';
const contentType = 'text/html';
const errorCode = 'E0001';
let templateEngine: jest.Mocked<TemplateEngine>;
let converter: ErrorToTemplateConverter;
@@ -17,7 +20,8 @@ describe('An ErrorToTemplateConverter', (): void => {
templateEngine = {
render: jest.fn().mockReturnValue(Promise.resolve('<html>')),
};
converter = new ErrorToTemplateConverter(templateEngine, templatePath, '.html', 'text/html');
converter = new ErrorToTemplateConverter(templateEngine,
{ mainTemplatePath, codeTemplatesPath, extension, contentType });
});
it('supports going from errors to the given content type.', async(): Promise<void> => {
@@ -45,6 +49,7 @@ describe('An ErrorToTemplateConverter', (): void => {
expect(templateEngine.render).toHaveBeenCalledTimes(1);
expect(templateEngine.render).toHaveBeenLastCalledWith(
{ name: 'Error', message: 'error text', stack: error.stack },
{ templateFile: mainTemplatePath },
);
});
@@ -64,7 +69,8 @@ describe('An ErrorToTemplateConverter', (): void => {
{},
{ templatePath: '/templates/codes', templateFile: 'H400.html' });
expect(templateEngine.render).toHaveBeenNthCalledWith(2,
{ name: 'BadRequestHttpError', message: 'error text', stack: error.stack });
{ name: 'BadRequestHttpError', message: 'error text', stack: error.stack },
{ templateFile: mainTemplatePath });
});
it('only adds stack if it is defined.', async(): Promise<void> => {
@@ -84,7 +90,8 @@ describe('An ErrorToTemplateConverter', (): void => {
{},
{ templatePath: '/templates/codes', templateFile: 'H400.html' });
expect(templateEngine.render).toHaveBeenNthCalledWith(2,
{ name: 'BadRequestHttpError', message: 'error text' });
{ name: 'BadRequestHttpError', message: 'error text' },
{ templateFile: mainTemplatePath });
});
it('adds additional information if an error code description is found.', async(): Promise<void> => {
@@ -101,7 +108,8 @@ describe('An ErrorToTemplateConverter', (): void => {
{ key: 'val' },
{ templatePath: '/templates/codes', templateFile: 'E0001.html' });
expect(templateEngine.render).toHaveBeenNthCalledWith(2,
{ name: 'BadRequestHttpError', message: 'error text', stack: error.stack, description: '<html>' });
{ name: 'BadRequestHttpError', message: 'error text', stack: error.stack, description: '<html>' },
{ templateFile: mainTemplatePath });
});
it('sends an empty object for additional error code parameters if none are defined.', async(): Promise<void> => {
@@ -119,7 +127,8 @@ describe('An ErrorToTemplateConverter', (): void => {
{},
{ templatePath: '/templates/codes', templateFile: 'E0001.html' });
expect(templateEngine.render).toHaveBeenNthCalledWith(2,
{ name: 'BadRequestHttpError', message: 'error text', stack: error.stack, description: '<html>' });
{ name: 'BadRequestHttpError', message: 'error text', stack: error.stack, description: '<html>' },
{ templateFile: mainTemplatePath });
});
it('converts errors with a code as usual if no corresponding template is found.', async(): Promise<void> => {
@@ -138,6 +147,26 @@ describe('An ErrorToTemplateConverter', (): void => {
{},
{ templatePath: '/templates/codes', templateFile: 'invalid.html' });
expect(templateEngine.render).toHaveBeenNthCalledWith(2,
{ name: 'BadRequestHttpError', message: 'error text', stack: error.stack });
{ name: 'BadRequestHttpError', message: 'error text', stack: error.stack },
{ templateFile: mainTemplatePath });
});
it('has default template options.', async(): Promise<void> => {
converter = new ErrorToTemplateConverter(templateEngine);
const error = new BadRequestHttpError('error text', { errorCode, details: { key: 'val' }});
const representation = new BasicRepresentation([ error ], 'internal/error', false);
const prom = converter.handle({ identifier, representation, preferences });
await expect(prom).resolves.toBeDefined();
const result = await prom;
expect(result.binary).toBe(true);
expect(result.metadata.contentType).toBe('text/markdown');
await expect(readableToString(result.data)).resolves.toBe('<html>');
expect(templateEngine.render).toHaveBeenCalledTimes(2);
expect(templateEngine.render).toHaveBeenNthCalledWith(1,
{ key: 'val' },
{ templatePath: '$PACKAGE_ROOT/templates/error/descriptions/', templateFile: 'E0001.md.hbs' });
expect(templateEngine.render).toHaveBeenNthCalledWith(2,
{ name: 'BadRequestHttpError', message: 'error text', stack: error.stack, description: '<html>' },
{ templateFile: '$PACKAGE_ROOT/templates/error/main.md.hbs' });
});
});