Merge pull request #3389 from ControlSystemStudio/CSSTUDIO-1967

Web sockets for save&restore

Author: shroffk

app/save-and-restore/app/doc/index.rst

@@ -58,9 +58,13 @@ A word of caution
 -----------------
 
 Save-and-restore data is persisted in a central service and is therefore accessible by multiple
-clients. Users should keep in mind that changes (e.g. new or deleted nodes) are not pushed to all clients.
-Caution is therefore advocated when working on the nodes in the tree, in particular when changing the structure by
-copying, deleting or moving nodes.
+clients. Users should keep in mind that changes (e.g. new or deleted nodes) are pushed by the service to
+all connected clients. If any other user is working in the save-and-restore app, saved changes may update
+the current view. For instance, if a folder node is expanded and another user adds an object (folder
+or configuration) to that folder, the new object will automatically be added to the expanded folder.
+
+In other words, changes in the current view are triggered not only by the current user, but may be triggered as a result of
+changes done by others.
 
 Tree View Context Menu
 ----------------------

app/save-and-restore/app/pom.xml

@@ -25,6 +25,16 @@
 			<artifactId>core-logbook</artifactId>
 			<version>5.0.1-SNAPSHOT</version>
 		</dependency>
+		<dependency>
+			<groupId>org.phoebus</groupId>
+			<artifactId>core-ui</artifactId>
+			<version>5.0.1-SNAPSHOT</version>
+		</dependency>
+		<dependency>
+			<groupId>org.phoebus</groupId>
+			<artifactId>core-websocket</artifactId>
+			<version>5.0.1-SNAPSHOT</version>
+		</dependency>
 		<dependency>
 		  <groupId>org.phoebus</groupId>
 		  <artifactId>save-and-restore-model</artifactId>

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/FilterViewInstance.java

@@ -54,6 +54,8 @@ public FilterViewInstance(AppDescriptor appDescriptor) {
             return CompletableFuture.completedFuture(true);
         });
 
+        dockItem.setOnCloseRequest(e -> searchResultTableViewController.handleTabClosed());
+
         DockPane.getActiveDockPane().addTab(dockItem);
     }
 

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/Messages.java

@@ -178,13 +178,18 @@ public class Messages {
     public static String toolTipConfigurationExists;
     public static String toolTipConfigurationExistsOption;
     public static String toolTipMultiplierSpinner;
+    public static String unnamedConfiguration;
+    public static String unnamedCompositeSnapshot;
     public static String unnamedSnapshot;
 
     public static String updateCompositeSnapshotFailed;
     public static String updateConfigurationFailed;
 
     public static String updateNodeFailed;
 
+    public static String webSocketConnected;
+    public static String webSocketDisconnected;
+
     static {
         NLS.initializeMessages(Messages.class);
     }

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/SaveAndRestoreInstance.java

@@ -55,7 +55,7 @@ public SaveAndRestoreInstance(AppDescriptor appDescriptor) {
             loader.setLocation(SaveAndRestoreApplication.class.getResource("ui/SaveAndRestoreUI.fxml"));
             dockItem = new DockItem(this, loader.load());
         } catch (Exception e) {
-            Logger.getLogger(SaveAndRestoreApplication.class.getName()).log(Level.SEVERE, "Failed loading fxml", e);
+            Logger.getLogger(SaveAndRestoreInstance.class.getName()).log(Level.SEVERE, "Failed loading fxml", e);
         }
 
         saveAndRestoreController = loader.getController();
@@ -82,11 +82,11 @@ public void openResource(URI uri) {
         saveAndRestoreController.openResource(uri);
     }
 
-    public void secureStoreChanged(List<ScopedAuthenticationToken> validTokens){
+    public void secureStoreChanged(List<ScopedAuthenticationToken> validTokens) {
         saveAndRestoreController.secureStoreChanged(validTokens);
     }
 
-    public void raise(){
+    public void raise() {
         dockItem.select();
     }
 }

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/client/SaveAndRestoreClientImpl.java

@@ -36,11 +36,9 @@
 import java.net.CookieManager;
 import java.net.CookiePolicy;
 import java.net.URI;
-import java.net.URLEncoder;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
-import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.util.Base64;
 import java.util.List;
@@ -588,10 +586,10 @@ public UserData authenticate(String userName, String password) {
             String stringBuilder = Preferences.jmasarServiceUrl +
                     "/login";
             HttpRequest request = HttpRequest.newBuilder()
-                .uri(URI.create(stringBuilder))
-                .header("Content-Type", CONTENT_TYPE_JSON)
-                .POST(HttpRequest.BodyPublishers.ofString(OBJECT_MAPPER.writeValueAsString(new LoginCredentials(userName, password))))
-                .build();
+                    .uri(URI.create(stringBuilder))
+                    .header("Content-Type", CONTENT_TYPE_JSON)
+                    .POST(HttpRequest.BodyPublishers.ofString(OBJECT_MAPPER.writeValueAsString(new LoginCredentials(userName, password))))
+                    .build();
             HttpResponse<String> response = CLIENT.send(request, HttpResponse.BodyHandlers.ofString());
             return OBJECT_MAPPER.readValue(response.body(), UserData.class);
         } catch (Exception e) {

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/ui/FilterChangeListener.java

@@ -20,6 +20,7 @@
 package org.phoebus.applications.saveandrestore.ui;
 
 import javafx.beans.property.SimpleStringProperty;
+import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
 import org.phoebus.security.store.SecureStore;
 import org.phoebus.security.tokens.AuthenticationScope;
 import org.phoebus.security.tokens.ScopedAuthenticationToken;
@@ -32,8 +33,12 @@
 public abstract class SaveAndRestoreBaseController {
 
     protected final SimpleStringProperty userIdentity = new SimpleStringProperty();
+    protected final WebSocketClientService webSocketClientService;
+    protected final SaveAndRestoreService saveAndRestoreService;
 
     public SaveAndRestoreBaseController() {
+        this.webSocketClientService = WebSocketClientService.getInstance();
+        this.saveAndRestoreService = SaveAndRestoreService.getInstance();
         try {
             SecureStore secureStore = new SecureStore();
             ScopedAuthenticationToken token =
@@ -63,4 +68,16 @@ public void secureStoreChanged(List<ScopedAuthenticationToken> validTokens) {
     public SimpleStringProperty getUserIdentity() {
         return userIdentity;
     }
+
+    /**
+     * Default no-op implementation of a handler for {@link SaveAndRestoreWebSocketMessage}s.
+     * @param webSocketMessage See {@link SaveAndRestoreWebSocketMessage}
+     */
+    protected void handleWebSocketMessage(SaveAndRestoreWebSocketMessage<?> webSocketMessage){
+    }
+
+
+    protected boolean handleTabClosed(){
+        return true;
+    }
 }