odTrip simulation: fixes after rebase on latest main

batch csv demand type has changed for the batch calculation job. We
create a similar demande file for the OdTripSimulationMethod type.

For sake of simplicity, for now, we keep the whole CsvFileAndMapper type
instead of just the field mapping, like in the batch calculation, as it
would require a different backend and frontend type with the options
descriptor. When we clean the option descriptor classes, we can make
sure the case is supported and the options descriptor type apply only to
the options configuration and allow for subsequent types in the backend.

Author: tahini

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

@@ -34,14 +34,19 @@ const createAndEnqueueEvolutionaryTransitNetworkDesignJob = async (
     // TODO Handle node weight file when supported
     // TODO Handle accessibility map simulation when supported
 
+    // FIXME For OdTripSimulation, we need to ensure the demand file is properly
+    // set in the job parameters and go from
+    // OdTripSimulationDemandFromCsvAttributes in the UI/frontend to simply
+    // OdTripSimulationFromCsvAttributes in the backend, but we need different
+    // types for the method configuration in backend and frontend to do so
+    // correctly.
     const job: EvolutionaryTransitNetworkDesignJob = await ExecutableJob.createJob({
         user_id: userId,
         name: 'evolutionaryTransitNetworkDesign',
         data: {
             parameters: jobParameters
         },
-        inputFiles,
-        hasOutputFiles: true
+        inputFiles
     });
     await job.enqueue(eventEmitter);
     await job.refresh();

packages/transition-backend/src/services/simulation/methods/OdTripSimulation.ts

@@ -10,6 +10,7 @@ import { unparse } from 'papaparse';
 import Preferences from 'chaire-lib-common/lib/config/Preferences';
 import { SimulationMethodFactory, SimulationMethod } from './SimulationMethod';
 import {
+    OdTripSimulationDemandFromCsvAttributes,
     OdTripSimulationDescriptor,
     OdTripSimulationOptions
 } from 'transition-common/lib/services/networkDesign/transit/simulationMethod/OdTripSimulationMethod';
@@ -24,6 +25,7 @@ import { BatchRouteJobType } from '../../transitRouting/BatchRoutingJob';
 import { BatchCalculationParameters } from 'transition-common/lib/services/batchCalculation/types';
 import { EventEmitter } from 'events';
 import { ReadStream, WriteStream } from 'fs';
+import { TransitDemandFromCsvRoutingAttributes } from 'transition-common/lib/services/transitDemand/types';
 
 export const OdTripSimulationTitle = 'OdTripSimulation';
 const timeCsvColumnHeader = 'time';
@@ -239,17 +241,15 @@ export default class OdTripSimulation implements SimulationMethod {
         });
     }
 
-    private getBatchRouteDemandAttributes() {
+    private getBatchRouteDemandAttributes(): TransitDemandFromCsvRoutingAttributes {
         // Clone the demand attributes to not modify the original
-        const demandAttributes = _cloneDeep(this.options.demandAttributes);
+        const demandAttributes = _cloneDeep(this.options.demandAttributes) as OdTripSimulationDemandFromCsvAttributes;
+        const demandFieldMapping = demandAttributes.fileAndMapping.fieldMappings as TransitDemandFromCsvRoutingAttributes;
         // Add the time, time type and format to the demand attributes, as they are not defined or even required in the main job
-        demandAttributes.fileAndMapping.fieldMappings.time = timeCsvColumnHeader;
-        demandAttributes.fileAndMapping.fieldMappings.timeFormat = 'secondsSinceMidnight';
-        demandAttributes.fileAndMapping.fieldMappings.timeType = 'departure';
-        if (!demandAttributes.csvFields.includes(timeCsvColumnHeader)){
-            demandAttributes.csvFields.push(timeCsvColumnHeader);
-        }
-        return demandAttributes;
+        demandFieldMapping.time = timeCsvColumnHeader;
+        demandFieldMapping.timeFormat = 'secondsSinceMidnight';
+        demandFieldMapping.timeType = 'departure';
+        return demandFieldMapping;
     }
 
     async simulate(
@@ -283,8 +283,7 @@ export default class OdTripSimulation implements SimulationMethod {
             resources: {
                 // Input file will be prepared later
                 files: { input: `sampled_transit_demand_${scenarioId}.csv` }
-            },
-            hasOutputFiles: false //TODO Manage the result
+            }
         });
 
         // Create the input file for the batch routing job as a random sample of the original demand file (from the currently running job)

packages/transition-common/src/services/networkDesign/transit/simulationMethod/OdTripSimulationMethod.ts

@@ -35,10 +35,22 @@ type OdTripEvaluationOptions = {
     fitnessFunction: string;
 };
 
+export type OdTripSimulationFromCsvAttributes = {
+    projection: string;
+    id: string;
+    originLat: string;
+    originLon: string;
+    destinationLat: string;
+    destinationLon: string;
+    expansionFactor?: string;
+};
+
+export type OdTripSimulationDemandFromCsvAttributes = CsvFileAndMapping<OdTripSimulationFromCsvAttributes>;
+
 // Define OD trip simulation options
 export type OdTripSimulationOptions = {
     // Describe where to get the OD trip data for the simulation
-    demandAttributes: CsvFileAndMapping;
+    demandAttributes: OdTripSimulationDemandFromCsvAttributes;
     // Transit routing parameters to use for the simulation
     transitRoutingAttributes: TransitRoutingBaseAttributes;
     evaluationOptions: OdTripEvaluationOptions;
@@ -183,6 +195,15 @@ const odDemandFieldDescriptors: CsvFieldMappingDescriptor[] = [
     }
 ];
 
+/**
+ * Describe a CSV file field mapping for a transition origin/destination pair file
+ */
+export class TransitOdTripSimulationDemandFromCsv extends CsvFileAndFieldMapper<OdTripSimulationFromCsvAttributes> {
+    constructor(csvFileAndMapping?: OdTripSimulationDemandFromCsvAttributes | undefined) {
+        super(odDemandFieldDescriptors, csvFileAndMapping);
+    }
+}
+
 const transitRoutingAttributesDescriptor = new TransitRoutingAttributesDescriptor();
 const simulationOptionsDescriptor = new SimulationOptionsDescriptor();
 
@@ -224,9 +245,8 @@ export class OdTripSimulationDescriptor implements SimulationAlgorithmDescriptor
 
         // Validate the demand attributes
         if (options.demandAttributes !== undefined) {
-            const demandFieldMappers = new CsvFileAndFieldMapper(
-                odDemandFieldDescriptors,
-                options.demandAttributes as CsvFileAndMapping
+            const demandFieldMappers = new TransitOdTripSimulationDemandFromCsv(
+                options.demandAttributes as OdTripSimulationDemandFromCsvAttributes
             );
             if (!demandFieldMappers.isValid()) {
                 valid = false;