RFR: 7198: add websocket server that pushes data on selection updates [v7]
Marcus Hirt
hirt at openjdk.java.net
Mon Sep 27 12:49:08 UTC 2021
On Mon, 20 Sep 2021 16:48:49 GMT, Alex Ciminian <github.com+348973+cimi at openjdk.org> 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 three additional commits since the last revision:
>
> - Use CopyOnWriteArrayList for websocket handlers; remove useless cast
> - Fix copyright statememnts: remove Datadog in existing files, use year ranges
> - Remove 2019-12 platform definition, leftover after rebase
Changes requested by hirt (Lead).
application/org.openjdk.jmc.flightrecorder.ui/src/main/resources/org/openjdk/jmc/flightrecorder/ui/messages/internal/messages.properties line 350:
> 348: PREFERENCES_CONFIRM_REMOVE_TEMPLATE_TEXT=Ask for confirmation before removing flight recording templates
> 349: PREFERENCES_ENABLE_RECORDING_ANALYSIS=Enable flight recording analysis
> 350: PREFERENCES_WEBSOCKET_SERVER_PORT_TEXT=Websocket server port (0 - disabled)
Perhaps (set to 0 to disable) or (0 means disabled)? The dash made me look twice.
application/org.openjdk.jmc.flightrecorder.ui/src/main/resources/org/openjdk/jmc/flightrecorder/ui/messages/internal/messages.properties line 361:
> 359: PREFERENCES_EVALUATION_THREAD_NUMBER_TOOLTIP=This sets the number of threads each editor will create and run in parallel to evaluate rules for that flight recording.
> 360: PREFERENCES_EVALUATION_THREAD_NUMBER_LESS_THAN_ONE=Number of rule evaluation threads: Must be at least 1
> 361: PREFERENCES_WEBSOCKET_SERVER_PORT_INVALID=Websocket server port must a number be between 0 and 65535
must be a number
releng/platform-definitions/platform-definition-2020-06/platform-definition-2020-06.target line 3:
> 1: <?xml version="1.0" encoding="UTF-8" standalone="no"?>
> 2: <!--
> 3: Copyright (c) 2020, 2021 Oracle and/or its affiliates. All rights reserved.
Lacks comma after the last year.
releng/platform-definitions/platform-definition-2020-06/platform-definition-2020-06.target line 4:
> 2: <!--
> 3: Copyright (c) 2020, 2021 Oracle and/or its affiliates. All rights reserved.
> 4: Copyright (c) 2020, 2021 Datadog, Inc. All rights reserved.
Lack comma after the last year.
releng/third-party/pom.xml line 3:
> 1: <?xml version="1.0" encoding="UTF-8"?>
> 2: <!--
> 3: Copyright (c) 2018, 2021 Oracle and/or its affiliates. All rights reserved.
Lack comma after the last year.
-------------
PR: https://git.openjdk.java.net/jmc/pull/306
More information about the jmc-dev
mailing list