Reject SIRI messages with missing Order attribute on calls

Author: vpaturet

application/src/main/java/org/opentripplanner/updater/spi/UpdateError.java

@@ -44,6 +44,7 @@ public enum UpdateErrorType {
     NO_FUZZY_TRIP_MATCH,
     MULTIPLE_FUZZY_TRIP_MATCHES,
     EMPTY_STOP_POINT_REF,
+    MISSING_CALL_ORDER,
     NO_TRIP_FOR_CANCELLATION_FOUND,
     TRIP_ALREADY_EXISTS,
     NO_START_DATE,

application/src/main/java/org/opentripplanner/updater/trip/siri/CallWrapper.java

@@ -1,8 +1,13 @@
 package org.opentripplanner.updater.trip.siri;
 
+import java.math.BigInteger;
 import java.time.ZonedDateTime;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
+import javax.annotation.Nullable;
+import org.opentripplanner.updater.spi.UpdateError.UpdateErrorType;
+import org.opentripplanner.utils.lang.StringUtils;
 import uk.org.siri.siri21.ArrivalBoardingActivityEnumeration;
 import uk.org.siri.siri21.CallStatusEnumeration;
 import uk.org.siri.siri21.DepartureBoardingActivityEnumeration;
@@ -43,7 +48,31 @@ static List<CallWrapper> of(EstimatedVehicleJourney estimatedVehicleJourney) {
     return List.copyOf(result);
   }
 
+  /**
+   * Validate that all calls have a non-empty stop point ref and a non-null order.
+   */
+  static Optional<UpdateErrorType> validateAll(List<CallWrapper> calls) {
+    return calls.stream().map(CallWrapper::validate).flatMap(Optional::stream).findFirst();
+  }
+
+  /**
+   * Validate that the call has a non-empty stop point ref and a non-null order.
+   */
+  default Optional<UpdateErrorType> validate() {
+    if (StringUtils.hasNoValueOrNullAsString(getStopPointRef())) {
+      return Optional.of(UpdateErrorType.EMPTY_STOP_POINT_REF);
+    }
+    if (getOrder() == null) {
+      return Optional.of(UpdateErrorType.MISSING_CALL_ORDER);
+    }
+    return Optional.empty();
+  }
+
   String getStopPointRef();
+
+  @Nullable
+  BigInteger getOrder();
+
   Boolean isCancellation();
   Boolean isPredictionInaccurate();
   boolean isExtraCall();
@@ -73,6 +102,11 @@ public String getStopPointRef() {
       return call.getStopPointRef() != null ? call.getStopPointRef().getValue() : null;
     }
 
+    @Override
+    public BigInteger getOrder() {
+      return call.getOrder();
+    }
+
     @Override
     public Boolean isCancellation() {
       return call.isCancellation();
@@ -175,6 +209,11 @@ public String getStopPointRef() {
       return call.getStopPointRef() != null ? call.getStopPointRef().getValue() : null;
     }
 
+    @Override
+    public BigInteger getOrder() {
+      return call.getOrder();
+    }
+
     @Override
     public Boolean isCancellation() {
       return call.isCancellation();

application/src/main/java/org/opentripplanner/updater/trip/siri/SiriRealTimeTripUpdateAdapter.java

@@ -1,7 +1,6 @@
 package org.opentripplanner.updater.trip.siri;
 
 import static java.lang.Boolean.TRUE;
-import static org.opentripplanner.updater.spi.UpdateError.UpdateErrorType.EMPTY_STOP_POINT_REF;
 import static org.opentripplanner.updater.spi.UpdateError.UpdateErrorType.NOT_MONITORED;
 import static org.opentripplanner.updater.spi.UpdateError.UpdateErrorType.NO_START_DATE;
 import static org.opentripplanner.updater.spi.UpdateError.UpdateErrorType.TRIP_NOT_FOUND;
@@ -33,7 +32,6 @@
 import org.opentripplanner.updater.trip.UpdateIncrementality;
 import org.opentripplanner.updater.trip.patterncache.TripPatternCache;
 import org.opentripplanner.updater.trip.patterncache.TripPatternIdGenerator;
-import org.opentripplanner.utils.lang.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import uk.org.siri.siri21.EstimatedTimetableDeliveryStructure;
@@ -133,10 +131,9 @@ private Result<UpdateSuccess, UpdateError> apply(
     EntityResolver entityResolver
   ) {
     List<CallWrapper> callWrappers = CallWrapper.of(journey);
-    for (var call : callWrappers) {
-      if (StringUtils.hasNoValueOrNullAsString(call.getStopPointRef())) {
-        return UpdateError.result(null, EMPTY_STOP_POINT_REF, journey.getDataSource());
-      }
+    var error = CallWrapper.validateAll(callWrappers);
+    if (error.isPresent()) {
+      return UpdateError.result(null, error.get(), journey.getDataSource());
     }
     SiriUpdateType siriUpdateType = null;
     try {

application/src/test/java/org/opentripplanner/updater/trip/siri/SiriEtBuilder.java

@@ -246,6 +246,12 @@ public RecordedCallsBuilder withIsCancellation(boolean cancel) {
       return this;
     }
 
+    public RecordedCallsBuilder clearOrder() {
+      var call = calls.getLast();
+      call.setOrder(null);
+      return this;
+    }
+
     public RecordedCallsBuilder addDestinationDisplay(String destinationDisplay) {
       var dd = new NaturalLanguageStringStructure();
       dd.setValue(destinationDisplay);
@@ -347,6 +353,12 @@ public EstimatedCallsBuilder withArrivalStopAssignment(
       return this;
     }
 
+    public EstimatedCallsBuilder clearOrder() {
+      var call = calls.getLast();
+      call.setOrder(null);
+      return this;
+    }
+
     public EstimatedCallsBuilder addDestinationDisplay(String destinationDisplay) {
       var dd = new NaturalLanguageStringStructure();
       dd.setValue(destinationDisplay);

application/src/test/java/org/opentripplanner/updater/trip/siri/TestCall.java

@@ -1,5 +1,6 @@
 package org.opentripplanner.updater.trip.siri;
 
+import java.math.BigInteger;
 import java.time.ZonedDateTime;
 import java.util.List;
 import uk.org.siri.siri21.ArrivalBoardingActivityEnumeration;
@@ -72,6 +73,11 @@ public String getStopPointRef() {
     return stopPointRef;
   }
 
+  @Override
+  public BigInteger getOrder() {
+    return null;
+  }
+
   @Override
   public Boolean isCancellation() {
     return cancellation;

application/src/test/java/org/opentripplanner/updater/trip/siri/moduletests/rejection/MissingCallOrderTest.java

@@ -0,0 +1,74 @@
+package org.opentripplanner.updater.trip.siri.moduletests.rejection;
+
+import static org.opentripplanner.updater.spi.UpdateError.UpdateErrorType.MISSING_CALL_ORDER;
+import static org.opentripplanner.updater.spi.UpdateResultAssertions.assertFailure;
+
+import org.junit.jupiter.api.Test;
+import org.opentripplanner.transit.model._data.TransitTestEnvironment;
+import org.opentripplanner.transit.model._data.TransitTestEnvironmentBuilder;
+import org.opentripplanner.transit.model._data.TripInput;
+import org.opentripplanner.transit.model.site.RegularStop;
+import org.opentripplanner.updater.trip.RealtimeTestConstants;
+import org.opentripplanner.updater.trip.SiriTestHelper;
+
+class MissingCallOrderTest implements RealtimeTestConstants {
+
+  private final TransitTestEnvironmentBuilder ENV_BUILDER = TransitTestEnvironment.of();
+  private final RegularStop STOP_A = ENV_BUILDER.stop(STOP_A_ID);
+  private final RegularStop STOP_B = ENV_BUILDER.stop(STOP_B_ID);
+  private final RegularStop STOP_C = ENV_BUILDER.stop(STOP_C_ID);
+
+  private final TripInput TRIP_INPUT = TripInput.of(TRIP_1_ID)
+    .withWithTripOnServiceDate(TRIP_1_ID)
+    .addStop(STOP_A, "0:00:10", "0:00:11")
+    .addStop(STOP_B, "0:00:20", "0:00:21")
+    .addStop(STOP_C, "0:00:40", "0:00:41");
+
+  @Test
+  void rejectMissingOrderOnEstimatedCall() {
+    var env = ENV_BUILDER.addTrip(TRIP_INPUT).build();
+    var siri = SiriTestHelper.of(env);
+
+    var updates = siri
+      .etBuilder()
+      .withDatedVehicleJourneyRef(TRIP_1_ID)
+      .withEstimatedCalls(builder ->
+        builder
+          .call(STOP_A)
+          .departAimedExpected("00:00:11", "00:00:15")
+          .call(STOP_B)
+          .departAimedExpected("00:00:21", "00:00:25")
+          .call(STOP_C)
+          .arriveAimedExpected("00:00:40", "00:00:45")
+          .clearOrder()
+      )
+      .buildEstimatedTimetableDeliveries();
+
+    var result = siri.applyEstimatedTimetable(updates);
+    assertFailure(MISSING_CALL_ORDER, result);
+  }
+
+  @Test
+  void rejectMissingOrderOnRecordedCall() {
+    var env = ENV_BUILDER.addTrip(TRIP_INPUT).build();
+    var siri = SiriTestHelper.of(env);
+
+    var updates = siri
+      .etBuilder()
+      .withDatedVehicleJourneyRef(TRIP_1_ID)
+      .withRecordedCalls(builder ->
+        builder.call(STOP_A).departAimedActual("00:00:11", "00:00:15").clearOrder()
+      )
+      .withEstimatedCalls(builder ->
+        builder
+          .call(STOP_B)
+          .departAimedExpected("00:00:21", "00:00:25")
+          .call(STOP_C)
+          .arriveAimedExpected("00:00:40", "00:00:45")
+      )
+      .buildEstimatedTimetableDeliveries();
+
+    var result = siri.applyEstimatedTimetable(updates);
+    assertFailure(MISSING_CALL_ORDER, result);
+  }
+}