@opentripplanner/core-utils 8.1.0 → 8.2.0

package/src/__tests__/query-params.ts

@@ -0,0 +1,279 @@
+import { ModeSetting, TransportMode } from "@opentripplanner/types";
+
+import { reduceOtpFlexModes } from "../query";
+import queryParams, { getCustomQueryParams } from "../query-params";
+import { extractAdditionalModes, generateCombinations } from "../query-gen";
+
+const customWalkDistanceOptions = [
+  {
+    text: "200 m",
+    value: 200
+  },
+  {
+    text: "500 m",
+    value: 500
+  }
+];
+
+function modeStrToTransportMode(m): TransportMode {
+  const splitVals = m.split("_");
+  return {
+    mode: splitVals[0],
+    qualifier: splitVals?.[1] || null
+  };
+}
+
+const mockLatLon = {
+  lat: 1,
+  lon: 2
+};
+
+function expectModes(modes: string[], expectedModes: string[][]) {
+  const generatedModesList = generateCombinations({
+    from: mockLatLon,
+    modes: modes.map(modeStrToTransportMode),
+    modeSettings: [],
+    to: mockLatLon
+  });
+  const expandedExpectedModesList = expectedModes.map(em => ({
+    from: mockLatLon,
+    modes: em.map(modeStrToTransportMode),
+    modeSettings: [],
+    to: mockLatLon
+  }));
+  return it(
+    modes.join(" "),
+    () =>
+      expect(generatedModesList.length === expandedExpectedModesList.length) &&
+      expect(new Set(generatedModesList)).toEqual(
+        new Set(expandedExpectedModesList)
+      )
+  );
+}
+
+describe("extract-modes", () => {
+  const mode = {
+    mode: "UNICYCLE"
+  };
+
+  const testTransportMode: TransportMode = {
+    mode: "testMode"
+  };
+
+  const checkboxModeSetting: ModeSetting = {
+    addTransportMode: mode,
+    applicableMode: testTransportMode.mode,
+    icon: null,
+    key: "test",
+    label: "test",
+    type: "CHECKBOX",
+    value: true
+  };
+
+  const dropdownModeSetting: ModeSetting = {
+    applicableMode: testTransportMode.mode,
+    key: "test",
+    label: "test",
+    options: [{ text: "testOption", value: "1", addTransportMode: mode }],
+    type: "DROPDOWN",
+    value: "1"
+  };
+
+  it("determines whether a checkbox setting is extracted correctly", () => {
+    expect(
+      extractAdditionalModes([checkboxModeSetting], [testTransportMode])
+    ).toEqual([mode]);
+  });
+  it("determines whether a dropdown setting is extracted correctly", () => {
+    expect(
+      extractAdditionalModes([dropdownModeSetting], [testTransportMode])
+    ).toEqual([mode]);
+  });
+  it("determines whether a checkbox setting set to false is ignored", () => {
+    expect(
+      extractAdditionalModes(
+        [{ ...checkboxModeSetting, value: false }],
+        [testTransportMode]
+      )
+    ).toEqual([]);
+  });
+  it("determines whether a checkbox setting with no modes is ignored", () => {
+    expect(extractAdditionalModes([{ ...checkboxModeSetting }], [])).toEqual(
+      []
+    );
+  });
+});
+
+describe("query-gen", () => {
+  describe("generateCombinations", () => {
+    expectModes(["WALK"], [["WALK"]]);
+    expectModes(["WALK", "TRANSIT"], [["WALK"], ["TRANSIT"]]);
+    expectModes(
+      ["WALK", "TRANSIT", "BICYCLE"],
+      [["WALK"], ["TRANSIT"], ["BICYCLE"], ["TRANSIT", "BICYCLE"]]
+    );
+    expectModes(
+      ["WALK", "TRANSIT", "CAR"],
+      [["WALK"], ["TRANSIT"], ["TRANSIT", "CAR"]]
+    );
+    expectModes(["TRANSIT", "CAR"], [["TRANSIT"], ["TRANSIT", "CAR"]]);
+    expectModes(["CAR"], []);
+    expectModes(
+      ["WALK", "TRANSIT", "BICYCLE", "CAR"],
+      [
+        ["WALK"],
+        ["TRANSIT"],
+        ["TRANSIT", "BICYCLE"],
+        ["BICYCLE"],
+        ["TRANSIT", "CAR"]
+      ]
+    );
+    expectModes(
+      ["BICYCLE_RENT", "TRANSIT", "WALK"],
+      [
+        ["TRANSIT"],
+        ["BICYCLE_RENT", "TRANSIT"],
+        ["BICYCLE_RENT", "WALK"],
+        ["WALK"]
+      ]
+    );
+    expectModes(
+      ["BICYCLE_RENT", "BICYCLE", "TRANSIT", "WALK"],
+      [
+        ["TRANSIT"],
+        ["BICYCLE_RENT", "TRANSIT"],
+        ["BICYCLE", "TRANSIT"],
+        ["BICYCLE_RENT", "WALK"],
+        ["BICYCLE"],
+        ["WALK"]
+      ]
+    );
+    expectModes(
+      ["SCOOTER_RENT", "BICYCLE_RENT", "TRANSIT", "WALK"],
+      [
+        ["TRANSIT"],
+        ["BICYCLE_RENT", "TRANSIT"],
+        ["BICYCLE_RENT", "WALK"],
+        ["SCOOTER_RENT", "TRANSIT"],
+        ["SCOOTER_RENT", "WALK"],
+        ["WALK"]
+      ]
+    );
+    expectModes(
+      ["FLEX", "TRANSIT", "WALK"],
+      [["TRANSIT"], ["FLEX", "TRANSIT"], ["FLEX", "WALK"], ["WALK"]]
+    );
+    expectModes(
+      ["FLEX", "SCOOTER_RENT", "TRANSIT", "WALK"],
+      [
+        ["TRANSIT"],
+        ["FLEX", "TRANSIT"],
+        ["WALK"],
+        ["FLEX", "WALK"],
+        ["FLEX", "SCOOTER_RENT", "WALK"], // Is this sensible?
+        ["FLEX", "SCOOTER_RENT", "TRANSIT"],
+        ["SCOOTER_RENT", "WALK"],
+        ["SCOOTER_RENT", "TRANSIT"]
+      ]
+    );
+    expectModes(
+      ["FLEX", "SCOOTER_RENT", "TRANSIT"],
+      [
+        ["TRANSIT"],
+        ["FLEX", "TRANSIT"],
+        ["FLEX", "SCOOTER_RENT", "TRANSIT"],
+        ["SCOOTER_RENT", "TRANSIT"]
+      ]
+    );
+    expectModes(
+      // Transit is required to enable other transit submodes
+      ["BUS", "RAIL", "GONDOLA", "TRAM", "TRANSIT"],
+      [["BUS", "RAIL", "GONDOLA", "TRAM"]]
+    );
+    expectModes(
+      // Transit is required to enable other transit submodes
+      ["TRANSIT"],
+      [["TRANSIT"]]
+    );
+  });
+});
+
+describe("query-params", () => {
+  describe("getCustomQueryParams", () => {
+    it("should return the original unmodified queryParams if no customizations", () => {
+      expect(getCustomQueryParams()).toEqual(queryParams);
+    });
+
+    it("should return queryParams with customizations", () => {
+      const customizations = {
+        maxWalkDistance: {
+          label: "Max Walk Distance In Meters",
+          options: customWalkDistanceOptions
+        }
+      };
+      expect(getCustomQueryParams(customizations)).toMatchSnapshot();
+    });
+
+    it("should ignore unknown query params", () => {
+      const customizations = {
+        unknownQueryParameter: {
+          label: "Unknown query parameter",
+          options: customWalkDistanceOptions
+        }
+      };
+      expect(getCustomQueryParams(customizations)).toEqual(queryParams);
+    });
+  });
+});
+
+describe("flex-reducer", () => {
+  it("should not touch a query that doesn't include flex modes", () => {
+    expect(reduceOtpFlexModes(["WALK", "TRANSIT", "BIKE"])).toStrictEqual([
+      "WALK",
+      "TRANSIT",
+      "BIKE"
+    ]);
+  });
+  it("should modify a query that includes some flex modes", () => {
+    expect(
+      reduceOtpFlexModes(["WALK", "TRANSIT", "BIKE", "FLEX_DIRECT"])
+    ).toStrictEqual(["WALK", "TRANSIT", "BIKE", "FLEX"]);
+  });
+  it("should modify a query that includes all flex modes", () => {
+    expect(
+      reduceOtpFlexModes([
+        "WALK",
+        "TRANSIT",
+        "BIKE",
+        "FLEX_DIRECT",
+        "FLEX_ACCESS",
+        "FLEX_EGRESS"
+      ])
+    ).toStrictEqual(["WALK", "TRANSIT", "BIKE", "FLEX"]);
+    expect(
+      reduceOtpFlexModes([
+        "FLEX_DIRECT",
+        "BIKE",
+        "FLEX_ACCESS",
+        "WALK",
+        "FLEX_EGRESS",
+        "TRANSIT"
+      ])
+    ).toStrictEqual(["FLEX", "BIKE", "WALK", "TRANSIT"]);
+  });
+  it("should modify a query that includes only flex modes", () => {
+    expect(
+      reduceOtpFlexModes(["FLEX_DIRECT", "FLEX_ACCESS", "FLEX_EGRESS"])
+    ).toStrictEqual(["FLEX"]);
+  });
+  it("should modify a query that includes duplicate flex modes", () => {
+    expect(
+      reduceOtpFlexModes([
+        "FLEX_DIRECT",
+        "FLEX_DIRECT",
+        "FLEX_ACCESS",
+        "FLEX_EGRESS"
+      ])
+    ).toStrictEqual(["FLEX"]);
+  });
+});

package/src/graphql.d.ts

@@ -0,0 +1,7 @@
+declare module "*.graphql" {
+  import { DocumentNode } from "graphql";
+
+  const Schema: DocumentNode;
+
+  export = Schema;
+}

package/src/index.ts

@@ -7,12 +7,14 @@ import * as route from "./route";
 import * as storage from "./storage";
 import * as time from "./time";
 import * as ui from "./ui";
+import * as queryGen from "./query-gen";
 
 const core = {
   itinerary,
   map,
   profile,
   query,
+  queryGen,
   queryParams,
   route,
   storage,

package/src/itinerary.ts

@@ -590,6 +590,7 @@ export function getLegCost(
   container: string
 ): { price?: Money; transferAmount?: number } {
   if (!leg.fareProducts) return { price: undefined };
+
   const relevantFareProducts = leg.fareProducts.filter(
     fp => fp.category.name === category && fp.container.name === container
   );

package/src/planQuery.graphql

@@ -0,0 +1,146 @@
+query PlanQuery(
+	$fromPlace: String!,
+	$toPlace: String!,
+	$modes: [TransportMode],
+	$time: String,
+	$date: String,
+	$wheelchair: Boolean,
+	$bikeReluctance: Float,
+	$carReluctance: Float,
+	$walkReluctance: Float,
+	$arriveBy: Boolean,
+	$intermediatePlaces: [InputCoordinates],
+	$preferred: InputPreferred,
+	$unpreferred: InputUnpreferred,
+	$banned: InputBanned,
+) {
+	plan(
+		fromPlace: $fromPlace
+		toPlace: $toPlace
+		transportModes: $modes
+		# Currently only supporting EN locale, used for times and text
+		locale: "en",
+		time: $time,
+		date: $date,
+		wheelchair: $wheelchair,
+		bikeReluctance: $bikeReluctance,
+		carReluctance: $carReluctance,
+		walkReluctance: $walkReluctance,
+		arriveBy: $arriveBy,
+		intermediatePlaces: $intermediatePlaces,
+		preferred: $preferred,
+		unpreferred: $unpreferred,
+		banned: $banned,
+	) {
+		itineraries {
+			duration
+			endTime
+			startTime
+			waitingTime
+			walkTime
+			legs {
+				distance
+				duration
+				endTime
+				mode
+				realTime
+				realtimeState	
+				startTime
+				transitLeg
+				trip {
+					id
+					gtfsId
+				}
+				agency {
+					name
+					id
+					timezone
+					url
+					alerts {
+            alertHeaderText
+            alertDescriptionText
+            alertUrl
+            effectiveStartDate
+          }
+				}
+				legGeometry {
+					length
+					points
+				}
+				intermediateStops {
+					lat
+					lon
+					name
+					stopCode: code
+					stopId: id
+					locationType
+				}
+				route {
+					shortName
+					color
+					textColor
+					id
+					type
+					alerts {
+            alertHeaderText
+            alertDescriptionText
+            alertUrl
+            effectiveStartDate
+          }
+				}
+				from {
+					lat
+					lon
+					name
+					vertexType
+					stop {
+						id
+						code
+						alerts {
+							alertHeaderText
+							alertDescriptionText
+							alertUrl
+							effectiveStartDate
+						}	
+					}
+				}
+				to {
+					lat
+					lon
+					name
+					vertexType
+					stop {
+						id
+						code
+						alerts {
+							alertHeaderText
+							alertDescriptionText
+							alertUrl
+							effectiveStartDate
+						}
+					}
+				}
+				steps {
+					distance
+					lat
+					lon
+          relativeDirection
+          absoluteDirection
+          stayOn
+          streetName
+          area
+          alerts{
+            alertHeaderText
+            alertDescriptionText
+            alertUrl
+            effectiveStartDate
+          }
+					elevationProfile {
+						distance
+						elevation
+					}
+				}
+			}
+		}
+	}
+}

package/src/query-gen.ts

@@ -0,0 +1,209 @@
+import { LonLatOutput } from "@conveyal/lonlat";
+import { print } from "graphql";
+import {
+  ModeSetting,
+  ModeSettingValues,
+  TransportMode
+} from "@opentripplanner/types";
+
+import PlanQuery from "./planQuery.graphql";
+
+type OTPQueryParams = {
+  from: LonLatOutput & { name?: string };
+  modes: TransportMode[];
+  modeSettings: ModeSetting[];
+  to: LonLatOutput & { name?: string };
+};
+
+type GraphQLQuery = {
+  query: string;
+  variables: Record<string, unknown>;
+};
+
+/**
+ * Mode Settings can contain additional modes to add to the query,
+ * this function extracts those additional modes from the settings
+ * and returns them in an array.
+ * @param modeSettings List of mode settings with values populated
+ * @returns Additional transport modes to add to query
+ */
+export function extractAdditionalModes(
+  modeSettings: ModeSetting[],
+  enabledModes: TransportMode[]
+): TransportMode[] {
+  return modeSettings.reduce<TransportMode[]>((prev, cur) => {
+    // First, ensure that the mode associated with this setting is even enabled
+    if (!enabledModes.map(m => m.mode).includes(cur.applicableMode)) {
+      return prev;
+    }
+
+    // In checkboxes, mode must be enabled and have a transport mode in it
+    if (cur.type === "CHECKBOX" && cur.addTransportMode && cur.value) {
+      return [...prev, cur.addTransportMode];
+    }
+    if (cur.type === "DROPDOWN") {
+      const transportMode = cur.options.find(o => o.value === cur.value)
+        .addTransportMode;
+      if (transportMode) {
+        return [...prev, transportMode];
+      }
+    }
+    return prev;
+  }, []);
+}
+
+/**
+ * Generates every possible mathematical subset of the input TransportModes.
+ * Uses code from:
+ * https://stackoverflow.com/questions/5752002/find-all-possible-subset-combos-in-an-array
+ * @param array Array of input transport modes
+ * @returns 2D array representing every possible subset of transport modes from input
+ */
+function combinations(array: TransportMode[]): TransportMode[][] {
+  if (!array) return [];
+  return (
+    // eslint-disable-next-line no-bitwise
+    new Array(1 << array.length)
+      .fill(null)
+      // eslint-disable-next-line no-bitwise
+      .map((e1, i) => array.filter((e2, j) => i & (1 << j)))
+  );
+}
+
+/**
+ * This constant maps all the transport mode to a broader mode type,
+ * which is used to determine the valid combinations of modes used in query generation.
+ */
+export const SIMPLIFICATIONS = {
+  AIRPLANE: "TRANSIT",
+  BICYCLE: "PERSONAL",
+  BUS: "TRANSIT",
+  CABLE_CAR: "TRANSIT",
+  CAR: "CAR",
+  FERRY: "TRANSIT",
+  FLEX: "SHARED", // TODO: this allows FLEX+WALK. Is this reasonable?
+  FUNICULAR: "TRANSIT",
+  GONDOLA: "TRANSIT",
+  RAIL: "TRANSIT",
+  SCOOTER: "PERSONAL",
+  SUBWAY: "TRANSIT",
+  TRAM: "TRANSIT",
+  TRANSIT: "TRANSIT",
+  WALK: "WALK"
+};
+
+// Inclusion of "TRANSIT" alone automatically implies "WALK" in OTP
+const VALID_COMBOS = [
+  ["WALK"],
+  ["PERSONAL"],
+  ["TRANSIT", "SHARED"],
+  ["WALK", "SHARED"],
+  ["TRANSIT"],
+  ["TRANSIT", "PERSONAL"],
+  ["TRANSIT", "CAR"]
+];
+
+const BANNED_TOGETHER = ["SCOOTER", "BICYCLE"];
+
+export const TRANSIT_SUBMODES = Object.keys(SIMPLIFICATIONS).filter(
+  mode => SIMPLIFICATIONS[mode] === "TRANSIT" && mode !== "TRANSIT"
+);
+export const TRANSIT_SUBMODES_AND_TRANSIT = Object.keys(SIMPLIFICATIONS).filter(
+  mode => SIMPLIFICATIONS[mode] === "TRANSIT"
+);
+
+function isCombinationValid(
+  combo: TransportMode[],
+  queryTransitSubmodes: string[]
+): boolean {
+  if (combo.length === 0) return false;
+
+  // All current qualifiers currently simplify to "SHARED"
+  const simplifiedModes = Array.from(
+    new Set(combo.map(c => (c.qualifier ? "SHARED" : SIMPLIFICATIONS[c.mode])))
+  );
+
+  // Ensure that if we have one transit mode, then we include ALL transit modes
+  if (simplifiedModes.includes("TRANSIT")) {
+    // Don't allow TRANSIT along with any other submodes
+    if (queryTransitSubmodes.length && combo.find(c => c.mode === "TRANSIT")) {
+      return false;
+    }
+
+    if (
+      combo.reduce((prev, cur) => {
+        if (queryTransitSubmodes.includes(cur.mode)) {
+          return prev - 1;
+        }
+        return prev;
+      }, queryTransitSubmodes.length) !== 0
+    ) {
+      return false;
+    }
+    // Continue to the other checks
+  }
+
+  // OTP doesn't support multiple non-walk modes
+  if (BANNED_TOGETHER.every(m => combo.find(c => c.mode === m))) return false;
+
+  return !!VALID_COMBOS.find(
+    vc =>
+      simplifiedModes.every(m => vc.includes(m)) &&
+      vc.every(m => simplifiedModes.includes(m))
+  );
+}
+
+/**
+ * Generates a list of queries for OTP to get a comprehensive
+ * set of results based on the modes input.
+ * @param params OTP Query Params
+ * @returns Set of parameters to generate queries
+ */
+export function generateCombinations(params: OTPQueryParams): OTPQueryParams[] {
+  const completeModeList = [
+    ...extractAdditionalModes(params.modeSettings, params.modes),
+    ...params.modes
+  ];
+
+  // List of the transit *submodes* that are included in the input params
+  const queryTransitSubmodes = completeModeList
+    .filter(mode => TRANSIT_SUBMODES.includes(mode.mode))
+    .map(mode => mode.mode);
+
+  return combinations(completeModeList)
+    .filter(combo => isCombinationValid(combo, queryTransitSubmodes))
+    .map(combo => ({ ...params, modes: combo }));
+}
+
+export function generateOtp2Query({
+  from,
+  modeSettings,
+  modes,
+  to
+}: OTPQueryParams): GraphQLQuery {
+  // This extracts the values from the mode settings to key value pairs
+  const modeSettingValues = modeSettings.reduce((prev, cur) => {
+    prev[cur.key] = cur.value;
+    return prev;
+  }, {}) as ModeSettingValues;
+
+  const {
+    bikeReluctance,
+    carReluctance,
+    walkReluctance,
+    wheelchair
+  } = modeSettingValues;
+
+  return {
+    query: print(PlanQuery),
+    variables: {
+      bikeReluctance,
+      carReluctance,
+      fromPlace: `${from.name}::${from.lat},${from.lon}}`,
+      modes,
+      toPlace: `${to.name}::${to.lat},${to.lon}}`,
+      walkReluctance,
+      wheelchair
+    }
+  };
+}

package/tsconfig.json

@@ -2,10 +2,12 @@
   "extends": "../../tsconfig.json",
   "compilerOptions": {
     "composite": true,
+    "target": "es2019",
     "outDir": "./lib",
     "rootDir": "./src",
     "lib": ["es2019", "dom"],
     "skipLibCheck": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["src/__tests__/**/*"]
 }