refactor(session): rename & smaller interfaces

Renames: * userDataFromRedis -> userData * cookieId -> cookieHeader * sessionContext -> sessionManager * updateSessionInHeader -> updateMainSession * sessionId -> debugId * updateSessionWithCsrfToken -> createSessionWithCsrf Refactor(csrf): pass cookieHeader instead of whole request Co-Authored-By: Pram Gurusinga <[email protected]> Co-Authored-By: Rafael Falk <[email protected]>
digitalservicebund · Mar 1, 2024 · 9700d0e · 9700d0e
1 parent 5fb8358
commit 9700d0e
Show file tree

Hide file tree

Showing 15 changed files with 142 additions and 136 deletions.
diff --git a/app/models/flows/fluggastrechte/index.ts b/app/models/flows/fluggastrechte/index.ts
@@ -1,5 +1,6 @@
 import { guards as fluggastrechteVorabcheckGuards } from "~/models/flows/fluggastrechte/guards";
 import fluggastrechteVorabcheckFlow from "~/models/flows/fluggastrechte/config.json";
+import type { Context } from "../contexts";
 
 export const fluggastrechteVorabcheck = {
   cmsSlug: "vorab-check-pages",
@@ -19,5 +20,7 @@ export const partnerCourtAirports = {
 
 type PartnerAirport = keyof typeof partnerCourtAirports;
 
-export const isPartnerAirport = (airport: string): airport is PartnerAirport =>
-  airport in partnerCourtAirports;
+export const isPartnerAirport = (
+  airport: Context[string],
+): airport is PartnerAirport =>
+  typeof airport === "string" && airport in partnerCourtAirports;
diff --git a/app/routes/action.send-rating.ts b/app/routes/action.send-rating.ts
@@ -2,7 +2,7 @@ import type { ActionFunctionArgs } from "@remix-run/node";
 import { json, redirect } from "@remix-run/node";
 import { BannerState } from "~/components/UserFeedback";
 import { userRatingFieldname } from "~/components/UserFeedback/RatingBox";
-import { getSessionForContext } from "~/services/session.server";
+import { getSessionManager } from "~/services/session.server";
 import { bannerStateName } from "~/services/feedback/handleFeedback";
 import { sendCustomEvent } from "~/services/analytics/customEvent";
 
@@ -16,7 +16,7 @@ export const action = async ({ request }: ActionFunctionArgs) => {
   const formData = await request.formData();
 
   const cookie = request.headers.get("Cookie");
-  const { getSession, commitSession } = getSessionForContext("main");
+  const { getSession, commitSession } = getSessionManager("main");
   const session = await getSession(cookie);
 
   const userRatings =

diff --git a/app/routes/beratungshilfe.antrag.pdf.tsx b/app/routes/beratungshilfe.antrag.pdf.tsx
@@ -1,22 +1,18 @@
 import { redirect, type LoaderFunctionArgs } from "@remix-run/node";
 import _ from "lodash";
-import type { BeratungshilfeFormularContext } from "~/models/flows/beratungshilfeFormular";
 import { getBeratungshilfePdfFromContext } from "~/services/pdf/beratungshilfe/beratungshilfe.server";
-import { getSessionForContext } from "~/services/session.server";
+import { getSessionData } from "~/services/session.server";
 
 export const loader = async ({ request }: LoaderFunctionArgs) => {
-  const cookieId = request.headers.get("Cookie");
-  const { data } = await getSessionForContext(
-    "beratungshilfe/antrag",
-  ).getSession(cookieId);
+  const cookieHeader = request.headers.get("Cookie");
+  const flowId = "beratungshilfe/antrag";
+  const { userData } = await getSessionData(flowId, cookieHeader);
 
-  const context: BeratungshilfeFormularContext = data; // Recast for now to get type safety
-
-  if (_.isEmpty(context)) {
+  if (_.isEmpty(userData)) {
     return redirect("/beratungshilfe/antrag");
   }
 
-  return new Response(await getBeratungshilfePdfFromContext(context), {
+  return new Response(await getBeratungshilfePdfFromContext(userData), {
     headers: {
       "Content-Type": "application/pdf",
     },

diff --git a/app/routes/beratungshilfe.zustaendiges-gericht.suche.tsx b/app/routes/beratungshilfe.zustaendiges-gericht.suche.tsx
@@ -13,7 +13,7 @@ import {
 } from "~/services/cms/index.server";
 import CourtFinderHeader from "~/components/CourtFinderHeader";
 import PageContent from "~/components/PageContent";
-import { getSessionForContext } from "~/services/session.server";
+import { getSessionManager } from "~/services/session.server";
 import { getReturnToURL } from "~/services/routing/getReturnToURL";
 import { ButtonNavigation } from "~/components/form/ButtonNavigation";
 import { postcodeSchema } from "~/services/validation/postcode";
@@ -30,7 +30,7 @@ const validatorServer = withZod(serverSchema);
 
 export async function loader({ request }: LoaderFunctionArgs) {
   const slug = new URL(request.url).pathname;
-  const sessionContext = getSessionForContext("beratungshilfe/vorabcheck");
+  const sessionContext = getSessionManager("beratungshilfe/vorabcheck");
 
   const [common, { form, meta }] = await Promise.all([
     fetchSingleEntry("amtsgericht-common"),

diff --git a/app/routes/geld-einklagen.vorabcheck.partnergericht.ergebnis.$.tsx b/app/routes/geld-einklagen.vorabcheck.partnergericht.ergebnis.$.tsx
@@ -18,7 +18,7 @@ import {
 } from "~/services/gerichtsfinder/amtsgerichtData.server";
 import { flowIDFromPathname } from "~/models/flows/contexts";
 import { splatFromParams } from "~/services/params";
-import { getSessionForContext } from "~/services/session.server";
+import { getSessionManager } from "~/services/session.server";
 import type { GeldEinklagenVorabcheckContext } from "~/models/flows/geldEinklagen/context";
 import Heading from "~/components/Heading";
 import type { ReactElement } from "react";
@@ -32,9 +32,10 @@ export const loader = async ({
 }: LoaderFunctionArgs) => {
   const { pathname } = new URL(request.url);
   const flowId = flowIDFromPathname(pathname);
-  const cookieId = request.headers.get("Cookie");
-  const { data, id } = await getSessionForContext(flowId).getSession(cookieId);
-  context.sessionId = getSessionForContext(flowId).getSessionId(id); // For showing in errors
+  const cookieHeader = request.headers.get("Cookie");
+  const sessionManager = getSessionManager(flowId);
+  const { data, id } = await sessionManager.getSession(cookieHeader);
+  context.debugId = sessionManager.getDebugId(id); // For showing in errors
 
   const contextData = data as GeldEinklagenVorabcheckContext;
   const zipCodes = [

diff --git a/app/routes/shared/formular.server.ts b/app/routes/shared/formular.server.ts
@@ -3,7 +3,7 @@ import { json, redirectDocument } from "@remix-run/node";
 import { validationError } from "remix-validated-form";
 import {
   getSessionData,
-  getSessionForContext,
+  getSessionManager,
   updateSession,
 } from "~/services/session.server";
 import {
@@ -36,7 +36,7 @@ import {
 } from "~/services/session.server/arrayDeletion";
 import { interpolateDeep } from "~/util/fillTemplate";
 import { stepMeta } from "~/services/meta/formStepMeta";
-import { updateSessionInHeader } from "~/services/session.server/updateSessionInHeader";
+import { updateMainSession } from "~/services/session.server/updateSessionInHeader";
 
 const structureCmsContent = (
   formPageContent: z.infer<CollectionSchemas["form-flow-pages"]>,
@@ -86,19 +86,16 @@ export const loader = async ({
   const { pathname, searchParams } = new URL(request.url);
   const returnTo = searchParams.get("returnTo") ?? undefined;
   const { flowId, stepId, arrayIndex } = parsePathname(pathname);
-  const cookieId = request.headers.get("Cookie");
+  const cookieHeader = request.headers.get("Cookie");
 
-  const { userDataFromRedis, sessionId } = await getSessionData(
-    flowId,
-    cookieId,
-  );
-  context.sessionId = sessionId; // For showing in errors
+  const { userData, debugId } = await getSessionData(flowId, cookieHeader);
+  context.debugId = debugId; // For showing in errors
 
   // get flow controller
   const currentFlow = flows[flowId];
   const flowController = buildFlowController({
     config: currentFlow.config,
-    data: userDataFromRedis,
+    data: userData,
     guards: currentFlow.guards,
   });
 
@@ -129,7 +126,7 @@ export const loader = async ({
   const cmsContent = interpolateDeep(
     structureCmsContent(formPageContent),
     "stringReplacements" in currentFlow
-      ? currentFlow.stringReplacements(userDataFromRedis)
+      ? currentFlow.stringReplacements(userData)
       : {},
   );
 
@@ -150,25 +147,21 @@ export const loader = async ({
 
   // filter user data for current step
   const fieldNames = formPageContent.form.map((entry) => entry.name);
-  const stepData = stepDataFromFieldNames(
-    fieldNames,
-    userDataFromRedis,
-    arrayIndex,
-  );
+  const stepData = stepDataFromFieldNames(fieldNames, userData, arrayIndex);
 
   // get array data to display in ArraySummary -> Formular + Vorabcheck?
   const arrayData = Object.fromEntries(
     formPageContent.pre_form.filter(isStrapiArraySummary).map((entry) => {
-      const possibleArray = userDataFromRedis[entry.arrayKey];
+      const possibleArray = userData[entry.arrayKey];
       return [
         entry.arrayKey,
         Array.isArray(possibleArray) ? possibleArray : [],
       ];
     }),
   );
 
-  const { headers, csrf } = await updateSessionInHeader({
-    request,
+  const { headers, csrf } = await updateMainSession({
+    cookieHeader,
     flowId,
     stepId,
   });
@@ -193,7 +186,7 @@ export const loader = async ({
     stepId,
     flowId,
     currentFlow,
-    cookieId,
+    cookieHeader,
   );
 
   return json(
@@ -226,9 +219,9 @@ export const action = async ({ request }: ActionFunctionArgs) => {
   }
   const { pathname } = new URL(request.url);
   const { flowId, stepId, arrayIndex } = parsePathname(pathname);
-  const { getSession, commitSession } = getSessionForContext(flowId);
-  const cookieId = request.headers.get("Cookie");
-  const flowSession = await getSession(cookieId);
+  const { getSession, commitSession } = getSessionManager(flowId);
+  const cookieHeader = request.headers.get("Cookie");
+  const flowSession = await getSession(cookieHeader);
 
   const formData = await request.formData();
   const currentFlow = flows[flowId];
@@ -263,7 +256,7 @@ export const action = async ({ request }: ActionFunctionArgs) => {
     stepId,
     flowId,
     currentFlow,
-    cookieId,
+    cookieHeader,
   );
   if (migrationData && validationResult.data["doMigration"] === "yes") {
     updateSession(flowSession, migrationData);

diff --git a/app/routes/shared/result.server.ts b/app/routes/shared/result.server.ts
@@ -1,6 +1,11 @@
 import type { ActionFunction, LoaderFunctionArgs } from "@remix-run/node";
 import { json, redirect } from "@remix-run/node";
-import { getSessionForContext, updateSession } from "~/services/session.server";
+import {
+  getSessionData,
+  getSessionManager,
+  mainSessionFromCookieHeader,
+  updateSession,
+} from "~/services/session.server";
 import {
   fetchCollectionEntry,
   fetchMeta,
@@ -12,7 +17,6 @@ import { parsePathname } from "~/models/flows/contexts";
 import { flows } from "~/models/flows/flows.server";
 import { BannerState } from "~/components/UserFeedback";
 import { throw404IfFeatureFlagEnabled } from "~/services/errorPages/throw404";
-import { lastStepKey } from "~/services/flow/constants";
 import {
   getFeedbackBannerState,
   handleFeedback,
@@ -24,19 +28,29 @@ import {
 } from "~/models/flows/fluggastrechte";
 import { findCourt } from "~/services/gerichtsfinder/amtsgerichtData.server";
 import type { Jmtd14VTErwerberGerbeh } from "~/services/gerichtsfinder/types";
+import { updateMainSession } from "~/services/session.server/updateSessionInHeader";
 
 export const loader = async ({ request, context }: LoaderFunctionArgs) => {
   await throw404IfFeatureFlagEnabled(request);
 
-  // get data from request
   const { pathname } = new URL(request.url);
   const { flowId, stepId } = parsePathname(pathname);
-  const cookieId = request.headers.get("Cookie");
-  const flowSession = await getSessionForContext(flowId).getSession(cookieId);
-  const { data, id } = flowSession;
-  context.sessionId = getSessionForContext(flowId).getSessionId(id); // For showing in errors
+  const cookieHeader = request.headers.get("Cookie");
+
+  const sessionManager = getSessionManager(flowId);
+  const { userData, debugId } = await getSessionData(flowId, cookieHeader);
+  context.debugId = debugId; // For showing in errors
+
+  const flowController = buildFlowController({
+    config: flows[flowId].config,
+    data: userData,
+    guards: flows[flowId].guards,
+  });
+
+  if (!flowController.isReachable(stepId))
+    return redirect(flowController.getInitial());
 
-  const courts = [data.startAirport, data.endAirport]
+  const courts = [userData.startAirport, userData.endAirport]
     .filter(isPartnerAirport)
     .map((airport) => findCourt({ zipCode: partnerCourtAirports[airport] }))
     .filter(Boolean) as Jmtd14VTErwerberGerbeh[];
@@ -49,18 +63,11 @@ export const loader = async ({ request, context }: LoaderFunctionArgs) => {
   }));
 
   if (zustaendigesAmtsgericht.length > 0) {
-    updateSession(flowSession, {
-      zustaendigesAmtsgericht: zustaendigesAmtsgericht[0],
-    });
-    await getSessionForContext(flowId).commitSession(flowSession);
+    const session = await sessionManager.getSession(cookieHeader);
+    session.set("zustaendigesAmtsgericht", zustaendigesAmtsgericht[0]);
+    await sessionManager.commitSession(session);
   }
 
-  const { config, guards } = flows[flowId];
-  const flowController = buildFlowController({ config, data, guards });
-
-  if (!flowController.isReachable(stepId))
-    return redirect(flowController.getInitial());
-
   // Slug change to keep Strapi slugs without ergebnis/
   const slug = pathname.replace(/ergebnis\//, "");
   const [common, cmsData, parentMeta, amtsgerichtCommon] = await Promise.all([
@@ -84,9 +91,12 @@ export const loader = async ({ request, context }: LoaderFunctionArgs) => {
         label: cmsData.nextLink?.text ?? common.nextButtonDefaultLabel,
       };
 
-  const { getSession, commitSession } = getSessionForContext("main");
-  const userDataFromRedis = await getSession(cookieId);
-  userDataFromRedis.set(lastStepKey, { [flowId]: stepId });
+  const mainSession = await mainSessionFromCookieHeader(cookieHeader);
+  const { headers } = await updateMainSession({
+    cookieHeader,
+    flowId,
+    stepId,
+  });
 
   return json(
     {
@@ -96,7 +106,7 @@ export const loader = async ({ request, context }: LoaderFunctionArgs) => {
       content: cmsData.freeZone,
       meta: { ...cmsData.meta, breadcrumbTitle: parentMeta?.title ?? "" },
       reasons: reasonElementsWithID.filter((reason) =>
-        Boolean(getReasonsToDisplay(data)[reason.elementId]),
+        Boolean(getReasonsToDisplay(userData)[reason.elementId]),
       ),
       progress: flowController.getProgress(stepId),
       nextButton,
@@ -105,12 +115,11 @@ export const loader = async ({ request, context }: LoaderFunctionArgs) => {
         label: common.backButtonDefaultLabel,
       },
       bannerState:
-        getFeedbackBannerState(userDataFromRedis, pathname) ??
-        BannerState.ShowRating,
+        getFeedbackBannerState(mainSession, pathname) ?? BannerState.ShowRating,
       amtsgerichtCommon,
       courts: cmsData.pageType === "success" && courts,
     },
-    { headers: { "Set-Cookie": await commitSession(userDataFromRedis) } },
+    { headers },
   );
 };