Merge pull request #838 from symphony-enrico/main

Unregister Activity

Author: Yannick-Malins

symphony-bdk-core/src/main/java/com/symphony/bdk/core/activity/ActivityRegistry.java

@@ -14,7 +14,7 @@
 import java.util.Optional;
 
 /**
- * This class allows to bind an {@link AbstractActivity} to the Real Time Events source, or Datafeed.
+ * This class allows to bind/unbind an {@link AbstractActivity} to the Real Time Events source, or Datafeed.
  * It also maintains the list of registered activities.
  * <p>
  * If an activity to be registered is already existing in the registry, then the old one will be replaced.
@@ -55,22 +55,30 @@ public void register(final AbstractActivity<?, ?> activity) {
     this.activityList.add(activity);
   }
 
-  public List<AbstractActivity<?, ?>> getActivityList() {
-    return new ArrayList<>(activityList);
-  }
-
-  private void preProcessActivity(AbstractActivity<?, ?> activity) {
-
+  /**
+   * Unregisters an activity from the registry.
+   *
+   * @param activity An activity.
+   */
+  public void unregister(final AbstractActivity<?, ?> activity) {
     Optional<AbstractActivity<?, ?>> act = this.activityList.stream()
         .filter(a -> a.equals(activity))
         .findFirst();
 
     act.ifPresent(abstractActivity -> {
       abstractActivity.bindToRealTimeEventsSource(this.datafeedLoop::unsubscribe);
       this.activityList.remove(abstractActivity);
-      log.debug("One activity '{}' has been removed/unsubscribed in order to be replaced",
+      log.debug("One activity '{}' has been removed/unsubscribed",
           abstractActivity.getInfo().name());
     });
+  }
+
+  public List<AbstractActivity<?, ?>> getActivityList() {
+    return new ArrayList<>(activityList);
+  }
+
+  private void preProcessActivity(AbstractActivity<?, ?> activity) {
+    unregister(activity); // Unregister, in case it already exists
 
     // a command activity (potentially) needs the bot display name and user ID in order to parse the message text content
     // this way of passing this information is not very clean though, we should find something

symphony-bdk-core/src/test/java/com/symphony/bdk/core/activity/ActivityRegistryTest.java

@@ -67,6 +67,22 @@ void shouldReplaceActivity() {
     verify(this.datafeedService, times(1)).unsubscribe(any(RealTimeEventListener.class));
   }
 
+  @Test
+  void shouldRemoveActivity() {
+    final CommandActivity<?> act = new TestCommandActivity("test");
+    assertTrue(this.registry.getActivityList().isEmpty(), "Registry must be empty");
+
+    this.registry.register(act);
+    assertEquals(1, this.registry.getActivityList().size(), "Registry must contain only 1 activity");
+    verify(this.datafeedService, times(1)).subscribe(any(RealTimeEventListener.class));
+    assertEquals(this.botSession.getDisplayName(), act.getBotDisplayName());
+    assertEquals(this.botSession.getId(), act.getBotUserId());
+
+    this.registry.unregister(act);
+    assertTrue(this.registry.getActivityList().isEmpty(), "Registry must be empty");
+    verify(this.datafeedService, times(1)).unsubscribe(any(RealTimeEventListener.class));
+  }
+
   @Test
   void shouldReplaceHelpActivity() {
     final HelpCommand helpCommand = new HelpCommand(this.registry, this.messageService);