Code to send Analytics Data to server (#14057)

* Code to send Analytics Data to server

* Addressing the review comments

* changes done to handle stage server and Prod Server

* changes done to define stage URL and Prod URL

* changes done to call analytics data server after health data server

* as server is change from Stage to Production ,environment variable needs to be changed to production

* Refactor code and cleanup

* Add force flag for testing and handle dev/stage or production enviroment

* Exposing command to explicitly test  health data sending  capability

* Handle stage environment

* Clean config json

* Correcting the sequence of call

Author: NehaModi

src/brackets.config.dev.json

@@ -1,3 +1,6 @@
 {
-    "healthDataServerURL"        : "https://healthdev.brackets.io/healthDataLog"
+    "healthDataServerURL"        : "https://healthdev.brackets.io/healthDataLog",
+    "analyticsDataServerURL"     : "https://cc-api-data-stage.adobe.io/ingest",
+    "serviceKey"                 : "brackets-service",
+    "environment"                : "stage"
 }

src/brackets.config.dist.json

@@ -1,3 +1,6 @@
 {
-    "healthDataServerURL"        : "https://health.brackets.io/healthDataLog"
+    "healthDataServerURL"     : "https://health.brackets.io/healthDataLog",
+    "analyticsDataServerURL"  : "https://cc-api-data.adobe.io/ingest",
+    "serviceKey"              : "brackets-service",
+    "environment"             : "production"
 }

src/config.json

@@ -20,7 +20,10 @@
         "extension_url": "https://s3.amazonaws.com/extend.brackets/{0}/{0}-{1}.zip",
         "linting.enabled_by_default": true,
         "build_timestamp": "",
-        "healthDataServerURL": "https://healthdev.brackets.io/healthDataLog"
+        "healthDataServerURL": "https://healthdev.brackets.io/healthDataLog",
+        "analyticsDataServerURL": "https://cc-api-data-stage.adobe.io/ingest",
+        "serviceKey": "brackets-service",
+        "environment": "stage"
     },
     "name": "Brackets",
     "version": "1.12.0-0",
@@ -96,4 +99,4 @@
             "url": "https://github.com/adobe/brackets/blob/master/LICENSE"
         }
     ]
-}
+}

src/extensions/default/HealthData/HealthDataManager.js

@@ -21,11 +21,11 @@
  *
  */
 
-/*global define, $, brackets,navigator, console, appshell */
+/*global define, $, brackets, console, appshell */
 define(function (require, exports, module) {
     "use strict";
-
     var AppInit             = brackets.getModule("utils/AppInit"),
+        CommandManager      = brackets.getModule("command/CommandManager"),
         HealthLogger        = brackets.getModule("utils/HealthLogger"),
         PreferencesManager  = brackets.getModule("preferences/PreferencesManager"),
         UrlParams           = brackets.getModule("utils/UrlParams").UrlParams,
@@ -59,7 +59,6 @@ define(function (require, exports, module) {
         oneTimeHealthData.bracketsLanguage = brackets.getLocale();
         oneTimeHealthData.bracketsVersion = brackets.metadata.version;
         $.extend(oneTimeHealthData, HealthLogger.getAggregatedHealthData());
-
         HealthDataUtils.getUserInstalledExtensions()
             .done(function (userInstalledExtensions) {
                 oneTimeHealthData.installedExtensions = userInstalledExtensions;
@@ -121,17 +120,42 @@ define(function (require, exports, module) {
 
                                 PreferencesManager.setViewState("UUID",      oneTimeHealthData.uuid);
                                 PreferencesManager.setViewState("OlderUUID", oneTimeHealthData.olderuuid);
-
                                 return result.resolve(oneTimeHealthData);
                             }
                         }
                     });
 
             });
-
         return result.promise();
     }
 
+    // Get Analytics data
+    function getAnalyticsData() {
+        var userUuid = PreferencesManager.getViewState("UUID"),
+            olderUuid = PreferencesManager.getViewState("OlderUUID");
+
+        return {
+            project: brackets.config.serviceKey,
+            environment: brackets.config.environment,
+            time: new Date().toISOString(),
+            ingesttype: "dunamis",
+            data: {
+                "event.guid": uuid.v4(),
+                "event.user_guid": olderUuid || userUuid,
+                "event.dts_end": new Date().toISOString(),
+                "event.category": "pingData",
+                "event.subcategory": "",
+                "event.type": "",
+                "event.subtype": "",
+                "event.user_agent": window.navigator.userAgent || "",
+                "event.language": brackets.app.language,
+                "source.name": brackets.metadata.version,
+                "source.platform": brackets.platform,
+                "source.version": brackets.metadata.version
+            }
+        };
+    }
+
     /**
      * Send data to the server
      */
@@ -165,13 +189,39 @@ define(function (require, exports, module) {
         return result.promise();
     }
 
+    // Send Analytics data to Server
+    function sendAnalyticsDataToServer() {
+        var result = new $.Deferred();
+
+        var analyticsData = getAnalyticsData();
+        $.ajax({
+            url: brackets.config.analyticsDataServerURL,
+            type: "POST",
+            data: JSON.stringify({events: [analyticsData]}),
+            headers: {
+                "Content-Type": "application/json",
+                "x-api-key": brackets.config.serviceKey
+            }
+        })
+            .done(function () {
+                result.resolve();
+            })
+            .fail(function (jqXHR, status, errorThrown) {
+                console.error("Error in sending Adobe Analytics Data. Response : " + jqXHR.responseText + ". Status : " + status + ". Error : " + errorThrown);
+                result.reject();
+            });
+
+        return result.promise();
+    }
+
     /*
      * Check if the Health Data is to be sent to the server. If the user has enabled tracking, Health Data will be sent once every 24 hours.
      * Send Health Data to the server if the period is more than 24 hours.
      * We are sending the data as soon as the user launches brackets. The data will be sent to the server only after the notification dialog
      * for opt-out/in is closed.
+     @param forceSend Flag for sending analytics data for testing purpose
      */
-    function checkHealthDataSend() {
+    function checkHealthDataSend(forceSend) {
         var result         = new $.Deferred(),
             isHDTracking   = prefs.get("healthDataTracking"),
             nextTimeToSend,
@@ -191,12 +241,11 @@ define(function (require, exports, module) {
                 // don't return yet though - still want to set the timeout below
             }
 
-            if (currentTime >= nextTimeToSend) {
-                // Bump up nextHealthDataSendTime now to avoid any chance of sending data again before 24 hours, e.g. if the server request fails
-                // or the code below crashes
+            if (currentTime >= nextTimeToSend || forceSend) {
+                // Bump up nextHealthDataSendTime at the begining of chaining to avoid any chance of sending data again before 24 hours, // e.g. if the server request fails or the code below crashes
                 PreferencesManager.setViewState("nextHealthDataSendTime", currentTime + ONE_DAY);
-
-                sendHealthDataToServer()
+                sendHealthDataToServer().always(function() {
+                    sendAnalyticsDataToServer()
                     .done(function () {
                         // We have already sent the health data, so can clear all health data
                         // Logged till now
@@ -209,7 +258,7 @@ define(function (require, exports, module) {
                     .always(function () {
                         timeoutVar = setTimeout(checkHealthDataSend, ONE_DAY);
                     });
-
+                });
             } else {
                 timeoutVar = setTimeout(checkHealthDataSend, nextTimeToSend - currentTime);
                 result.reject();
@@ -221,6 +270,15 @@ define(function (require, exports, module) {
         return result.promise();
     }
 
+    // Expose a command to test data sending capability, but limit it to dev environment only
+    CommandManager.register("Sends health data and Analytics data for testing purpose", "sendHealthData", function() {
+        if (brackets.config.environment === "stage") {
+            return checkHealthDataSend(true);
+        } else {
+            return $.Deferred().reject().promise();
+        }
+    });
+
     prefs.on("change", "healthDataTracking", function () {
         checkHealthDataSend();
     });
@@ -238,5 +296,6 @@ define(function (require, exports, module) {
     });
 
     exports.getHealthData = getHealthData;
+    exports.getAnalyticsData = getAnalyticsData;
     exports.checkHealthDataSend = checkHealthDataSend;
 });

src/extensions/default/HealthData/HealthDataPreview.js

@@ -45,7 +45,10 @@ define(function (require, exports, module) {
         var result = new $.Deferred();
 
         HealthDataManager.getHealthData().done(function (healthDataObject) {
-            var content = JSON.stringify(healthDataObject, null, 4);
+            var combinedHealthAnalyticsData = HealthDataManager.getAnalyticsData("pingData", "", "", ""),
+                content;
+            combinedHealthAnalyticsData = [healthDataObject, combinedHealthAnalyticsData ];
+            content = JSON.stringify(combinedHealthAnalyticsData, null, 4);
             content = _.escape(content);
             content = content.replace(/ /g, " ");
             content = content.replace(/(?:\r\n|\r|\n)/g, "<br />");