feat: Move GIS to module, setup routes

api.planx.uk/modules/gis/routes.ts

@@ -0,0 +1,10 @@
+import { Router } from "express";
+import { locationSearch } from "./service";
+import { classifiedRoadsSearch } from "./service/classifiedRoads";
+
+const router = Router();
+
+router.get("/gis/:localAuthority", locationSearch);
+router.get("/roads", classifiedRoadsSearch);
+
+export default router;

api.planx.uk/gis/classifiedRoads.test.ts → api.planx.uk/modules/gis/service/classifiedRoads.test.ts

@@ -1,7 +1,7 @@
 import supertest from "supertest";
 
-import loadOrRecordNockRequests from "../tests/loadOrRecordNockRequests";
-import app from "../server";
+import loadOrRecordNockRequests from "../../../tests/loadOrRecordNockRequests";
+import app from "../../../server";
 import { PASSPORT_FN } from "./classifiedRoads";
 
 it("returns an error if required query param is missing", async () => {
@@ -17,7 +17,7 @@
 
 // "Success" test commented out due to reliance on external API calls and fallibility of nocks
 //   Please comment in and run locally if making changes to /roads functionality
 describe.skip("fetching classified roads data from OS Features API for any local authority", () => {
   jest.setTimeout(10000);
 
   // address is for reference only, geom is buffered & flipped site boundary coords

api.planx.uk/gis/digitalLand.ts → api.planx.uk/modules/gis/service/digitalLand.ts

@@ -7,7 +7,7 @@
 import fetch from "isomorphic-fetch";
 import { addDesignatedVariable, omitGeometry } from "./helpers";
 import { baseSchema } from "./local_authorities/metadata/base";
-import { $api } from "../client";
+import { $api } from "../../../client";
 
 export interface LocalAuthorityMetadata {
   planningConstraints: {
@@ -68,8 +68,8 @@
     options,
   )}${datasets}`;
   const res = await fetch(url)
     .then((response: { json: () => any }) => response.json())
     .catch((error: any) => console.log(error));
 
   // if analytics are "on", store an audit record of the raw response
   if (extras?.analytics !== "false") {
@@ -103,7 +103,7 @@
   // check for & add any 'positive' constraints to the formattedResult
   let formattedResult: Record<string, Constraint> = {};
   if (res && res.count > 0 && res.entities) {
     res.entities.forEach((entity: { dataset: any }) => {
       // get the planx variable that corresponds to this entity's 'dataset', should never be null because our initial request is filtered on 'dataset'
       const key = Object.keys(baseSchema).find(
         (key) =>
@@ -152,7 +152,7 @@
     formattedResult["designated.nationalPark"] &&
     formattedResult["designated.nationalPark"].value
   ) {
     formattedResult["designated.nationalPark"]?.data?.forEach((entity: any) => {
       if (
         baseSchema[broads]["digital-land-entities"]?.includes(entity.entity)
       ) {

api.planx.uk/gis/index.test.ts → api.planx.uk/modules/gis/service/index.test.ts

@@ -1,8 +1,8 @@
 import supertest from "supertest";
 
-import { locationSearchWithTimeout } from "../gis";
-import loadOrRecordNockRequests from "../tests/loadOrRecordNockRequests";
-import app from "../server";
+import loadOrRecordNockRequests from "../../../tests/loadOrRecordNockRequests";
+import app from "../../../server";
+import { locationSearchWithTimeout } from ".";
 
 // Tests commented out due to reliance on external API calls and fallibility of nocks
 //   Please comment in and run locally if making changes to /gis functionality

api.planx.uk/gis/local_authorities/scotland.js → api.planx.uk/modules/gis/service/local_authorities/scotland.js

@@ -7,7 +7,7 @@ import {
   rollupResultLayers,
   addDesignatedVariable,
 } from "../helpers.js";
-import { planningConstraints } from "./metadata/scotland";
+import { planningConstraints } from "./metadata/scotland.js";
 
 // Process local authority metadata
 const gisLayers = getQueryableConstraints(planningConstraints);

api.planx.uk/server.ts

@@ -13,7 +13,6 @@ import passport from "passport";
 import helmet from "helmet";
 
 import { ServerError } from "./errors";
-import { locationSearch } from "./gis/index";
 import {
   makePaymentViaProxy,
   fetchPaymentViaProxy,
@@ -33,7 +32,6 @@ import { sendToBOPS } from "./send/bops";
 import { createSendEvents } from "./send/createSendEvents";
 import { downloadApplicationFiles, sendToEmail } from "./send/email";
 import { sendToUniform } from "./send/uniform";
-import { classifiedRoadsSearch } from "./gis/classifiedRoads";
 import { googleStrategy } from "./modules/auth/strategy/google";
 import authRoutes from "./modules/auth/routes";
 import teamRoutes from "./modules/team/routes";
@@ -47,11 +45,10 @@ import ordnanceSurveyRoutes from "./modules/ordnanceSurvey/routes";
 import saveAndReturnRoutes from "./modules/saveAndReturn/routes";
 import sendEmailRoutes from "./modules/sendEmail/routes";
 import fileRoutes from "./modules/file/routes";
+import gisRoutes from "./modules/gis/routes";
 import { useSwaggerDocs } from "./docs";
 import { Role } from "@opensystemslab/planx-core/types";
 
-const router = express.Router();
-
 const app = express();
 
 useSwaggerDocs(app);
@@ -172,19 +169,7 @@ app.use("/file", fileRoutes);
 app.use(saveAndReturnRoutes);
 app.use(sendEmailRoutes);
 app.use("/flows", flowRoutes);
-
-app.use("/gis", router);
-
-app.get("/gis", (_req, _res, next) => {
-  next({
-    status: 400,
-    message: "Please specify a local authority",
-  });
-});
-
-app.get("/gis/:localAuthority", locationSearch);
-
-app.get("/roads", classifiedRoadsSearch);
+app.use(gisRoutes);
 
 // allows an applicant to download their application data on the Confirmation page
 app.post("/download-application", async (req, res, next) => {

api.planx.uk/tests/serverErrorHandler.test.js

@@ -31,7 +31,7 @@ describe("bad requests", () => {
   });
 
   test(`app.get("/gis")`, async () => {
-    await get("/gis").expect(400);
+    await get("/gis").expect(404);
   });
 
   test(`app.get("/gis/wrong")`, async () => {