Filter out dead runs while importing timetables.

Resolves HSLdevcom/jore4#1596

Author: jarkkoka

src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/TripRecord.kt

@@ -20,7 +20,7 @@ package fi.hsl.jore4.hastus.data.hastus
  * @property tripType2 Duplicated(?) type of the trip. 0 = normal, 1 = pull out, 2 = pull in, 3 = transfer
  * @property note Special note. Value 'p' means it's a friday trip
  * @property note2 Reserved for extra information
- * @property direction Direction. 1 = outbound, 2 = inbound
+ * @property direction Direction. 1 = outbound, 2 = inbound, null = dead run
  * @property vehicleType HSL vehicle type id
  * @property isVehicleTypeMandatory Is vehicle type mandatory
  * @property isBackupTrip Is this a backup trip
@@ -45,7 +45,7 @@ data class TripRecord(
     val tripType2: String, // TODO This field appears to be a duplicate
     val note: String,
     val note2: String,
-    val direction: Int,
+    val direction: Int?,
     val vehicleType: Int,
     val isVehicleTypeMandatory: Boolean,
     val isBackupTrip: Boolean,
@@ -70,7 +70,7 @@ data class TripRecord(
         tripType2 = elements[15],
         note = elements[16],
         note2 = elements[17],
-        direction = parseToInt(elements[18]),
+        direction = elements[18].trim().toIntOrNull(),
         vehicleType = parseToInt(elements[19]),
         isVehicleTypeMandatory = parseToBoolean(elements[20]),
         isBackupTrip = parseToBoolean(elements[21]),

src/main/kotlin/fi/hsl/jore4/hastus/service/importing/ConversionsFromHastus.kt

@@ -321,6 +321,7 @@ object ConversionsFromHastus {
         return when (trip.direction) {
             1 -> JoreRouteDirection.OUTBOUND
             2 -> JoreRouteDirection.INBOUND
+            null -> throw IllegalArgumentException("Null route direction encountered (dead run)")
             else -> throw IllegalArgumentException("Unknown Hastus route direction: ${trip.direction}")
         }
     }

src/main/kotlin/fi/hsl/jore4/hastus/service/importing/ImportService.kt

@@ -24,7 +24,7 @@ class ImportService(private val graphQLServiceFactory: GraphQLServiceFactory) {
         csv: String,
         hasuraHeaders: Map<String, String>
     ): UUID? {
-        val hastusItems: List<IHastusData> = READER.parseCsv(csv)
+        val hastusItems: List<IHastusData> = getHastusDataItems(csv)
         val graphQLService: GraphQLService = graphQLServiceFactory.createForSession(hasuraHeaders)
 
         val hastusBookingRecord: BookingRecord = hastusItems.filterIsInstance<BookingRecord>().first()
@@ -63,6 +63,8 @@ class ImportService(private val graphQLServiceFactory: GraphQLServiceFactory) {
         return graphQLService.persistVehicleScheduleFrame(vehicleScheduleFrame, selectedJourneyPatternRefs)
     }
 
+    private fun getHastusDataItems(csv: String): List<IHastusData> = filterOutDeadRunItems(READER.parseCsv(csv))
+
     companion object {
 
         private val READER = CsvReader(";")
@@ -189,5 +191,31 @@ class ImportService(private val graphQLServiceFactory: GraphQLServiceFactory) {
                 throw exception
             }
         }
+
+        private fun filterOutDeadRunItems(hastusItems: List<IHastusData>): List<IHastusData> {
+            val internalNumbersOfDeadRuns: List<String> = hastusItems
+                .filterIsInstance<TripRecord>()
+                .filter { trip ->
+                    // Null direction denotes a dead run which is not imported to Jore4.
+                    trip.direction == null
+                }
+                .map {
+                    it.tripInternalNumber.also {
+                        LOGGER.info {
+                            "Found a dead run trip with internal number $it. " +
+                                "Discarding the trip and the related stop points."
+                        }
+                    }
+                }
+
+            return hastusItems
+                .filter { item ->
+                    when (item) {
+                        is TripRecord -> item.tripInternalNumber !in internalNumbersOfDeadRuns
+                        is TripStopRecord -> item.tripInternalNumber !in internalNumbersOfDeadRuns
+                        else -> true
+                    }
+                }
+        }
     }
 }