networkDesign: extend to schedule to full day when saving scenarios

For simplicity and given the number of schedules generated, the
simulations only create schedules for a few hours during a day. But when
saving a scenario, in order to simulate it with real data, the schedules
need to span the whole day.

This adds the collection manager to the network design job, as it is
required for the schedules generation.

Also, it saves the scenarios, services and modified lines to the main
cache after saving, so they are right away available to the user for
calculations.

Author: tahini

packages/transition-backend/src/services/evolutionaryAlgorithm/preparation/ServicePreparation.ts

@@ -231,7 +231,7 @@ export const prepareServices = async (
 export const saveSimulationScenario = async (
     scenario: Scenario,
     jobWrapper: TransitNetworkDesignJobWrapper<EvolutionaryTransitNetworkDesignJobType>
-): Promise<string | undefined> => {
+): Promise<{ scenarioId: string; lineIds: string[] } | undefined> => {
     try {
         console.log('saving simulation scenario');
         // Find all simulated services to merge as one
@@ -247,7 +247,7 @@ export const saveSimulationScenario = async (
         // Create a new service for this scenario and save to DB
         const service = new Service(
             {
-                name: `GALND_${scenario.attributes.name}`,
+                name: `ND_${scenario.attributes.name}`,
                 monday: true,
                 tuesday: true,
                 wednesday: true,
@@ -259,27 +259,47 @@ export const saveSimulationScenario = async (
                 end_date: moment().format('YYYY-MM-DD'),
                 data: { forJob: jobWrapper.job.id }
             },
-            true
+            true,
+            jobWrapper.collectionManager
         );
         await service.save(serviceLocator.socketEventManager);
 
         // For each service to merge and save, find the lines that has them
+        const modifiedLines = {};
         for (let i = 0; i < simulatedServiceIds.length; i++) {
             const servicedLines = jobWrapper.simulatedLineCollection
                 .getFeatures()
                 .filter((line) => line.attributes.scheduleByServiceId[simulatedServiceIds[i]] !== undefined);
-            // Copy the schedules for those services, add the service to the line, then save to the database
+            // Copy the schedules for those services, extend the schedule for
+            // the entire day, add the service to the line, then save to the
+            // database
             for (let lineIdx = 0; lineIdx < servicedLines.length; lineIdx++) {
+                const servicedLine = servicedLines[lineIdx];
                 const currentSchedule = new Schedule(
-                    servicedLines[lineIdx].attributes.scheduleByServiceId[simulatedServiceIds[i]],
+                    servicedLine.attributes.scheduleByServiceId[simulatedServiceIds[i]],
                     true
                 );
+                // Copy the schedule and extend to full day
                 const scheduleAttributes = currentSchedule.getClonedAttributes(true);
+                // Remove the constraints on custom start/end times to allow to extend to full day
+                (scheduleAttributes.periods || []).forEach((period) => {
+                    delete period.custom_start_at_str;
+                    delete period.custom_end_at_str;
+                    return period;
+                });
                 scheduleAttributes.service_id = service.getId();
-                const schedule = new Schedule(scheduleAttributes, true);
-                servicedLines[lineIdx].addSchedule(schedule);
+                const schedule = new Schedule(scheduleAttributes, true, jobWrapper.collectionManager);
+                // Recreate schedule for full day period, without time constraints
+                schedule.attributes.periods.forEach((period) => {
+                    if (period.period_shortname) {
+                        schedule.generateForPeriod(period.period_shortname);
+                    }
+                });
+                // Add the schedule to the line with the new service
+                servicedLine.addSchedule(schedule);
                 // Save the schedules to DB
                 await schedule.save(serviceLocator.socketEventManager);
+                modifiedLines[servicedLine.getId()] = servicedLine;
             }
         }
 
@@ -297,7 +317,10 @@ export const saveSimulationScenario = async (
         );
         await newScenario.save(serviceLocator.socketEventManager);
 
-        return newScenario.getId();
+        return {
+            scenarioId: newScenario.getId(),
+            lineIds: Object.keys(modifiedLines)
+        };
     } catch (error) {
         console.error('Error saving simulation scenario:', error);
         return undefined;

packages/transition-backend/src/services/networkDesign/transitNetworkDesign/TransitNetworkDesignJobWrapper.ts

@@ -43,6 +43,7 @@ export class TransitNetworkDesignJobWrapper<
     private _agencyCollection: AgencyCollection | undefined = undefined;
     private _serviceCollection: ServiceCollection | undefined = undefined;
     private _lineServices: LineServices | undefined = undefined;
+    private _collectionManager: CollectionManager | undefined = undefined;
 
     constructor(
         private wrappedJob: ExecutableJob<TJobType>,
@@ -107,6 +108,13 @@ export class TransitNetworkDesignJobWrapper<
         return this._lineServices;
     }
 
+    get collectionManager(): CollectionManager {
+        if (this._collectionManager === undefined) {
+            throw new Error('Collection manager not set yet');
+        }
+        return this._collectionManager;
+    }
+
     setLineServices(lineServices: LineServices) {
         this._lineServices = lineServices;
     }
@@ -135,6 +143,7 @@ export class TransitNetworkDesignJobWrapper<
         this._lineCollection = lines;
         this._agencyCollection = agencies;
         this._serviceCollection = services;
+        this._collectionManager = collectionManager;
     };
 
     /**

packages/transition-backend/src/services/networkDesign/transitNetworkDesign/evolutionary/EvolutionaryTransitNetworkDesignJob.ts

@@ -43,6 +43,11 @@ import {
 import { prepareServices, saveSimulationScenario } from '../../../evolutionaryAlgorithm/preparation/ServicePreparation';
 import Line from 'transition-common/lib/services/line/Line';
 import resultsDbQueries from '../../../../models/db/networkDesignResults.db.queries';
+import {
+    loadAndSaveLinesByIdsToCache,
+    loadAndSaveScenariosToCache,
+    loadAndSaveServicesToCache
+} from '../../../capnpCache/dbToCache';
 
 const CANDIDATE_LINES_RESULTS_CSV_FILE_PREFIX = 'ndCandidateLinesResults';
 const CANDIDATE_SIMULATION_RESULTS_CSV_FILE_PREFIX = 'ndCandidateSimulationResults';
@@ -251,7 +256,7 @@ class EvolutionaryTransitNetworkDesignJobExecutor extends TransitNetworkDesignJo
         // Load the necessary data from the server
         const jobId = this.job.id;
         console.time(`Preparing data for evolutionary transit network design job from cache ${jobId}`);
-        // FIXME Do we even need this? Or can we just start recovery at serviceCollectionFromCache call and get only required data?
+        // FIXME We need to have the paths and lines loaded in a CollectionManager to save the scenarios and re-generate schedules at the end. But not the whole data
         await this.loadServerData(serviceLocator.socketEventManager);
 
         // Get the simulated lines from cache, to make sure the order is the same as before
@@ -368,17 +373,24 @@ class EvolutionaryTransitNetworkDesignJobExecutor extends TransitNetworkDesignJo
 
                 // Save best scenarios if necessary
                 // FIXME Refactor this so we can map a candidate with the scenario it generated and save it in the result's data for output in files
+                // FIXME2 Extract this block to a function when we clean up this class
                 if (this.options.numberOfGenerations - this.currentIteration < this.options.keepGenerations) {
                     const bestScenarios = previousGeneration.getBestScenarios(this.options.keepCandidates);
                     const scenarioSavePromises = bestScenarios?.map((scenario) =>
                         saveSimulationScenario(scenario, this)
                     );
-                    const scenarioIds = (await Promise.all(scenarioSavePromises)).filter(
-                        (scenarioId) => scenarioId !== undefined
-                    ) as string[];
-                    algorithmResults.scenarioIds.push(...scenarioIds);
+                    const scenarioSaveResults = (await Promise.all(scenarioSavePromises)).filter(
+                        (scenarioSaveResult) => scenarioSaveResult !== undefined
+                    );
+                    algorithmResults.scenarioIds.push(...scenarioSaveResults.map((result) => result!.scenarioId));
                     this.job.attributes.data.results = algorithmResults;
                     await this.job.save(this.executorOptions.progressEmitter);
+
+                    // Update the main cache with the saved scenarios to allow analyzing them from Transition UI
+                    await loadAndSaveScenariosToCache();
+                    await loadAndSaveServicesToCache();
+                    await loadAndSaveLinesByIdsToCache({ lineIds: scenarioSaveResults.flatMap((result) => result!.lineIds) });
+                    // FIXME Should signal the main thread to restart trRouting. Or maybe it works directly?
                 }
 
                 // Save the results of this generation to the database