feat: config driven user flow to support gds and dvs jounrey (#396)

* feat: add config-driven routing system for environment-based access control

Implement middleware that controls route rendering based on route name and environment configuration. Centralizes route definitions and adds comprehensive test coverage.

* chore: testing for dev

* chore: testing in dev

* chore: reverting 19ea031 75e2bd8

Author: schoubey-gds

.env.example

@@ -10,4 +10,4 @@ OIDC_CLIENT_ID=TEST_CLIENT_ID
 CLIENT_SIGNING_KEY_ID=14122ec4-cdd0-4154-8275-04363c15fbd9
 OIDC_ISSUER_DISCOVERY_ENDPOINT=http://localhost:8000
 COOKIE_TTL_IN_MILLISECONDS=3600000
-WALLET_APPS=govuk-build,wallet-test-dev,wallet-test-build
+WALLET_APPS=govuk-build,wallet-test-dev,wallet-test-build,wallet-test-verifier-integration

src/app.ts

@@ -25,8 +25,9 @@ import { refreshRouter } from "./refresh/router";
 import { simpleDocumentBuilderRouter } from "./simpleDocumentBuilder/router";
 import { drivingLicenceBuilderRouter } from "./drivingLicenceBuilder/router";
 import { dvsStartRouter } from "./dvsStart/router";
-import { dvsDrivingLicenceBuilderRouter } from "./dvsDrivingLicenceBuilder/router";
 import { dvsJourneySelectorRouter } from "./dvsJourneySelector/router";
+import { dvsDrivingLicenceBuilderRouter } from "./dvsDrivingLicenceBuilder/router";
+import { dvsCredentialOfferViewerRouter } from "./dvsCredentialOfferViewer/router";
 import { startRouter } from "./start/router";
 
 const APP_VIEWS = [
@@ -44,6 +45,7 @@ const APP_VIEWS = [
   path.resolve("dist/veteranCardDocumentBuilder/views"),
   path.resolve("dist/dvsStart/views"),
   path.resolve("dist/dvsJourneySelector/views"),
+  path.resolve("dist/dvsCredentialOfferViewer/views"),
   path.resolve("dist/start/views"),
   path.resolve("dist/views"),
   path.resolve("node_modules/govuk-frontend/dist"),
@@ -87,9 +89,11 @@ export async function createApp(): Promise<express.Application> {
   app.use(dvsStartRouter);
   app.use(dvsJourneySelectorRouter);
   app.use(dvsDrivingLicenceBuilderRouter);
+  app.use(dvsCredentialOfferViewerRouter);
   app.use(startRouter);
 
   app.use(auth(getOIDCConfig()));
+
   app.use(appSelectorRouter);
   app.use(credentialOfferViewerRouter);
   app.use(credentialViewerRouter);

src/appSelector/router.ts

@@ -3,11 +3,23 @@ import {
   appSelectorGetController,
   appSelectorPostController,
 } from "./controller";
+import { guardRouteByEnvironment } from "../middleware/guardRouteByEnvironment";
+import { ROUTES } from "../config/routes";
 import { requiresAuth } from "../middleware/requiresAuth";
 
 const router = express.Router();
 
-router.get("/select-app", requiresAuth, appSelectorGetController());
-router.post("/select-app", requiresAuth, appSelectorPostController());
+router.get(
+  ROUTES.SELECT_APP,
+  guardRouteByEnvironment(),
+  requiresAuth,
+  appSelectorGetController(),
+);
+router.post(
+  ROUTES.SELECT_APP,
+  guardRouteByEnvironment(),
+  requiresAuth,
+  appSelectorPostController(),
+);
 
 export { router as appSelectorRouter };

src/config/environments.ts

@@ -0,0 +1,22 @@
+export const ENVIRONMENTS = {
+  LOCAL: "local",
+  DEV: "dev",
+  BUILD: "build",
+  STAGE: "staging",
+  INT: "integration",
+};
+
+export const dvsRoutesNonProdEnvs = [
+  ENVIRONMENTS.LOCAL,
+  ENVIRONMENTS.DEV,
+  ENVIRONMENTS.BUILD,
+];
+export const dvsRoutesProdEnvs = [ENVIRONMENTS.INT];
+export const allDvsRoutesEnvs = [...dvsRoutesNonProdEnvs, ...dvsRoutesProdEnvs];
+
+export const gdsRoutesEnvs = [
+  ENVIRONMENTS.LOCAL,
+  ENVIRONMENTS.DEV,
+  ENVIRONMENTS.BUILD,
+  ENVIRONMENTS.STAGE,
+];

src/config/routes.ts

@@ -0,0 +1,57 @@
+export const ROUTES = {
+  // DVS Routes
+  DVS_START: "/dvs/start",
+  DVS_SELECT_JOURNEY: "/dvs/select-journey",
+  DVS_BUILD_TEST_DRIVING_LICENCE: "/dvs/build-driving-licence",
+  DVS_CREDENTIAL_OFFER_VIEWER: "/dvs/view-credential-offer/:itemId",
+  // GDS Routes
+  START: "/start",
+  SELECT_APP: "/select-app",
+  SELECT_DOCUMENT: "/select-document",
+  BUILD_NINO_DOCUMENT: "/build-nino-document",
+  BUILD_DBS_DOCUMENT: "/build-dbs-document",
+  BUILD_VETERAN_CARD_DOCUMENT: "/build-veteran-card-document",
+  BUILD_DRIVING_LICENCE_DOCUMENT: "/build-driving-licence",
+  BUILD_SIMPLE_DOCUMENT: "/build-simple-document",
+  LOGGED_OUT: "/logged-out",
+  PROOF_JWT: "/proof-jwt",
+  REFRESH: "/refresh/:credentialType",
+  REFRESH_NO_UPDATE: "/refresh/:credentialType/no-update",
+  WELL_KNOWN_JWKS: "/.well-known/jwks.json",
+  TOKEN: "/token",
+  LOGOUT: "/logout",
+  RETURN_FROM_AUTH: "/return-from-auth",
+  VIEW_CREDENTIAL: "/view-credential",
+  CREDENTIAL_OFFER_VIEWER: "/view-credential-offer/:itemId",
+  // Common Routes
+  DOCUMENT: "/document/:itemId",
+  REVOKE: "/revoke",
+};
+
+export const dvsRoutes = [
+  ROUTES.DVS_START,
+  ROUTES.DVS_SELECT_JOURNEY,
+  ROUTES.DVS_BUILD_TEST_DRIVING_LICENCE,
+  ROUTES.DVS_CREDENTIAL_OFFER_VIEWER,
+];
+export const gdsRoutes = [
+  ROUTES.START,
+  ROUTES.SELECT_APP,
+  ROUTES.SELECT_DOCUMENT,
+  ROUTES.BUILD_NINO_DOCUMENT,
+  ROUTES.BUILD_DBS_DOCUMENT,
+  ROUTES.BUILD_VETERAN_CARD_DOCUMENT,
+  ROUTES.BUILD_DRIVING_LICENCE_DOCUMENT,
+  ROUTES.BUILD_SIMPLE_DOCUMENT,
+  ROUTES.LOGGED_OUT,
+  ROUTES.PROOF_JWT,
+  ROUTES.REFRESH,
+  ROUTES.REFRESH_NO_UPDATE,
+  ROUTES.WELL_KNOWN_JWKS,
+  ROUTES.TOKEN,
+  ROUTES.LOGOUT,
+  ROUTES.RETURN_FROM_AUTH,
+  ROUTES.VIEW_CREDENTIAL,
+  ROUTES.CREDENTIAL_OFFER_VIEWER,
+];
+export const commonRoutes = [ROUTES.REVOKE, ROUTES.DOCUMENT];

src/config/walletAppsConfig.ts

@@ -26,4 +26,8 @@ export const walletAppsConfig: WalletAppsConfig = {
     url: "https://mobile.staging.account.gov.uk/wallet-test/",
     name: "Wallet Test App (Staging)",
   },
+  "wallet-test-verifier-integration": {
+    url: "https://mobile.integration.account.gov.uk/wallet-test/",
+    name: "Wallet Test App (Integration)",
+  },
 };

src/credentialOfferViewer/router.ts

@@ -1,12 +1,15 @@
 import express from "express";
 import { credentialOfferViewerController } from "./controller";
 import { requiresAuth } from "../middleware/requiresAuth";
+import { ROUTES } from "../config/routes";
+import { guardRouteByEnvironment } from "../middleware/guardRouteByEnvironment";
 import { requiresAppSelected } from "../middleware/requiresAppSelected";
 
 const router = express.Router();
 
 router.get(
-  "/view-credential-offer/:itemId",
+  ROUTES.CREDENTIAL_OFFER_VIEWER,
+  guardRouteByEnvironment(),
   requiresAuth,
   requiresAppSelected,
   credentialOfferViewerController(),

src/credentialViewer/router.ts

@@ -1,12 +1,15 @@
 import express from "express";
 import { credentialViewerController } from "./controller";
 import { requiresAuth } from "../middleware/requiresAuth";
+import { ROUTES } from "../config/routes";
+import { guardRouteByEnvironment } from "../middleware/guardRouteByEnvironment";
 import { requiresAppSelected } from "../middleware/requiresAppSelected";
 
 const router = express.Router();
 
 router.get(
-  "/view-credential",
+  ROUTES.VIEW_CREDENTIAL,
+  guardRouteByEnvironment(),
   requiresAuth,
   requiresAppSelected,
   credentialViewerController,

src/dbsDocumentBuilder/controller.ts

@@ -58,11 +58,11 @@ export async function dbsDocumentBuilderPostController(
       timeToLive,
     });
 
-    const redirectUrl = getViewCredentialOfferRedirectUrl(
+    const redirectUrl = getViewCredentialOfferRedirectUrl({
       itemId,
-      CREDENTIAL_TYPE,
-      body["throwError"],
-    );
+      credentialType: CREDENTIAL_TYPE,
+      selectedError: body["throwError"],
+    });
     res.redirect(redirectUrl);
   } catch (error) {
     logger.error(error, "An error happened processing DBS document request");

src/dbsDocumentBuilder/router.ts

@@ -4,18 +4,22 @@ import {
   dbsDocumentBuilderPostController,
 } from "./controller";
 import { requiresAuth } from "../middleware/requiresAuth";
+import { ROUTES } from "../config/routes";
+import { guardRouteByEnvironment } from "../middleware/guardRouteByEnvironment";
 import { requiresAppSelected } from "../middleware/requiresAppSelected";
 
 const router = express.Router();
 
 router.get(
-  "/build-dbs-document",
+  ROUTES.BUILD_DBS_DOCUMENT,
+  guardRouteByEnvironment(),
   requiresAuth,
   requiresAppSelected,
   dbsDocumentBuilderGetController(),
 );
 router.post(
-  "/build-dbs-document",
+  ROUTES.BUILD_DBS_DOCUMENT,
+  guardRouteByEnvironment(),
   requiresAuth,
   requiresAppSelected,
   dbsDocumentBuilderPostController,