feat: add refactorings tracking

lib/features/index.js

@@ -4,6 +4,7 @@ import feelPopupTracking from './feel-popup';
 import modelingTracking from './modeling';
 import paletteTracking from './palette';
 import popupMenuTracking from './popup-menu';
+import refactoringsTracking from './refactorings';
 import selectionTracking from './selection';
 
 export default {
@@ -14,6 +15,7 @@ export default {
     modelingTracking,
     paletteTracking,
     popupMenuTracking,
+    refactoringsTracking,
     selectionTracking
   ]
 };

lib/features/refactorings/RefactoringsTracking.js

@@ -0,0 +1,24 @@
+export default class ContextPadTracking {
+  constructor(eventBus, bpmnJSTracking) {
+    this._bpmnJSTracking = bpmnJSTracking;
+    this._eventBus = eventBus;
+
+    this._eventBus.on('refactorings.execute', this.trackRefactoring.bind(this));
+  }
+
+  trackRefactoring(event) {
+    const { refactoring } = event;
+
+    this._bpmnJSTracking.track({
+      name: 'refactorings.execute',
+      data: {
+        refactoring
+      }
+    });
+  }
+}
+
+ContextPadTracking.$inject = [
+  'eventBus',
+  'bpmnJSTracking'
+];

lib/features/refactorings/index.js

@@ -0,0 +1,8 @@
+import RefactoringsTracking from './RefactoringsTracking';
+
+export default {
+  __init__: [
+    'refactoringsTracking'
+  ],
+  refactoringsTracking: [ 'type', RefactoringsTracking ]
+};

test/spec/features/RefactoringsTracking.spec.js

@@ -0,0 +1,119 @@
+import {
+  bootstrapModeler,
+  inject
+} from 'test/TestHelper';
+
+import RefactoringsModule from '@bpmn-io/refactorings';
+
+import { BpmnJSTracking } from 'lib';
+import RefactoringsTracking from 'lib/features/refactorings';
+
+class FoobarProvider {
+  constructor(eventBus, refactorings) {
+    refactorings.registerProvider(this);
+
+    this._eventBus = eventBus;
+  }
+
+  /**
+   * @param {Element[]} elements
+   *
+   * @returns {Refactoring[]}
+   */
+  getRefactorings(elements) {
+    return [
+      {
+        id: 'foo',
+        label: 'Foo',
+        execute: () => {
+          this._eventBus.fire('refactorings.execute', {
+            refactoring: {
+              type: 'foo'
+            }
+          });
+        }
+      }
+    ];
+  }
+}
+
+FoobarProvider.$inject = [ 'eventBus', 'refactorings' ];
+
+describe('RefactoringsTracking', function() {
+
+  const diagram = require('test/spec/simple.bpmn').default;
+
+  beforeEach(bootstrapModeler(diagram, {
+    additionalModules: [
+      BpmnJSTracking,
+      RefactoringsTracking,
+      RefactoringsModule,
+      {
+        __init__: [
+          'foobarProvider'
+        ],
+        foobarProvider: [ 'type', FoobarProvider ],
+        openAIElementTemplatesProvider: [ 'value', null ]
+      }
+    ]
+  }));
+
+
+  describe('should subscribe', function() {
+
+    it('refactorings.execute', inject(async function(elementRegistry, bpmnJSTracking, refactorings) {
+
+      // given
+      const spy = sinon.spy(bpmnJSTracking, 'track');
+
+      const element = elementRegistry.get('StartEvent_1');
+
+      const [ refactoring ] = await refactorings.getRefactorings([ element ]);
+
+      // when
+      refactoring.execute();
+
+      // expect
+      expect(spy).to.have.been.calledOnce;
+    }));
+
+  });
+
+
+  describe('should track', function() {
+
+    beforeEach(inject(function(bpmnJSTracking) {
+      bpmnJSTracking.enable();
+    }));
+
+    it('popup menu open', inject(async function(bpmnJSTracking, elementRegistry, refactorings) {
+
+      // given
+      const element = elementRegistry.get('StartEvent_1');
+
+      const spy = sinon.spy(function(event) {
+        expect(event).to.eventEqual({
+          name: 'refactorings.execute',
+          data: {
+            refactoring: {
+              type: 'foo'
+            }
+          },
+          type: 'tracking.event'
+        });
+      });
+
+      bpmnJSTracking.on('tracking.event', spy);
+
+      const [ refactoring ] = await refactorings.getRefactorings([ element ]);
+
+      // when
+      refactoring.execute();
+
+      // then
+      expect(spy).to.have.been.calledOnce;
+    }));
+
+  });
+
+});