-
Notifications
You must be signed in to change notification settings - Fork 299
Migrate EPP XML generation from Soy to JAXB and emails to FreeMarker #3038
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
CydeWeys
wants to merge
1
commit into
google:master
Choose a base branch
from
CydeWeys:freemarker
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
common/src/main/java/google/registry/util/TemplateRenderer.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| // Copyright 2026 The Nomulus Authors. All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package google.registry.util; | ||
|
|
||
| import com.google.common.collect.ImmutableMap; | ||
| import freemarker.core.HTMLOutputFormat; | ||
| import freemarker.template.Configuration; | ||
| import freemarker.template.Template; | ||
| import freemarker.template.TemplateExceptionHandler; | ||
| import jakarta.inject.Inject; | ||
| import java.io.StringWriter; | ||
|
|
||
| /** | ||
| * A utility class for rendering FreeMarker templates. | ||
| * | ||
| * <p>This renderer is configured to use HTML as the default output format, which enables automatic | ||
| * escaping of all interpolated variables. It also uses the "computer" number format to ensure | ||
| * consistent formatting of numeric values across different locales. | ||
| */ | ||
| public class TemplateRenderer { | ||
|
|
||
| private final Configuration configuration; | ||
|
|
||
| @Inject | ||
| public TemplateRenderer() { | ||
| this.configuration = new Configuration(Configuration.VERSION_2_3_32); | ||
| this.configuration.setClassLoaderForTemplateLoading(getClass().getClassLoader(), ""); | ||
| this.configuration.setDefaultEncoding("UTF-8"); | ||
| this.configuration.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER); | ||
| this.configuration.setLogTemplateExceptions(false); | ||
| this.configuration.setWrapUncheckedExceptions(true); | ||
| this.configuration.setFallbackOnNullLoopVariable(false); | ||
| this.configuration.setOutputFormat(HTMLOutputFormat.INSTANCE); | ||
| this.configuration.setNumberFormat("computer"); | ||
| } | ||
|
|
||
| /** | ||
| * Renders the specified template with the given data model. | ||
| * | ||
| * @param templatePath the path to the template file relative to the classpath root | ||
| * @param dataModel an immutable map containing the data to be used in the template | ||
| * @return the rendered template as a string | ||
| * @throws RuntimeException if the template cannot be found, parsed, or processed | ||
| */ | ||
| public String render(String templatePath, ImmutableMap<String, Object> dataModel) { | ||
| try { | ||
| Template template = configuration.getTemplate(templatePath); | ||
| StringWriter writer = new StringWriter(); | ||
| template.process(dataModel, writer); | ||
| return writer.toString(); | ||
| } catch (Exception e) { | ||
| throw new RuntimeException(String.format("Error rendering template %s", templatePath), e); | ||
| } | ||
| } | ||
| } |
67 changes: 67 additions & 0 deletions
67
common/src/test/java/google/registry/util/TemplateRendererTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| // Copyright 2026 The Nomulus Authors. All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package google.registry.util; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static org.junit.Assert.assertThrows; | ||
|
|
||
| import com.google.common.collect.ImmutableMap; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| /** Unit tests for {@link TemplateRenderer}. */ | ||
| class TemplateRendererTest { | ||
|
|
||
| private final TemplateRenderer renderer = new TemplateRenderer(); | ||
|
|
||
| @Test | ||
| void testRender_success() { | ||
| ImmutableMap<String, Object> data = | ||
| ImmutableMap.of( | ||
| "name", "World", "score", 42, "showMessage", true, "message", "Keep going!"); | ||
| String result = renderer.render("google/registry/util/test_template.ftl", data); | ||
| assertThat(result).isEqualTo("Hello World!\nYour score is 42.\nMessage: Keep going!\n"); | ||
| } | ||
|
|
||
| @Test | ||
| void testRender_conditional_false() { | ||
| ImmutableMap<String, Object> data = | ||
| ImmutableMap.of("name", "User", "score", 0, "showMessage", false); | ||
| String result = renderer.render("google/registry/util/test_template.ftl", data); | ||
| assertThat(result).isEqualTo("Hello User!\nYour score is 0.\n"); | ||
| } | ||
|
|
||
| @Test | ||
| void testRender_htmlEscaping() { | ||
| ImmutableMap<String, Object> data = | ||
| ImmutableMap.of("name", "<b>World</b>", "score", 42, "showMessage", false); | ||
| String result = renderer.render("google/registry/util/test_template.ftl", data); | ||
| assertThat(result).contains("Hello <b>World</b>!"); | ||
| } | ||
|
|
||
| @Test | ||
| void testRender_missingTemplate_throwsException() { | ||
| assertThrows( | ||
| RuntimeException.class, | ||
| () -> renderer.render("non/existent/template.ftl", ImmutableMap.of())); | ||
| } | ||
|
|
||
| @Test | ||
| void testRender_invalidTemplate_throwsException() { | ||
| // This will fail during parsing or rendering if the template is broken. | ||
| assertThrows( | ||
| RuntimeException.class, | ||
| () -> renderer.render("google/registry/util/test_template.ftl", ImmutableMap.of())); | ||
| } | ||
| } |
5 changes: 5 additions & 0 deletions
5
common/src/test/resources/google/registry/util/test_template.ftl
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| Hello ${name}! | ||
| Your score is ${score}. | ||
| <#if showMessage> | ||
| Message: ${message} | ||
| </#if> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did this change?