RFR: 7198: add websocket server that pushes data on selection updates [v8]
Alex Macdonald
aptmac at openjdk.java.net
Wed Oct 27 15:13:21 UTC 2021
On Tue, 12 Oct 2021 06:00:22 GMT, Alex Ciminian <duke at openjdk.java.net> wrote:
>> This PR adds a websocket server that pushes event data as JSON to all connected clients whenever the user updates their current selection in JMC. The server is disabled by default and can be enabled and disabled from JMC preferences. This is a rework of the proof-of-concept code in https://github.com/openjdk/jmc/pull/225 and uses the JSON serialiser introduced in #279.
>>
>> 
>>
>> ### Dependency management
>>
>>
>> Brice pointed out that there are newer versions of the Jetty websocket server available under a different artefact name - I used the same version as required in the UI tests (`10.0.5`) and this made the build succeed in both eclipse and CLI. I've had to add SPI fly since it was required by jetty, but I don't really understand what it does.
>>
>> Initially I struggled to add the required dependencies to the project. Initially I was only testing in eclipse with the setup from #225 and it worked fine.`mvn package` also worked on the command line. However, the spotless task from our CI script failed with the following error:
>>
>>
>> org.apache.felix.resolver.reason.ReasonException: Uses constraint violation. Unable to resolve resource org.openjdk.jmc.flightrecorder.ui [osgi.identity; osgi.identity="org.openjdk.jmc.flightrecorder.ui"; type="osgi.bundle"; version:Version="8.2.0.qualifier"; singleton:="true"] because it is exposed to package 'javax.servlet' from resources javax.servlet [osgi.identity; osgi.identity="javax.servlet"; type="osgi.bundle"; version:Version="3.1.0.v201410161800"] and jakarta.servlet-api [osgi.identity; osgi.identity="jakarta.servlet-api"; type="osgi.bundle"; version:Version="4.0.0"] via two dependency chains.
>> [ERROR]
>> [ERROR] Chain 1:
>> [ERROR] org.openjdk.jmc.flightrecorder.ui [osgi.identity; osgi.identity="org.openjdk.jmc.flightrecorder.ui"; type="osgi.bundle"; version:Version="8.2.0.qualifier"; singleton:="true"]
>> [ERROR] require: (osgi.wiring.bundle=javax.servlet)
>> [ERROR] |
>> [ERROR] provide: osgi.wiring.bundle: javax.servlet
>> [ERROR] javax.servlet [osgi.identity; osgi.identity="javax.servlet"; type="osgi.bundle"; version:Version="3.1.0.v201410161800"]
>> [ERROR]
>> [ERROR] Chain 2:
>> [ERROR] org.openjdk.jmc.flightrecorder.ui [osgi.identity; osgi.identity="org.openjdk.jmc.flightrecorder.ui"; type="osgi.bundle"; version:Version="8.2.0.qualifier"; singleton:="true"]
>> [ERROR] require: (osgi.wiring.bundle=org.eclipse.jetty.server)
>> [ERROR] |
>> [ERROR] provide: osgi.wiring.bundle; bundle-version:Version="10.0.5"; osgi.wiring.bundle="org.eclipse.jetty.server"
>> [ERROR] org.eclipse.jetty.server [osgi.identity; osgi.identity="org.eclipse.jetty.server"; type="osgi.bundle"; version:Version="10.0.5"]
>> [ERROR] import: (&(osgi.wiring.package=javax.servlet)(&(version>=4.0.0)(!(version>=5.0.0))))
>> [ERROR] |
>> [ERROR] export: osgi.wiring.package: javax.servlet
>> [ERROR] jakarta.servlet-api [osgi.identity; osgi.identity="jakarta.servlet-api"; type="osgi.bundle"; version:Version="4.0.0"]
>>
>>
>> This is because the task is run with the `-P uitests` and something in the UI test configuration pulls in jetty.server 10.0.5. Since [the latest available version](https://mvnrepository.com/artifact/org.eclipse.jetty.websocket/websocket-server) for the jetty websocket server is `9.4.43.v20210629` we can't use the newer `10.x` for the transitive dependencies.
>>
>> I was able to work around this problem by setting bundle-version constraints in the `flightrecorder.ui` manifest. This makes all CI checks pass, but unfortunately it also breaks the JFR editor view in eclipse ��
>>
>>
>> org.osgi.framework.BundleException: Could not resolve module: org.openjdk.jmc.joverflow.ui [457]
>> Unresolved requirement: Import-Package: org.openjdk.jmc.flightrecorder.ui
>> -> Export-Package: org.openjdk.jmc.flightrecorder.ui; bundle-symbolic-name="org.openjdk.jmc.flightrecorder.ui"; bundle-version="8.2.0.qualifier"; version="0.0.0"
>> org.openjdk.jmc.flightrecorder.ui [445]
>> Unresolved requirement: Require-Bundle: org.eclipse.jetty.server; bundle-version="[9.4.43,10.0.0)"
>
> Alex Ciminian has updated the pull request incrementally with one additional commit since the last revision:
>
> Fix websocket UI messages and copyright notices
Taking a closer look at the error, it seems to be complaining that it can't find the required asm version for spifly.
Unresolved requirement: Require-Capability: osgi.extender; filter:="(osgi.extender=osgi.serviceloader.registrar)"; resolution:="optional"
-> Provide-Capability: osgi.extender; osgi.extender="osgi.serviceloader.registrar"; version:Version="1.0.0"
org.apache.aries.spifly.dynamic.bundle [15]
Unresolved requirement: Import-Package: org.objectweb.asm; version="[9.2.0,10.0.0)"
Taking a look at the 2021-06 target (https://download.eclipse.org/releases/2021-06/202106161001/plugins/), we have access to asm 8.0.1 and 9.1.0, but spifly requires at least 9.2.0.
For the JMC-Eclipse launcher, if I add asm 9.2.0 to a list of additional plugins then everything works properly.
This can be verified if I disable one of the asm plugins and try to validate, Eclipse will tell me there's something missing:
-------------
PR: https://git.openjdk.java.net/jmc/pull/306
More information about the jmc-dev
mailing list