Test formGet

Author: Lan2u

src/authentication/login/get-user-from-session.ts

@@ -13,7 +13,7 @@ const SessionCodec = t.strict({
 });
 
 export const getUserFromSession =
-  (deps: Dependencies) =>
+  (deps: Pick<Dependencies, 'logger'>) =>
   (session: unknown): O.Option<User> =>
     pipe(
       session,

src/http/form-get.ts

@@ -5,7 +5,7 @@ import {pipe} from 'fp-ts/lib/function';
 import {getUserFromSession} from '../authentication';
 import {Dependencies} from '../dependencies';
 import {oopsPage, pageTemplate} from '../templates';
-import {Form} from '../types/form';
+import {Form, FormDependencies} from '../types/form';
 import {CompleteHtmlDocument, sanitizeString} from '../types/html';
 import {logInPath} from '../authentication/login/routes';
 
@@ -14,7 +14,7 @@ import {logInPath} from '../authentication/login/routes';
 // get a view of the current state of a resource. This should be completely pure because its read-only and
 // is where conflict resolution etc. is handled as described in form-post.
 export const formGet =
-  <T>(deps: Dependencies, form: Form<T>) =>
+  <T>(deps: FormDependencies, form: Form<T>) =>
   async (req: Request, res: Response<CompleteHtmlDocument>) => {
     const user = getUserFromSession(deps)(req.session);
     if (O.isNone(user)) {

src/types/form.ts

@@ -6,7 +6,7 @@ import {SharedReadModel} from '../read-models/shared-state';
 import {Member} from './tagged-union';
 import { Dependencies } from '../dependencies';
 
-export type FormDependencies = Pick<Dependencies, 'getEventById'>;
+export type FormDependencies = Pick<Dependencies, 'getEventById' | 'sharedReadModel' | 'logger'>;
 
 export type Form<T> = {
   renderForm: (viewModel: T) => Member<HttpResponse, 'LoggedInContent'>;

tests/http/form-get.test.ts

@@ -0,0 +1,62 @@
+import {Request, Response} from 'express';
+import {faker} from '@faker-js/faker';
+import * as TE from 'fp-ts/TaskEither';
+import {Dependencies} from '../../src/dependencies';
+import {formGet} from '../../src/http/form-get';
+import {
+  html,
+  CompleteHtmlDocument,
+  safe,
+  sanitizeString,
+  toLoggedInContent,
+} from '../../src/types/html';
+import {Form} from '../../src/types/form';
+import {initTestFramework, TestFramework} from '../read-models/test-framework';
+import { arbitraryUser } from '../types/user.helper';
+
+describe('formGet', () => {
+  const user = arbitraryUser();
+  let framework: TestFramework;
+
+  beforeEach(async () => {
+    framework = await initTestFramework();
+    await framework.commands.memberNumbers.linkNumberToEmail({
+      email: user.emailAddress,
+      memberNumber: user.memberNumber,
+      name: undefined,
+      formOfAddress: undefined,
+    });
+  });
+
+  afterEach(() => {
+    framework.close();
+  });
+
+  it('responds with a rendered page when the form loads successfully', async () => {
+    const form: Form<{message: string}> = {
+      constructForm: input => _context => TE.right({message: (input as any).id}),
+      renderForm: ({message}) => toLoggedInContent(html`Test form`)(html`<p>${sanitizeString(message)}</p>`),
+    };
+    const req = {
+      session: {passport: {user}},
+      query: {},
+      params: {id: 'hello'},
+    } as unknown as Request;
+    const res = {
+      status: jest.fn(),
+      send: jest.fn(),
+      redirect: jest.fn(),
+    };
+    res.status.mockReturnValue(res);
+    res.send.mockReturnValue(res);
+
+    await formGet(framework, form)(
+      req,
+      res as unknown as Response<CompleteHtmlDocument>
+    );
+
+    expect(res.redirect).not.toHaveBeenCalled();
+    expect(res.status).toHaveBeenCalledWith(200);
+    expect(res.send).toHaveBeenCalledWith(expect.stringContaining('hello'));
+  });
+});

tests/read-models/test-framework.ts

@@ -1,10 +1,11 @@
-import createLogger from 'pino';
+import createLogger, { Logger } from 'pino';
 import * as T from 'fp-ts/Task';
 import * as O from 'fp-ts/Option';
 import * as TE from 'fp-ts/TaskEither';
 import {
   getAllEvents,
   getAllEventsByType,
+  getEventById,
 } from '../../src/init-dependencies/event-store/get-all-events';
 import {ensureEventTableExists} from '../../src/init-dependencies/event-store/ensure-events-table-exists';
 import {Actor, DomainEvent, StoredDomainEvent, StoredEventOfType} from '../../src/types';
@@ -47,6 +48,8 @@ type ToFrameworkCommands<T> = {
 };
 
 export type TestFramework = {
+  logger: Logger;
+  getEventById: Dependencies['getEventById'];
   getAllEvents: () => Promise<ReadonlyArray<StoredDomainEvent>>;
   getAllEventsByType: <T extends EventName>(
     eventType: T
@@ -107,6 +110,8 @@ export const initTestFramework = async (): Promise<TestFramework> => {
     };
 
   return {
+    logger,
+    getEventById: getEventById(eventDB),
     getAllEvents: frameworkGetAllEvents,
     getAllEventsByType: frameworkGetAllEventsByType,
     getTroubleTicketData: getTroubleTicketData(