(fix): Move form name translation to preload (#302)

Author: NethmiRodrigo

README.md

@@ -218,6 +218,7 @@ See the [documentation on Initializer's logging properties](readme/rtprops.md#lo
 #### Version 2.10.0
 * Support enhanced methods for loading htmlforms when running htmlformentry 5.5.0+
 * Support loading drug ingredients within the drug domain, for compatible OpenMRS versions
+* Moved the form name translation loader to the preload function to support loading form names on instance restarts
 
 #### Version 2.9.0
 * Fix for InitializerSerializer to ensure compatibility with OpenMRS version 2.7.0+

api/src/main/java/org/openmrs/module/initializer/api/loaders/AmpathFormsTranslationsLoader.java

@@ -41,6 +41,37 @@ protected String getFileExtension() {
 		return "json";
 	}
 
+	@Override
+	protected void preload(File file) throws Exception {
+		String jsonTranslationsString = FileUtils.readFileToString(file, StandardCharsets.UTF_8.toString());
+		Map<String, Object> jsonTranslationsDefinition = new ObjectMapper().readValue(jsonTranslationsString, Map.class);
+		
+		Form form = null;
+		
+		String formName = (String) jsonTranslationsDefinition.get("form");
+		if (formName == null) {
+			throw new IllegalArgumentException("'form' property is required for AMPATH forms translations loader.");
+		}
+		form = formService.getForm(formName);
+		if (form == null) {
+			throw new IllegalArgumentException(
+			        "Could not find a form named '" + formName + "'. Please ensure an existing form is configured.");
+		}
+		
+		String language = (String) jsonTranslationsDefinition.get("language");
+		if (StringUtils.isBlank(language)) {
+			throw new IllegalArgumentException("'language' property is required for AMPATH forms translations loader.");
+		}
+		
+		String formNameTranslation = (String) jsonTranslationsDefinition.get("form_name_translation");
+		if (!StringUtils.isBlank(formNameTranslation)) {
+			msgSource.addPresentation(new PresentationMessage("ui.i18n.Form.name." + form.getUuid(),
+			        LocaleUtils.toLocale(language), formNameTranslation, null));
+			msgSource.addPresentation(new PresentationMessage("org.openmrs.Form." + form.getUuid(),
+			        LocaleUtils.toLocale(language), formNameTranslation, null));
+		}
+	}
+	
 	@Override
 	protected void load(File file) throws Exception {
 		String jsonTranslationsString = FileUtils.readFileToString(file, StandardCharsets.UTF_8.toString());
@@ -84,13 +115,5 @@ protected void load(File file) throws Exception {
 
 		formResource.setValue(jsonTranslationsString);
 		formService.saveFormResource(formResource);
-		
-		String formNameTranslation = (String) jsonTranslationsDefinition.get("form_name_translation");
-		if (!StringUtils.isBlank(formNameTranslation)) {
-			msgSource.addPresentation(new PresentationMessage("ui.i18n.Form.name." + form.getUuid(),
-			        LocaleUtils.toLocale(language), formNameTranslation, null));
-			msgSource.addPresentation(new PresentationMessage("org.openmrs.Form." + form.getUuid(),
-			        LocaleUtils.toLocale(language), formNameTranslation, null));
-		}
 	}
 }

api/src/test/java/org/openmrs/module/initializer/api/form/AmpathFormsTranslationsLoaderIntegrationTest.java

@@ -169,6 +169,7 @@ public void load_shouldThrowGivenMissingLanguageFieldInFormTranslationsDef() thr
 		FileUtils.copyFile(srcFile, dstFile);
 
 		// Replay
+		ampathFormsLoader.load();
 		ampathFormsTranslationsLoader.loadUnsafe(Collections.emptyList(), true);
 
 	}