[BEAM-3202] Multiple deserializations of PipelineOptions leaks memory

• Type: Bug
• Status: Resolved
• Priority: P2
• Resolution: Fixed
• Fix Version/s: 2.3.0
• Component/s: sdk-java-core
• Labels: Done
• Assignee: Luke Cwik
• Reporter: Luke Cwik
• Created: 16/Nov/17 17:23
• Updated: 06/Oct/20 21:59
• Resolved: 16/Nov/17 22:34

Description

In particular, upon deserializing a PipelineOptions object,
ProxyInvocationHandler.Deserializer
calls ValueProvider.RuntimeValueProvider.setRuntimeOptions(options) which
stores the (newly) deserialized PipelineOptions instance in a static map
inside the RuntimeValueProvider class, where the key is an id obtained by
calling deserializedOptions.getOptionsId().

The thing is, performing a serialize-deserialize cycle on a given
PipelineOptions instance and invoking getOptionsId() yields different
optionsIds. Therefore, multiple deserializations of the same
PipelineOptions instance result in new keys being added to the static
"optionsMap" map inside the ValueProvider.RuntimeValueProvider class.

The fix is to populate the options id when PipelineOptions is created. This can be tested by creating a PipelineOptions object and then serializing/deserializing it and ensuring that it has the same options id as the original.

Issue Links

• links to: GitHub Pull Request #4140