[ZEPPELIN-6340] Add ZeppelinEventBus

- Add ZeppelinEventBus
- Update NotebookServer to handle NoteRemoveEvent using EventBus

Author: seung-00

conf/zeppelin-site.xml.template

@@ -824,4 +824,10 @@
   <description>fields to be excluded from being saved in note files, with Paragraph prefix mean the fields in Paragraph, e.g. Paragraph.results</description>
 </property>
 
+<property>
+  <name>zeppelin.eventbus.enabled</name>
+  <value>false</value>
+  <description>Enables the new event-driven architecture using an in-process EventBus</description>
+</property>
+
 </configuration>

zeppelin-interpreter/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java

@@ -895,6 +895,8 @@ public boolean isPrometheusMetricEnabled() {
     return getBoolean(ConfVars.ZEPPELIN_METRIC_ENABLE_PROMETHEUS);
   }
 
+  public boolean isEventBusEnabled() { return getBoolean(ConfVars.ZEPPELIN_EVENTBUS_ENABLED); }
+
   public DEFAULT_UI getDefaultUi() {
     return DEFAULT_UI.valueOf(getString(ConfVars.ZEPPELIN_DEFAULT_UI).toUpperCase());
   }
@@ -1131,7 +1133,8 @@ public enum ConfVars {
     ZEPPELIN_SPARK_ONLY_YARN_CLUSTER("zeppelin.spark.only_yarn_cluster", false),
     ZEPPELIN_SESSION_CHECK_INTERVAL("zeppelin.session.check_interval", 60 * 10 * 1000),
     ZEPPELIN_NOTE_CACHE_THRESHOLD("zeppelin.note.cache.threshold", 50),
-    ZEPPELIN_NOTE_FILE_EXCLUDE_FIELDS("zeppelin.note.file.exclude.fields", "");
+    ZEPPELIN_NOTE_FILE_EXCLUDE_FIELDS("zeppelin.note.file.exclude.fields", ""),
+    ZEPPELIN_EVENTBUS_ENABLED("zeppelin.eventbus.enabled", false);
 
     private String varName;
     private Class<?> varClass;

zeppelin-server/src/main/java/org/apache/zeppelin/server/ZeppelinServer.java

@@ -64,6 +64,9 @@
 import org.apache.zeppelin.conf.ZeppelinConfiguration.ConfVars;
 import org.apache.zeppelin.conf.ZeppelinConfiguration.DEFAULT_UI;
 import org.apache.zeppelin.display.AngularObjectRegistryListener;
+import org.apache.zeppelin.event.EventBus;
+import org.apache.zeppelin.event.NoOpEventBus;
+import org.apache.zeppelin.event.ZeppelinEventBus;
 import org.apache.zeppelin.healthcheck.HealthChecks;
 import org.apache.zeppelin.helium.ApplicationEventListener;
 import org.apache.zeppelin.helium.Helium;
@@ -178,6 +181,11 @@ protected void configure() {
             bind(storage).to(ConfigStorage.class);
             bindAsContract(PluginManager.class).in(Singleton.class);
             bind(GsonNoteParser.class).to(NoteParser.class).in(Singleton.class);
+            if (zConf.isEventBusEnabled()) {
+              bind(ZeppelinEventBus.class).to(EventBus.class).in(Singleton.class);
+            } else {
+              bind(NoOpEventBus.class).to(EventBus.class).in(Singleton.class);
+            }
             bindAsContract(InterpreterFactory.class).in(Singleton.class);
             bindAsContract(NotebookRepoSync.class).to(NotebookRepo.class).in(Singleton.class);
             bindAsContract(Helium.class).in(Singleton.class);

zeppelin-server/src/main/java/org/apache/zeppelin/socket/NotebookServer.java

@@ -40,6 +40,8 @@
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.atomic.AtomicReference;
+import io.reactivex.rxjava3.disposables.Disposable;
+import jakarta.annotation.PreDestroy;
 import jakarta.inject.Inject;
 import jakarta.inject.Provider;
 import jakarta.websocket.CloseReason;
@@ -62,6 +64,9 @@
 import org.apache.zeppelin.display.AngularObjectRegistryListener;
 import org.apache.zeppelin.display.GUI;
 import org.apache.zeppelin.display.Input;
+import org.apache.zeppelin.event.EventBus;
+import org.apache.zeppelin.event.NoteEvent;
+import org.apache.zeppelin.event.NoteRemoveEvent;
 import org.apache.zeppelin.helium.ApplicationEventListener;
 import org.apache.zeppelin.helium.HeliumPackage;
 import org.apache.zeppelin.interpreter.InterpreterGroup;
@@ -156,6 +161,8 @@ String getKey() {
   private AuthorizationService authorizationService;
   private Provider<ConfigurationService> configurationServiceProvider;
   private Provider<JobManagerService> jobManagerServiceProvider;
+  private Disposable disposable;
+
 
   public NotebookServer() {
     NotebookServer.self.set(this);
@@ -167,6 +174,26 @@ public void setZeppelinConfiguration(ZeppelinConfiguration zConf) {
     this.zConf = zConf;
   }
 
+  @Inject
+  public void registerEventBus(EventBus eventBus, ZeppelinConfiguration zConf) {
+    if (!zConf.isEventBusEnabled()) {
+      LOGGER.debug("ZeppelinEventBus is disabled");
+      return;
+    }
+
+    this.disposable = eventBus.observe(NoteEvent.class)
+        .subscribe(this::handleNoteEvent);
+  }
+
+  @PreDestroy
+  public void cleanup() {
+    if (disposable != null && !disposable.isDisposed()) {
+      disposable.dispose();
+    }
+    executorService.shutdown();
+  }
+
+
   @Inject
   public void setNoteParser(Provider<NoteParser> noteParser) {
     this.noteParser = noteParser;
@@ -1876,19 +1903,12 @@ public void onParagraphRemove(Paragraph p) {
 
   @Override
   public void onNoteRemove(Note note, AuthenticationInfo subject) {
-    try {
-      broadcastUpdateNoteJobInfo(note, System.currentTimeMillis() - 5000);
-    } catch (IOException e) {
-      LOGGER.warn("can not broadcast for job manager: {}", e.getMessage(), e);
-    }
-
-    try {
-      getJobManagerService().removeNoteJobInfo(note.getId(), null,
-          new JobManagerServiceCallback());
-    } catch (IOException e) {
-      LOGGER.warn("can not broadcast for job manager: {}", e.getMessage(), e);
+    if (zConf.isEventBusEnabled()) {
+      LOGGER.debug("ZeppelinEventBus is enabed");
+      return;
     }
 
+    handleNoteRemove(note);
   }
 
   @Override
@@ -2330,4 +2350,28 @@ public void onFailure(Exception ex, ServiceContext context) throws IOException {
       }
     }
   }
+
+  private void handleNoteEvent(NoteEvent event) {
+    if (event instanceof NoteRemoveEvent) {
+      Note note = event.getNote();
+      handleNoteRemove(note);
+    } else {
+      LOGGER.warn("Unknown event type: {}", event.getClass().getName());
+    }
+  }
+
+  private void handleNoteRemove(Note note) {
+    try {
+      broadcastUpdateNoteJobInfo(note, System.currentTimeMillis() - 5000);
+    } catch (IOException e) {
+      LOGGER.warn("can not broadcast for job manager: {}", e.getMessage(), e);
+    }
+
+    try {
+      getJobManagerService().removeNoteJobInfo(note.getId(), null,
+          new JobManagerServiceCallback());
+    } catch (IOException e) {
+      LOGGER.warn("can not broadcast for job manager: {}", e.getMessage(), e);
+    }
+  }
 }

zeppelin-server/src/test/java/org/apache/zeppelin/MiniZeppelinServer.java

@@ -89,6 +89,7 @@ public MiniZeppelinServer(String classname, String zeppelinConfiguration) throws
     zConf = ZeppelinConfiguration.load(zeppelinConfiguration);
     zConf.setProperty(ConfVars.ZEPPELIN_HOME.getVarName(),
         zeppelinHome.getAbsoluteFile().toString());
+    zConf.setProperty(ConfVars.ZEPPELIN_EVENTBUS_ENABLED.getVarName(), "true");
     Optional<File> webWar = getWebWar();
     Optional<File> webAngularWar = getWebAngularWar();
     if (webWar.isPresent()) {

zeppelin-server/src/test/java/org/apache/zeppelin/service/NotebookServiceTest.java

@@ -46,6 +46,8 @@
 
 import org.apache.commons.lang3.StringUtils;
 import org.apache.zeppelin.conf.ZeppelinConfiguration;
+import org.apache.zeppelin.event.EventBus;
+import org.apache.zeppelin.event.ZeppelinEventBus;
 import org.apache.zeppelin.interpreter.Interpreter;
 import org.apache.zeppelin.interpreter.Interpreter.FormType;
 import org.apache.zeppelin.interpreter.InterpreterFactory;
@@ -102,6 +104,7 @@ void setUp(TestInfo testInfo) throws Exception {
     ZeppelinConfiguration zConf = ZeppelinConfiguration.load();
     zConf.setProperty(ZeppelinConfiguration.ConfVars.ZEPPELIN_NOTEBOOK_DIR.getVarName(),
         notebookDir.getAbsolutePath());
+    zConf.setProperty(ZeppelinConfiguration.ConfVars.ZEPPELIN_EVENTBUS_ENABLED.getVarName(), "true");
     // enable cron for testNoteUpdate method
     if ("testNoteUpdate()".equals(testInfo.getDisplayName())){
       confDir = Files.createTempDirectory("confDir").toAbsolutePath().toFile();
@@ -138,6 +141,7 @@ void setUp(TestInfo testInfo) throws Exception {
     NoteManager noteManager = new NoteManager(notebookRepo, zConf);
     AuthorizationService authorizationService =
         new AuthorizationService(noteManager, zConf, storage);
+    EventBus eventBus = new ZeppelinEventBus();
     notebook =
         new Notebook(
             zConf,
@@ -147,7 +151,7 @@ void setUp(TestInfo testInfo) throws Exception {
             mockInterpreterFactory,
             mockInterpreterSettingManager,
             credentials,
-            null);
+            eventBus);
     searchService = new LuceneSearch(zConf, notebook);
     QuartzSchedulerService schedulerService = new QuartzSchedulerService(zConf, notebook);
     notebook.initNotebook();

zeppelin-zengine/pom.xml

@@ -291,6 +291,12 @@
       <groupId>org.apache.hadoop</groupId>
       <artifactId>hadoop-client-runtime</artifactId>
     </dependency>
+
+    <dependency>
+      <groupId>io.reactivex.rxjava3</groupId>
+      <artifactId>rxjava</artifactId>
+      <version>3.1.10</version>
+    </dependency>
   </dependencies>
 
   <build>

zeppelin-zengine/src/main/java/org/apache/zeppelin/event/EventBus.java

@@ -0,0 +1,10 @@
+package org.apache.zeppelin.event;
+
+import io.reactivex.rxjava3.core.Observable;
+
+public interface EventBus {
+
+  void post(Object event);
+
+  <T> Observable<T> observe(Class<T> eventType);
+}

zeppelin-zengine/src/main/java/org/apache/zeppelin/event/NoOpEventBus.java

@@ -0,0 +1,26 @@
+package org.apache.zeppelin.event;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import io.reactivex.rxjava3.core.Observable;
+import jakarta.inject.Inject;
+
+public class NoOpEventBus implements EventBus {
+
+  private static final Logger LOGGER = LoggerFactory.getLogger(NoOpEventBus.class);
+
+  @Inject
+  public NoOpEventBus() {
+    LOGGER.info("Starting NoOpEventBus");
+  }
+
+  @Override
+  public void post(Object event) {
+    LOGGER.debug("Posting event: {}", event.getClass().getName());
+  }
+
+  @Override
+  public <T> io.reactivex.rxjava3.core.Observable<T> observe(Class<T> eventType) {
+    return Observable.empty();
+  }
+}

zeppelin-zengine/src/main/java/org/apache/zeppelin/event/NoteEvent.java

@@ -0,0 +1,11 @@
+package org.apache.zeppelin.event;
+
+import org.apache.zeppelin.notebook.Note;
+import org.apache.zeppelin.user.AuthenticationInfo;
+
+public interface NoteEvent {
+
+  Note getNote();
+
+  AuthenticationInfo getSubject();
+}