Merge pull request #2425 from ControlSystemStudio/CSSTUDIO-1771

Handle connection failure to logbook service

Author: shroffk

app/logbook/olog/client-es/src/main/java/org/phoebus/olog/es/api/OlogClient.java

@@ -514,4 +514,10 @@ public void authenticate(String username, String password) throws Exception {
             throw e;
         }
     }
+
+    @Override
+    public String serviceInfo(){
+        ClientResponse clientResponse = service.path("").get(ClientResponse.class);
+        return clientResponse.getEntity(String.class);
+    }
 }

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/Messages.java

@@ -43,6 +43,8 @@ public class Messages
                          SearchAvailableItems,
                          SelectFile,
                          SelectFolder,
+                         ServiceConnectionErrorTitle,
+                         ServiceConnectionErrorBody,
                          ShowHideDetails,
                          Tags,
                          TagsTitle,

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/write/LogEntryEditorController.java

@@ -58,6 +58,7 @@
 import org.phoebus.logbook.olog.ui.HelpViewer;
 import org.phoebus.logbook.olog.ui.LogbookUIPreferences;
 import org.phoebus.logbook.olog.ui.PreviewViewer;
+import org.phoebus.logbook.olog.ui.menu.SendToLogBookApp;
 import org.phoebus.olog.es.api.OlogProperties;
 import org.phoebus.olog.es.api.model.OlogLog;
 import org.phoebus.security.store.SecureStore;
@@ -88,7 +89,9 @@ public class LogEntryEditorController {
     private final Logger logger = Logger.getLogger(LogEntryEditorController.class.getName());
 
     @FXML
-    private VBox root;
+    private VBox editorPane;
+    @FXML
+    private VBox errorPane;
     @FXML
     private Button submitButton;
     @FXML
@@ -185,6 +188,7 @@ public class LogEntryEditorController {
      */
     private String originalTitle = "";
 
+
     public LogEntryEditorController(LogEntry logEntry, LogEntry inReplyTo, LogEntryCompletionHandler logEntryCompletionHandler) {
         this.replyTo = inReplyTo;
         this.completionHandler = logEntryCompletionHandler;
@@ -205,17 +209,29 @@ public LogEntryEditorController(LogEntry logEntry, LogEntry inReplyTo, LogEntryC
             this.logEntry = logEntry;
         }
     }
-    
+
     @FXML
     public void initialize() {
-        completionMessageLabel.setText("");
+
+        // This could be configured in the fxml, but then these UI components would not be visible
+        // in Scene Builder.
+        completionMessageLabel.textProperty().set("");
+        progressIndicator.visibleProperty().bind(submissionInProgress);
+
+        // Remote log service not reachable, so show error pane.
+        if (!checkConnectivity()) {
+            errorPane.visibleProperty().set(true);
+            editorPane.disableProperty().set(true);
+            return;
+        }
+
         submitButton.disableProperty().bind(Bindings.createBooleanBinding(() ->
                         !inputValid.get() || submissionInProgress.get(),
                 inputValid, submissionInProgress));
         completionMessageLabel.visibleProperty()
                 .bind(Bindings.createBooleanBinding(() -> completionMessageLabel.textProperty().isNotEmpty().get() && !submissionInProgress.get(),
                         completionMessageLabel.textProperty(), submissionInProgress));
-        progressIndicator.visibleProperty().bind(submissionInProgress);
+
         cancelButton.disableProperty().bind(submissionInProgress);
         attachmentsEditorController.setTextArea(textArea);
 
@@ -390,7 +406,7 @@ public void initialize() {
     public void cancel() {
         // Need to clear selections.
         SelectionService.getInstance().clearSelection("");
-        ((LogEntryEditorStage) cancelButton.getScene().getWindow()).handleCloseEditor(isDirty, root);
+        ((LogEntryEditorStage) cancelButton.getScene().getWindow()).handleCloseEditor(isDirty, editorPane);
     }
 
     @FXML
@@ -676,4 +692,20 @@ private void updateDropDown(ContextMenu contextMenu, String itemName, boolean it
     public boolean isDirty() {
         return isDirty;
     }
+
+    /**
+     * Checks connectivity to remote service by querying the info end-point. If connection fails,
+     * connectionError property is set to <code>true</code>, which should set opacity of the editor pane, and
+     * set visibility of error pane.
+     */
+    private boolean checkConnectivity() {
+        LogClient logClient = LogService.getInstance().getLogFactories().get(LogbookPreferences.logbook_factory).getLogClient();
+        try {
+            logClient.serviceInfo();
+            return true;
+        } catch (Exception e) {
+            Logger.getLogger(SendToLogBookApp.class.getName()).warning("Failed to query logbook service, it may be off-line.");
+            return false;
+        }
+    }
 }

app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/LogEntryTableView.fxml

@@ -37,7 +37,7 @@
                                 </Button>
                                 <ComboBox fx:id="query" editable="true" maxWidth="1.7976931348623157E308" GridPane.columnIndex="2" GridPane.hgrow="ALWAYS" GridPane.vgrow="NEVER">
                                     <tooltip>
-                                        <Tooltip text="%SearchToolTip"/>
+                                        <Tooltip text="%SearchToolTip" />
                                     </tooltip>
                                     <GridPane.margin>
                                         <Insets bottom="10.0" top="10.0" />

app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/messages.properties

@@ -9,6 +9,7 @@ BrowseButton=Browse
 Cancel=Cancel
 CancelTooltip=Cancel the current entry.
 Clear=Clear
+Close=Close
 Clear_Tooltip=Clear the selected items list.
 ClipboardButton=Clipboard
 ClipboardButtonTooltip=Add files or image data from clipboard
@@ -74,6 +75,7 @@ SelectFolder=Select Folder
 SelectFile=Select Image File
 SelectLevelTooltip=Select the log entry level.
 SelectLogEntry=Select Log Entry
+ServiceConnectionError=Unable to connect to the logbook service
 ShowHelp=Show Help
 ShowHideDetails=Show/Hide Details
 SortAscending=Sort ascending on date