Merge pull request #3391 from ControlSystemStudio/CSSTUDIO-3229

Update logbook clients to use server side managed "levels"

Author: shroffk

app/logbook/inmemory/src/main/java/org/phoebus/applications/logbook/InMemoryLogClient.java

@@ -1,14 +1,28 @@
 package org.phoebus.applications.logbook;
 
+import org.phoebus.logbook.Attachment;
+import org.phoebus.logbook.AttachmentImpl;
+import org.phoebus.logbook.LogClient;
+import org.phoebus.logbook.LogEntry;
+import org.phoebus.logbook.LogEntryImpl;
+import org.phoebus.logbook.LogEntryImpl.LogEntryBuilder;
+import org.phoebus.logbook.LogEntryLevel;
+import org.phoebus.logbook.Logbook;
+import org.phoebus.logbook.LogbookException;
+import org.phoebus.logbook.LogbookImpl;
+import org.phoebus.logbook.Property;
+import org.phoebus.logbook.PropertyImpl;
+import org.phoebus.logbook.SearchResult;
+import org.phoebus.logbook.Tag;
+import org.phoebus.logbook.TagImpl;
+
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URLConnection;
-import java.nio.file.CopyOption;
 import java.nio.file.Files;
-import java.nio.file.StandardCopyOption;
 import java.time.Instant;
 import java.util.Arrays;
 import java.util.Collection;
@@ -23,21 +37,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import org.phoebus.logbook.Attachment;
-import org.phoebus.logbook.AttachmentImpl;
-import org.phoebus.logbook.LogClient;
-import org.phoebus.logbook.LogEntry;
-import org.phoebus.logbook.LogEntryImpl;
-import org.phoebus.logbook.LogEntryImpl.LogEntryBuilder;
-import org.phoebus.logbook.Logbook;
-import org.phoebus.logbook.LogbookException;
-import org.phoebus.logbook.LogbookImpl;
-import org.phoebus.logbook.Property;
-import org.phoebus.logbook.PropertyImpl;
-import org.phoebus.logbook.SearchResult;
-import org.phoebus.logbook.Tag;
-import org.phoebus.logbook.TagImpl;
-
 /**
  * A logbook which maintains logentries in memory. It is mainly for testing and debugging purpose.
  */
@@ -47,16 +46,16 @@ public class InMemoryLogClient implements LogClient {
     private final Map<Long, LogEntry> logEntries;
 
     private final Collection<Logbook> logbooks = Arrays.asList(LogbookImpl.of("Controls"),
-                                                               LogbookImpl.of("Commissioning"),
-                                                               LogbookImpl.of("Scratch Pad"));
+            LogbookImpl.of("Commissioning"),
+            LogbookImpl.of("Scratch Pad"));
     private final Collection<Tag> tags = Arrays.asList(TagImpl.of("Operations"),
-                                                       TagImpl.of("Alarm"),
-                                                       TagImpl.of("Example"));
+            TagImpl.of("Alarm"),
+            TagImpl.of("Example"));
     private final List<String> levels = Arrays.asList("Urgent", "Suggestion", "Info", "Request", "Problem");
 
     private static List<Property> inMemoryProperties() {
         Map<String, String> tracAttributes = new HashMap<>();
-        Property track = PropertyImpl.of("Track",tracAttributes);
+        Property track = PropertyImpl.of("Track", tracAttributes);
         Map<String, String> experimentAttributes = new HashMap<>();
         Property experimentProperty = PropertyImpl.of("Experiment", experimentAttributes);
         Map<String, String> resourceAttributes = new HashMap<>();
@@ -80,8 +79,8 @@ public InMemoryLogClient() {
     }
 
     @Override
-    public Collection<String> listLevels() {
-        return levels;
+    public Collection<LogEntryLevel> listLevels() {
+        return levels.stream().map(l -> new LogEntryLevel(l, false)).toList();
     }
 
     @Override
@@ -110,6 +109,7 @@ public LogEntry getLog(Long logId) {
     }
 
     String prefix = "phoebus_tmp_file";
+
     @Override
     public LogEntry set(LogEntry log) {
         long id = logIdCounter.incrementAndGet();
@@ -155,12 +155,12 @@ public SearchResult search(Map<String, String> map) {
     @Override
     public List<LogEntry> findLogs(Map<String, String> map) {
         Stream<LogEntry> searchStream = logEntries.values().stream();
-        if(map.containsKey("start")) {
+        if (map.containsKey("start")) {
             searchStream = searchStream.filter(log -> {
                 return log.getCreatedDate().isAfter(Instant.ofEpochSecond(Long.valueOf(map.get("start"))));
             });
         }
-        if(map.containsKey("end")) {
+        if (map.containsKey("end")) {
             searchStream = searchStream.filter(log -> {
                 return log.getCreatedDate().isBefore(Instant.ofEpochSecond(Long.valueOf(map.get("end"))));
             });
@@ -169,7 +169,7 @@ public List<LogEntry> findLogs(Map<String, String> map) {
             final String searchString = map.get("search").replaceAll("\\*", "");
             if (!searchString.isEmpty()) {
                 searchStream = searchStream.filter(log -> {
-                    return log.getDescription().contains(searchString)||log.getTitle().contains(searchString);
+                    return log.getDescription().contains(searchString) || log.getTitle().contains(searchString);
                 });
             }
         }

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

@@ -13,6 +13,7 @@
 import org.phoebus.logbook.LogClient;
 import org.phoebus.logbook.LogEntry;
 import org.phoebus.logbook.LogEntryChangeHandler;
+import org.phoebus.logbook.LogEntryLevel;
 import org.phoebus.logbook.LogTemplate;
 import org.phoebus.logbook.Logbook;
 import org.phoebus.logbook.LogbookException;
@@ -49,6 +50,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.ServiceLoader;
+import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -548,4 +550,22 @@ public LogTemplate saveTemplate(LogTemplate template) throws LogbookException {
             throw new LogbookException(e);
         }
     }
+
+    @Override
+    public Collection<LogEntryLevel> listLevels(){
+        HttpRequest request = HttpRequest.newBuilder()
+                .uri(URI.create(Preferences.olog_url + "/levels"))
+                .GET()
+                .build();
+
+        try {
+            HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
+            return OlogObjectMappers.logEntryDeserializer.readValue(
+                    response.body(), new TypeReference<Set<LogEntryLevel>>() {
+                    });
+        } catch (Exception e) {
+            LOGGER.log(Level.WARNING, "Unable to get templates from service", e);
+            return Collections.emptySet();
+        }
+    }
 }

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

@@ -6,6 +6,7 @@
 import org.phoebus.logbook.Attachment;
 import org.phoebus.logbook.LogClient;
 import org.phoebus.logbook.LogEntry;
+import org.phoebus.logbook.LogEntryLevel;
 import org.phoebus.logbook.Logbook;
 import org.phoebus.logbook.LogbookException;
 import org.phoebus.logbook.Messages;
@@ -197,13 +198,12 @@ private OlogClient(HttpClient httpClient, String userName, String password) {
 
     }
 
-
     // A predefined set of levels supported by olog
     private final List<String> levels = Arrays.asList("Urgent", "Suggestion", "Info", "Request", "Problem");
 
     @Override
-    public Collection<String> listLevels() {
-        return levels;
+    public Collection<LogEntryLevel> listLevels() {
+        return levels.stream().map(l -> new LogEntryLevel(l, false)).toList();
     }
 
     @Override