Date: Wed, 13 Dec 2023 19:28:25 -0800
Subject: [PATCH 12/15] Added Javadoc to unit test, to explain the process by
which snapshot files are first generated and need to be regenerated when
template files are changed.
---
.../middleware/utils/TemplateUtilsTest.java | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java b/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java
index f5084e20c..dbcd219a1 100644
--- a/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java
+++ b/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java
@@ -16,6 +16,14 @@
import static com.zenika.snapshotmatcher.SnapshotMatcher.matchesSnapshot;
import static org.hamcrest.MatcherAssert.assertThat;
+/**
+ * Unit tests for {@code resources/templates/*.ftl} Freemarker Template Language files.
+ *
+ * When the tests are first run, the {@code com.zenika.snapshotmatcher.SnapshotMatcher} class will create JSON snapshot
+ * files in {@code resources/snapshots/org/opentripplanner/middleware} which are used thereafter to compare with the
+ * results of the template files. If you change any {@code *.ftl} files you will need to delete their corresponding
+ * snapshot files, run the tests to create new snapshots, and then commit those files along with new template files.
+ */
public class TemplateUtilsTest extends OtpMiddlewareTestEnvironment {
/**
* A parameterized test that checks whether various templates render in a way that matches a snapshot. The name of
@@ -104,4 +112,4 @@ private static void assertMatchesSnapshot(String actual, String snapshotName)
String actualWithStandardLineSeparators = actual.replaceAll("\r\n", "\n");
assertThat(actualWithStandardLineSeparators, matchesSnapshot(snapshotName));
}
-}
\ No newline at end of file
+}
From 39520919b6fc0e4d3ab67814f3e4c478b78a98e4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adriana=20Ceri=C4=87?=
<62163307+AdrianaCeric@users.noreply.github.com>
Date: Thu, 14 Dec 2023 16:49:32 -0500
Subject: [PATCH 13/15] fix: fix formatting and address pr comments
---
.../middleware/models/TripMonitorNotification.java | 1 +
.../middleware/tripmonitor/jobs/CheckMonitoredTrip.java | 2 +-
.../opentripplanner/middleware/utils/TemplateUtilsTest.java | 6 ++++--
3 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/opentripplanner/middleware/models/TripMonitorNotification.java b/src/main/java/org/opentripplanner/middleware/models/TripMonitorNotification.java
index 0eb62f21b..5daf1ced0 100644
--- a/src/main/java/org/opentripplanner/middleware/models/TripMonitorNotification.java
+++ b/src/main/java/org/opentripplanner/middleware/models/TripMonitorNotification.java
@@ -41,6 +41,7 @@ public TripMonitorNotification(NotificationType type, String body) {
public int sortOrder() {
return type == NotificationType.INITIAL_REMINDER ? -100 : 0;
}
+
public static TripMonitorNotification createAlertNotification(
Set previousAlerts,
Set newAlerts)
diff --git a/src/main/java/org/opentripplanner/middleware/tripmonitor/jobs/CheckMonitoredTrip.java b/src/main/java/org/opentripplanner/middleware/tripmonitor/jobs/CheckMonitoredTrip.java
index dddd12ba3..06bd2c77e 100644
--- a/src/main/java/org/opentripplanner/middleware/tripmonitor/jobs/CheckMonitoredTrip.java
+++ b/src/main/java/org/opentripplanner/middleware/tripmonitor/jobs/CheckMonitoredTrip.java
@@ -428,7 +428,7 @@ private void sendNotifications() {
Map templateData = Map.of(
"tripId", trip.id,
"tripName", trip.tripName,
- "notifications", notifications.stream()
+ "notifications", new ArrayList<>(notifications).stream()
// Make certain notifications, such as the initial reminder one, appear on top.
.sorted(Comparator.comparingInt(TripMonitorNotification::sortOrder))
.map(notification -> Map.of(
diff --git a/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java b/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java
index f5084e20c..cb0343fdb 100644
--- a/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java
+++ b/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java
@@ -52,8 +52,10 @@ public static List createTemplateRenderingTestCases()
// Trip Monitor Notifications tests (for CheckMonitoredTrip#sendNotifications).
Map notificationsData = Map.of(
"tripId", "18f642d5-f7a8-475a-9469-800129e6c0b3",
- "notifications", List.of(new TripMonitorNotification(NotificationType.INITIAL_REMINDER, "This is the initial reminder text"), new TripMonitorNotification(NotificationType.DEPARTURE_DELAY, "This is the departure delay text"))
- );
+ "notifications", List.of(
+ new TripMonitorNotification(NotificationType.INITIAL_REMINDER, "This is the initial reminder text"),
+ new TripMonitorNotification(NotificationType.DEPARTURE_DELAY, "This is the departure delay text")
+ ));
testCases.add(new TemplateRenderingTestCase(
notificationsData, "MonitoredTripSms.ftl", "Monitored Trip SMS"
));
From b694be23e0f295008af35ce3f5a090da6056f1e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adriana=20Ceri=C4=87?=
<62163307+AdrianaCeric@users.noreply.github.com>
Date: Thu, 14 Dec 2023 16:57:14 -0500
Subject: [PATCH 14/15] fix: remove space
---
.../org/opentripplanner/middleware/utils/TemplateUtilsTest.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java b/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java
index 6f65e4cdf..020002a18 100644
--- a/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java
+++ b/src/test/java/org/opentripplanner/middleware/utils/TemplateUtilsTest.java
@@ -114,4 +114,4 @@ private static void assertMatchesSnapshot(String actual, String snapshotName)
String actualWithStandardLineSeparators = actual.replaceAll("\r\n", "\n");
assertThat(actualWithStandardLineSeparators, matchesSnapshot(snapshotName));
}
-}
+}
\ No newline at end of file
From fb8c783196264b0ca407e9164287debedd5284b4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adriana=20Ceri=C4=87?=
<62163307+AdrianaCeric@users.noreply.github.com>
Date: Wed, 20 Dec 2023 10:33:01 -0500
Subject: [PATCH 15/15] fix: clean up sendNotifications function
---
.../middleware/tripmonitor/jobs/CheckMonitoredTrip.java | 9 +--------
1 file changed, 1 insertion(+), 8 deletions(-)
diff --git a/src/main/java/org/opentripplanner/middleware/tripmonitor/jobs/CheckMonitoredTrip.java b/src/main/java/org/opentripplanner/middleware/tripmonitor/jobs/CheckMonitoredTrip.java
index 06bd2c77e..0e90e56c0 100644
--- a/src/main/java/org/opentripplanner/middleware/tripmonitor/jobs/CheckMonitoredTrip.java
+++ b/src/main/java/org/opentripplanner/middleware/tripmonitor/jobs/CheckMonitoredTrip.java
@@ -428,14 +428,7 @@ private void sendNotifications() {
Map templateData = Map.of(
"tripId", trip.id,
"tripName", trip.tripName,
- "notifications", new ArrayList<>(notifications).stream()
- // Make certain notifications, such as the initial reminder one, appear on top.
- .sorted(Comparator.comparingInt(TripMonitorNotification::sortOrder))
- .map(notification -> Map.of(
- "type", notification.type.toString(),
- "body", notification.body
- ))
- .collect(Collectors.toList())
+ "notifications", new ArrayList<>(notifications)
);
// FIXME: Change log level
LOG.info("Sending notification to user {}", trip.userId);