Add wentToEntry step to tutorial

Ryan Huffman committed 10 years ago

Commit dd4e06e1 parent e3ee7a22 files · +36 −6Browse files

Showing the changes to tutorial/tutorial.js (1 of 2 files). Show all

Unified · Split

     var startedTutorialAt = 0;
     var startedLastStepAt = 0;
+    var WENT_TO_ENTRY_STEP_NUM = 20;
+    var VERSION = 1;
+    var tutorialID;
     var self = this;
     this.startTutorial = function() {
         currentStepNum = -1;
         currentStep = null;
         startedTutorialAt = Date.now();
+        tutorialID = Script.generateUUID();
         STEPS = [
             new stepStart("start"),
             new stepOrient("orient"),
     this.onFinish = function() {
         debug("onFinish", currentStepNum);
         if (currentStep && currentStep.shouldLog !== false) {
-            var timeToFinishStep = (Date.now() - startedLastStepAt) / 1000;
+            self.trackStep(currentStep.tag, currentStepNum);
-            var tutorialTimeElapsed = (Date.now() - startedTutorialAt) / 1000;
-            UserActivityLogger.tutorialProgress(
-                    currentStep.tag, currentStepNum, timeToFinishStep, tutorialTimeElapsed);
         }
         self.startNextStep();
         ++currentStepNum;
+        // This always needs to be set because we use this value when
+        // tracking that the user has gone through the entry portal. When the
+        // tutorial finishes, there is a last "pseudo" step that the user
+        // finishes when stepping into the portal.
+        startedLastStepAt = Date.now();
         if (currentStepNum >= STEPS.length) {
             // Done
             info("DONE WITH TUTORIAL");
         } else {
             info("Starting step", currentStepNum);
             currentStep = STEPS[currentStepNum];
-            startedLastStepAt = Date.now();
             currentStep.start(this.onFinish);
             return true;
         }
         currentStepNum = -1;
         currentStep = null;
     }
+    this.trackStep = function(name, stepNum) {
+        var timeToFinishStep = (Date.now() - startedLastStepAt) / 1000;
+        var tutorialTimeElapsed = (Date.now() - startedTutorialAt) / 1000;
+        UserActivityLogger.tutorialProgress(
+                name, stepNum, timeToFinishStep, tutorialTimeElapsed,
+                tutorialID, VERSION);
+    }
+    // This is a message sent from the "entry" portal in the courtyard,
+    // after the tutorial has finished.
+    this.enteredEntryPortal = function() {
+        info("Got enteredEntryPortal, tracking");
+        this.trackStep("wentToEntry", WENT_TO_ENTRY_STEP_NUM);
+    }
 }
 // To run the tutorial: