Merge pull request #47 from open-craft/kelketek/analytics-refinement

Update and refine analytics events and their documentation.

.travis.yml

 language: python
+sudo: false
 python:
     - "2.7"
 before_install:

drag_and_drop_v2/drag_and_drop_v2.py

@@ -287,9 +287,7 @@ class DragAndDropBlock(XBlock, XBlockWithSettingsMixin, ThemableXBlockMixin):
                 # so we have to figure that we're running in Studio for now
                 pass
 
-        self.runtime.publish(self, 'xblock.drag-and-drop-v2.item.dropped', {
-            'user_id': self.scope_ids.user_id,
-            'component_id': self._get_unique_id(),
+        self.runtime.publish(self, 'edx.drag_and_drop_v2.item.dropped', {
             'item_id': item['id'],
             'location': attempt.get('zone'),
             'input': attempt.get('input'),
@@ -444,9 +442,6 @@ class DragAndDropBlock(XBlock, XBlockWithSettingsMixin, ThemableXBlockMixin):
         except KeyError:
             return {'result': 'error', 'message': 'Missing event_type in JSON data'}
 
-        data['user_id'] = self.scope_ids.user_id
-        data['component_id'] = self._get_unique_id()
-
         self.runtime.publish(self, event_type, data)
         return {'result': 'success'}
 

drag_and_drop_v2/public/js/drag_and_drop.js

@@ -12,6 +12,9 @@ function DragAndDropBlock(runtime, element, configuration) {
     var state = undefined;
     var __vdom = virtualDom.h();  // blank virtual DOM
 
+    // Event string size limit.
+    var MAX_LENGTH = 255;
+
     // Keyboard accessibility
     var ESC = 27;
     var RET = 13;
@@ -57,7 +60,7 @@ function DragAndDropBlock(runtime, element, configuration) {
             $element.on('click', '.submit-input', submitInput);
 
             // Indicate that exercise is done loading
-            publishEvent({event_type: 'xblock.drag-and-drop-v2.loaded'});
+            publishEvent({event_type: 'edx.drag_and_drop_v2.loaded'});
         }).fail(function() {
             $root.text(gettext("An error occurred. Unable to load drag and drop exercise."));
         });
@@ -84,6 +87,15 @@ function DragAndDropBlock(runtime, element, configuration) {
         }
     };
 
+    var truncateField = function(data, fieldName){
+        if (data[fieldName].length > MAX_LENGTH) {
+            data[fieldName] = data[fieldName].substring(0, MAX_LENGTH);
+            data['truncated'] = true;
+        } else {
+            data['truncated'] = false;
+        }
+    };
+
     var focusModalButton = function() {
         $root.find('.keyboard-help-dialog .modal-dismiss-button ').focus();
     };
@@ -160,28 +172,26 @@ function DragAndDropBlock(runtime, element, configuration) {
      * Update the DOM to reflect 'state'.
      */
     var applyState = function() {
-        // Is there a change to the feedback popup?
-        if (state.feedback !== previousFeedback) {
-            if (state.feedback) {
-                if (previousFeedback) {
-                    publishEvent({
-                        event_type: 'xblock.drag-and-drop-v2.feedback.closed',
-                        content: previousFeedback,
-                        manually: false,
-                    });
+        // Has the feedback popup been closed?
+        if (state.closing) {
+            var data = {
+                event_type: 'edx.drag_and_drop_v2.feedback.closed',
+                content: previousFeedback || state.feedback,
+                manually: state.manually_closed,
+            };
+            truncateField(data, 'content');
+            publishEvent(data);
+            delete state.feedback;
+            delete state.closing;
         }
-                publishEvent({
-                    event_type: 'xblock.drag-and-drop-v2.feedback.opened',
-                    content: state.feedback,
-                });
-            } else {
-                publishEvent({
-                    event_type: 'xblock.drag-and-drop-v2.feedback.closed',
+        // Has feedback been set?
+        if (state.feedback) {
+            var data = {
+                event_type: 'edx.drag_and_drop_v2.feedback.opened',
                 content: state.feedback,
-                    manually: true,
-                });
-            }
-            previousFeedback = state.feedback;
+            };
+            truncateField(data, 'content');
+            publishEvent(data);
         }
 
         updateDOM();
@@ -336,7 +346,7 @@ function DragAndDropBlock(runtime, element, configuration) {
                         var $item = $(this);
                         grabItem($item);
                         publishEvent({
-                            event_type: 'xblock.drag-and-drop-v2.item.picked-up',
+                            event_type: 'edx.drag_and_drop_v2.item.picked_up',
                             item_id: $item.data('value'),
                         });
                     },
@@ -471,7 +481,14 @@ function DragAndDropBlock(runtime, element, configuration) {
             return;
         }
 
-        delete state.feedback;
+        state.closing = true;
+        previousFeedback = state.feedback;
+        if (target.is(close_button)) {
+            state.manually_closed = true;
+        } else {
+            state.manually_closed = false;
+        }
+
         applyState();
     };
 

setup.py

@@ -29,7 +29,8 @@ setup(
     install_requires=[
         'XBlock',
         'xblock-utils',
-        'ddt'
+        'ddt',
+        'mock',
     ],
     entry_points={
         'xblock.v1': 'drag-and-drop-v2 = drag_and_drop_v2:DragAndDropBlock',

tests/integration/test_interaction.py

 # Imports ###########################################################
 
-from ddt import ddt, data
+from ddt import ddt, data, unpack
+from mock import Mock, patch
 
 from selenium.common.exceptions import NoSuchElementException
 from selenium.webdriver import ActionChains
 from selenium.webdriver.common.keys import Keys
 
+from workbench.runtime import WorkbenchRuntime
 from xblockutils.resources import ResourceLoader
 
 from drag_and_drop_v2.default_data import (
@@ -310,9 +312,9 @@ class InteractionTestBase(object):
             self.assertFalse(dialog_modal.is_displayed())
 
 
-class BasicInteractionTest(InteractionTestBase):
+class DefaultDataTestMixin(object):
     """
-    Testing interactions with Drag and Drop XBlock against default data. If default data changes this will break.
+    Provides a test scenario with default options.
     """
     PAGE_TITLE = 'Drag and Drop v2'
     PAGE_ID = 'drag_and_drop_v2'
@@ -340,6 +342,11 @@ class BasicInteractionTest(InteractionTestBase):
     def _get_scenario_xml(self):  # pylint: disable=no-self-use
         return "<vertical_demo><drag-and-drop-v2/></vertical_demo>"
 
+
+class BasicInteractionTest(DefaultDataTestMixin, InteractionTestBase):
+    """
+    Testing interactions with Drag and Drop XBlock against default data. If default data changes this will break.
+    """
     def test_item_positive_feedback_on_good_move(self):
         self.parameterized_item_positive_feedback_on_good_move(self.items_map)
 
@@ -360,6 +367,74 @@ class BasicInteractionTest(InteractionTestBase):
 
 
 @ddt
+class EventsFiredTest(DefaultDataTestMixin, InteractionTestBase, BaseIntegrationTest):
+    """
+    Tests that the analytics events are fired and in the proper order.
+    """
+    # These events must be fired in this order.
+    scenarios = (
+        {
+            'name': 'edx.drag_and_drop_v2.loaded',
+            'data': {},
+        },
+        {
+            'name': 'edx.drag_and_drop_v2.item.picked_up',
+            'data': {'item_id': 0},
+        },
+        {
+            'name': 'grade',
+            'data': {'max_value': 1, 'value': (1.0 / 3)},
+        },
+        {
+            'name': 'edx.drag_and_drop_v2.item.dropped',
+            'data': {
+                'input': None,
+                'is_correct': True,
+                'is_correct_location': True,
+                'item_id': 0,
+                'location': u'The Top Zone',
+            },
+        },
+        {
+            'name': 'edx.drag_and_drop_v2.feedback.opened',
+            'data': {
+                'content': u'Correct! This one belongs to The Top Zone.',
+                'truncated': False,
+            },
+        },
+        {
+            'name': 'edx.drag_and_drop_v2.feedback.closed',
+            'data': {
+                'manually': False,
+                'content': u'Correct! This one belongs to The Top Zone.',
+                'truncated': False,
+            },
+        },
+    )
+
+    def setUp(self):
+        mock = Mock()
+        context = patch.object(WorkbenchRuntime, 'publish', mock)
+        context.start()
+        self.addCleanup(context.stop)
+        self.publish = mock
+        super(EventsFiredTest, self).setUp()
+
+    def _get_scenario_xml(self):  # pylint: disable=no-self-use
+        return "<vertical_demo><drag-and-drop-v2/></vertical_demo>"
+
+    @data(*enumerate(scenarios))  # pylint: disable=star-args
+    @unpack
+    def test_event(self, index, event):
+        self.parameterized_item_positive_feedback_on_good_move(self.items_map)
+        dummy, name, published_data = self.publish.call_args_list[index][0]
+        self.assertEqual(name, event['name'])
+        self.assertEqual(
+                published_data, event['data']
+        )
+
+
+@ddt
 class KeyboardInteractionTest(BasicInteractionTest, BaseIntegrationTest):
     @data(Keys.RETURN, Keys.SPACE, Keys.CONTROL+'m', Keys.COMMAND+'m')
     def test_item_positive_feedback_on_good_move_with_keyboard(self, action_key):