8476: Websocket server is tied to JfrEditor

Author: aptmac

application/coverage/pom.xml

@@ -267,6 +267,11 @@
 			<artifactId>org.openjdk.jmc.ui.celleditors</artifactId>
 			<version>${project.version}</version>
 		</dependency>
+		<dependency>
+			<groupId>org.openjdk.jmc</groupId>
+			<artifactId>org.openjdk.jmc.ui.websocket</artifactId>
+			<version>${project.version}</version>
+		</dependency>
 		<dependency>
 			<groupId>org.openjdk.jmc</groupId>
 			<artifactId>org.openjdk.jmc.ui.common</artifactId>

application/org.openjdk.jmc.feature.core/feature.xml

@@ -166,6 +166,13 @@
          version="0.0.0"
          unpack="false"/>
 
+   <plugin
+         id="org.openjdk.jmc.ui.websocket"
+         download-size="0"
+         install-size="0"
+         version="0.0.0"
+         unpack="false"/>
+
    <plugin
          id="org.openjdk.jmc.rjmx.common"
          download-size="0"

application/org.openjdk.jmc.flightrecorder.ui/META-INF/MANIFEST.MF

@@ -18,6 +18,7 @@ Require-Bundle: org.openjdk.jmc.rjmx,
  org.openjdk.jmc.flightrecorder.configuration,
  org.openjdk.jmc.commands,
  org.openjdk.jmc.browser,
+ org.openjdk.jmc.ui.websocket,
  org.hdrhistogram.HdrHistogram,
  org.eclipse.jetty.io,
  org.eclipse.jetty.websocket.server,

application/org.openjdk.jmc.flightrecorder.ui/src/main/java/org/openjdk/jmc/flightrecorder/ui/FlightRecorderUI.java

@@ -143,23 +143,6 @@ public static IQuantity parseItemListSize(String size) {
 		}
 	}
 
-	public static int parseWebsocketPort(String port) {
-		try {
-			return Integer.parseInt(port);
-		} catch (NumberFormatException e) {
-			return PreferenceKeys.DEFAULT_WEBSOCKET_PORT;
-		}
-	}
-
-	public int getWebsocketPort() {
-		return parseWebsocketPort(getPreferenceStore().getString(PreferenceKeys.PROPERTY_WEBSOCKET_SERVER_PORT));
-	}
-
-	public boolean isWebsocketServerEnabled() {
-		int port = getWebsocketPort();
-		return port > 0 && port < 65535;
-	}
-
 	public static String validateDumpTimespan(String text) {
 		try {
 			IQuantity timespan = UnitLookup.TIMESPAN.parseInteractive(text);

application/org.openjdk.jmc.flightrecorder.ui/src/main/java/org/openjdk/jmc/flightrecorder/ui/JfrEditor.java

@@ -83,13 +83,13 @@
 import org.openjdk.jmc.flightrecorder.ui.preferences.PreferenceKeys;
 import org.openjdk.jmc.flightrecorder.ui.selection.IFlavoredSelection;
 import org.openjdk.jmc.flightrecorder.ui.selection.SelectionStore;
-import org.openjdk.jmc.flightrecorder.ui.websocket.WebsocketServer;
 import org.openjdk.jmc.ui.MCPathEditorInput;
 import org.openjdk.jmc.ui.idesupport.IDESupportUIToolkit;
 import org.openjdk.jmc.ui.misc.CompositeToolkit;
 import org.openjdk.jmc.ui.misc.DialogToolkit;
 import org.openjdk.jmc.ui.misc.DisplayToolkit;
 import org.openjdk.jmc.ui.misc.SelectionProvider;
+import org.openjdk.jmc.ui.websocket.WebsocketPlugin;
 
 public class JfrEditor extends EditorPart implements INavigationLocationProvider, IPageContainer {
 
@@ -113,8 +113,6 @@ public class JfrEditor extends EditorPart implements INavigationLocationProvider
 	private Reference<ResultPage> resultPageRef = new WeakReference<>(null);
 	private RuleManager ruleEngine;
 	private IPropertyChangeListener analysisEnabledListener;
-	private IPropertyChangeListener websocketServerEnabledListener;
-	private WebsocketServer websocketServer;
 
 	public JfrEditor() {
 		super();
@@ -126,29 +124,7 @@ public JfrEditor() {
 				}
 			}
 		};
-		if (FlightRecorderUI.getDefault().isWebsocketServerEnabled()) {
-			int websocketServerPort = FlightRecorderUI.getDefault().getWebsocketPort();
-			websocketServer = new WebsocketServer(websocketServerPort);
-		}
-		websocketServerEnabledListener = e -> {
-			if (e.getProperty().equals(PreferenceKeys.PROPERTY_WEBSOCKET_SERVER_PORT)) {
-				int newWebsocketServerPort = FlightRecorderUI.parseWebsocketPort((String) e.getNewValue());
-				if (newWebsocketServerPort > 0) {
-					if (websocketServer != null) {
-						websocketServer.shutdown();
-						websocketServer = null;
-					}
-					websocketServer = new WebsocketServer(newWebsocketServerPort);
-				} else {
-					if (websocketServer != null) {
-						websocketServer.shutdown();
-						websocketServer = null;
-					}
-				}
-			}
-		};
 		FlightRecorderUI.getDefault().getPreferenceStore().addPropertyChangeListener(analysisEnabledListener);
-		FlightRecorderUI.getDefault().getPreferenceStore().addPropertyChangeListener(websocketServerEnabledListener);
 	}
 
 	@Override
@@ -214,8 +190,8 @@ public void showSelection(IItemCollection items) {
 		if (!items.hasItems() && currentPage != null) {
 			selectionItems = getModel().getItems().apply(getDisplayablePage(currentPage).getDefaultSelectionFilter());
 		}
-		if (websocketServer != null) {
-			websocketServer.notifyAll(selectionItems);
+		if (WebsocketPlugin.getDefault().getServerEnabled() == true) {
+			WebsocketPlugin.getDefault().notifyAll(selectionItems);
 		}
 		getSite().getSelectionProvider().setSelection(new StructuredSelection(selectionItems));
 	}
@@ -429,7 +405,6 @@ public RuleManager getRuleManager() {
 	public void dispose() {
 		ruleEngine.dispose();
 		FlightRecorderUI.getDefault().getPreferenceStore().removePropertyChangeListener(analysisEnabledListener);
-		FlightRecorderUI.getDefault().getPreferenceStore().removePropertyChangeListener(websocketServerEnabledListener);
 		super.dispose();
 	}
 

application/org.openjdk.jmc.flightrecorder.ui/src/main/java/org/openjdk/jmc/flightrecorder/ui/messages/internal/Messages.java

@@ -470,9 +470,6 @@ public class Messages extends NLS {
 	public static String PREFERENCES_RULES_CONFIGURE_SELECTED;
 	public static String PREFERENCES_SHOW_MONITORING_WARNING_TEXT;
 	public static String PREFERENCES_STACKTRACE_SHOW_HIDDEN_FRAMES;
-	public static String PREFERENCES_WEBSOCKET_SERVER_PORT_INVALID;
-	public static String PREFERENCES_WEBSOCKET_SERVER_PORT_TEXT;
-	public static String PREFERENCES_WEBSOCKET_SERVER_PORT_TOOLTIP;
 	public static String ProcessesPage_AGGR_CONCURRENT_PROCESSES;
 	public static String ProcessesPage_AGGR_CONCURRENT_PROCESSES_DESC;
 	public static String ProcessesPage_AGGR_FIRST_SAMPLE;

application/org.openjdk.jmc.flightrecorder.ui/src/main/java/org/openjdk/jmc/flightrecorder/ui/preferences/GeneralPage.java

@@ -93,7 +93,6 @@ public void setToDefault() {
 	private Text itemListValue;
 	private Text propertiesArrayStringSizeValue;
 	private Text editorRuleEvaluationThreadsValue;
-	private Text websocketPortValue;
 
 	@Override
 	protected Control createContents(Composite parent) {
@@ -172,21 +171,12 @@ protected Control createContents(Composite parent) {
 		editorRuleEvaluationThreadsValue.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
 		QuantityKindProposal.install(editorRuleEvaluationThreadsValue, UnitLookup.NUMBER);
 
-		Label websocketPortLabel = new Label(defaultTimespanContainer, SWT.NONE);
-		websocketPortLabel.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false, false));
-		websocketPortLabel.setText(Messages.PREFERENCES_WEBSOCKET_SERVER_PORT_TEXT);
-		websocketPortLabel.setToolTipText(Messages.PREFERENCES_WEBSOCKET_SERVER_PORT_TOOLTIP);
-		websocketPortValue = new Text(defaultTimespanContainer, SWT.BORDER);
-		websocketPortValue.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
-		QuantityKindProposal.install(websocketPortValue, UnitLookup.NUMBER);
-
 		loadDumpTypeFromPrefStore(false);
 		loadTimespanFromPrefStore(false);
 		loadSelectionStoreSizeFromPrefStore(false);
 		loadItemListSizeFromPrefStore(false);
 		loadPropertiesArrayStringSizeFromPrefStore(false);
 		loadEditorRuleEvaluationThreadsFromPrefStore(false);
-		loadWebsocketPortFromPrefStore(false);
 		timespanValue.addModifyListener(new ModifyListener() {
 			@Override
 			public void modifyText(ModifyEvent e) {
@@ -217,12 +207,6 @@ public void modifyText(ModifyEvent e) {
 				validatePage();
 			}
 		});
-		websocketPortValue.addModifyListener(new ModifyListener() {
-			@Override
-			public void modifyText(ModifyEvent e) {
-				validatePage();
-			}
-		});
 
 		return container;
 	}
@@ -243,23 +227,7 @@ private void validatePage() {
 		if (error == null && error2 == null && error3 == null) {
 			setErrorMessage(error4);
 		}
-		String error5 = validateWebsocketPort(websocketPortValue.getText());
-		if (error == null && error2 == null && error3 == null) {
-			setErrorMessage(error5);
-		}
-		setValid(error == null && error2 == null && error3 == null && error4 == null && error5 == null);
-	}
-
-	public static String validateWebsocketPort(String text) {
-		try {
-			int port = Integer.parseInt(text);
-			if (port < 0 || port > 65535) {
-				return Messages.PREFERENCES_WEBSOCKET_SERVER_PORT_INVALID;
-			}
-		} catch (NumberFormatException e) {
-			return Messages.PREFERENCES_WEBSOCKET_SERVER_PORT_INVALID;
-		}
-		return null;
+		setValid(error == null && error2 == null && error3 == null && error4 == null);
 	}
 
 	public static String validateNumEvaluationThreads(String text) {
@@ -339,52 +307,6 @@ private void loadEditorRuleEvaluationThreadsFromPrefStore(boolean loadDefault) {
 		editorRuleEvaluationThreadsValue.setText(FlightRecorderUI.parseItemListSize(size).interactiveFormat());
 	}
 
-	private void loadWebsocketPortFromPrefStore(boolean loadDefault) {
-		String port = loadDefault ? getPreferenceStore().getDefaultString(PreferenceKeys.PROPERTY_WEBSOCKET_SERVER_PORT)
-				: getPreferenceStore().getString(PreferenceKeys.PROPERTY_WEBSOCKET_SERVER_PORT);
-		websocketPortValue.setText(Integer.toString(FlightRecorderUI.parseWebsocketPort(port)));
-	}
-
-//	private Button createClearButton(Composite parent) {
-//		Button button = new Button(parent, SWT.NONE);
-//		button.setText(Messages.PREFERENCES_CLEAR_USER_SETTINGS_TEXT);
-//		button.addSelectionListener(new SelectionAdapter() {
-//			@Override
-//			public void widgetSelected(SelectionEvent e) {
-//				if (ensureAllEditorsClosed()) {
-//					showConfirmUserSettingReset();
-//				}
-//			}
-//		});
-//		return button;
-//	}
-//
-//	private boolean ensureAllEditorsClosed() {
-//		for (IEditorReference ref : m_workbench.getActiveWorkbenchWindow().getActivePage().getEditorReferences()) {
-//			if (JfrEditor.EDITOR_ID.equals(ref.getId())) {
-//				showMustCloseEditor();
-//				return false;
-//			}
-//		}
-//		return true;
-//	}
-//
-//	private void showMustCloseEditor() {
-//		MessageBox messageBox = new MessageBox(getShell(), SWT.ICON_INFORMATION);
-//		messageBox.setMessage(Messages.PREFERENCES_OPEN_FLIGHT_RECORDING_DIALOG_TEXT);
-//		messageBox.setText(Messages.PREFERENCES_OPEN_FLIGHT_RECORDING_DIALOG_TITLE);
-//		messageBox.open();
-//	}
-//
-//	private void showConfirmUserSettingReset() {
-//		MessageBox messageBox = new MessageBox(getShell(), SWT.ICON_WARNING | SWT.YES | SWT.NO);
-//		messageBox.setMessage(Messages.PREFERENCES_RESET_USER_SETTINGS_DIALOG_TEXT);
-//		messageBox.setText(Messages.PREFERENCES_RESET_USER_SETTINGS_DIALOG_TITLE);
-//		if (messageBox.open() == SWT.YES) {
-//			ComponentsPlugin.getDefault().getUserInterfaceRepository().clearUserSettings(JfrEditor.EDITOR_ID);
-//		}
-//	}
-
 	private Button createRemoveRecordingsCheckBox(Composite parent) {
 		return createCheckBox(parent, Messages.PREFERENCES_REMOVE_FINISHED_RECORDING_TEXT,
 				PreferenceKeys.PROPERTY_REMOVE_FINISHED_RECORDING);
@@ -431,7 +353,6 @@ protected void performDefaults() {
 		loadItemListSizeFromPrefStore(true);
 		loadPropertiesArrayStringSizeFromPrefStore(true);
 		loadEditorRuleEvaluationThreadsFromPrefStore(true);
-		loadWebsocketPortFromPrefStore(true);
 		super.performDefaults();
 	}
 
@@ -483,13 +404,6 @@ public boolean performOk() {
 			setErrorMessage(qce.getLocalizedMessage());
 			return false;
 		}
-		try {
-			int port = Integer.parseInt(websocketPortValue.getText());
-			getPreferenceStore().setValue(PreferenceKeys.PROPERTY_WEBSOCKET_SERVER_PORT, Integer.toString(port));
-		} catch (NumberFormatException e) {
-			setErrorMessage(Messages.PREFERENCES_WEBSOCKET_SERVER_PORT_INVALID);
-			return false;
-		}
 
 		setErrorMessage(null);
 		if (timespanRadio.getSelection()) {

application/org.openjdk.jmc.flightrecorder.ui/src/main/resources/org/openjdk/jmc/flightrecorder/ui/messages/internal/messages.properties

@@ -405,8 +405,6 @@ NAVIGATOR_ZOOM_OUT_TEXT=Zoom Out
 
 PREFERENCES_CONFIRM_REMOVE_TEMPLATE_TEXT=Ask for confirmation before removing flight recording templates
 PREFERENCES_ENABLE_RECORDING_ANALYSIS=Enable flight recording analysis
-PREFERENCES_WEBSOCKET_SERVER_PORT_TEXT=Websocket server port (set to 0 to disable)
-PREFERENCES_WEBSOCKET_SERVER_PORT_TOOLTIP=Start a websocket server bound to 127.0.0.1 and the selected port. The server pushes updates whenever the selection changes in the UI.
 PREFERENCES_INCLUDE_EXPERIMENTAL_EVENTS_AND_FIELDS=Include experimental events and fields when reading flight recording files
 PREFERENCES_ALLOW_INCOMPLETE_RECORDING_FILE=Enable reading of incomplete flight recording files
 PREFERENCES_STACKTRACE_SHOW_HIDDEN_FRAMES=Show hidden frames in stacktraces
@@ -417,7 +415,6 @@ PREFERENCES_ENABLED_RULES=Enabled Rules
 PREFERENCES_EVALUATION_THREAD_NUMBER_TEXT=Number of rule evaluation threads:
 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.
 PREFERENCES_EVALUATION_THREAD_NUMBER_LESS_THAN_ONE=Number of rule evaluation threads: Must be at least 1
-PREFERENCES_WEBSOCKET_SERVER_PORT_INVALID=Websocket server port must be a number between 0 and 65535
 # {0} is an exception message
 PREFERENCES_EVALUATION_THREAD_NUMBER_UNPARSEABLE=Number of rule evaluation threads: {0}
 PREFERENCES_PROPERTIES_ARRAY_STRING_SIZE_TEXT=Maximum display length of arrays in Properties view

application/org.openjdk.jmc.ui.websocket/META-INF/MANIFEST.MF

@@ -0,0 +1,24 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: %Bundle-Name
+Bundle-SymbolicName: org.openjdk.jmc.ui.websocket;singleton:=true
+Bundle-Version: 10.0.0.qualifier
+Automatic-Module-Name: org.openjdk.jmc.ui.websocket
+Bundle-RequiredExecutionEnvironment: JavaSE-21
+Require-Bundle: org.eclipse.core.runtime,
+ org.eclipse.osgi,
+ org.eclipse.ui,
+ org.eclipse.jetty.ee9.server,
+ org.eclipse.jetty.ee9.servlet,
+ org.eclipse.jetty.ee9.websocket.api,
+ org.eclipse.jetty.ee9.websocket.server,
+ org.eclipse.jetty.server,
+ org.eclipse.jetty.servlet-api,
+ org.eclipse.jetty.util,
+ org.openjdk.jmc.common,
+ org.openjdk.jmc.flightrecorder.serializers,
+ org.openjdk.jmc.flightrecorder
+Export-Package:  org.openjdk.jmc.ui.websocket
+Bundle-Activator: org.openjdk.jmc.ui.websocket.WebsocketPlugin
+Bundle-ActivationPolicy: lazy
+Import-Package: org.openjdk.jmc.ui

application/org.openjdk.jmc.ui.websocket/build.properties

@@ -0,0 +1,38 @@
+#
+#  Copyright (c) 2025 Oracle and/or its affiliates. All rights reserved.
+#  Copyright (c) 2025 IBM Corporation. All rights reserved.
+#
+#  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+#
+#  The contents of this file are subject to the terms of either the Universal Permissive License
+#  v 1.0 as shown at https://oss.oracle.com/licenses/upl
+# 
+#  or the following license:
+#
+#  Redistribution and use in source and binary forms, with or without modification, are permitted
+#  provided that the following conditions are met:
+#
+#  1. Redistributions of source code must retain the above copyright notice, this list of conditions
+#  and the following disclaimer.
+#
+#  2. Redistributions in binary form must reproduce the above copyright notice, this list of
+#  conditions and the following disclaimer in the documentation and/or other materials provided with
+#  the distribution.
+#
+#  3. Neither the name of the copyright holder nor the names of its contributors may be used to
+#  endorse or promote products derived from this software without specific prior written permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
+#  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+#  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+#  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+#  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+#  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
+#  WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+source.. = src/main/java/
+output.. = target/classes/
+bin.includes = META-INF/,\
+               .,\
+               plugin.xml,\
+               plugin.properties