Skip to content

Fix data race in JsonPayloadSerializerProvider.#38265

Open
stankiewicz wants to merge 2 commits intoapache:masterfrom
stankiewicz:JsonPayloadSerializerProvider_tsan
Open

Fix data race in JsonPayloadSerializerProvider.#38265
stankiewicz wants to merge 2 commits intoapache:masterfrom
stankiewicz:JsonPayloadSerializerProvider_tsan

Conversation

@stankiewicz
Copy link
Copy Markdown
Contributor

The anonymous class returned by getSerializer captured ObjectMapper instances. When these were serialized (e.g., during pipeline translation in DirectRunner), a data race occurred in Jackson's DeserializerCache.writeReplace() due to concurrent modification of internal caches during serialization.

This change introduces a concrete JsonPayloadSerializer class that marks the ObjectMapper instances as transient and initializes them lazily. This avoids serializing the mappers and eliminates the data race.


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@github-actions github-actions Bot added the java label Apr 22, 2026
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves a critical data race that arose from the serialization of ObjectMapper instances within anonymous classes. By refactoring the serialization logic into a dedicated class and ensuring that ObjectMapper instances are not serialized but rather lazily initialized, the change enhances the robustness and thread safety of JSON payload processing.

Highlights

  • Data Race Fix: Addressed a data race occurring in Jackson's DeserializerCache.writeReplace() when ObjectMapper instances, captured by anonymous classes, were serialized during pipeline translation.
  • New PayloadSerializer Implementation: Introduced a concrete JsonPayloadSerializer class to encapsulate the serialization and deserialization logic for JSON payloads.
  • Transient and Lazy Initialization: Marked ObjectMapper instances within the new JsonPayloadSerializer as transient and implemented lazy, synchronized initialization to prevent their serialization and resolve the data race.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Copy Markdown
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@stankiewicz
Copy link
Copy Markdown
Contributor Author

/gemini review

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors JsonPayloadSerializerProvider to use a private inner class, JsonPayloadSerializer, for handling serialization and deserialization with lazy-loaded ObjectMapper instances. The review feedback suggests several improvements for concurrency and code cleanliness: marking the mapper fields as volatile to ensure visibility, implementing double-checked locking to reduce synchronization overhead in high-throughput scenarios, and removing redundant null initializations in the constructor.

Comment on lines +48 to +49
private transient @Nullable ObjectMapper deserializeMapper;
private transient @Nullable ObjectMapper serializeMapper;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The ObjectMapper fields should be marked as volatile to ensure proper visibility when using lazy initialization, especially if using double-checked locking to avoid synchronization overhead.

Suggested change
private transient @Nullable ObjectMapper deserializeMapper;
private transient @Nullable ObjectMapper serializeMapper;
private transient volatile @Nullable ObjectMapper deserializeMapper;
private transient volatile @Nullable ObjectMapper serializeMapper;

Comment on lines +51 to +55
public JsonPayloadSerializer(Schema schema) {
this.schema = schema;
this.deserializeMapper = null;
this.serializeMapper = null;
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Explicitly initializing fields to null in the constructor is redundant in Java, as they are already initialized to their default values. This can be simplified.

    public JsonPayloadSerializer(Schema schema) {
      this.schema = schema;
    }

Comment on lines +57 to +69
private synchronized ObjectMapper getDeserializeMapper() {
if (deserializeMapper == null) {
deserializeMapper = RowJsonUtils.newObjectMapperWith(RowJsonDeserializer.forSchema(schema));
}
return deserializeMapper;
}

private synchronized ObjectMapper getSerializeMapper() {
if (serializeMapper == null) {
serializeMapper = RowJsonUtils.newObjectMapperWith(RowJsonSerializer.forSchema(schema));
}
return serializeMapper;
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using synchronized on the entire method for every access to the ObjectMapper can introduce contention in high-throughput scenarios, as these methods are called for every record processed. Consider using double-checked locking (with the fields marked as volatile) to optimize the common path where the mappers are already initialized.

    private ObjectMapper getDeserializeMapper() {
      ObjectMapper result = deserializeMapper;
      if (result == null) {
        synchronized (this) {
          result = deserializeMapper;
          if (result == null) {
            deserializeMapper = result = RowJsonUtils.newObjectMapperWith(RowJsonDeserializer.forSchema(schema));
          }
        }
      }
      return result;
    }

    private ObjectMapper getSerializeMapper() {
      ObjectMapper result = serializeMapper;
      if (result == null) {
        synchronized (this) {
          result = serializeMapper;
          if (result == null) {
            serializeMapper = result = RowJsonUtils.newObjectMapperWith(RowJsonSerializer.forSchema(schema));
          }
        }
      }
      return result;
    }

@github-actions
Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @chamikaramj for label java.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant