added a noRepeats option to get live help survey questions

pgbovine · pgbovine · commit 579867b0ab07 · 2018-06-24T19:25:47.000-07:00
so that we don't show each user the same question again
diff --git a/v5-unity/js/opt-shared-sessions.ts b/v5-unity/js/opt-shared-sessions.ts
@@ -243,6 +243,7 @@ var liveHelpSurvey = {
 */
 
 // 2018-03-17: minor tweaks on version 4's wording to make it sound a bit more optional and casual
+/*
 var liveHelpSurvey = {
   requestHelp:   [ {prompt: 'You are now on the help queue. Please wait for help to arrive.\n\n[OPTIONAL] Support our research by letting us know:\nWhy did you decide to ask for help at this time?',
                     v: 'r4a'},
@@ -255,14 +256,32 @@ var liveHelpSurvey = {
                     v: 'h4b'},
                  ]
 };
+*/
 
+// 2018-06-24: version 5 is nearly identical to version 4, except that I turned
+// on noRepeats=true so we don't ask users the same question more than once
+var liveHelpSurvey = {
+  requestHelp:   [ {prompt: 'You are now on the help queue. Please wait for help to arrive.\n\nSupport our research by letting us know:\nWhy did you decide to ask for help at this time?',
+                    v: 'r5a'},
+                   {prompt: 'You are now on the help queue. Please wait for help to arrive.\n\nSupport our research by letting us know:\nWhy did you ask for help anonymously on this website rather than getting help from someone you know?',
+                    v: 'r5b'},
+                 ],
+  volunteerHelp: [ {prompt: "Thanks for volunteering! You are about to join a live chat.\n\nSupport our research by letting us know:\nWhy did you decide to volunteer at this time? What motivated you to click on this particular help link?",
+                    v: 'h5a'},
+                   {prompt: "Thanks for volunteering! You are about to join a live chat.\n\nSupport our research by letting us know:\nWhat is your current job or profession?",
+                    v: 'h5b'},
+                 ]
+};
 
 
 
 // randomly picks a survey item from liveHelpSurvey and mutates
 // localStorage to record that this has been randomly picked, so it won't
 // be picked again during the next call
-function randomlyPickSurveyItem(key) {
+//
+// 2018-06-24: if noRepeats is true, then don't ask this user repeated
+// questions; simply return null if all questions have already been asked
+function randomlyPickSurveyItem(key, noRepeats=false) {
   var lst = liveHelpSurvey[key];
   var filteredLst = [];
 
@@ -281,6 +300,10 @@ function randomlyPickSurveyItem(key) {
   // if ALL entries have been filtered out, then reset everything and
   // start from scratch:
   if (filteredLst.length == 0) {
+    if (noRepeats) {
+      return null; // punt early if noRepeats=true!!!
+    }
+
     if (supports_html5_storage()) {
       lst.forEach((e) => {
         localStorage.removeItem(e.v);
@@ -710,7 +733,12 @@ Get live help!
             // add these handlers AFTER the respective DOM nodes have been added above:
 
             $(".gotoHelpLink").click(function() {
-              var surveyItem = randomlyPickSurveyItem('volunteerHelp');
+              // 2018-06-24: don't show the user repeated questions (noRepeats=true)
+              var surveyItem = randomlyPickSurveyItem('volunteerHelp', true);
+              if (!surveyItem) {
+                // punt early!
+                return true; // ALWAYS cause the link to be clicked
+              }
               var miniSurveyResponse = prompt(surveyItem.prompt);
 
               // always log every impression, even if miniSurveyResponse is blank,
@@ -1601,20 +1629,23 @@ Get live help!
     // pop up the survey BEFORE you make the request, so in case you get
     // hung up on the prompt() and take a long time to answer the question,
     // you're not put on the queue yet until you finish or click Cancel:
-    var surveyItem = randomlyPickSurveyItem('requestHelp');
-    var miniSurveyResponse = prompt(surveyItem.prompt);
-
-    // always log every impression, even if miniSurveyResponse is blank,
-    // since we can know how many times that survey question was ever seen:
-    var surveyUrl = TogetherJS.config.get("hubBase").replace(/\/*$/, "") + "/survey";
-    $.ajax({
-      url: surveyUrl,
-      dataType: "json",
-      data: {id: shareId, user_uuid: this.userUUID, kind: 'requestHelp', v: surveyItem.v, response: miniSurveyResponse},
-      success: function() {}, // NOP
-      error: function() {},   // NOP
-    });
-
+    //
+    // 2018-06-24: don't show the user repeated questions (noRepeats=true)
+    var surveyItem = randomlyPickSurveyItem('requestHelp', true);
+    if (surveyItem) {
+      var miniSurveyResponse = prompt(surveyItem.prompt);
+
+      // always log every impression, even if miniSurveyResponse is blank,
+      // since we can know how many times that survey question was ever seen:
+      var surveyUrl = TogetherJS.config.get("hubBase").replace(/\/*$/, "") + "/survey";
+      $.ajax({
+        url: surveyUrl,
+        dataType: "json",
+        data: {id: shareId, user_uuid: this.userUUID, kind: 'requestHelp', v: surveyItem.v, response: miniSurveyResponse},
+        success: function() {}, // NOP
+        error: function() {},   // NOP
+      });
+    }
 
     this.iMadeAPublicHelpRequest = true; // this will always be true even if you shut the door later and don't let people in (i.e., make this into a private session)
 
