Migrate EPP XML generation from Soy to JAXB and emails to FreeMarker by CydeWeys · Pull Request #3038 · google/nomulus

CydeWeys · 2026-05-08T14:06:04Z

This CL eliminates the deprecated Closure Template (Soy) engine from the Nomulus codebase.

Key changes:

Migrated all EPP tool commands (CreateDomain, UpdateDomain, etc.) from Soy templates to type-safe JAXB models using EppInput.
Migrated Spec11 emails to Apache FreeMarker using a new TemplateRenderer utility.
Updated EppInput and related models to support all necessary extensions (Fee, SecDNS, Metadata, AllocationToken, etc.).
Refactored DsRecord to remove Soy dependencies.
Updated tool test data XML files to match JAXB output (standardizing headers, removing redundant lang="en" attributes, and using self-closing tags).
Removed Soy dependencies and associated Gradle tasks from the build system.
Consolidated EPP exception classes to improve code health and remove circular dependencies.

Verified with ./gradlew :core:test and specialized tool command tests.

This change is

CydeWeys · 2026-05-11T19:28:06Z

-      'com.google.template:soy:[2024-02-26,)',
      'com.google.truth:truth:[1.1.2,)',
      'com.googlecode.json-simple:json-simple:[1.1.1,)',
+      'org.freemarker:freemarker:2.3.32',


Don't lock this to this specific revision. Use the open-ended [ ) syntax.

CydeWeys · 2026-05-11T19:28:26Z

 and is written primarily in Java. It is the software that
 [Google Registry](https://www.registry.google/) uses to operate TLDs such as .google,
-.app, .how, .soy, and .みんな. It can run any number of TLDs in a single shared registry
+.app, .how, and .みんな. It can run any number of TLDs in a single shared registry


Why did this change?

weiminyu

@weiminyu reviewed 58 files and made 1 comment.
Reviewable status: 58 of 104 files reviewed, 10 unresolved discussions (waiting on CydeWeys).

common/src/main/java/google/registry/util/TemplateRenderer.java line 57 at r5 (raw file):

   * @throws RuntimeException if the template cannot be found, parsed, or processed
   */
  public String render(String templatePath, ImmutableMap<String, Object> dataModel) {

If template variables and dataModel map keys do not match, missing or unused data keys, will the render throw an error?

CydeWeys

@CydeWeys made 2 comments and resolved 2 discussions.
Reviewable status: 58 of 104 files reviewed, 8 unresolved discussions (waiting on weiminyu).

CydeWeys · 2026-05-21T20:20:37Z

-      'com.google.template:soy:[2024-02-26,)',
      'com.google.truth:truth:[1.1.2,)',
      'com.googlecode.json-simple:json-simple:[1.1.1,)',
+      'org.freemarker:freemarker:2.3.32',


CydeWeys · 2026-05-21T20:20:37Z

 and is written primarily in Java. It is the software that
 [Google Registry](https://www.registry.google/) uses to operate TLDs such as .google,
-.app, .how, .soy, and .みんな. It can run any number of TLDs in a single shared registry
+.app, .how, and .みんな. It can run any number of TLDs in a single shared registry


CydeWeys · 2026-05-21T21:38:26Z

Yes, FreeMarker strictly throws an exception for missing variables. Unused variables in the data model are safely ignored. I have added explicit tests for both of these behaviors in TemplateRendererTest.java.

github-actions

⚠️ Attention Required: Lockfile Detected

This pull request contains modifications to one or more *.lockfile files. Please confirm that you have run update_dependency.sh to push new dependencies to the private repo.

Someone with Admin role must manually dismiss this review before merging.

  @XmlRootElement
-  public static class Create extends HostCreateOrChange
-      implements ResourceCreateOrChange<Host.Builder> {
+  public static class Create extends HostCreateOrChange {


CydeWeys

@CydeWeys made 1 comment.
Reviewable status: 19 of 114 files reviewed, 11 unresolved discussions (waiting on weiminyu).

common/src/main/java/google/registry/util/TemplateRenderer.java line 57 at r5 (raw file):

Previously, weiminyu (Weimin Yu) wrote…

If template variables and dataModel map keys do not match, missing or unused data keys, will the render throw an error?

Yes, and added a test.

github-actions

⚠️ Attention Required: Lockfile Detected

This pull request contains modifications to one or more *.lockfile files. Please confirm that you have run update_dependency.sh to push new dependencies to the private repo.

Someone with Admin role must manually dismiss this review before merging.

CydeWeys · 2026-05-22T18:19:43Z

PTAL

- Replace deprecated Soy templates for EPP XML with JAXB models and a refined Fluent DSL. - Migrate Spec11 and administrative emails to FreeMarker with HTML auto-escaping. - Remove Soy compiler, Gradle tasks, and library dependencies. - Address PR feedback regarding shadowing, version locking, and security warnings. - Enhance tests with comprehensive XML equality assertions using Java 15 text blocks. - Improve Javadocs and maintain strict temporal consistency using java.time. FreeMarker replaces Soy for email templating, providing native HTML auto-escaping and allowing the removal of the complex 'soyToJava' compilation step from the build process. This significantly simplifies the build system and reduces maintenance overhead. For EPP XML, migrating to JAXB allows tool-generated commands to use the same model classes as the server-side EPP flows. This ensures that tool-generated XML is always schema-compliant and eliminates the risk of divergence between tool templates and actual server-side implementation. This unified approach provides compile-time type safety and improves developer ergonomics via a refined fluent DSL. The base ImmutableObject class now provides a public clone() override that correctly resets the cached hashCode to null. This centralizes the custom cloning logic previously handled by a static helper and ensures that all subclasses—including the newly added JAXB models—satisfy CodeQL security requirements without needing redundant per-class overrides. The legacy static clone(T) helper has been updated to delegate to this instance method to maintain compatibility and architectural consistency.

github-actions

⚠️ Attention Required: Lockfile Detected

This pull request contains modifications to one or more *.lockfile files. Please confirm that you have run update_dependency.sh to push new dependencies to the private repo.

Someone with Admin role must manually dismiss this review before merging.

weiminyu

@weiminyu reviewed 100 files and all commit messages, and resolved 1 discussion.
Reviewable status: all files reviewed, 10 unresolved discussions (waiting on CydeWeys).

weiminyu

@weiminyu made 1 comment.
Reviewable status: all files reviewed, 10 unresolved discussions (waiting on CydeWeys).

Update_dependency ran out of band.

CydeWeys force-pushed the freemarker branch 4 times, most recently from 1268bcc to d9d1130 Compare May 11, 2026 14:37

github-advanced-security AI found potential problems May 11, 2026

View reviewed changes

CydeWeys force-pushed the freemarker branch 3 times, most recently from dcec4a2 to 9258e15 Compare May 11, 2026 19:17

CydeWeys commented May 11, 2026

View reviewed changes

CydeWeys force-pushed the freemarker branch 2 times, most recently from 5f0a007 to 0b20767 Compare May 12, 2026 01:49

github-advanced-security AI found potential problems May 12, 2026

View reviewed changes

Comment thread core/src/main/java/google/registry/model/domain/DomainCommand.java Dismissed

Comment thread core/src/main/java/google/registry/model/host/HostCommand.java Dismissed

CydeWeys force-pushed the freemarker branch 3 times, most recently from a4a0fc1 to cd82ada Compare May 12, 2026 15:22

github-advanced-security AI found potential problems May 12, 2026

View reviewed changes

Comment thread core/src/main/java/google/registry/model/contact/ContactCommand.java Fixed

Comment thread core/src/main/java/google/registry/model/domain/DomainCommand.java Dismissed

Comment thread core/src/main/java/google/registry/model/host/HostCommand.java Dismissed

CydeWeys requested a review from weiminyu May 12, 2026 19:45

CydeWeys force-pushed the freemarker branch from cd82ada to 76fd933 Compare May 13, 2026 00:24

weiminyu requested changes May 13, 2026

View reviewed changes

CydeWeys commented May 21, 2026

View reviewed changes

CydeWeys force-pushed the freemarker branch from 76fd933 to 7a9a3a0 Compare May 22, 2026 16:04

github-actions Bot requested changes May 22, 2026

View reviewed changes

github-advanced-security AI found potential problems May 22, 2026

View reviewed changes

CydeWeys commented May 22, 2026

View reviewed changes

CydeWeys force-pushed the freemarker branch from 7a9a3a0 to 1a9377a Compare May 22, 2026 18:14

github-actions Bot requested changes May 22, 2026

View reviewed changes

CydeWeys force-pushed the freemarker branch from 1a9377a to be55b94 Compare May 22, 2026 18:25

github-actions Bot previously requested changes May 22, 2026

View reviewed changes

weiminyu approved these changes May 22, 2026

View reviewed changes

CydeWeys added this pull request to the merge queue May 22, 2026

Merged via the queue into google:master with commit 53b92d6 May 22, 2026
13 of 15 checks passed

CydeWeys deleted the freemarker branch May 22, 2026 20:33

Conversation

CydeWeys commented May 8, 2026 • edited by gbrodman Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CydeWeys May 11, 2026

Choose a reason for hiding this comment

Uh oh!

CydeWeys May 21, 2026

Choose a reason for hiding this comment

Uh oh!

CydeWeys May 11, 2026

Choose a reason for hiding this comment

Uh oh!

CydeWeys May 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weiminyu left a comment

Choose a reason for hiding this comment

Uh oh!

CydeWeys left a comment

Choose a reason for hiding this comment

Uh oh!

CydeWeys May 21, 2026

Choose a reason for hiding this comment

Uh oh!

CydeWeys May 21, 2026

Choose a reason for hiding this comment

Uh oh!

CydeWeys commented May 21, 2026

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

⚠️ Attention Required: Lockfile Detected

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CydeWeys left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

⚠️ Attention Required: Lockfile Detected

Uh oh!

CydeWeys commented May 22, 2026

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

⚠️ Attention Required: Lockfile Detected

Uh oh!

weiminyu left a comment

Choose a reason for hiding this comment

Uh oh!

weiminyu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CydeWeys commented May 8, 2026 •

edited by gbrodman

Loading