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: isFlex truthy more of the time #776

Merged
Merged
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
16 changes: 16 additions & 0 deletions packages/core-utils/src/__tests__/itinerary.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ import {
getLegRouteLongName,
getLegRouteName,
getLegRouteShortName,
isFlex,
isTransit,
mapOldElevationComponentToNew
} from "../itinerary";

const bikeRentalItinerary = require("./__mocks__/bike-rental-itinerary.json");
const tncItinerary = require("./__mocks__/tnc-itinerary.json");
const fareProductItinerary = require("./__mocks__/fare-products-itinerary.json");
const flexItinerary = require("../../../itinerary-body/src/__mocks__/itineraries/flex-itinerary.json");

const basePlace = {
lat: 0,
Expand All @@ -40,6 +42,20 @@ describe("util > itinerary", () => {
});
});

describe("isFlex", () => {
it("should detect flex if present", () => {
fareProductItinerary.legs.forEach(leg => expect(isFlex(leg)).toBe(false));
tncItinerary.legs.forEach(leg => expect(isFlex(leg)).toBe(false));
expect(isFlex(flexItinerary.legs[0])).toBe(false);
expect(isFlex(flexItinerary.legs[1])).toBe(false);
expect(isFlex(flexItinerary.legs[2])).toBe(false);
expect(isFlex(flexItinerary.legs[3])).toBe(false);
expect(isFlex(flexItinerary.legs[4])).toBe(false);
expect(isFlex(flexItinerary.legs[5])).toBe(true);
expect(isFlex(flexItinerary.legs[6])).toBe(false); // Does not exist
expect(isFlex(flexItinerary.legs[7])).toBe(false); // Does not exist
});
});
describe("isTransit", () => {
it("should work", () => {
expect(isTransit("CAR")).toBeFalsy();
Expand Down
42 changes: 31 additions & 11 deletions packages/core-utils/src/itinerary.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export function isTransit(mode: string): boolean {
* property which encodes this info.
*/
export function isReservationRequired(leg: Leg): boolean {
return leg.boardRule === "mustPhone" || leg.alightRule === "mustPhone";
return leg?.boardRule === "mustPhone" || leg?.alightRule === "mustPhone";
}
/**
* Returns true if a user must ask the driver to let the user off
Expand All @@ -61,25 +61,45 @@ export function isReservationRequired(leg: Leg): boolean {
*/
export function isCoordinationRequired(leg: Leg): boolean {
return (
leg.boardRule === "coordinateWithDriver" ||
leg.alightRule === "coordinateWithDriver"
leg?.boardRule === "coordinateWithDriver" ||
leg?.alightRule === "coordinateWithDriver"
);
}
/**
* The two rules checked by the above two functions are the only values
* returned by OTP when a leg is a flex leg.
*/
export function isFlex(leg: Leg): boolean {
return isReservationRequired(leg) || isCoordinationRequired(leg);
}

export function containsGeometry(place: Place): boolean {
return (
place?.stop?.geometries !== null && place?.stop?.geometries !== undefined
);
}
export function endsWithGeometry(leg: Leg): boolean {
return containsGeometry(leg?.to);
}
export function startsWithGeometry(leg: Leg): boolean {
return containsGeometry(leg?.from);
}
export function legContainsGeometry(leg: Leg): boolean {
return endsWithGeometry(leg) || startsWithGeometry(leg);
}
export function isAdvanceBookingRequired(info: FlexBookingInfo): boolean {
return info?.latestBookingTime?.daysPrior > 0;
}
export function legDropoffRequiresAdvanceBooking(leg: Leg): boolean {
return isAdvanceBookingRequired(leg.dropOffBookingInfo);
return isAdvanceBookingRequired(leg?.dropOffBookingInfo);
}

/**
* The two rules checked by the above two functions are the only values
* returned by OTP when a leg is a flex leg.
*/
export function isFlex(leg: Leg): boolean {
return (
isReservationRequired(leg) ||
isCoordinationRequired(leg) ||
legDropoffRequiresAdvanceBooking(leg) ||
isAdvanceBookingRequired(leg?.pickupBookingInfo) ||
legContainsGeometry(leg)
);
}
export function isRideshareLeg(leg: Leg): boolean {
return !!leg.rideHailingEstimate?.provider?.id;
}
Expand Down
Loading