feat: sendHostname can works after 7 days and change GA Tracking ID (#20)

sohee-lee7 · web-flow · commit bdda85ce9b48 · 2018-12-05T16:12:56.000+09:00
* chore: reduce call of sendHostname * feat: sendHostname can works after 7 days * feat: change GA Tracking ID * fix: apply code review * fix: remove unused module * Revert "fix: remove unused module" This reverts commit 2d0542f. * Revert "fix: apply code review" This reverts commit af5a7ee. * fix: apply code review
diff --git a/src/js/request.js b/src/js/request.js
@@ -8,24 +8,47 @@
 var object = require('./object');
 var collection = require('./collection');
 var type = require('./type');
+var ms7days = 7 * 24 * 60 * 60 * 1000;
+
+/**
+ * Check if the date has passed 7 days
+ * @param {number} date - milliseconds
+ * @returns {boolean}
+ * @ignore
+ */
+function isExpired(date) {
+    var now = new Date().getTime();
+
+    return now - date > ms7days;
+}
 
 /**
  * Send hostname on DOMContentLoaded.
  * To prevent hostname set tui.usageStatistics to false.
- * @param {string} applicationId - application id to send
+ * @param {string} appName - application name
+ * @param {string} trackingId - GA tracking ID
  * @ignore
  */
-function sendHostname(applicationId) {
+function sendHostname(appName, trackingId) {
     var url = 'https://www.google-analytics.com/collect';
     var hostname = location.hostname;
     var hitType = 'event';
-    var trackingId = 'UA-115377265-9';
+    var eventCategory = 'use';
+    var applicationKeyForStorage = 'TOAST UI ' + appName + ' for ' + hostname + ': Statistics';
+    var date = window.localStorage.getItem(applicationKeyForStorage);
 
-    // skip only if the flag is defined and is set to false explicitly
+    // skip if the flag is defined and is set to false explicitly
     if (!type.isUndefined(window.tui) && window.tui.usageStatistics === false) {
         return;
     }
 
+    // skip if not pass seven days old
+    if (date && !isExpired(date)) {
+        return;
+    }
+
+    window.localStorage.setItem(applicationKeyForStorage, new Date().getTime());
+
     setTimeout(function() {
         if (document.readyState === 'interactive' || document.readyState === 'complete') {
             imagePing(url, {
@@ -34,7 +57,9 @@ function sendHostname(applicationId) {
                 tid: trackingId,
                 cid: hostname,
                 dp: hostname,
-                dh: applicationId
+                dh: appName,
+                el: appName,
+                ec: eventCategory
             });
         }
     }, 1000);
diff --git a/test/request.test.js b/test/request.test.js
@@ -29,6 +29,7 @@ describe('module:request', function() {
             // can not spy on imagePing. spy on appendChild instead.
             spyOn(document.body, 'appendChild');
             spyOn(document.body, 'removeChild');
+            spyOn(localStorage, 'getItem').and.returnValue(null);
         });
 
         it('should call appendChild', function(done) {
@@ -51,4 +52,46 @@ describe('module:request', function() {
             }, 1500);
         });
     });
+
+    describe('sendHostname with localstorage', function() {
+        beforeEach(function() {
+            window.tui = window.tui || {};
+
+            // can not spy on imagePing. spy on appendChild instead.
+            spyOn(document.body, 'appendChild');
+            spyOn(document.body, 'removeChild');
+        });
+
+        it('should not call appendChild within 7 days', function(done) {
+            var now = new Date().getTime();
+            var ms6days = 6 * 24 * 60 * 60 * 1000;
+
+            spyOn(localStorage, 'getItem').and.returnValue(now - ms6days);
+
+            window.tui.usageStatistics = true;
+
+            request.sendHostname('editor');
+
+            setTimeout(function() {
+                expect(document.body.appendChild).not.toHaveBeenCalled();
+                done();
+            }, 1500);
+        });
+
+        it('should call appendChild after 7 days', function(done) {
+            var now = new Date().getTime();
+            var ms8days = 8 * 24 * 60 * 60 * 1000;
+
+            spyOn(localStorage, 'getItem').and.returnValue(now - ms8days);
+
+            window.tui.usageStatistics = true;
+
+            request.sendHostname('editor');
+
+            setTimeout(function() {
+                expect(document.body.appendChild).toHaveBeenCalled();
+                done();
+            }, 1500);
+        });
+    });
 });
