Merge pull request opentripplanner#7002 from entur/disable_translated_string_cache_in_updaters

vpaturet · web-flow · commit c813ac3ff063 · 2025-11-04T13:46:36.000+01:00
Disable translated string cache in updaters
diff --git a/application/src/ext-test/java/org/opentripplanner/ext/vectortiles/layers/stops/StopsLayerTest.java b/application/src/ext-test/java/org/opentripplanner/ext/vectortiles/layers/stops/StopsLayerTest.java
@@ -28,7 +28,6 @@ public class StopsLayerTest {
         put("de", "nameDE");
       }
     },
-    false,
     false
   );
   private static final I18NString DESC_TRANSLATIONS = TranslatedString.getI18NString(
@@ -38,7 +37,6 @@ public class StopsLayerTest {
         put("de", "descDE");
       }
     },
-    false,
     false
   );
 
diff --git a/application/src/ext-test/java/org/opentripplanner/ext/vectortiles/layers/vehicleparkings/VehicleParkingGroupsLayerTest.java b/application/src/ext-test/java/org/opentripplanner/ext/vectortiles/layers/vehicleparkings/VehicleParkingGroupsLayerTest.java
@@ -48,7 +48,6 @@ public void setUp() {
               put("de", "groupDE");
             }
           },
-          false,
           false
         )
       )
@@ -64,7 +63,6 @@ public void setUp() {
               put("de", "DE");
             }
           },
-          false,
           false
         )
       )
diff --git a/application/src/ext-test/java/org/opentripplanner/ext/vectortiles/layers/vehicleparkings/VehicleParkingsLayerTest.java b/application/src/ext-test/java/org/opentripplanner/ext/vectortiles/layers/vehicleparkings/VehicleParkingsLayerTest.java
@@ -59,11 +59,7 @@ public void setUp() {
     vehicleParking = VehicleParking.builder()
       .id(ID)
       .name(
-        TranslatedString.getI18NString(
-          Map.of("", "default name", "de", "deutscher Name"),
-          false,
-          false
-        )
+        TranslatedString.getI18NString(Map.of("", "default name", "de", "deutscher Name"), false)
       )
       .coordinate(new WgsCoordinate(2, 1))
       .bicyclePlaces(true)
diff --git a/application/src/ext-test/java/org/opentripplanner/ext/vectortiles/layers/vehiclerental/mapper/VehicleRentalLayerTest.java b/application/src/ext-test/java/org/opentripplanner/ext/vectortiles/layers/vehiclerental/mapper/VehicleRentalLayerTest.java
@@ -79,7 +79,6 @@ public void stationWithTranslations() {
               put("de", germanName);
             }
           },
-          false,
           false
         )
       )
diff --git a/application/src/ext/java/org/opentripplanner/ext/vehicleparking/liipi/LiipiHubToVehicleParkingGroupMapper.java b/application/src/ext/java/org/opentripplanner/ext/vehicleparking/liipi/LiipiHubToVehicleParkingGroupMapper.java
@@ -52,7 +52,7 @@ public Map<FeedScopedId, VehicleParkingGroup> parseHub(JsonNode jsonNode) {
         });
       I18NString name = translations.isEmpty()
         ? new NonLocalizedString(hubId.getId())
-        : TranslatedString.getI18NString(translations, true, false);
+        : TranslatedString.getI18NString(translations, false);
       Geometry geometry = GEOMETRY_PARSER.geometryFromJson(jsonNode.path("location"));
       var vehicleParkingGroup = VehicleParkingGroup.of(hubId)
         .withName(name)
diff --git a/application/src/ext/java/org/opentripplanner/ext/vehicleparking/liipi/LiipiParkToVehicleParkingMapper.java b/application/src/ext/java/org/opentripplanner/ext/vehicleparking/liipi/LiipiParkToVehicleParkingMapper.java
@@ -90,7 +90,7 @@ public VehicleParking parsePark(
         });
       I18NString name = translations.isEmpty()
         ? new NonLocalizedString(vehicleParkId.getId())
-        : TranslatedString.getI18NString(translations, true, false);
+        : TranslatedString.getI18NString(translations, false);
       Geometry geometry = GEOMETRY_PARSER.geometryFromJson(jsonNode.path("location"));
 
       var stateText = jsonNode.path("status").asText();
diff --git a/application/src/ext/java/org/opentripplanner/ext/vehicleparking/parkapi/ParkAPIUpdater.java b/application/src/ext/java/org/opentripplanner/ext/vehicleparking/parkapi/ParkAPIUpdater.java
@@ -66,7 +66,7 @@ protected VehicleParking parseElement(JsonNode jsonNode) {
         var noteFiled = noteFieldIterator.next();
         noteLocalizations.put(noteFiled.getKey(), noteFiled.getValue().asText());
       }
-      note = TranslatedString.getI18NString(noteLocalizations, true, false);
+      note = TranslatedString.getI18NString(noteLocalizations, false);
     }
 
     var vehicleParkId = createIdForNode(jsonNode);
diff --git a/application/src/main/java/org/opentripplanner/framework/i18n/TranslatedString.java b/application/src/main/java/org/opentripplanner/framework/i18n/TranslatedString.java
@@ -49,23 +49,64 @@ public static I18NString getI18NString(String untranslated, String... translatio
     for (int i = 0; i < translations.length - 1; i += 2) {
       map.put(translations[i], translations[i + 1]);
     }
-    return getI18NString(map, false, false);
+    return getI18NString(map, false);
   }
 
   /**
-   * Gets an I18NString. If the translations only have a single value, return a NonTranslatedString,
+   * Gets a deduplicated I18NString. If the translations only have a single value, return a
+   * NonLocalizedString, otherwise a TranslatedString. The resulting I18NString is interned for
+   * memory efficiency.
+   * <p>
+   * This should be used when calling this method during graph building. This should not be called
+   * from a real-time updater as this is not thread-safe and may cause a memory leak.
+   *
+   * @param translations A Map of languages and translations, a null language is the default
+   *                     translation
+   * @param forceTranslatedString Should the language information be kept, even when only a single
+   *                              translation is provided. This is useful when the language
+   *                              information is important or is presented to the user.
+   */
+  public static I18NString getDeduplicatedI18NString(
+    Map<String, String> translations,
+    boolean forceTranslatedString
+  ) {
+    return getI18NString(translations, true, forceTranslatedString);
+  }
+
+  /**
+   * Gets a non-deduplicated I18NString. If the translations only have a single value, return a
+   * NonLocalizedString, otherwise a TranslatedString. The resulting I18NString is NOT interned.
+   * <p>
+   * This should be used from real-time updaters to avoid memory leaks. For graph building, use
+   * {@link #getDeduplicatedI18NString(Map, boolean)} instead.
+   *
+   * @param translations A Map of languages and translations, a null language is the default
+   *                     translation
+   * @param forceTranslatedString Should the language information be kept, even when only a single
+   *                              translation is provided. This is useful when the language
+   *                              information is important or is presented to the user.
+   */
+  public static I18NString getI18NString(
+    Map<String, String> translations,
+    boolean forceTranslatedString
+  ) {
+    return getI18NString(translations, false, forceTranslatedString);
+  }
+
+  /**
+   * Gets an I18NString. If the translations only have a single value, return a NonLocalizedString,
    * otherwise a TranslatedString
    *
    * @param translations A Map of languages and translations, a null language is the default
    *                     translation
    * @param intern Should the resulting I18NString be interned. This should be used when calling
-   *               this method during graph building, or when the string will be retained until the
-   *               instance is shut down, as it will cause a memory leak otherwise.
+   *               this method during graph building. This should not be called from a real-time
+   *               updater as this is not thread-safe and may cause a memory leak.
    * @param forceTranslatedString Should the language information be kept, even when only a single
    *                              translation is provided. This is useful when the language
    *                              information is important or is presented to the user.
    */
-  public static I18NString getI18NString(
+  static I18NString getI18NString(
     Map<String, String> translations,
     boolean intern,
     boolean forceTranslatedString
diff --git a/application/src/main/java/org/opentripplanner/gtfs/mapping/TranslationHelper.java b/application/src/main/java/org/opentripplanner/gtfs/mapping/TranslationHelper.java
@@ -157,7 +157,7 @@ I18NString getTranslation(
           hm.put(translation.getLanguage(), translation.getTranslation());
         }
       }
-      return TranslatedString.getI18NString(hm, true, false);
+      return TranslatedString.getDeduplicatedI18NString(hm, false);
     }
     return NonLocalizedString.ofNullable(defaultValue);
   }
diff --git a/application/src/main/java/org/opentripplanner/netex/mapping/StationMapper.java b/application/src/main/java/org/opentripplanner/netex/mapping/StationMapper.java
@@ -122,7 +122,7 @@ private I18NString resolveName(StopPlace stopPlace) {
         }
       }
 
-      name = TranslatedString.getI18NString(translations, true, false);
+      name = TranslatedString.getDeduplicatedI18NString(translations, false);
     } else {
       name = new NonLocalizedString(stopPlace.getName().getValue());
     }
diff --git a/application/src/main/java/org/opentripplanner/osm/model/OsmEntity.java b/application/src/main/java/org/opentripplanner/osm/model/OsmEntity.java
@@ -521,7 +521,10 @@ public I18NString getAssumedName() {
       return null;
     }
     if (tags.containsKey("name")) {
-      return TranslatedString.getI18NString(this.generateI18NForPattern("{name}"), true, false);
+      return TranslatedString.getDeduplicatedI18NString(
+        this.generateI18NForPattern("{name}"),
+        false
+      );
     }
     if (tags.containsKey("otp:route_name")) {
       return new NonLocalizedString(tags.get("otp:route_name"));
diff --git a/application/src/main/java/org/opentripplanner/osm/wayproperty/NoteProperties.java b/application/src/main/java/org/opentripplanner/osm/wayproperty/NoteProperties.java
@@ -28,7 +28,7 @@ public StreetNoteAndMatcher generateNote(OsmEntity way) {
     if (patternMatcher.matcher(notePattern).matches()) {
       //This gets language -> translation of notePattern and all tags (which can have translations name:en for example)
       Map<String, String> noteText = way.generateI18NForPattern(notePattern);
-      text = TranslatedString.getI18NString(noteText, true, false);
+      text = TranslatedString.getDeduplicatedI18NString(noteText, false);
     } else {
       text = LocalizedStringMapper.getInstance().map(notePattern, way);
     }
diff --git a/application/src/main/java/org/opentripplanner/updater/alert/gtfs/AlertsUpdateHandler.java b/application/src/main/java/org/opentripplanner/updater/alert/gtfs/AlertsUpdateHandler.java
@@ -204,6 +204,6 @@ private I18NString deBuffer(GtfsRealtime.TranslatedString input) {
       String string = translation.getText();
       translations.put(language, string);
     }
-    return translations.isEmpty() ? null : TranslatedString.getI18NString(translations, true, true);
+    return translations.isEmpty() ? null : TranslatedString.getI18NString(translations, true);
   }
 }
diff --git a/application/src/main/java/org/opentripplanner/updater/alert/siri/SiriAlertsUpdateHandler.java b/application/src/main/java/org/opentripplanner/updater/alert/siri/SiriAlertsUpdateHandler.java
@@ -312,8 +312,6 @@ private I18NString mapTranslatedString(List<DefaultedTextStructure> input) {
       translations.put("", "");
     }
 
-    return translations.isEmpty()
-      ? null
-      : TranslatedString.getI18NString(translations, false, true);
+    return translations.isEmpty() ? null : TranslatedString.getI18NString(translations, true);
   }
 }
diff --git a/application/src/main/java/org/opentripplanner/updater/vehicle_rental/datasources/gbfs/v3/GbfsFeedMapper.java b/application/src/main/java/org/opentripplanner/updater/vehicle_rental/datasources/gbfs/v3/GbfsFeedMapper.java
@@ -167,11 +167,7 @@ private Map<String, RentalVehicleType> getVehicleTypes(VehicleRentalSystem syste
       return null;
     }
 
-    return TranslatedString.getI18NString(
-      name.stream().collect(toMap(language, text)),
-      true,
-      false
-    );
+    return TranslatedString.getI18NString(name.stream().collect(toMap(language, text)), false);
   }
 
   static <X> I18NString localizedString(
diff --git a/application/src/test/java/org/opentripplanner/framework/graphql/GraphQLUtilsTest.java b/application/src/test/java/org/opentripplanner/framework/graphql/GraphQLUtilsTest.java
@@ -52,7 +52,7 @@ void testGetTranslationWithTranslations() {
       entry("en", "translationEn"),
       entry("fr", frenchTranslation)
     );
-    var translatedString = TranslatedString.getI18NString(translations, true, false);
+    var translatedString = TranslatedString.getDeduplicatedI18NString(translations, false);
 
     var translation = GraphQLUtils.getTranslation(translatedString, env);
 
diff --git a/application/src/test/java/org/opentripplanner/framework/i18n/TranslatedStringTest.java b/application/src/test/java/org/opentripplanner/framework/i18n/TranslatedStringTest.java
@@ -16,19 +16,19 @@ public void testGetI18NString() {
     HashMap<String, String> translations = new HashMap<>();
 
     translations.put(null, "Test");
-    I18NString string1 = TranslatedString.getI18NString(translations, false, false);
+    I18NString string1 = TranslatedString.getI18NString(translations, false);
     assertEquals("Test", string1.toString());
     assertEquals("Test", string1.toString(Locale.ENGLISH));
     assertTrue(string1 instanceof NonLocalizedString);
 
     translations.put("en", "Test");
-    I18NString string2 = TranslatedString.getI18NString(translations, false, false);
+    I18NString string2 = TranslatedString.getI18NString(translations, false);
     assertEquals("Test", string2.toString());
     assertEquals("Test", string2.toString(Locale.ENGLISH));
     assertTrue(string2 instanceof NonLocalizedString);
 
     translations.put("fi", "Testi");
-    I18NString string3 = TranslatedString.getI18NString(translations, true, false);
+    I18NString string3 = TranslatedString.getDeduplicatedI18NString(translations, false);
     assertEquals("Test", string3.toString());
     assertEquals("Test", string3.toString(Locale.ENGLISH));
     assertEquals("Testi", string3.toString(new Locale("fi")));
@@ -38,7 +38,7 @@ public void testGetI18NString() {
     translations2.put(null, "Test");
     translations2.put("en", "Test");
     translations2.put("fi", "Testi");
-    I18NString string4 = TranslatedString.getI18NString(translations2, true, false);
+    I18NString string4 = TranslatedString.getDeduplicatedI18NString(translations2, false);
     assertSame(string3, string4);
   }
 
@@ -48,16 +48,12 @@ public void testForceTransltaedString() {
 
     translations.put("en", "Test");
 
-    I18NString translatedString = TranslatedString.getI18NString(translations, false, true);
+    I18NString translatedString = TranslatedString.getI18NString(translations, true);
     assertEquals("Test", translatedString.toString());
     assertEquals("Test", translatedString.toString(Locale.ENGLISH));
     assertTrue(translatedString instanceof TranslatedString);
 
-    I18NString emptyLanguageString = TranslatedString.getI18NString(
-      Map.of("", "Test"),
-      false,
-      true
-    );
+    I18NString emptyLanguageString = TranslatedString.getI18NString(Map.of("", "Test"), true);
     assertEquals("Test", emptyLanguageString.toString());
     assertTrue(emptyLanguageString instanceof NonLocalizedString);
   }
diff --git a/application/src/test/java/org/opentripplanner/updater/vehicle_rental/datasources/gbfs/v3/GbfsFeedMapperTest.java b/application/src/test/java/org/opentripplanner/updater/vehicle_rental/datasources/gbfs/v3/GbfsFeedMapperTest.java
@@ -94,7 +94,6 @@ void makeStationFromV30() {
     assertEquals(
       TranslatedString.getI18NString(
         Map.of("en", "Check Technologies", "nl", "Check Technologies (nl)"),
-        false,
         false
       ),
       system.name()

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@ public class StopsLayerTest {`
`28`	`28`	`put("de", "nameDE");`
`29`	`29`	`}`
`30`	`30`	`},`
`31`		`- false,`
`32`	`31`	`false`
`33`	`32`	`);`
`34`	`33`	`private static final I18NString DESC_TRANSLATIONS = TranslatedString.getI18NString(`
`@@ -38,7 +37,6 @@ public class StopsLayerTest {`
`38`	`37`	`put("de", "descDE");`
`39`	`38`	`}`
`40`	`39`	`},`
`41`		`- false,`
`42`	`40`	`false`
`43`	`41`	`);`
`44`	`42`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,6 @@ public void setUp() {`
`48`	`48`	`put("de", "groupDE");`
`49`	`49`	`}`
`50`	`50`	`},`
`51`		`- false,`
`52`	`51`	`false`
`53`	`52`	`)`
`54`	`53`	`)`
`@@ -64,7 +63,6 @@ public void setUp() {`
`64`	`63`	`put("de", "DE");`
`65`	`64`	`}`
`66`	`65`	`},`
`67`		`- false,`
`68`	`66`	`false`
`69`	`67`	`)`
`70`	`68`	`)`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,6 @@ public void stationWithTranslations() {`
`79`	`79`	`put("de", germanName);`
`80`	`80`	`}`
`81`	`81`	`},`
`82`		`- false,`
`83`	`82`	`false`
`84`	`83`	`)`
`85`	`84`	`)`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ protected VehicleParking parseElement(JsonNode jsonNode) {`
`66`	`66`	`var noteFiled = noteFieldIterator.next();`
`67`	`67`	`noteLocalizations.put(noteFiled.getKey(), noteFiled.getValue().asText());`
`68`	`68`	`}`
`69`		`- note = TranslatedString.getI18NString(noteLocalizations, true, false);`
	`69`	`+ note = TranslatedString.getI18NString(noteLocalizations, false);`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`var vehicleParkId = createIdForNode(jsonNode);`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,7 @@ I18NString getTranslation(`
`157`	`157`	`hm.put(translation.getLanguage(), translation.getTranslation());`
`158`	`158`	`}`
`159`	`159`	`}`
`160`		`- return TranslatedString.getI18NString(hm, true, false);`
	`160`	`+ return TranslatedString.getDeduplicatedI18NString(hm, false);`
`161`	`161`	`}`
`162`	`162`	`return NonLocalizedString.ofNullable(defaultValue);`
`163`	`163`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ private I18NString resolveName(StopPlace stopPlace) {`
`122`	`122`	`}`
`123`	`123`	`}`
`124`	`124`
`125`		`- name = TranslatedString.getI18NString(translations, true, false);`
	`125`	`+ name = TranslatedString.getDeduplicatedI18NString(translations, false);`
`126`	`126`	`} else {`
`127`	`127`	`name = new NonLocalizedString(stopPlace.getName().getValue());`
`128`	`128`	`}`