fix: make event bus prop optional

bpmn-io · Mar 29, 2022 · 5a21e9d · 5a21e9d
1 parent f7c1190
commit 5a21e9d
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 14 deletions.
diff --git a/src/PropertiesPanel.js b/src/PropertiesPanel.js
@@ -96,6 +96,7 @@ const bufferedEvents = [
  * @param {Function} [props.layoutChanged]
  * @param {DescriptionConfig} [props.descriptionConfig]
  * @param {Function} [props.descriptionLoaded]
+ * @param {Object} [props.eventBus]
  */
 export default function PropertiesPanel(props) {
   const {

diff --git a/src/context/EventContext.js b/src/context/EventContext.js
@@ -31,10 +31,6 @@
 
 import { createContext } from 'preact';
 
-import EventBus from 'diagram-js/lib/core/EventBus';
-
-const eventBus = new EventBus();
-
-const EventContext = createContext({ eventBus });
+const EventContext = createContext({ eventBus: null });
 
 export default EventContext;
diff --git a/src/hooks/useEvent.js b/src/hooks/useEvent.js
@@ -18,8 +18,12 @@ export function useEvent(event, callback, priority = DEFAULT_PRIORITY) {
   const { eventBus } = useContext(EventContext);
 
   useEffect(() => {
+    if (!eventBus) {
+      return;
+    }
+
     eventBus.on(event, priority, callback);
 
     return () => eventBus.off(event, callback);
-  }, [ event, eventBus, callback, priority ]);
+  }, [ callback, event, eventBus, priority ]);
 }
diff --git a/src/hooks/useShowErrorEvent.js b/src/hooks/useShowErrorEvent.js
@@ -30,7 +30,9 @@ export function useShowErrorEvent(show) {
     setTemporaryError(null);
 
     if (show(event)) {
-      eventBus.fire('propertiesPanel.showEntry', event);
+      if (eventBus) {
+        eventBus.fire('propertiesPanel.showEntry', event);
+      }
 
       setTemporaryError(event.message);
     }

diff --git a/test/spec/hooks/useEvent.spec.js b/test/spec/hooks/useEvent.spec.js
@@ -33,6 +33,19 @@ describe('hooks/useEvent', function() {
   });
 
 
+  it('should not subscribe (no event bus)', function() {
+
+    // given
+    const onSpy = sinon.spy(eventBus, 'on');
+
+    // when
+    renderHook(() => useEvent('foo', noop));
+
+    // then
+    expect(onSpy).not.to.have.been.called;
+  });
+
+
   it('should call callback', function() {
 
     // given

diff --git a/test/spec/hooks/useShowEntryEvent.spec.js b/test/spec/hooks/useShowEntryEvent.spec.js
@@ -43,6 +43,28 @@ describe('hooks/useShowEntryEvent', function() {
   });
 
 
+  it('should not call onShow (no event bus)', function() {
+
+    // given
+    const show = () => true;
+
+    const onShowSpy = sinon.spy();
+
+    renderHook(() => {
+      const ref = useShowEntryEvent(show);
+
+      return <input id="foo" ref={ ref } />;
+    });
+
+    // when
+
+    eventBus.fire('propertiesPanel.showEntry');
+
+    // then
+    expect(onShowSpy).not.to.have.been.called;
+  });
+
+
   it('should call focus', function() {
 
     // given

diff --git a/test/spec/hooks/useShowErrorEvent.spec.js b/test/spec/hooks/useShowErrorEvent.spec.js
@@ -25,19 +25,36 @@ describe('hooks/useShowErrorEvent', function() {
     // given
     const show = () => true;
 
-    const onShowSpy = sinon.spy();
+    let temporaryError;
+
+    renderHook(() => {
+      temporaryError = useShowErrorEvent(show);
+    }, { wrapper: WithEventContext(eventBus) });
+
+    // when
+    act(() => eventBus.fire('propertiesPanel.showError', { message: 'foo' }));
+
+    // then
+    expect(temporaryError).to.equal('foo');
+  });
+
+
+  it('should not set temporary error (no event bus)', function() {
+
+    // given
+    const show = () => true;
 
     let temporaryError;
 
     renderHook(() => {
       temporaryError = useShowErrorEvent(show);
-    }, { wrapper: WithEventContext(eventBus, onShowSpy) });
+    });
 
     // when
     act(() => eventBus.fire('propertiesPanel.showError', { message: 'foo' }));
 
     // then
-    expect(temporaryError).to.have.equal('foo');
+    expect(temporaryError).to.be.null;
   });
 
 
@@ -52,7 +69,7 @@ describe('hooks/useShowErrorEvent', function() {
 
     renderHook(() => {
       useShowErrorEvent(show);
-    }, { wrapper: WithEventContext(eventBus, noop) });
+    }, { wrapper: WithEventContext(eventBus) });
 
     // when
     act(() => eventBus.fire('propertiesPanel.showError', { message: 'foo' }));
@@ -68,13 +85,11 @@ describe('hooks/useShowErrorEvent', function() {
     // given
     const show = () => true;
 
-    const onShowSpy = sinon.spy();
-
     let temporaryError;
 
     renderHook(() => {
       temporaryError = useShowErrorEvent(show);
-    }, { wrapper: WithEventContext(eventBus, onShowSpy) });
+    }, { wrapper: WithEventContext(eventBus) });
 
     act(() => eventBus.fire('propertiesPanel.showError', { message: 'foo' }));