Merge branch 'feat/df-623-payment' of https://github.com/DEFRA/forms-engine-plugin into feat/df-623-payment

Author: jbarnsley10

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.42",
+  "version": "4.0.43",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

package.json

@@ -138,10 +138,18 @@ export function makeTileRequestTransformer(apiPath) {
    * @param {string} resourceType - the resource type
    */
   return function transformTileRequest(url, resourceType) {
-    // Only proxy OS API requests that don't already have a key
-    if (resourceType !== 'Style' && url.startsWith('https://api.os.uk')) {
-      const urlObj = new URL(url)
-      if (!urlObj.searchParams.has('key')) {
+    if (url.startsWith('https://api.os.uk')) {
+      if (resourceType === 'Tile') {
+        return {
+          url: url.replace(
+            'https://api.os.uk/maps/vector/v1/vts',
+            `${window.location.origin}${apiPath}`
+          ),
+          headers: {}
+        }
+      }
+
+      if (resourceType !== 'Style') {
         return {
           url: `${apiPath}/map-proxy?url=${encodeURIComponent(url)}`,
           headers: {}

src/client/javascripts/location-map.js

@@ -22,7 +22,8 @@ export const configureEnginePlugin = async (
     preparePageEventRequestOptions,
     onRequest,
     saveAndExit,
-    ordnanceSurveyApiKey
+    ordnanceSurveyApiKey,
+    ordnanceSurveyApiSecret
   }: RouteConfig = {},
   cache?: CacheService
 ): Promise<{
@@ -65,7 +66,8 @@ export const configureEnginePlugin = async (
       onRequest,
       baseUrl: 'http://localhost:3009', // always runs locally
       saveAndExit,
-      ordnanceSurveyApiKey
+      ordnanceSurveyApiKey,
+      ordnanceSurveyApiSecret
     }
   }
 }

src/server/plugins/engine/configureEnginePlugin.ts

@@ -26,7 +26,8 @@ const pluginRegistrationOptionsSchema = Joi.object({
   onRequest: Joi.function().optional(),
   baseUrl: Joi.string().uri().required(),
   saveAndExit: Joi.function().optional(),
-  ordnanceSurveyApiKey: Joi.string().optional()
+  ordnanceSurveyApiKey: Joi.string().optional(),
+  ordnanceSurveyApiSecret: Joi.string().optional()
 })
 
 /**

src/server/plugins/engine/options.js

@@ -40,7 +40,8 @@ export const plugin = {
       preparePageEventRequestOptions,
       onRequest,
       ordnanceSurveyApiKey,
-      baseUrl
+      baseUrl,
+      ordnanceSurveyApiSecret
     } = options
 
     const cacheService =
@@ -60,12 +61,13 @@ export const plugin = {
       })
     }
 
-    // Register the maps plugin only if we have an OS api key
-    if (ordnanceSurveyApiKey) {
+    // Register the maps plugin only if we have an OS api key & secret
+    if (ordnanceSurveyApiKey && ordnanceSurveyApiSecret) {
       await server.register({
         plugin: mapPlugin,
         options: {
-          ordnanceSurveyApiKey
+          ordnanceSurveyApiKey,
+          ordnanceSurveyApiSecret
         }
       })
     }

src/server/plugins/engine/plugin.ts

@@ -430,6 +430,7 @@ export interface PluginOptions {
   onRequest?: OnRequestCallback
   baseUrl: string // base URL of the application, protocol and hostname e.g. "https://myapp.com"
   ordnanceSurveyApiKey?: string
+  ordnanceSurveyApiSecret?: string
 }
 
 export interface FormAdapterSubmissionMessageMeta {

src/server/plugins/engine/types.ts

@@ -0,0 +1,41 @@
+import { post } from '~/src/server/services/httpService.js'
+
+/**
+ * @type {string}
+ */
+let cachedToken
+let tokenExpiry = 0
+
+/**
+ * Get Ordnance Survey OAuth token
+ * @param {MapConfiguration} options - Ordnance survey map options
+ */
+export async function getAccessToken(options) {
+  const { ordnanceSurveyApiKey: key, ordnanceSurveyApiSecret: secret } = options
+  const now = Date.now()
+
+  if (cachedToken && now < tokenExpiry) {
+    return cachedToken
+  }
+
+  const creds = `${key}:${secret}`
+  const result = await post('https://api.os.uk/oauth2/token/v1', {
+    headers: {
+      Authorization: `Basic ${btoa(creds)}`,
+      'Content-Type': 'application/x-www-form-urlencoded'
+    },
+    payload: 'grant_type=client_credentials',
+    json: true
+  })
+
+  const data = result.payload
+
+  cachedToken = data.access_token
+  tokenExpiry = now + (data.expires_in - 60) * 1000 // refresh early
+
+  return cachedToken
+}
+
+/**
+ * @import { MapConfiguration } from '~/src/server/plugins/map/types.js'
+ */

src/server/plugins/map/routes/get-os-token.js

@@ -0,0 +1,55 @@
+import { getAccessToken } from '~/src/server/plugins/map/routes/get-os-token.js'
+import { post } from '~/src/server/services/httpService.js'
+
+jest.mock('~/src/server/services/httpService.ts')
+
+describe('OS OAuth token', () => {
+  describe('getAccessToken', () => {
+    it('should get access token', async () => {
+      jest.mocked(post).mockResolvedValueOnce({
+        res: /** @type {IncomingMessage} */ ({
+          statusCode: 200,
+          headers: {}
+        }),
+        payload: {
+          access_token: 'access_token',
+          expires_in: '299',
+          issued_at: '1770036762387',
+          token_type: 'Bearer'
+        },
+        error: undefined
+      })
+
+      const token = await getAccessToken({
+        ordnanceSurveyApiKey: 'apikey',
+        ordnanceSurveyApiSecret: 'apisecret'
+      })
+
+      expect(token).toBe('access_token')
+
+      expect(post).toHaveBeenCalledWith('https://api.os.uk/oauth2/token/v1', {
+        headers: {
+          Authorization: `Basic ${btoa('apikey:apisecret')}`,
+          'Content-Type': 'application/x-www-form-urlencoded'
+        },
+        payload: 'grant_type=client_credentials',
+        json: true
+      })
+      expect(post).toHaveBeenCalledTimes(1)
+    })
+
+    it('should return an cached token', async () => {
+      const token = await getAccessToken({
+        ordnanceSurveyApiKey: 'apikey',
+        ordnanceSurveyApiSecret: 'apisecret'
+      })
+
+      expect(token).toBe('access_token')
+      expect(post).toHaveBeenCalledTimes(0)
+    })
+  })
+})
+
+/**
+ * @import  { IncomingMessage } from 'node:http'
+ */

src/server/plugins/map/routes/get-os-token.test.js

@@ -1,27 +1,33 @@
 import { resolve } from 'node:path'
 
+import { StatusCodes } from 'http-status-codes'
 import Joi from 'joi'
 
+import { getAccessToken } from '~/src/server/plugins/map/routes/get-os-token.js'
 import { find, nearest } from '~/src/server/plugins/map/service.js'
-import { request as httpRequest } from '~/src/server/services/httpService.js'
+import {
+  get,
+  request as httpRequest
+} from '~/src/server/services/httpService.js'
 
 /**
  * Gets the map support routes
  * @param {MapConfiguration} options - ordnance survey names api key
  */
 export function getRoutes(options) {
   return [
+    mapStyleResourceRoutes(),
     mapProxyRoute(options),
+    tileProxyRoute(options),
     geocodeProxyRoute(options),
-    reverseGeocodeProxyRoute(options),
-    ...tileRoutes()
+    reverseGeocodeProxyRoute(options)
   ]
 }
 
 /**
  * Proxies ordnance survey requests from the front end to api.os.com
- * Used for VTS map tiles, sprites and fonts by forwarding on the request
- * and adding the apikey and optionally an SRS (spatial reference system)
+ * Used for the VTS map source by forwarding on the request
+ * and adding the auth token and SRS (spatial reference system)
  * @param {MapConfiguration} options - the map options
  * @returns {ServerRoute<MapProxyGetRequestRefs>}
  */
@@ -32,14 +38,15 @@ function mapProxyRoute(options) {
     handler: async (request, h) => {
       const { query } = request
       const targetUrl = new URL(decodeURIComponent(query.url))
+      const token = await getAccessToken(options)
 
-      // Add API key server-side and set SRS
-      targetUrl.searchParams.set('key', options.ordnanceSurveyApiKey)
-      if (!targetUrl.searchParams.has('srs')) {
-        targetUrl.searchParams.set('srs', '3857')
-      }
+      targetUrl.searchParams.set('srs', '3857')
 
-      const proxyResponse = await httpRequest('get', targetUrl.toString())
+      const proxyResponse = await httpRequest('get', targetUrl.toString(), {
+        headers: {
+          Authorization: `Bearer ${token}`
+        }
+      })
       const buffer = proxyResponse.payload
       const contentType = proxyResponse.res.headers['content-type']
       const response = h.response(buffer)
@@ -63,7 +70,44 @@ function mapProxyRoute(options) {
 }
 
 /**
- * Proxies ordnance survey geocode requests from the front end to api.os.com
+ * Proxies ordnance survey requests from the front end to api.os.uk
+ * Used for VTS map tiles forwarding on the request and adding the auth token
+ * @param {MapConfiguration} options - the map options
+ * @returns {ServerRoute<MapProxyGetRequestRefs>}
+ */
+function tileProxyRoute(options) {
+  return {
+    method: 'GET',
+    path: '/api/tile/{z}/{y}/{x}.pbf',
+    handler: async (request, h) => {
+      const { z, y, x } = request.params
+      const token = await getAccessToken(options)
+
+      const url = `https://api.os.uk/maps/vector/v1/vts/tile/${z}/${y}/${x}.pbf?srs=3857`
+
+      const { payload, res } = await get(url, {
+        headers: {
+          Authorization: `Bearer ${token}`,
+          Accept: 'application/x-protobuf'
+        },
+        json: false,
+        gunzip: true
+      })
+
+      if (res.statusCode && res.statusCode !== StatusCodes.OK.valueOf()) {
+        return h.response('Tile fetch failed').code(res.statusCode)
+      }
+
+      return h
+        .response(payload)
+        .type('application/x-protobuf')
+        .header('Cache-Control', 'public, max-age=86400')
+    }
+  }
+}
+
+/**
+ * Proxies ordnance survey geocode requests from the front end to api.os.uk
  * Used for the gazzeteer address lookup to find name from query strings like postcode and place names
  * @param {MapConfiguration} options - the map options
  * @returns {ServerRoute<MapGeocodeGetRequestRefs>}
@@ -91,7 +135,7 @@ function geocodeProxyRoute(options) {
 }
 
 /**
- * Proxies ordnance survey reverse geocode requests from the front end to api.os.com
+ * Proxies ordnance survey reverse geocode requests from the front end to api.os.uk
  * Used to find name from easting and northing points.
  * N.B this endpoint is currently not used by the front end but will be soon in "maps V2"
  * @param {MapConfiguration} options - the map options
@@ -124,20 +168,22 @@ function reverseGeocodeProxyRoute(options) {
   }
 }
 
-function tileRoutes() {
-  return [
-    {
-      method: 'GET',
-      path: '/api/maps/vts/{path*}',
-      options: {
-        handler: {
-          directory: {
-            path: resolve(import.meta.dirname, './vts')
-          }
+/**
+ * Resource routes to return sprites and glyphs
+ * @returns {ServerRoute<MapProxyGetRequestRefs>}
+ */
+function mapStyleResourceRoutes() {
+  return {
+    method: 'GET',
+    path: '/api/maps/vts/{path*}',
+    options: {
+      handler: {
+        directory: {
+          path: resolve(import.meta.dirname, './vts')
         }
       }
     }
-  ]
+  }
 }
 
 /**