refactor: Align EJS engine with Handlebars.

2024-10-03 14:55:10 +00:00 · 2021-07-20 19:39:28 +02:00
parent 19624dc729
commit 9628fe98b8
40 changed files with 215 additions and 266 deletions
--- a/test/unit/server/util/RenderEjsHandler.test.ts
+++ b/test/unit/server/util/RenderEjsHandler.test.ts
@@ -1,77 +0,0 @@
-import { createResponse } from 'node-mocks-http';
-import { joinFilePath } from '../../../../src';
-import type { HttpResponse } from '../../../../src';
-import { RenderEjsHandler } from '../../../../src/server/util/RenderEjsHandler';
-
-describe('RenderEjsHandler', (): void => {
-  let response: HttpResponse;
-  let templatePath: string;
-  let templateFile: string;
-
-  beforeEach((): void => {
-    response = createResponse() as HttpResponse;
-    templatePath = joinFilePath(__dirname, '../../../assets/idp');
-    templateFile = 'testHtml.ejs';
-  });
-
-  it('throws an error if the path is not valid.', async(): Promise<void> => {
-    const handler = new RenderEjsHandler<{ message: string }>('/bad/path', 'badFile.thing');
-    await expect(handler.handle({
-      response,
-      props: {
-        message: 'cool',
-      },
-    })).rejects.toThrow(`ENOENT: no such file or directory, open '/bad/path/badFile.thing'`);
-  });
-
-  it('throws an error if valid parameters were not provided.', async(): Promise<void> => {
-    const handler = new RenderEjsHandler<string>(templatePath, templateFile);
-    await expect(handler.handle({
-      response,
-      props: 'This is an invalid prop.',
-    })).rejects.toThrow();
-  });
-
-  it('successfully renders a page.', async(): Promise<void> => {
-    const handler = new RenderEjsHandler<{ message: string }>(templatePath, templateFile);
-    await handler.handle({
-      response,
-      props: {
-        message: 'cool',
-      },
-    });
-    // Cast to any because mock-response depends on express, which this project doesn't have
-    const testResponse = response as any;
-    expect(testResponse._isEndCalled()).toBe(true);
-    expect(testResponse._getData()).toBe('<html><body><p>cool</p></body></html>');
-    expect(testResponse._getStatusCode()).toBe(200);
-  });
-
-  it('successfully escapes html input.', async(): Promise<void> => {
-    const handler = new RenderEjsHandler<{ message: string }>(templatePath, templateFile);
-    await handler.handle({
-      response,
-      props: {
-        message: '<script>alert(1)</script>',
-      },
-    });
-    // Cast to any because mock-response depends on express, which this project doesn't have
-    const testResponse = response as any;
-    expect(testResponse._isEndCalled()).toBe(true);
-    expect(testResponse._getData()).toBe('<html><body><p>&lt;script&gt;alert(1)&lt;/script&gt;</p></body></html>');
-    expect(testResponse._getStatusCode()).toBe(200);
-  });
-
-  it('successfully renders when no props are needed.', async(): Promise<void> => {
-    const handler = new RenderEjsHandler<undefined>(templatePath, 'noPropsTestHtml.ejs');
-    await handler.handle({
-      response,
-      props: undefined,
-    });
-    // Cast to any because mock-response depends on express, which this project doesn't have
-    const testResponse = response as any;
-    expect(testResponse._isEndCalled()).toBe(true);
-    expect(testResponse._getData()).toBe('<html><body><p>secret message</p></body></html>');
-    expect(testResponse._getStatusCode()).toBe(200);
-  });
-});
--- a/test/unit/server/util/TemplateHandler.test.ts
+++ b/test/unit/server/util/TemplateHandler.test.ts
@@ -0,0 +1,30 @@
+import { createResponse } from 'node-mocks-http';
+import type { HttpResponse } from '../../../../src';
+import { TemplateHandler } from '../../../../src/server/util/TemplateHandler';
+import type { TemplateEngine } from '../../../../src/util/templates/TemplateEngine';
+
+describe('A TemplateHandler', (): void => {
+  const contents = { contents: 'contents' };
+  let templateEngine: jest.Mocked<TemplateEngine>;
+  let response: HttpResponse;
+
+  beforeEach((): void => {
+    templateEngine = {
+      render: jest.fn().mockResolvedValue('rendered'),
+    };
+    response = createResponse() as HttpResponse;
+  });
+
+  it('renders the template in the response.', async(): Promise<void> => {
+    const handler = new TemplateHandler(templateEngine);
+    await handler.handle({ response, contents });
+
+    expect(templateEngine.render).toHaveBeenCalledTimes(1);
+    expect(templateEngine.render).toHaveBeenCalledWith(contents);
+
+    expect(response.getHeaders()).toHaveProperty('content-type', 'text/html');
+    expect((response as any)._isEndCalled()).toBe(true);
+    expect((response as any)._getData()).toBe('rendered');
+    expect((response as any)._getStatusCode()).toBe(200);
+  });
+});