feat: Team Settings Form Fetching Boundary GeoJSON using Boundary URL #3378

RODO94 · 2024-07-05T13:38:19Z

What does this PR do?

This PR uses the boundary_url provided by users to generate the boundary GeoJSON from https://www.planning.data.gov.uk/ API - using the entity number is the guide.

The returned GeoJSON is then passed through turf.js to output a boundary box geoJSON, a simplified geoJSON object, that is stored in the team_settings table

github-actions · 2024-07-05T14:01:30Z

Removed vultr server and associated DNS entries

github-actions · 2024-07-05T16:21:13Z

🤖 Hasura Change Summary compared a subset of table metadata including permissions:

Updated Tables (1)

public.team_settings permissions:

	insert	select	update	delete
platformAdmin			^➕/_➖
teamEditor			^➕/_➖

2 added column permissions

	insert	select	update
platformAdmin			➕ boundary_bbox
teamEditor

DafyddLlyr

A few small comments!

I'll pick up the changes and add them as commits to this branch, but still wanted to follow through the feedback process so you can see the changes made here when you're back 👍

DafyddLlyr · 2024-07-08T08:49:24Z

editor.planx.uk/package.json

@@ -38,6 +38,7 @@
    "@turf/area": "^7.0.0",
    "@turf/buffer": "^6.5.0",
    "@turf/helpers": "^6.5.0",
+    "@turf/turf": "^7.0.0",


I think we should just import the functions we need rather than the entire package.

Take a look at the difference between https://bundlephobia.com/package/@turf/[email protected] & https://bundlephobia.com/package/@turf/[email protected]

Fixed in c4f1e3d

DafyddLlyr · 2024-07-08T09:07:51Z

editor.planx.uk/src/pages/FlowEditor/components/Settings/GeneralSettings/BoundaryForm.tsx

+      } catch (error) {
+        formik.errors.boundaryUrl =
+          "We are unable to retrieve your boundary, check your boundary URL and try again";
+        console.error(error);


This looks good!

We might want slightly more fine-grained checking of the error type (i.e. using isAxiosError()) or a bit more control over the URL we send the request to.

Addressed here - 7c1d9fb

I've also used the helper method setFieldError() as there may be a side effect of directly modifying the errors object (docs).

DafyddLlyr · 2024-07-08T09:08:55Z

package.json

+  },
+  "dependencies": {
+    "@types/geojson": "^7946.0.14"


This looks like an npm i at the wrong level

Fixed by c410ab5

DafyddLlyr · 2024-07-08T09:11:46Z

editor.planx.uk/src/pages/FlowEditor/components/Settings/GeneralSettings/BoundaryForm.tsx

@@ -9,10 +11,16 @@ import { SettingsForm } from "../shared/SettingsForm";
 import { FormProps } from ".";

 export default function BoundaryForm({ formikConfig, onSuccess }: FormProps) {
+  const suffixRegEx = /\d{1,10}$/;


This is a good approach 👍

We might actually want to restrict the domain as well (e.g. we don't want to allow users to make a request to https://something-dodgy.com/123456). I'll check with @ianjon3s but I think an an input prefix here is likely the best way forward.

Fixed here - 21cfa53

For now I've not added an prefix - I think just copy/pasting the full URL is likely an easier user interaction than grabbing the entity ID.

DafyddLlyr · 2024-07-08T13:28:03Z

editor.planx.uk/src/pages/FlowEditor/components/Settings/GeneralSettings/BoundaryForm.tsx

+        const bboxPoly = bboxPolygon(bbox(data));
+        const bboxFeature = feature(bboxPoly.geometry);


I'm not quite sure if this is the simplest way to achieve this. If we add types and maybe wrap this in a descriptive helper function it may help clear this up.

Addressed here - 74e7089

The confusion may have come from the fact that there's a bbox property on the generated GeoJSON feature, which sort of looks wrong if you're not expecting it. This is actually fine and is an optional part of the GeoJSON spec (docs).

jessicamcinchak

Changes work for me here !

RODO94 marked this pull request as ready for review July 5, 2024 17:13

RODO94 closed this Jul 5, 2024

RODO94 reopened this Jul 5, 2024

DafyddLlyr requested changes Jul 8, 2024

View reviewed changes

DafyddLlyr force-pushed the rory/team-settings-bbox-fetch branch from c410ab5 to bba77f5 Compare July 8, 2024 11:19

RODO94 and others added 8 commits July 8, 2024 12:23

add boundary form validation and table permissions update

8b6ff65

add boundary form validation and table permissions update

0612245

update error message on fail fetch:

8744aa6

fix regex statement in Yup validation

b75b3d5

repointing boundarybbox from teams table to team_settings

34e5744

remove redundant imports

a3195e5

adjust one error text

6a1a0e9

fix: Remove @types/geojson from root project

b0cf22a

DafyddLlyr force-pushed the rory/team-settings-bbox-fetch branch from bba77f5 to b0cf22a Compare July 8, 2024 11:23

DafyddLlyr added 2 commits July 8, 2024 12:29

chore: Import turf modules, not full package

c4f1e3d

feat: Update regex and examples to restrict domain

21cfa53

DafyddLlyr force-pushed the rory/team-settings-bbox-fetch branch from c1db3f2 to 21cfa53 Compare July 8, 2024 12:53

chore: Add types, use helper function for turf

74e7089

DafyddLlyr requested changes Jul 8, 2024

View reviewed changes

fix: Handle AxiosError, use formik helper method

7c1d9fb

jessicamcinchak approved these changes Jul 8, 2024

View reviewed changes

DafyddLlyr approved these changes Jul 8, 2024

View reviewed changes

DafyddLlyr merged commit fdc795d into main Jul 8, 2024
12 checks passed

DafyddLlyr deleted the rory/team-settings-bbox-fetch branch July 8, 2024 16:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Team Settings Form Fetching Boundary GeoJSON using Boundary URL #3378

feat: Team Settings Form Fetching Boundary GeoJSON using Boundary URL #3378

RODO94 commented Jul 5, 2024 •

edited

Loading

github-actions bot commented Jul 5, 2024 •

edited

Loading

github-actions bot commented Jul 5, 2024 •

edited

Loading

DafyddLlyr left a comment

DafyddLlyr Jul 8, 2024

DafyddLlyr Jul 8, 2024

DafyddLlyr Jul 8, 2024

DafyddLlyr Jul 8, 2024

DafyddLlyr Jul 8, 2024

DafyddLlyr Jul 8, 2024

DafyddLlyr Jul 8, 2024

DafyddLlyr Jul 8, 2024

DafyddLlyr Jul 8, 2024

DafyddLlyr Jul 8, 2024 •

edited

Loading

jessicamcinchak left a comment

		const bboxPoly = bboxPolygon(bbox(data));
		const bboxFeature = feature(bboxPoly.geometry);

feat: Team Settings Form Fetching Boundary GeoJSON using Boundary URL #3378

feat: Team Settings Form Fetching Boundary GeoJSON using Boundary URL #3378

Conversation

RODO94 commented Jul 5, 2024 • edited Loading

What does this PR do?

github-actions bot commented Jul 5, 2024 • edited Loading

github-actions bot commented Jul 5, 2024 • edited Loading

Updated Tables (1)

DafyddLlyr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DafyddLlyr Jul 8, 2024 • edited Loading

Choose a reason for hiding this comment

jessicamcinchak left a comment

Choose a reason for hiding this comment

RODO94 commented Jul 5, 2024 •

edited

Loading

github-actions bot commented Jul 5, 2024 •

edited

Loading

github-actions bot commented Jul 5, 2024 •

edited

Loading

DafyddLlyr Jul 8, 2024 •

edited

Loading