Use url builder to generate all URLs

src/interfaces/service-container.ts

@@ -3,5 +3,5 @@ import { StatsWalesApi } from '../services/stats-wales-api';
 
 export interface ServiceContainer {
     swapi: StatsWalesApi;
-    buildUrl: (path: string, locale: Locale, query?: Record<string, string>) => string;
+    buildUrl: (path: string, locale: Locale | string, query?: Record<string, string>) => string;
 }

src/middleware/ensure-authenticated.ts

@@ -4,17 +4,12 @@ import JWT from 'jsonwebtoken';
 import { JWTPayloadWithUser } from '../interfaces/jwt-payload-with-user';
 import { logger } from '../utils/logger';
 import { appConfig } from '../config';
-import { Locale } from '../enums/locale';
-
-import { localeUrl } from './language-switcher';
 
 const config = appConfig();
 
 export const ensureAuthenticated = (req: Request, res: Response, next: NextFunction) => {
     logger.debug(`checking if user is authenticated for route ${req.originalUrl}...`);
 
-    const locale = req.language as Locale;
-
     try {
         if (!req.cookies.jwt) {
             throw new Error('JWT cookie not found');
@@ -30,7 +25,7 @@ export const ensureAuthenticated = (req: Request, res: Response, next: NextFunct
         if (decoded.exp && decoded.exp <= Date.now() / 1000) {
             logger.error('JWT token has expired');
             res.status(401);
-            return res.redirect(localeUrl('/auth/login', locale, { error: 'expired' }));
+            return res.redirect(req.buildUrl(`/auth/login`, req.language, { error: 'expired' }));
         }
 
         // store the token string in the request as we need it for Authorization header in API requests
@@ -43,7 +38,7 @@ export const ensureAuthenticated = (req: Request, res: Response, next: NextFunct
     } catch (err) {
         logger.error(`authentication failed: ${err}`);
         res.status(401);
-        return res.redirect(localeUrl('/auth/login', locale));
+        return res.redirect(req.buildUrl(`/auth/login`, req.language));
     }
 
     return next();

src/middleware/language-switcher.ts

@@ -6,18 +6,19 @@
 
 import { ignoreRoutes, SUPPORTED_LOCALES, i18next } from './translation';
 
-export const localeUrl = (path: string, locale: Locale, query?: Record<string, string>): string => {
+export const localeUrl = (path: string, locale: Locale | string, query?: Record<string, string>): string => {
     const locales = SUPPORTED_LOCALES as string[];
 
-    let pathElements = path
+    const pathElements = path
         .split('/')
         .filter(Boolean) // strip empty elements to avoid trailing slash
         .filter((element) => !locales.includes(element)); // strip language from the path if present
 
-    if (![Locale.English, Locale.EnglishGb].includes(locale)) {
-        // translate the url path to the new locale
-        pathElements = pathElements.map((element) => i18next.t(`routes.${element}`, { lng: locale }));
-    }
+    // TODO: re-enable path translation once the router knows how to handle it
+    // if (![Locale.English, Locale.EnglishGb].includes(locale as Locale)) {
+    //     // translate the url path to the new locale
+    //     pathElements = pathElements.map((element) => i18next.t(`routes.${element}`, { lng: locale }));
+    // }
 
     const newPath = isEmpty(pathElements) ? '' : `/${pathElements.join('/')}`;
     const queryString = isEmpty(query) ? '' : `?${new URLSearchParams(query).toString()}`;

src/middleware/translations/en.json

@@ -214,18 +214,15 @@
     "routes": {
         "healthcheck": "healthcheck",
         "feedback": "feedback",
-        "view": {
-            "start": "dataset"
-        },
-        "publish": {
-            "start": "publish",
-            "title": "title",
-            "upload": "upload",
-            "preview": "preview",
-            "confirm": "confirm",
-            "sources": "sources",
-            "source_confirmation": "source-confirmation",
-            "tasklist": "tasklist"
-        }
+        "dataset": "dataset",
+        "publish": "publish",
+        "start": "start",
+        "title": "title",
+        "preview": "preview",
+        "upload": "upload",
+        "confirm": "confirm",
+        "sources": "sources",
+        "source_confirmation": "source-confirmation",
+        "tasklist": "tasklist"
     }
 }

src/routes/auth.ts

@@ -55,11 +55,11 @@ auth.get('/callback', (req: Request, res: Response) => {
     }
 
     logger.debug('User successfully logged in');
-    res.redirect(`/${req.language}`);
+    res.redirect(req.buildUrl('/', req.language));
 });
 
 auth.get('/logout', (req: Request, res: Response) => {
     logger.debug('logging out user');
     res.clearCookie('jwt', { domain: cookieDomain });
-    res.redirect(`/${req.language}/auth/login`);
+    res.redirect(req.buildUrl(`/auth/login`, req.language));
 });

src/routes/error-handler.ts

@@ -11,7 +11,7 @@ export const errorHandler: ErrorRequestHandler = (err: any, req: Request, res: R
         case 401:
             logger.error('401 error detected, logging user out');
             res.clearCookie('jwt', { domain: cookieDomain });
-            res.redirect(`/${req.language}/auth/login`);
+            res.redirect(req.buildUrl(`/auth/login`, req.language));
             break;
 
         case 404: