Introduce announcement banner for maintenance notification (#1143)

* Show announcements

* Fix code smells

* Provide CSS for announcements

* Update bundle

* Use relational units for grid rows within project-overview

* Adjust styling

Co-authored-by: Shraddha Pawar <[email protected]>

---------

Co-authored-by: KochTobi <[email protected]>
Co-authored-by: Steffengreiner <[email protected]>
Co-authored-by: Shraddha Pawar <[email protected]>

Author: 3 people

sql/complete-schema.sql

@@ -577,6 +577,17 @@ CREATE TABLE IF NOT EXISTS `confounding_variable_levels`
   DEFAULT CHARSET = utf8mb4
   COLLATE utf8mb4_unicode_ci;
 
+CREATE TABLE IF NOT EXISTS `announcements`
+(
+    `id`         bigint(20)   NOT NULL AUTO_INCREMENT PRIMARY KEY,
+    `start_time` datetime(6)  NOT NULL,
+    `end_time`   datetime(6)  NOT NULL,
+    `message`    VARCHAR(255) NOT NULL
+) ENGINE = InnoDB
+  AUTO_INCREMENT = 1
+  DEFAULT CHARSET = utf8mb4
+  COLLATE utf8mb4_unicode_ci;
+
 
 
 DROP VIEW IF EXISTS data_management.project_measurements;

user-interface/frontend/themes/datamanager/components/all.css

@@ -475,7 +475,27 @@ Layout
 /****************************
 Older stuff -
 ****************************/
+#announcements {
+  background-color: var(--lumo-warning-color);
+  padding: var(--lumo-space-s) var(--lumo-space-m);
+  text-align: left;
+}
+
+.announcement {
+  margin: var(--lumo-space-s) 0;
+  display: flex;
+  gap: var(--lumo-space-s);
+}
 
+.announcement vaadin-icon {
+  min-width: var(--icon-size-s);
+  max-width: var(--icon-size-s);
+  color: var(--icon-color-default);
+}
+
+.announcement-text {
+  display: inline;
+}
 
 .heading-with-icon {
   color: #878787;

user-interface/frontend/themes/datamanager/components/main.css

@@ -2,14 +2,19 @@
   grid-area: content-area;
 }
 
+#announcements {
+  grid-area: announcements;
+}
+
 #main-layout {
   display: grid;
   grid-template-columns: 1fr;
-  grid-template-rows: minmax(max-content, 95%) minmax(min-content, 5%);
+  grid-template-rows: auto minmax(max-content, 0.95fr) minmax(min-content, 0.05fr);
   height: 100%;
   /*Default design of components is too big for smaller screens*/
   zoom: 90%;
   grid-template-areas:
+    "announcements"
     "content-area"
     "data-manager-footer";
 }
@@ -273,8 +278,8 @@
 }
 
 .main.project-overview {
-  grid-template-columns: minmax(min-content, 1fr);
-  grid-template-rows: minmax(min-content, 10%) minmax(min-content, 80%);
+  grid-template-columns: 1fr;
+  grid-template-rows: 0.1fr 0.9fr;
   grid-template-areas:
     "."
     "projectcollection";
@@ -484,14 +489,6 @@
     grid-template-rows: minmax(min-content, 60%) minmax(min-content, 20%) minmax(min-content, 20%);
   }
 
-  .main.project-overview {
-    grid-template-columns: minmax(min-content, 1fr);
-    grid-template-rows:  minmax(min-content, 10%) minmax(min-content, 80%);
-    grid-template-areas:
-    "."
-    "projectcollection";
-  }
-
   .main.raw-data {
     grid-template-columns: minmax(min-content, 1fr);
     grid-template-areas:

user-interface/src/main/bundles/dev.bundle

@@ -85,7 +85,7 @@
  * @since 1.0.0
  */
 @Configuration
-@ComponentScan({"life.qbic.identity.infrastructure"})
+@ComponentScan({"life.qbic.identity.infrastructure", "life.qbic.datamanager.announcements"})
 public class AppConfig {
   /*
   Wiring up identity application core and policies

user-interface/src/main/java/life/qbic/datamanager/AppConfig.java

@@ -0,0 +1,88 @@
+package life.qbic.datamanager.announcements;
+
+import static java.util.Objects.nonNull;
+
+import com.vaadin.flow.component.AttachEvent;
+import com.vaadin.flow.component.Component;
+import com.vaadin.flow.component.DetachEvent;
+import com.vaadin.flow.component.Html;
+import com.vaadin.flow.component.UI;
+import com.vaadin.flow.component.html.Div;
+import com.vaadin.flow.component.icon.VaadinIcon;
+import java.time.Duration;
+import java.time.Instant;
+import java.time.temporal.ChronoUnit;
+import java.util.List;
+import life.qbic.datamanager.announcements.AnnouncementService.Announcement;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import reactor.core.Disposable;
+import reactor.core.publisher.Flux;
+
+public class AnnouncementComponent extends Div {
+
+  private static final Log log = LogFactory.getLog(AnnouncementComponent.class);
+  private final transient AnnouncementService announcementService;
+  private static final Duration INITIAL_DELAY = Duration.ZERO;
+  private static final Duration REFRESH_INTERVAL = Duration.of(1, ChronoUnit.HOURS);
+  private transient Disposable refreshRoutine;
+
+
+  public AnnouncementComponent(AnnouncementService announcementService) {
+    this.announcementService = announcementService;
+    this.setId("announcements");
+  }
+
+  private void subscribeToAnnouncements() {
+    unsubscribeFromAnnouncements();
+    UI ui = getUI().orElseThrow();
+    refreshRoutine = Flux.interval(INITIAL_DELAY, REFRESH_INTERVAL)
+        .doOnNext(
+            it -> {
+              ui.getSession().lock();
+              log.debug("Fetching announcements for ui[%s] vaadin[%s] http[%s] ".formatted(
+                  ui.getUIId(), ui.getSession().getPushId(),
+                  ui.getSession().getSession().getId()));
+              ui.getSession().unlock();
+            })
+        .flatMap(it -> announcementService.loadActiveAnnouncements(Instant.now())
+            .collectList())
+        .subscribe(announcements -> refreshAnnouncements(announcements, ui));
+  }
+
+  private void unsubscribeFromAnnouncements() {
+    if (nonNull(refreshRoutine)) {
+      refreshRoutine.dispose();
+    }
+  }
+
+  private void refreshAnnouncements(List<Announcement> announcements, UI ui) {
+    ui.access(() -> {
+      this.removeAll();
+      this.setVisible(!announcements.isEmpty());
+      for (Announcement announcement : announcements) {
+        add(renderAnnouncement(announcement));
+      }
+    });
+  }
+
+  private Component renderAnnouncement(AnnouncementService.Announcement announcement) {
+    Html html = new Html(
+        "<div class=\"announcement-text\">%s</div>".formatted(announcement.message()));
+    Div div = new Div(VaadinIcon.WRENCH.create(), html);
+    div.addClassNames("announcement");
+    return div;
+  }
+
+  @Override
+  protected void onAttach(AttachEvent attachEvent) {
+    super.onAttach(attachEvent);
+    subscribeToAnnouncements();
+  }
+
+  @Override
+  protected void onDetach(DetachEvent detachEvent) {
+    unsubscribeFromAnnouncements();
+    super.onDetach(detachEvent);
+  }
+}

user-interface/src/main/java/life/qbic/datamanager/announcements/AnnouncementComponent.java

@@ -0,0 +1,50 @@
+package life.qbic.datamanager.announcements;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
+import java.time.Instant;
+import java.util.List;
+import life.qbic.datamanager.announcements.AnnouncementRepository.Announcement;
+import org.springframework.data.repository.Repository;
+
+@org.springframework.stereotype.Repository
+public interface AnnouncementRepository extends Repository<Announcement, Long> {
+
+  @Entity
+  @Table(name = "announcements")
+  class Announcement {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.AUTO)
+    @Column(name = "id", nullable = false)
+    private Long id;
+    @Column(name = "start_time")
+    private Instant displayStartTime;
+    @Column(name = "end_time")
+    private Instant displayEndTime;
+    @Column(name = "message")
+    private String message;
+
+    public Long getId() {
+      return id;
+    }
+
+    public void setId(Long id) {
+      this.id = id;
+    }
+
+    public String getMessage() {
+      return message;
+    }
+  }
+
+  List<Announcement> getAnnouncementByDisplayStartTimeBeforeAndDisplayEndTimeAfterOrderByDisplayStartTimeAsc(
+      Instant min,
+      Instant max);
+
+
+}

user-interface/src/main/java/life/qbic/datamanager/announcements/AnnouncementRepository.java

@@ -0,0 +1,28 @@
+package life.qbic.datamanager.announcements;
+
+import java.time.Instant;
+import reactor.core.publisher.Flux;
+
+/**
+ * Loads announcements
+ */
+public interface AnnouncementService {
+
+  /**
+   * A {@link Flux} containing Announcements. Only publishes announcements that are valid given the
+   * provided time. Published announcements are distinct until changed.
+   *
+   * @param timePoint the timepoint at which the announcement is valid
+   * @return a {@link Flux} publishing announcements
+   */
+  Flux<Announcement> loadActiveAnnouncements(Instant timePoint);
+
+  /**
+   * An announcement with a given message.
+   *
+   * @param message
+   */
+  record Announcement(String message) {
+
+  }
+}

user-interface/src/main/java/life/qbic/datamanager/announcements/AnnouncementService.java

@@ -0,0 +1,31 @@
+package life.qbic.datamanager.announcements;
+
+import java.time.Instant;
+import java.util.Objects;
+import life.qbic.datamanager.VirtualThreadScheduler;
+import org.springframework.stereotype.Service;
+import reactor.core.publisher.Flux;
+
+@Service
+public class AnnouncementServiceImpl implements AnnouncementService {
+
+  private final AnnouncementRepository announcementRepository;
+
+  public AnnouncementServiceImpl(AnnouncementRepository announcementRepository) {
+    this.announcementRepository = announcementRepository;
+  }
+
+  @Override
+  public Flux<Announcement> loadActiveAnnouncements(Instant timePoint) {
+    return Flux.fromIterable(
+            announcementRepository.getAnnouncementByDisplayStartTimeBeforeAndDisplayEndTimeAfterOrderByDisplayStartTimeAsc(
+                timePoint, timePoint))
+        .distinctUntilChanged(Objects::hashCode) //avoid unnecessary work
+        .map(AnnouncementServiceImpl::toApiObject)
+        .subscribeOn(VirtualThreadScheduler.getScheduler());
+  }
+
+  private static Announcement toApiObject(AnnouncementRepository.Announcement announcement) {
+    return new Announcement(announcement.getMessage());
+  }
+}

user-interface/src/main/java/life/qbic/datamanager/announcements/AnnouncementServiceImpl.java

@@ -41,7 +41,8 @@
 @Configuration
 @EnableTransactionManagement
 @EnableJpaRepositories(
-    basePackages = {"life.qbic.projectmanagement", "life.qbic.identity"},
+    basePackages = {"life.qbic.projectmanagement", "life.qbic.identity",
+        "life.qbic.datamanager.announcements"},
     entityManagerFactoryRef = "dataManagementEntityManagerFactory",
     transactionManagerRef = "dataManagementTransactionManager")
 public class DataManagementDatasourceConfig {
@@ -72,7 +73,8 @@ public LocalContainerEntityManagerFactoryBean entityManagerFactory(
       @Qualifier("dataManagementDataSource") DataSource dataSource) {
     return builder
         .dataSource(dataSource)
-        .packages("life.qbic.projectmanagement", "life.qbic.identity")
+        .packages("life.qbic.projectmanagement", "life.qbic.identity",
+            "life.qbic.datamanager.announcements")
         .properties(Map.of(
             "hibernate.hbm2ddl.auto", hibernateDdlAuto
         ))