Fixed issues with loading #Build static initializer in OSGi container. #21955

trajar · 2016-12-03T11:09:55Z

Fix static initialization runtime exception when running in OSGi or other protected runtime that intercepts calls to URL.openStream. The use case is embedding elasticsearch library in OSGi application for local client. An example of the stack trace:

[INFO] Caused by: java.lang.RuntimeException: java.io.IOException: FakeURLStreamHandler can not be used!
[INFO] at org.elasticsearch.Build.(Build.java:53) ~[?:?]
[INFO] ... 11 more
[INFO] Caused by: java.io.IOException: FakeURLStreamHandler can not be used!
[INFO] at org.apache.felix.framework.FakeURLStreamHandler.openConnection(FakeURLStreamHandler.java:39) ~[felix-4.2.1.jar!/:?]
[INFO] at java.net.URL.openConnection(URL.java:979) ~[?:1.8.0_112]
[INFO] at java.net.URL.openStream(URL.java:1045) ~[?:1.8.0_112]
[INFO] at org.elasticsearch.Build.(Build.java:47) ~[?:?]
[INFO] ... 11 more

…ted runtime container

elasticmachine · 2017-03-02T16:06:45Z

Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually?

jasontedor · 2017-03-12T17:07:49Z

Thanks for the PR @trajar. I'm sorry though, but we do not support running in an OSGi container. This means that we do not test this use-case at all, which means that we can not provide any guarantees that this behavior works or continues to work in the future. We have a policy about accepting PRs for features/platforms/etc. that we do not support so I'm going to close this PR.

trajar · 2017-04-04T03:34:29Z

For the record, I really do think the decision not to integrate this PR is shortsighted. As it stands, this class generates an uncatch-able runtime exception when the library is loaded within a container or protected class loader. It'd be one thing if the code executed during some factory or builder logic, which could be catch and recovered, but the exception is generated in the static initializer which is never good. While I understand need to get version information for ES during runtime, doing it in this manner (in static initialization and trying to read the jar itself during runtime) is not ideal.

This PR is not an enhancement for OSGi container support, it's a fix to ensure a less catastrophic failure during static initialization.

dadoonet · 2017-04-04T04:24:18Z

when the library is loaded within a container or protected class loader.

I think that's the point. Elasticsearch is not a library as Lucene is. It's a server as explained in: https://www.elastic.co/blog/elasticsearch-the-server

jasontedor · 2017-04-04T06:19:39Z

@trajar Thank you for your thoughts here. Can you clarify one thing? You say:

this class generates an uncatch-able runtime exception when the library is loaded within a container or protected class loader

Are you suggesting that this might be broken in something like JBoss or Wildfly? This would be disappointing to me and is probably worth fixing (relates #18999). Do you have a reproduction?

To be clear, I'm referring to usage of the clients, not of embedding Elasticsearch which we do not support.

trajar · 2017-04-04T11:21:27Z

To clarify, yes I'm simply trying to use the Java api to build a transport client and communicate with an ES instance.

In an effort to determine if runtime exceptions are thrown in other non-OSGi containers (per your query), I took the 'helloworld' example over at https://github.com/wildfly/quickstart, added ES core and transport libraries, and inserted code to connect via PreBuiltTransportClient to ES instance on localhost. Good news is that the Wildfly container actually returns a non-null URL via #getElasticsearchCodebase logic, unlike the OSGi container which fails. Bad news is that it still throws a runtime exception in the static initialization, specifically a NPE on line Build:49. I presume it's from the chained accessor to #getMainAttributes when trying to pull the shortHash. Once that error hits, no client on subsequent servlet executions can connect because the Builder class is never actually loaded.

I've attached the modified 'helloworld' maven project as well as the full server log. Defer to your team, but I'd welcome reconsideration of this PR or similar change that didn't generate a runtime exception in the static block.

helloworld.zip
wildfly-helloworld-es.txt

jasontedor · 2017-04-04T11:24:00Z

Thank you for doing this @trajar! I will take a look at this very soon and we will come up with something.

trajar · 2017-04-04T11:34:26Z

@jasontedor no problem, happy to help!

dadoonet · 2017-04-04T12:57:35Z

To clarify, yes I'm simply trying to use the Java api to build a transport client and communicate with an ES instance.

I'm sorry with my previous answer. I thought you were trying to embed an elasticsearch node.

rjernst · 2017-04-10T23:20:27Z

@trajar Can you please post the actual full stacktrace? In the original description it seems there are stack frames missing. I'm trying to figure out what is causing Build to be loaded at all from the TransportClient. Every use I see should only be in the context of a node.

trajar · 2017-04-11T13:11:47Z

@rjernst Of course, can do. See below, which was generated today with recent official 5.3.0 release.

java.lang.ExceptionInInitializerError
	at org.elasticsearch.common.logging.DeprecationLogger.<clinit>(DeprecationLogger.java:138) ~[?:?]
	at org.elasticsearch.common.xcontent.support.AbstractXContentParser.<init>(AbstractXContentParser.java:57) ~[com-myapp.jar:?]
	at org.elasticsearch.common.xcontent.json.JsonXContentParser.<init>(JsonXContentParser.java:44) ~[com-myapp.jar:?]
	at org.elasticsearch.common.xcontent.json.JsonXContent.createParser(JsonXContent.java:103) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.parseableStringToList(Setting.java:832) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.lambda$listSetting$28(Setting.java:795) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.<init>(Setting.java:125) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.<init>(Setting.java:149) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting$2.<init>(Setting.java:798) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.listSetting(Setting.java:797) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.listSetting(Setting.java:780) ~[com-myapp.jar:?]
	at org.elasticsearch.common.network.NetworkService.<clinit>(NetworkService.java:48) ~[?:?]
	at org.elasticsearch.client.transport.TransportClient.newPluginService(TransportClient.java:98) ~[com-myapp.jar:?]
	at org.elasticsearch.client.transport.TransportClient.buildTemplate(TransportClient.java:126) ~[com-myapp.jar:?]
	at org.elasticsearch.client.transport.TransportClient.<init>(TransportClient.java:268) ~[com-myapp.jar:?]
	at org.elasticsearch.transport.client.PreBuiltTransportClient.<init>(PreBuiltTransportClient.java:125) ~[com-myapp.jar:?]
	at org.elasticsearch.transport.client.PreBuiltTransportClient.<init>(PreBuiltTransportClient.java:111) ~[com-myapp.jar:?]
	at org.elasticsearch.transport.client.PreBuiltTransportClient.<init>(PreBuiltTransportClient.java:101) ~[com-myapp.jar:?]
	at com.myapp.index.elastic.ElasticUtils.createClient(ElasticUtils) ~[com-myapp.jar:?]netbeans.jar!/:?]
	at java.lang.Thread.run(Thread.java:745) [?:1.8.0_121]
Caused by: java.lang.RuntimeException: java.io.IOException: FakeURLStreamHandler can not be used!
	at org.elasticsearch.Build.<clinit>(Build.java:53) ~[?:?]
	... 27 more
Caused by: java.io.IOException: FakeURLStreamHandler can not be used!
	at org.apache.felix.framework.FakeURLStreamHandler.openConnection(FakeURLStreamHandler.java:39) ~[felix-4.2.1.jar!/:?]
	at java.net.URL.openConnection(URL.java:979) ~[?:1.8.0_121]
	at java.net.URL.openStream(URL.java:1045) ~[?:1.8.0_121]
	at org.elasticsearch.Build.<clinit>(Build.java:47) ~[?:?]
	... 27 more
19:01:33.815 [myapp-LoadSettings] ERROR Unexpected application error.
java.lang.ExceptionInInitializerError
	at org.elasticsearch.common.logging.DeprecationLogger.<clinit>(DeprecationLogger.java:138) ~[?:?]
	at org.elasticsearch.common.xcontent.support.AbstractXContentParser.<init>(AbstractXContentParser.java:57) ~[com-myapp.jar:?]
	at org.elasticsearch.common.xcontent.json.JsonXContentParser.<init>(JsonXContentParser.java:44) ~[com-myapp.jar:?]
	at org.elasticsearch.common.xcontent.json.JsonXContent.createParser(JsonXContent.java:103) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.parseableStringToList(Setting.java:832) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.lambda$listSetting$28(Setting.java:795) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.<init>(Setting.java:125) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.<init>(Setting.java:149) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting$2.<init>(Setting.java:798) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.listSetting(Setting.java:797) ~[com-myapp.jar:?]
	at org.elasticsearch.common.settings.Setting.listSetting(Setting.java:780) ~[com-myapp.jar:?]
	at org.elasticsearch.common.network.NetworkService.<clinit>(NetworkService.java:48) ~[?:?]
	at org.elasticsearch.client.transport.TransportClient.newPluginService(TransportClient.java:98) ~[com-myapp.jar:?]
	at org.elasticsearch.client.transport.TransportClient.buildTemplate(TransportClient.java:126) ~[com-myapp.jar:?]
	at org.elasticsearch.client.transport.TransportClient.<init>(TransportClient.java:268) ~[com-myapp.jar:?]
	at org.elasticsearch.transport.client.PreBuiltTransportClient.<init>(PreBuiltTransportClient.java:125) ~[com-myapp.jar:?]
	at org.elasticsearch.transport.client.PreBuiltTransportClient.<init>(PreBuiltTransportClient.java:111) ~[com-myapp.jar:?]
	at org.elasticsearch.transport.client.PreBuiltTransportClient.<init>(PreBuiltTransportClient.java:101) ~[com-myapp.jar:?]
	at com.myapp.index.elastic.ElasticUtils.createClient(ElasticUtils) ~[com-myapp.jar:?]

rjernst · 2017-04-11T20:04:44Z

Thanks @trajar. I opened #24049 which should fix this issue in a way that will not add leniency for elasticsearch running as a server.

trajar · 2017-04-11T20:23:56Z

Thanks @rjernst, I really appreciate the team taking a look at this and working through a fix.

jasontedor · 2017-04-11T20:26:03Z

We appreciate your patience here @trajar. We also opened #24050 to add some testing so that we do not break use-cases like this again.

This change makes the build info initialization only try to load a jar manifest if it is the elasticsearch jar. Anything else (eg a repackaged ES for use of transport client in an uber jar) will contain "Unknown" for the build info as it does for tests currently. fixes #21955

jasontedor · 2017-04-18T02:49:18Z

We are adding tests for this in #24147.

fixed issues with loading #Build static initializer in OSGi or protec…

dd9e0d6

…ted runtime container

clintongormley added :Core/Infra/Transport API Transport client API discuss labels Dec 12, 2016

trajar added 2 commits March 1, 2017 18:42

Merge branch 'master' into master

5a5e4f0

Merge remote-tracking branch 'elastic/master'

03e60fe

jasontedor closed this Mar 12, 2017

dadoonet reopened this Apr 4, 2017

dadoonet closed this Apr 4, 2017

rjernst mentioned this pull request Apr 11, 2017

Restrict build info loading to ES jar, not any jar #24049

Merged

jasontedor mentioned this pull request Apr 18, 2017

Add test for deploying transport client in Wildfly #24050

Closed

jacool mentioned this pull request Apr 24, 2017

Dependency on elasticsearch 5.3.0 is problematic Philippus/elastic4s#889

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed issues with loading #Build static initializer in OSGi container. #21955

Fixed issues with loading #Build static initializer in OSGi container. #21955

trajar commented Dec 3, 2016

elasticmachine commented Mar 2, 2017

jasontedor commented Mar 12, 2017 •

edited

Loading

trajar commented Apr 4, 2017

dadoonet commented Apr 4, 2017 •

edited

Loading

jasontedor commented Apr 4, 2017 •

edited

Loading

trajar commented Apr 4, 2017

jasontedor commented Apr 4, 2017

trajar commented Apr 4, 2017

dadoonet commented Apr 4, 2017

rjernst commented Apr 10, 2017

trajar commented Apr 11, 2017 •

edited

Loading

rjernst commented Apr 11, 2017

trajar commented Apr 11, 2017

jasontedor commented Apr 11, 2017 •

edited

Loading

jasontedor commented Apr 18, 2017

Fixed issues with loading #Build static initializer in OSGi container. #21955

Fixed issues with loading #Build static initializer in OSGi container. #21955

Conversation

trajar commented Dec 3, 2016

elasticmachine commented Mar 2, 2017

jasontedor commented Mar 12, 2017 • edited Loading

trajar commented Apr 4, 2017

dadoonet commented Apr 4, 2017 • edited Loading

jasontedor commented Apr 4, 2017 • edited Loading

trajar commented Apr 4, 2017

jasontedor commented Apr 4, 2017

trajar commented Apr 4, 2017

dadoonet commented Apr 4, 2017

rjernst commented Apr 10, 2017

trajar commented Apr 11, 2017 • edited Loading

rjernst commented Apr 11, 2017

trajar commented Apr 11, 2017

jasontedor commented Apr 11, 2017 • edited Loading

jasontedor commented Apr 18, 2017

jasontedor commented Mar 12, 2017 •

edited

Loading

dadoonet commented Apr 4, 2017 •

edited

Loading

jasontedor commented Apr 4, 2017 •

edited

Loading

trajar commented Apr 11, 2017 •

edited

Loading

jasontedor commented Apr 11, 2017 •

edited

Loading