Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(core-utils): optimize flex combination generation #747

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 22 additions & 25 deletions packages/core-utils/src/__tests__/query-params.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ function modeStrToTransportMode(m): TransportMode {
qualifier: splitVals?.[1] || null
};
}
function transportModeToModeStr(m: TransportMode): string {
if (m.qualifier) {
return `${m.mode}_${m.qualifier}`;
}
return m.mode;
}

const mockLatLon = {
lat: 1,
Expand All @@ -33,22 +39,17 @@ function expectModes(modes: string[], expectedModes: string[][]) {
from: mockLatLon,
modes: modes.map(modeStrToTransportMode),
modeSettings: [],
to: mockLatLon
to: mockLatLon,
arriveBy: false
});
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)
)

const generatedModesListStrings = generatedModesList.map(qp =>
qp.modes.map(transportModeToModeStr)
);
return it(modes.join(" "), () => {
// expect(generatedModesList.length).toEqual(expectedModes.length);
expect(new Set(generatedModesListStrings)).toEqual(new Set(expectedModes));
});
}

describe("extract-modes", () => {
Expand Down Expand Up @@ -184,30 +185,26 @@ describe("query-gen", () => {
]
);
expectModes(
["FLEX", "TRANSIT", "WALK"],
[["TRANSIT"], ["FLEX", "TRANSIT"], ["FLEX", "WALK"], ["WALK"]]
["FLEX_DIRECT", "TRANSIT", "WALK"],
[["TRANSIT"], ["FLEX_DIRECT"], ["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"]
]
[["TRANSIT"], ["FLEX", "TRANSIT"], ["SCOOTER_RENT", "TRANSIT"]]
);
expectModes(
["FLEX", "BICYCLE", "TRANSIT"],
[["BICYCLE", "TRANSIT"], ["BICYCLE"], ["TRANSIT"], ["FLEX", "TRANSIT"]]
);
expectModes(
// Transit is required to enable other transit submodes
Expand Down
20 changes: 15 additions & 5 deletions packages/core-utils/src/query-gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export const SIMPLIFICATIONS = {
CABLE_CAR: "TRANSIT",
CAR: "CAR",
FERRY: "TRANSIT",
FLEX: "SHARED", // TODO: this allows FLEX+WALK. Is this reasonable?
FLEX: "FLEX", // FLEX_DIRECT gets labeled as FLEX_DIRECT
FUNICULAR: "TRANSIT",
GONDOLA: "TRANSIT",
RAIL: "TRANSIT",
Expand All @@ -121,6 +121,16 @@ export const SIMPLIFICATIONS = {
WALK: "WALK"
};

export function simplifyMode(tm: TransportMode): string {
if (tm.mode === "FLEX" && tm.qualifier === "DIRECT") {
return "FLEX_DIRECT";
}
if (["RENT", "PICKUP", "DROPOFF", "DROPOFF", "HAIL"].includes(tm.qualifier)) {
return "SHARED";
}
return SIMPLIFICATIONS[tm.mode];
}

// Inclusion of "TRANSIT" alone automatically implies "WALK" in OTP
const VALID_COMBOS = [
["WALK"],
Expand All @@ -129,7 +139,9 @@ const VALID_COMBOS = [
["WALK", "SHARED"],
["TRANSIT"],
["TRANSIT", "PERSONAL"],
["TRANSIT", "CAR"]
["TRANSIT", "CAR"],
["FLEX_DIRECT"],
["FLEX", "TRANSIT"]
];

const BANNED_TOGETHER = ["SCOOTER", "BICYCLE", "CAR"];
Expand All @@ -148,9 +160,7 @@ function isCombinationValid(
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])))
);
const simplifiedModes = Array.from(new Set(combo.map(simplifyMode)));

// Ensure that if we have one transit mode, then we include ALL transit modes
if (simplifiedModes.includes("TRANSIT")) {
Expand Down
Loading