[
https://issues.apache.org/jira/browse/BEAM-308?focusedWorklogId=222705&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-222705
]
ASF GitHub Bot logged work on BEAM-308:
---------------------------------------
Author: ASF GitHub Bot
Created on: 03/Apr/19 23:52
Start Date: 03/Apr/19 23:52
Worklog Time Spent: 10m
Work Description: lukecwik commented on pull request #8214: [BEAM-308]
Update PipelineOptionsFactory to throw an exception on non-public
PipelineOptions interface
URL: https://github.com/apache/beam/pull/8214
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 222705)
Time Spent: 1.5h (was: 1h 20m)
> PipelineOptions throws when using package-private PipelineOptions interfaces
> from multiple packages
> ---------------------------------------------------------------------------------------------------
>
> Key: BEAM-308
> URL: https://issues.apache.org/jira/browse/BEAM-308
> Project: Beam
> Issue Type: Bug
> Components: sdk-java-core
> Reporter: Scott Wegner
> Assignee: Luke Cwik
> Priority: Minor
> Labels: backwards-incompatible
> Fix For: 2.13.0
>
> Time Spent: 1.5h
> Remaining Estimate: 0h
>
> If a PipelineOptions instance is used as multiple PipelineOptions
> package-private interfaces from different packages, {{PipelineOptions.as}}
> will throw an exception:
> {quote}
> java.lang.IllegalArgumentException: non-public interfaces from different
> packages
> at java.lang.reflect.Proxy$ProxyClassFactory.apply(Proxy.java:652)
> at java.lang.reflect.Proxy$ProxyClassFactory.apply(Proxy.java:592)
> at java.lang.reflect.WeakCache$Factory.get(WeakCache.java:244)
> at java.lang.reflect.WeakCache.get(WeakCache.java:141)
> at java.lang.reflect.Proxy.getProxyClass0(Proxy.java:455)
> at java.lang.reflect.Proxy.getProxyClass(Proxy.java:405)
> at
> org.apache.beam.sdk.options.PipelineOptionsFactory.validateWellFormed(PipelineOptionsFactory.java:620)
> at
> org.apache.beam.sdk.options.ProxyInvocationHandler.as(ProxyInvocationHandler.java:209)
> at
> org.apache.beam.sdk.options.ProxyInvocationHandler.invoke(ProxyInvocationHandler.java:135)
> at com.sun.proxy.$Proxy6.as(Unknown Source)
> {quote}
> This fails because ProxyInvocationHandler attempts to create a Java Proxy
> object implementing the full set of interfaces, which has the
> [restriction|https://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Proxy.html#getProxyClass(java.lang.ClassLoader,%20java.lang.Class...)]:
>
> bq. All non-public interfaces must be in the same package; otherwise, it
> would not be possible for the proxy class to implement all of the interfaces,
> regardless of what package it is defined in.
> This can be triggered in a couple edge-case scenarios:
> # {{PipelineOptions.as}} is called on the same PipelineOptions instance with
> multiple package-private interfaces.
> # {{PipelineOptionsFactory.register}} is called with a package-private
> interface, and then {{PipelineOptions.as}} is called with a different
> package-private instance.
> We hit the second scenario in [DataflowSDK unit
> tests|https://github.com/GoogleCloudPlatform/DataflowJavaSDK/pull/286#issuecomment-221438063].
> It's hard to trigger, but possible.
> ----
> I propose we make the behavior for package-private options explicit:
> # Give a better exception message if we hit this issue in
> {{PipelineOptions.as}} listing the non-public interfaces and what packages
> they're in.
> # Explicitly reject non-public interfaces from
> {{PipelineOptionsFactory.register}}, since this state is global and is easier
> to cause issues.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
