Merge branch 'main' into SW-233-update-translations

package.json

@@ -16,7 +16,7 @@
     "test:ci": "APP_ENV=ci jest --ci --coverage --config=jest.config.ts",
     "check": "npm-run-all prettier:fix lint:fix test build",
     "dev:check": "npm-run-all check dev",
-    "predev": "f() { if [ -x $(command -v podman) ]; then podman compose up -d redis; else docker compose up -d redis; fi }; f",
+    "predev": "f() { if [ $(command -v podman) ]; then podman compose up -d redis; else docker compose up -d redis; fi }; f",
     "dev": "APP_ENV=local nodemon --watch src -e ts,ejs --exec npm run start",
     "start": "npm run build && node dist/server.js | pino-colada",
     "start:container": "node dist/server.js"

src/@types/express/index.d.ts

@@ -0,0 +1,6 @@
+import { AuthenticatedRequest } from '../../interfaces/authenticated-request';
+import { ServiceContainer } from '../../interfaces/service-container';
+
+declare module 'express-serve-static-core' {
+    interface Request extends ServiceContainer, AuthenticatedRequest {}
+}

src/app.ts

@@ -19,6 +19,7 @@ import { dataset } from './routes/dataset';
 import { errorHandler } from './routes/error-handler';
 import { homepage } from './routes/homepage';
 import { notFound } from './routes/not-found';
+import { initServices } from './middleware/services';
 
 const app: Application = express();
 const config = appConfig();
@@ -38,6 +39,7 @@ app.use(session);
 app.use(i18nextMiddleware.handle(i18next));
 app.use(skipMap);
 app.use(languageSwitcher);
+app.use(initServices);
 
 // configure the view engine
 app.set('views', path.join(__dirname, 'views'));

src/interfaces/authenticated-request.ts

@@ -0,0 +1,6 @@
+import { User } from './user.interface';
+
+export interface AuthenticatedRequest {
+    user?: User;
+    jwt?: string;
+}

src/interfaces/service-container.ts

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

src/middleware/ensure-authenticated.ts

@@ -1,7 +1,6 @@
-import { RequestHandler } from 'express';
+import { Request, Response, NextFunction } from 'express';
 import JWT from 'jsonwebtoken';
 
-import { AuthedRequest } from '../interfaces/authed-request';
 import { JWTPayloadWithUser } from '../interfaces/jwt-payload-with-user';
 import { logger } from '../utils/logger';
 import { appConfig } from '../config';
@@ -11,7 +10,7 @@ import { localeUrl } from './language-switcher';
 
 const config = appConfig();
 
-export const ensureAuthenticated: RequestHandler = (req: AuthedRequest, res, next) => {
+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;

src/middleware/language-switcher.ts

@@ -4,17 +4,21 @@ import { isEmpty, omit } from 'lodash';
 import { logger } from '../utils/logger';
 import { Locale } from '../enums/locale';
 
-import { ignoreRoutes, SUPPORTED_LOCALES } from './translation';
+import { ignoreRoutes, SUPPORTED_LOCALES, i18next } from './translation';
 
 export const localeUrl = (path: string, locale: Locale, query?: Record<string, string>): string => {
     const locales = SUPPORTED_LOCALES as string[];
 
-    // TODO: translate URL path, params? to Welsh language
-    const pathElements = path
+    let 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 }));
+    }
+
     const newPath = isEmpty(pathElements) ? '' : `/${pathElements.join('/')}`;
     const queryString = isEmpty(query) ? '' : `?${new URLSearchParams(query).toString()}`;
 

src/middleware/services.ts

@@ -0,0 +1,17 @@
+import { NextFunction, Request, Response } from 'express';
+
+import { Locale } from '../enums/locale';
+import { StatsWalesApi } from '../services/stats-wales-api';
+
+import { localeUrl } from './language-switcher';
+
+// initialise any request-scoped services required by the app and store them on the request object for later use
+// see interfaces/service-container.ts and @types/express/index.d.ts for details
+export const initServices = (req: Request, res: Response, next: NextFunction): void => {
+    if (!/^\/(public|css|assets)/.test(req.originalUrl)) {
+        req.swapi = new StatsWalesApi(req.language as Locale, req.cookies.jwt);
+        req.buildUrl = localeUrl; // for controllers
+        res.locals.buildUrl = localeUrl; // for templates
+    }
+    next();
+};

src/routes/auth.ts

@@ -4,7 +4,6 @@ import JWT from 'jsonwebtoken';
 import { logger } from '../utils/logger';
 import { JWTPayloadWithUser } from '../interfaces/jwt-payload-with-user';
 import { appConfig } from '../config';
-import { AuthedRequest } from '../interfaces/authed-request';
 
 export const auth = Router();
 
@@ -59,7 +58,7 @@ auth.get('/callback', (req: Request, res: Response) => {
     res.redirect(`/${req.language}`);
 });
 
-auth.get('/logout', (req: AuthedRequest, res: Response) => {
+auth.get('/logout', (req: Request, res: Response) => {
     logger.debug('logging out user');
     res.clearCookie('jwt', { domain: cookieDomain });
     res.redirect(`/${req.language}/auth/login`);

src/routes/dataset.ts

@@ -1,25 +1,24 @@
 import { Readable } from 'stream';
 
-import { Router, Response, NextFunction } from 'express';
+import { Router, Request, Response, NextFunction } from 'express';
 import { validate as validateUUID } from 'uuid';
 
 import { StatsWalesApi } from '../services/stats-wales-api';
 import { FileList } from '../dtos/file-list';
 import { ViewErrDTO } from '../dtos/view-dto';
 import { logger } from '../utils/logger';
-import { AuthedRequest } from '../interfaces/authed-request';
 import { FileImportDTO } from '../dtos/dataset-dto';
 import { Locale } from '../enums/locale';
 
 export const dataset = Router();
 
-const statsWalesApi = (req: AuthedRequest) => {
+const statsWalesApi = (req: Request) => {
     const lang = req.language as Locale;
     const token = req.jwt;
     return new StatsWalesApi(lang, token);
 };
 
-dataset.get('/', async (req: AuthedRequest, res: Response, next: NextFunction) => {
+dataset.get('/', async (req: Request, res: Response, next: NextFunction) => {
     try {
         const fileList: FileList = await statsWalesApi(req).getFileList();
         logger.debug(`FileList from server = ${JSON.stringify(fileList)}`);
@@ -29,7 +28,7 @@ dataset.get('/', async (req: AuthedRequest, res: Response, next: NextFunction) =
     }
 });
 
-dataset.get('/:datasetId', async (req: AuthedRequest, res: Response) => {
+dataset.get('/:datasetId', async (req: Request, res: Response) => {
     const datasetId = req.params.datasetId;
     const page: number = Number.parseInt(req.query.page_number as string, 10) || 1;
     const page_size: number = Number.parseInt(req.query.page_size as string, 10) || 100;
@@ -63,7 +62,7 @@ dataset.get('/:datasetId', async (req: AuthedRequest, res: Response) => {
     }
 });
 
-dataset.get('/:datasetId/import/:importId', async (req: AuthedRequest, res: Response) => {
+dataset.get('/:datasetId/import/:importId', async (req: Request, res: Response) => {
     if (!validateUUID(req.params.datasetId)) {
         const err: ViewErrDTO = {
             success: false,