DBC22-5929: support for out-of-bc locations (#1281)

Author: ray-oxd

.env.example

@@ -54,6 +54,7 @@ REACT_APP_ROUTE_PLANNER=<route planner url>
 REACT_APP_ROUTE_PLANNER_KEY=<route planner auth key>
 REACT_APP_GEOCODER_HOST=<geocoder url>
 REACT_APP_GEOCODER_API_AUTH_KEY=<api auth key>
+REACT_APP_ROUTABLE_LOCATIONS_HOST=<routable locations api url>
 REACT_APP_RECAPTCHA_CLIENT_ID=<reCAPTCHA client ID>
 REACT_APP_SURVEY_LINK=<exit survey link>
 REACT_APP_REPORT_WMS_LAYER=<report wms layer url>

compose/frontend/generate-config.sh

@@ -37,6 +37,7 @@ window.API_HOST='${REACT_APP_API_HOST}';
 window.REPORT_WMS_LAYER='${REACT_APP_REPORT_WMS_LAYER}';
 window.GEOCODER_HOST='${REACT_APP_GEOCODER_HOST}';
 window.GEOCODER_API_CLIENT_ID='${REACT_APP_GEOCODER_API_CLIENT_ID}';
+window.ROUTABLE_LOCATIONS_HOST='${REACT_APP_ROUTABLE_LOCATIONS_HOST}';
 window.ROUTE_PLANNER='${REACT_APP_ROUTE_PLANNER}';
 window.ROUTE_PLANNER_CLIENT_ID='${REACT_APP_ROUTE_PLANNER_CLIENT_ID}';
 window.REPLAY_THE_DAY='${REACT_APP_REPLAY_THE_DAY}';
@@ -107,4 +108,4 @@ fi
 
 
 echo "Configuration and assets ready in ${SHARED_CONFIG}:"
-ls -la "${SHARED_CONFIG}/"
+ls -la "${SHARED_CONFIG}/"

src/frontend/src/Components/data/locations.js

@@ -1,18 +1,81 @@
 import { get } from "./helper.js";
 
+function escapeCqlString(value) {
+  return String(value).replace(/'/g, "''");
+}
+
+function sanitizeForILikePrefix(value) {
+  return String(value).replace(/%/g, "").replace(/_/g, "");
+}
+
+function normalizeRoutableLocationFeature(feature) {
+  const props = feature.properties || {};
+  const displayName = props.name != null ? String(props.name) : "";
+  return {
+    ...feature,
+    properties: {
+      ...props,
+      fullAddress: displayName,
+    },
+  };
+}
+
+export function getExtraLocations(addressInput) {
+  // return empty promise if address input is less than 2 characters
+  const trimmed = (addressInput || "").trim();
+  if (trimmed.length < 2) {
+    return Promise.resolve({ type: "FeatureCollection", features: [] });
+  }
+
+  // escape CQL string and sanitize for ILike prefix
+  const literal = escapeCqlString(sanitizeForILikePrefix(trimmed));
+  return get(
+    `${window.ROUTABLE_LOCATIONS_HOST}`,
+    {
+      service: "WFS",
+      version: "1.0.0",
+      request: "GetFeature",
+      typeName: "public:routable-locations",
+      outputFormat: "application/json",
+      maxFeatures: 5,
+      cql_filter: `authority='DriveBC' and name ilike '${literal}%'`,
+    },
+    {},
+    false,
+  );
+}
+
 export function getLocations(addressInput) {
-  return get(`${window.GEOCODER_HOST}/addresses.json`, {
-      minScore: 50,
-      maxResults: 7,
-      echo: 'false',
-      brief: true,
-      autoComplete: true,
-      addressString: addressInput,
-      exactSpelling: false,
-      locationDescriptor: 'routingPoint',
-      fuzzyMatch: true,
-    }, {
-      'apiKey': `${window.GEOCODER_API_CLIENT_ID}`,
-    }
-  ).then((data) => data);
+  const geocoderPromise = get(`${window.GEOCODER_HOST}/addresses.json`, {
+    minScore: 50,
+    maxResults: 7,
+    echo: "false",
+    brief: true,
+    autoComplete: true,
+    addressString: addressInput,
+    exactSpelling: false,
+    locationDescriptor: "routingPoint",
+    fuzzyMatch: true,
+  }, {
+    apiKey: `${window.GEOCODER_API_CLIENT_ID}`,
+  });
+
+  const extraPromise = getExtraLocations(addressInput).catch(() => ({
+    type: "FeatureCollection",
+    features: [],
+  }));
+
+  // return all features from geocoder and extra locations
+  return Promise.all([geocoderPromise, extraPromise]).then(
+    ([geoData, extraData]) => {
+      const extraFeatures = (extraData.features || []).map(
+        normalizeRoutableLocationFeature,
+      );
+      const geoFeatures = geoData.features || [];
+      return {
+        ...geoData,
+        features: [...extraFeatures, ...geoFeatures],
+      };
+    },
+  );
 }

src/frontend/src/env.js

@@ -18,6 +18,7 @@ window.MAP_STYLE = `${process.env.REACT_APP_MAP_STYLE}`;
 window.REPLAY_THE_DAY = `${process.env.REACT_APP_REPLAY_THE_DAY}`;
 window.GEOCODER_HOST = `${process.env.REACT_APP_GEOCODER_HOST}`;
 window.GEOCODER_API_CLIENT_ID = `${process.env.REACT_APP_GEOCODER_API_CLIENT_ID}`;
+window.ROUTABLE_LOCATIONS_HOST = `${process.env.REACT_APP_ROUTABLE_LOCATIONS_HOST}`;
 window.ROUTE_PLANNER = `${process.env.REACT_APP_ROUTE_PLANNER}`;
 window.ROUTE_PLANNER_CLIENT_ID = `${process.env.REACT_APP_ROUTE_PLANNER_CLIENT_ID}`;
 window.PRIMARY_ROUTE_GDF = `${process.env.REACT_APP_PRIMARY_ROUTE_GDF}`;