feature/DF-680 location maps latlong, E&N and OSGR #287

davidjamesstone · 2026-01-08T12:55:01Z

Proposed change

Add map capability to the LatLong location field using defra-map

Jira ticket: https://eaflood.atlassian.net/browse/DF-680

Type of change

Bug fix
New feature
Breaking change
Misc. (documentation, build updates, etc)

Checklist

You have executed this code locally and it performs as expected.
You have added tests to verify your code works.
You have added code comments and JSDoc, where appropriate.
There is no commented-out code.
You have added developer docs in README.md and docs/* (where appropriate, e.g. new features).
The tests are passing (npm run test).
The linting checks are passing (npm run lint).
The code has been formatted (npm run format).

…ps and postcode lookup plugins

…field base template

…prites)

…ts on the page

…n components on the page

jbarnsley10 · 2026-01-14T08:50:26Z

src/server/plugins/map/routes/index.js

+}
+
+/**
+ * @param {MapConfiguration} options - the map options


It would be helpful to add a one-line description of what each of these handlers do as not totally obvious why they are needed

jbarnsley10 · 2026-01-14T08:53:37Z

src/server/plugins/map/service.js

+function logErrorAndReturnEmpty(err, endpoint) {
+  const msg = `${getErrorMessage(err)} ${(Boom.isBoom(err) && err.data?.payload?.error?.message) ?? ''}`
+
+  logger.error(err, `Exception occured calling OS names ${endpoint} - ${msg}}`)


Do we need to log these as errors, or just info?

These are errors returned from OS api calls. They're unlikely to happen but if they do we should log as errors. This code matches the postcode lookup logging.

jbarnsley10 · 2026-01-14T09:01:50Z

src/server/plugins/map/service.js

+ */
+export async function find(query, apiKey) {
+  const endpoint = 'find'
+  const url = `https://api.os.uk/search/names/v1/find?key=${apiKey}&query=${query}&fq=local_type:postcode%20local_type:hamlet%20local_type:village%20local_type:town%20local_type:city%20local_type:other_settlement&maxresults=8`


Are the list of types likely to need changing? How did you determine what to include?

These url's were supplied by Dan Leech from the defra-maps team. They come from here and here. They're unlikely to change so I didn't think it necessary to include them as envars

jbarnsley10 · 2026-01-14T09:02:09Z

src/server/plugins/map/service.js

+ */
+export async function nearest(easting, northing, apiKey) {
+  const endpoint = 'nearest'
+  const url = `https://api.os.uk/search/names/v1/nearest?key=${apiKey}&point=${easting},${northing}&radius=1000&fq=local_type:Airfield%20local_type:Airport%20local_type:Bus_Station%20local_type:Chemical_Works%20local_type:City%20local_type:Coach_Station%20local_type:Electricity_Distribution%20local_type:Electricity_Production%20local_type:Further_Education%20local_type:Gas_Distribution_or_Storage%20local_type:Hamlet%20local_type:Harbour%20local_type:Helicopter_Station%20local_type:Heliport%20local_type:Higher_or_University_Education%20local_type:Hill_Or_Mountain%20local_type:Hospice%20local_type:Hospital%20local_type:Medical_Care_Accommodation%20local_type:Named_Road%20local_type:Non_State_Primary_Education%20local_type:Non_State_Secondary_Education%20local_type:Other_Settlement%20local_type:Passenger_Ferry_Terminal%20local_type:Port_Consisting_of_Docks_and_Nautical_Berthing%20local_type:Postcode%20local_type:Primary_Education%20local_type:Railway_Station%20local_type:Road_User_Services%20local_type:Secondary_Education%20local_type:Section_Of_Named_Road%20local_type:Section_Of_Numbered_Road%20local_type:Special_Needs_Education%20local_type:Suburban_Area%20local_type:Town%20local_type:Urban_Greenspace%20local_type:Vehicular_Ferry_Terminal%20local_type:Vehicular_Rail_Terminal%20local_type:Village%20local_type:Waterfall%20`


As above, are the list of types likely to need changing? How did you determine what to include?

jbarnsley10

Looks really good. Just a couple of very minor comments, and a question or to for my benefit. Approving in principal.

* Add eastingnorthingfield to the list of supported location fields * Add easting northing capability to location maps * Remove unused osgrid * Add easting and northing tests location map client tests * Add map tests with initial field values

alexluckett · 2026-01-19T11:15:03Z

src/client/javascripts/location-map.js

+  VTS_OUTDOOR_URL:
+    'https://raw.githubusercontent.com/OrdnanceSurvey/OS-Vector-Tile-API-Stylesheets/main/OS_VTS_3857_Outdoor.json',
+  VTS_DARK_URL:
+    'https://raw.githubusercontent.com/OrdnanceSurvey/OS-Vector-Tile-API-Stylesheets/main/OS_VTS_3857_Dark.json',
+  VTS_BLACK_AND_WHITE_URL:
+    'https://raw.githubusercontent.com/OrdnanceSurvey/OS-Vector-Tile-API-Stylesheets/main/OS_VTS_3857_Black_and_White.json'
+}


We should definitely pull these into our app, rather than hardcoding them to Ordnance Survey's github. Since this looks the main branch, if they restructure the repo/delete the files/etc it'll break our app.

I'd rather we downlod a copy and mirror them on our end, that way we can guarantee they'll always be there.

I've reverted this 9bae11a commit and will work on identifying any subsequent requests made to that domain.

Resolved with 09da972 and DEFRA/forms-runner@0941c6d

alexluckett · 2026-01-19T11:19:09Z

src/client/javascripts/location-map.js

+            thumbnail: `${assetPath}/defra-map/assets/images/outdoor-map-thumb.jpg`,
+            logo: `${assetPath}/defra-map/assets/images/os-logo.svg`,
+            logoAltText,
+            attribution: `Contains OS data ${String.fromCodePoint(COMPANY_SYMBOL_CODE)} Crown copyright and database rights ${new Date().getFullYear()}`,


this is missing from dark/black-white

Thanks 👍

Resolved with 5324874

alexluckett · 2026-01-19T11:21:03Z

src/client/javascripts/location-map.js

+    zoom: '16',
+    center,
+    markers: [
+      {
+        id: 'location',
+        coords: center
+      }
+    ]


worth pulling these (except center) into a constant and reusing them between the different inputs? so we don't get any drift between the individual component's maps

Resolved with 88f2216 👍

alexluckett · 2026-01-19T11:23:31Z

src/client/javascripts/location-map.js

+      // Move the 'location' marker to the new point
+      map.addMarker('location', center)
+
+      // Pan & zoom the map to the new valid location
+      mapProvider.flyTo({
+        center,
+        zoom: 14,
+        essential: true


could pull this out into a centerMap(center) and share it between the component handlers?

Resolved with bd5918b

alexluckett · 2026-01-19T11:27:33Z

This is great stuff, Dave 🚀

Only one major comment really (styles), everything else is fairly trivial.

…s e.g. sprites)" This reverts commit 9bae11a.

sonarqubecloud · 2026-01-20T09:04:39Z

Quality Gate passed

Issues
8 New issues
1 Accepted issue

Measures
0 Security Hotspots
92.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

davidjamesstone added 30 commits January 8, 2026 10:57

Import the location styles in the correct file

80fd1c9

Add location field map styles

c7fefbc

Update the OS API KEY config to inform that it is used by both the ma…

58a13f3

…ps and postcode lookup plugins

Add class app-location-field and dataset attribute to the location …

c3d3d4a

…field base template

Add the new map plugin and client script

f7b94d5

Register the new map plugin

aa9453c

Add defra-map dependency

60f117d

Sonar fixes (Define a constant instead of duplicating)

9be89a3

Sonar fixes (No magic number)

83024b5

Sonar fixes (No magic number)

7eb2da0

Sonar fixes (use "return" consistently)

2364c9b

Sonar fixes (out scope)

1e0593d

Sonar fixes (No magic number)

0e85e54

Sonar fixes (Explicit return value)

5d2d90a

Sonar fixes (Split it into smaller functions)

8f4cd49

Sonar fixes ("return" consistently)

bd6ca9d

Sonar fixes (Split it into smaller functions)

6a36896

Add location maps client tests

62790be

Fix formatting

d556643

Add map service tests

ac114c2

Delete map tile proxy routes (because there are other requests e.g. s…

9bae11a

…prites)

Add tests for map plugin routes

aae6b65

Add shared client JS tests

7b2097e

Add map proxy route tests

288602b

Map prox test to cover no content type returned

0d50547

Add tile request transformer client tests

41b6343

Test to ensure initMaps only applies when there are location componen…

6cc86a7

…ts on the page

Test to ensure initMaps only applies when there are supported locatio…

0f83369

…n components on the page

Fix comment

4fdc569

Sonar fixes (Use export…from)

8990a9a

Sonar fixes (Prefer String.fromCodePoint)

534f77b

davidjamesstone marked this pull request as ready for review January 13, 2026 16:45

jbarnsley10 reviewed Jan 14, 2026

View reviewed changes

jbarnsley10 approved these changes Jan 14, 2026

View reviewed changes

davidjamesstone added 8 commits January 14, 2026 11:18

Add map routes JsDoc descriptions

95e3d2a

Update to latest defra-map

e36f36d

Restructure location map tests

8afe7da

Add OS grid reference to the location map

ee85669

Add OS grid reference to the location map tests

7d8b096

Sonar fixes (Define a constant instead of duplicating this literal)

48f0cba

Sonar fixes (Define a constant instead of duplicating this literal)

92aeb4c

davidjamesstone changed the title ~~feature/DF-680 location maps latlong~~ feature/DF-680 location maps latlong, E&N and OSGR Jan 16, 2026

alexluckett reviewed Jan 19, 2026

View reviewed changes

davidjamesstone added 7 commits January 19, 2026 15:54

Revert "Delete map tile proxy routes (because there are other request…

09da972

…s e.g. sprites)" This reverts commit 9bae11a.

Add attribution to the dark and black/white styles

5324874

Add VTS 3857 sprites

b6c1c13

Refactor to shared centerMap function

bd5918b

Refactor to shared init map config center function

88f2216

Fix OsGridRef initial values test

64edab4

Add transformer test for raw.githubusercontent.com

5680ddd

feature/DF-680 location maps latlong, E&N and OSGR #287

Are you sure you want to change the base?

feature/DF-680 location maps latlong, E&N and OSGR #287

Conversation

davidjamesstone commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jbarnsley10 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

davidjamesstone Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexluckett commented Jan 19, 2026

Uh oh!

sonarqubecloud bot commented Jan 20, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

davidjamesstone commented Jan 8, 2026 •

edited

Loading

davidjamesstone Jan 19, 2026 •

edited

Loading