schedules: add a query to get the trips in time range

This query returns the trips in a given time range for a list of lines
and services. It is all the trips that have a departure time before the
range end and an arrival time after the range start.

Author: tahini

packages/transition-backend/src/models/db/__tests__/TransitSchedule.db.test.ts

@@ -21,6 +21,7 @@ const agencyId = uuidV4();
 const lineId = uuidV4();
 const lineId2 = uuidV4();
 const serviceId = uuidV4();
+const serviceId2 = uuidV4();
 const pathId = uuidV4();
 const pathId2 = uuidV4();
 
@@ -54,6 +55,9 @@ beforeAll(async () => {
     await servicesDbQueries.create({
         id: serviceId
     } as any);
+    await servicesDbQueries.create({
+        id: serviceId2
+    } as any);
 });
 
 afterAll(async () => {
@@ -1067,3 +1071,109 @@ describe('Schedules duplication', () => {
     });
 
 });
+
+describe('getTripsInTimeRange', () => {
+
+    beforeEach(async () => {
+        // Empty the tables
+        await dbQueries.truncateSchedules();
+        await dbQueries.truncateSchedulePeriods();
+        await dbQueries.truncateScheduleTrips();
+
+        // Add a few schedules
+        const service1Line1 = _cloneDeep(scheduleForServiceId) as any;
+        service1Line1.line_id = lineId;
+        service1Line1.service_id = serviceId;
+        await dbQueries.save(service1Line1);
+
+        // duplicate schedule for the same line, different service
+        await dbQueries.duplicateSchedule({serviceIdMapping: { [serviceId]: serviceId2 } });
+        // duplicate the service1 service for another line
+        await dbQueries.duplicateSchedule({serviceIdMapping: { [serviceId]: serviceId }, lineIdMapping: { [lineId]: lineId2 } });
+    });
+
+    test('No trips in range', async() => {
+        const trips = await dbQueries.getTripsInTimeRange({
+            rangeStart: 0,
+            rangeEnd: 10000,
+            lineIds: [lineId, lineId2],
+            serviceIds: [serviceId, serviceId2]
+        });
+        expect(trips.length).toEqual(0);
+    });
+
+    test('Get trips in range for multiple service and line', async() => {
+        const trips = await dbQueries.getTripsInTimeRange({
+            rangeStart: 25000,
+            rangeEnd: 35000,
+            lineIds: [lineId, lineId2],
+            serviceIds: [serviceId, serviceId2]
+        });
+        // There should be 3 trips by line/service pairs
+        expect(trips.length).toEqual(3 * 3);
+        expect(trips.filter(trip => trip.line_id === lineId && trip.service_id === serviceId).length).toEqual(3);
+        expect(trips.filter(trip => trip.line_id === lineId2 && trip.service_id === serviceId).length).toEqual(3);
+        expect(trips.filter(trip => trip.line_id === lineId && trip.service_id === serviceId2).length).toEqual(3);
+    });
+
+    test('Get trips in range only for line', async() => {
+        const trips = await dbQueries.getTripsInTimeRange({
+            rangeStart: 25000,
+            rangeEnd: 35000,
+            lineIds: [lineId],
+            serviceIds: [serviceId, serviceId2]
+        });
+        // There should be 3 trips by line/service pairs
+        expect(trips.length).toEqual(2 * 3);
+        expect(trips.some(trip => trip.line_id === lineId2)).toBe(false);
+    });
+
+    test('Get trips in range only for service', async() => {
+        const trips = await dbQueries.getTripsInTimeRange({
+            rangeStart: 25000,
+            rangeEnd: 35000,
+            lineIds: [lineId, lineId2],
+            serviceIds: [serviceId]
+        });
+        // There should be 3 trips by line/service pairs
+        expect(trips.length).toEqual(2 * 3);
+        expect(trips.some(trip => trip.service_id === serviceId2)).toBe(false);
+    });
+
+    test('Trips ending at range start', async() => {
+        const trips = await dbQueries.getTripsInTimeRange({
+            rangeStart: 27015,
+            rangeEnd: 29000,
+            lineIds: [lineId],
+            serviceIds: [serviceId]
+        });
+        // There should be 1 trip, the one ending at 27015
+        expect(trips.length).toEqual(1);
+        expect(trips[0].arrival_time_seconds).toEqual(27015);
+    });
+
+    test('Trips starting at range end', async() => {
+        const trips = await dbQueries.getTripsInTimeRange({
+            rangeStart: 10000,
+            rangeEnd: 25200,
+            lineIds: [lineId],
+            serviceIds: [serviceId]
+        });
+        // There should be 1 trip, the one starting at 25200
+        expect(trips.length).toEqual(1);
+        console.log("trips", trips[0]);
+        expect(trips[0].departure_time_seconds).toEqual(25200);
+    });
+
+    test('Unexisting line for service', async() => {
+        const trips = await dbQueries.getTripsInTimeRange({
+            rangeStart: 25000,
+            rangeEnd: 35000,
+            lineIds: [lineId2],
+            serviceIds: [serviceId2]
+        });
+        // There should be no trip
+        expect(trips.length).toEqual(0);
+    });
+
+});

packages/transition-backend/src/models/db/transitSchedules.db.queries.ts

@@ -800,6 +800,39 @@ const duplicateSchedule = async ({
     }
 };
 
+const getTripsInTimeRange = async ({
+    rangeStart,
+    rangeEnd,
+    lineIds,
+    serviceIds
+}: {
+    rangeStart: number;
+    rangeEnd: number;
+    lineIds: string[];
+    serviceIds: string[];
+}): Promise<(SchedulePeriodTrip & { line_id: string; service_id: string })[]> => {
+    try {
+        const query = knex(tripTable)
+            .select([`${tripTable}.*`, `${scheduleTable}.service_id`, `${scheduleTable}.line_id`])
+            .join(periodTable, `${tripTable}.schedule_period_id`, `${periodTable}.id`)
+            .join(scheduleTable, `${periodTable}.schedule_id`, `${scheduleTable}.id`)
+            .whereIn(`${scheduleTable}.line_id`, lineIds)
+            .whereIn(`${scheduleTable}.service_id`, serviceIds)
+            .andWhere(`${tripTable}.departure_time_seconds`, '<=', rangeEnd)
+            .andWhere(`${tripTable}.arrival_time_seconds`, '>=', rangeStart);
+
+        const rows = await query;
+        const trips = rows.map(scheduleTripsAttributesParser);
+        return trips as (SchedulePeriodTrip & { line_id: string; service_id: string })[];
+    } catch (error) {
+        throw new TrError(
+            `Cannot get trips in time range ${rangeStart}-${rangeEnd} in database (knex error: ${error})`,
+            'DBSCHED0004',
+            'TransitScheduleCannotUpdateBecauseDatabaseError'
+        );
+    }
+};
+
 export default {
     exists: exists.bind(null, knex, scheduleTable),
     read: readScheduleData,
@@ -828,5 +861,6 @@ export default {
     collection,
     /** Read the schedules for a list of lines */
     readForLines,
-    duplicateSchedule
+    duplicateSchedule,
+    getTripsInTimeRange
 };