Merge pull request #757 from Autodesk/analytics

MattMoradi · web-flow · commit 8244fbd5ff82 · 2021-08-29T21:17:15.000-07:00
Analytics Implementation
diff --git a/engine/Assets/EditModeTests/AnalyticsTest.cs b/engine/Assets/EditModeTests/AnalyticsTest.cs
@@ -7,7 +7,7 @@ public class AnalyticsTest
 {
     [Test]
     public void EventTest() {
-        var data = new AnalyticsEvent(category: "dog", action: "bark", value: "9"); 
+        var data = new AnalyticsEvent(category: "dog", action: "bark", label: "9"); 
         AnalyticsManager.LogEvent(data);
         AnalyticsManager.PostData();
         
diff --git a/engine/Assets/Scripts/AnalyticsManager.cs b/engine/Assets/Scripts/AnalyticsManager.cs
@@ -3,7 +3,6 @@
 
 public static class AnalyticsManager
 {
-
     private static string AllData = "";
 
     public const string TRACKING_ID = "UA-81892961-6";
@@ -58,29 +57,35 @@ public struct PostResult {
         public bool usedBatchUrl;
         public string result;
     }
-
 }
 
-
-
 public interface IAnalytics
 {
     public string GetPostData();
 }
 public class AnalyticsEvent : IAnalytics
 {
 
-    public string Category, Value, Action;
+    public string Category, Value, Action, Label;
 
+    public AnalyticsEvent(string category, string action, string label)
+    {
+        Category = category;
+        Action = action;
+        Label = label;
+    }
+
+    /*
     public AnalyticsEvent(string category, string action, string value)
     {
         Category = category;
         Action = action;
         Value = value;
     }
+    */
 
     public string GetPostData()
-        => $"t=event&ec={Category}&ea={Action}&ev={Value}";
+        => $"t=event&ec={Category}&ea={Action}&el={Label}";
 }
 
 public class AnalyticsScreenView : IAnalytics
@@ -118,6 +123,5 @@ public AnalyticsLogTiming(string category, string vari, string label, int time)
     }
 
     public string GetPostData() => $"t=timing&utc={Category}&utv={Vari}&utt={Time.ToString()}&utl={Label}";
-
 }
 
diff --git a/engine/Assets/Scripts/AutoUpdater.cs b/engine/Assets/Scripts/AutoUpdater.cs
@@ -13,7 +13,7 @@
 public class AutoUpdater : MonoBehaviour
 {
     // public static string updater;
-    public const string LocalVersion = "5.0.0.0";
+    public const string LocalVersion = "5.0.0.0"; // must be a version value
     public GameObject updaterPanelPrefab;
 
     // Start is called before the first frame update
@@ -24,6 +24,11 @@ void Start()
         Debug.Log($"Version {LocalVersion} Beta");
         // game = GameObject.Find("UpdatePrompt");
 
+        // Analytics For Client Startup
+        var init = new AnalyticsEvent(category: "Startup", action: "Launched", label: $"Version {LocalVersion} BETA");
+        AnalyticsManager.LogEvent(init);
+        AnalyticsManager.PostData();
+
         if (CheckConnection())
         {
             WebClient client = new WebClient();
diff --git a/engine/Assets/Scripts/TestAnalytics.cs b/engine/Assets/Scripts/TestAnalytics.cs
diff --git a/engine/Assets/Scripts/TestAnalytics.cs.meta b/engine/Assets/Scripts/TestAnalytics.cs.meta
diff --git a/engine/Assets/Scripts/UI/NavigationBar.cs b/engine/Assets/Scripts/UI/NavigationBar.cs
@@ -22,6 +22,8 @@ public class NavigationBar : MonoBehaviour
 
         public NavigationBar navBarPrefab;
 
+        private string lastOpenedPanel;
+
         private void Start() {
             VersionNumber.text = $"v {AutoUpdater.LocalVersion} BETA";
             OpenTab(homeTab);
@@ -31,7 +33,13 @@ public void Exit() {
             if (Application.isEditor)
                 Debug.Log("Would exit, but it's editor mode");
             else
+            {
+                var update = new AnalyticsEvent(category: "Exit", action: "Closed", label: $"Closed Synthesis");
+                AnalyticsManager.LogEvent(update);
+                AnalyticsManager.PostData();
+
                 Application.Quit();
+            }
         }
         private void Update()
         {
@@ -41,6 +49,13 @@ private void Update()
             }
         }
 
+        public void PanelAnalytics(string prefabName, string status)
+        {
+            var panel = new AnalyticsEvent(category: "Panel", action: status, label: prefabName);
+            AnalyticsManager.LogEvent(panel);
+            AnalyticsManager.PostData();
+        }
+
         public void OpenPanel(GameObject prefab)
         {
             if(prefab!=null){
@@ -51,12 +66,18 @@ public void OpenPanel(GameObject prefab)
                 //set current panel button to the button clicked
                 _currentPanelButton = EventSystem.current.currentSelectedGameObject;
                 changePanelButton(artifaktBold,new Color(0.8705882f,0.8705882f,0.8705882f,1));
+
+                // Analytics Stuff
+                lastOpenedPanel = prefab.name; // this will need to be an array for movable panels
+                PanelAnalytics(prefab.name, "Opened");
             }
         }
         public void CloseAllPanels()
         {
             LayoutManager.ClosePanel();
             if(_currentPanelButton!=null) changePanelButton(artifaktRegular,new Color(1,1,1,1));
+
+            PanelAnalytics(lastOpenedPanel, "Closed");
         }
         private void changePanelButton(TMP_FontAsset f, Color c){ //changes color and font of the clicked button    
             //set font
@@ -92,7 +113,5 @@ private void changeTabButton(TMP_FontAsset f, float underlineHeight, Color c){
             Image img = underline.GetComponent<Image>();
             img.color = c;//color
         }
-
-
     }
 }
diff --git a/engine/Assets/Scripts/UI/Panels/Variants/AddPanel/AddItem.cs b/engine/Assets/Scripts/UI/Panels/Variants/AddPanel/AddItem.cs
@@ -15,14 +15,23 @@ public class AddItem : MonoBehaviour
     GameObject p;
     private bool _isRobot;
 
+    private void ItemAnalytics(string item)
+    {
+        var update = new AnalyticsEvent(category: $"{item}", action: "Loaded", label: $"{item} Loaded");
+        AnalyticsManager.LogEvent(update);
+        AnalyticsManager.PostData();
+    }    
+
     public void AddModel(bool reverseSideMotors)
     {
         ModelManager.AddModel(_fullPath, reverseSideMotors);
+        ItemAnalytics("Robot");
     }
 
     public void AddField()
     {
         ModelManager.SetField(_fullPath);
+        ItemAnalytics("Field");
     }
 
     public void Init(string name, string path)
diff --git a/engine/Assets/Scripts/UI/Panels/Variants/AddPanel/AddPanel.cs b/engine/Assets/Scripts/UI/Panels/Variants/AddPanel/AddPanel.cs
@@ -80,7 +80,6 @@ public void LoadField()
             }
         }
 
-
         void Start()
         {
             _root = ParsePath(Path.Combine("$appdata/Autodesk/Synthesis", Folder), '/');
@@ -117,7 +116,6 @@ private void ShowDirectory(string filePath)
                         ParsePath(path, '\\'));
                 }
             }
-
         }
 
         private string ParsePath(string p, char c)
@@ -141,7 +139,5 @@ private string ParsePath(string p, char c)
             // Debug.Log(b);
             return b;
         }
-
-
     }
 }
diff --git a/engine/Assets/Scripts/UI/Panels/Variants/Settings/SettingsPanel.cs b/engine/Assets/Scripts/UI/Panels/Variants/Settings/SettingsPanel.cs
@@ -68,7 +68,6 @@ void Start()
             DisplaySettings();
         }
 
-
         public void disableSaveButton()
         {
             saveButton.GetComponent<Image>().color = disabledColor;
@@ -109,14 +108,16 @@ private void DisplaySettings()
             setup = false;
         }
 
-
-
         public void SaveSettings()
         {//writes settings back into preference manager when save button is clicked
             Save();
             LoadSettings();
             disableSaveButton();
             RepopulatePanel();
+
+            var update = new AnalyticsEvent(category: "Settings", action: "Saved", label: $"Saved Settings");
+            AnalyticsManager.LogEvent(update);
+            AnalyticsManager.PostData();
         }
         public void onValueChanged(SettingsInput si)
         {
@@ -177,13 +178,21 @@ public override void Close()
         {
             Save();
             base.Close();
+
+            var update = new AnalyticsEvent(category: "Settings", action: "Closed", label: $"Closed Settings");
+            AnalyticsManager.LogEvent(update);
+            AnalyticsManager.PostData();
         }
 
         public void ResetSettings()
         {
             SetDefaultPreferences();
             LoadSettings();
             RepopulatePanel();
+
+            var update = new AnalyticsEvent(category: "Settings", action: "Reset", label: $"Reset Settings");
+            AnalyticsManager.LogEvent(update);
+            AnalyticsManager.PostData();
         }
         private void SetMaxResolution()
         {
diff --git a/engine/Assets/Scripts/UI/Panels/Variants/UpdatePromptPanel.cs b/engine/Assets/Scripts/UI/Panels/Variants/UpdatePromptPanel.cs
@@ -10,11 +10,32 @@ public class UpdatePromptPanel: Panel {
         public string UpdaterLink = string.Empty;
 
         public void Agreed() {
+
+            bool updateAgreed = false;
+
             if (UpdaterLink == string.Empty)
+            {
                 Debug.LogWarning("No updater link provided");
+            }
             else
+            {
+                updateAgreed = true;
+
                 Process.Start(UpdaterLink);
 
+                var update = new AnalyticsEvent(category: "Startup", action: "Update Prompted", label: $"Update Agreed");
+                AnalyticsManager.LogEvent(update);
+            }
+
+            if(updateAgreed == false)
+            {
+                Debug.Log("Update Declined");
+                var update = new AnalyticsEvent(category: "Startup", action: "Update Prompted", label: $"Update Declined");
+                AnalyticsManager.LogEvent(update);
+            }
+
+            AnalyticsManager.PostData();
+
             if (Application.isEditor)
                 Debug.Log("Would exit, but it's editor mode");
             else

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ public class AnalyticsTest`
`7`	`7`	`{`
`8`	`8`	`[Test]`
`9`	`9`	`public void EventTest() {`
`10`		`- var data = new AnalyticsEvent(category: "dog", action: "bark", value: "9");`
	`10`	`+ var data = new AnalyticsEvent(category: "dog", action: "bark", label: "9");`
`11`	`11`	`AnalyticsManager.LogEvent(data);`
`12`	`12`	`AnalyticsManager.PostData();`
`13`	`13`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@`
`3`	`3`
`4`	`4`	`public static class AnalyticsManager`
`5`	`5`	`{`
`6`		`-`
`7`	`6`	`private static string AllData = "";`
`8`	`7`
`9`	`8`	`public const string TRACKING_ID = "UA-81892961-6";`
`@@ -58,29 +57,35 @@ public struct PostResult {`
`58`	`57`	`public bool usedBatchUrl;`
`59`	`58`	`public string result;`
`60`	`59`	`}`
`61`		`-`
`62`	`60`	`}`
`63`	`61`
`64`		`-`
`65`		`-`
`66`	`62`	`public interface IAnalytics`
`67`	`63`	`{`
`68`	`64`	`public string GetPostData();`
`69`	`65`	`}`
`70`	`66`	`public class AnalyticsEvent : IAnalytics`
`71`	`67`	`{`
`72`	`68`
`73`		`- public string Category, Value, Action;`
	`69`	`+ public string Category, Value, Action, Label;`
`74`	`70`
	`71`	`+ public AnalyticsEvent(string category, string action, string label)`
	`72`	`+ {`
	`73`	`+ Category = category;`
	`74`	`+ Action = action;`
	`75`	`+ Label = label;`
	`76`	`+ }`
	`77`	`+`
	`78`	`+ /*`
`75`	`79`	`public AnalyticsEvent(string category, string action, string value)`
`76`	`80`	`{`
`77`	`81`	`Category = category;`
`78`	`82`	`Action = action;`
`79`	`83`	`Value = value;`
`80`	`84`	`}`
	`85`	`+ */`
`81`	`86`
`82`	`87`	`public string GetPostData()`
`83`		`- => $"t=event&ec={Category}&ea={Action}&ev={Value}";`
	`88`	`+ => $"t=event&ec={Category}&ea={Action}&el={Label}";`
`84`	`89`	`}`
`85`	`90`
`86`	`91`	`public class AnalyticsScreenView : IAnalytics`
`@@ -118,6 +123,5 @@ public AnalyticsLogTiming(string category, string vari, string label, int time)`
`118`	`123`	`}`
`119`	`124`
`120`	`125`	`public string GetPostData() => $"t=timing&utc={Category}&utv={Vari}&utt={Time.ToString()}&utl={Label}";`
`121`		`-`
`122`	`126`	`}`
`123`	`127`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@ public class NavigationBar : MonoBehaviour`
`22`	`22`
`23`	`23`	`public NavigationBar navBarPrefab;`
`24`	`24`
	`25`	`+ private string lastOpenedPanel;`
	`26`	`+`
`25`	`27`	`private void Start() {`
`26`	`28`	`VersionNumber.text = $"v {AutoUpdater.LocalVersion} BETA";`
`27`	`29`	`OpenTab(homeTab);`
`@@ -31,7 +33,13 @@ public void Exit() {`
`31`	`33`	`if (Application.isEditor)`
`32`	`34`	`Debug.Log("Would exit, but it's editor mode");`
`33`	`35`	`else`
	`36`	`+ {`
	`37`	`+ var update = new AnalyticsEvent(category: "Exit", action: "Closed", label: $"Closed Synthesis");`
	`38`	`+ AnalyticsManager.LogEvent(update);`
	`39`	`+ AnalyticsManager.PostData();`
	`40`	`+`
`34`	`41`	`Application.Quit();`
	`42`	`+ }`
`35`	`43`	`}`
`36`	`44`	`private void Update()`
`37`	`45`	`{`
`@@ -41,6 +49,13 @@ private void Update()`
`41`	`49`	`}`
`42`	`50`	`}`
`43`	`51`
	`52`	`+ public void PanelAnalytics(string prefabName, string status)`
	`53`	`+ {`
	`54`	`+ var panel = new AnalyticsEvent(category: "Panel", action: status, label: prefabName);`
	`55`	`+ AnalyticsManager.LogEvent(panel);`
	`56`	`+ AnalyticsManager.PostData();`
	`57`	`+ }`
	`58`	`+`
`44`	`59`	`public void OpenPanel(GameObject prefab)`
`45`	`60`	`{`
`46`	`61`	`if(prefab!=null){`
`@@ -51,12 +66,18 @@ public void OpenPanel(GameObject prefab)`
`51`	`66`	`//set current panel button to the button clicked`
`52`	`67`	`_currentPanelButton = EventSystem.current.currentSelectedGameObject;`
`53`	`68`	`changePanelButton(artifaktBold,new Color(0.8705882f,0.8705882f,0.8705882f,1));`
	`69`	`+`
	`70`	`+ // Analytics Stuff`
	`71`	`+ lastOpenedPanel = prefab.name; // this will need to be an array for movable panels`
	`72`	`+ PanelAnalytics(prefab.name, "Opened");`
`54`	`73`	`}`
`55`	`74`	`}`
`56`	`75`	`public void CloseAllPanels()`
`57`	`76`	`{`
`58`	`77`	`LayoutManager.ClosePanel();`
`59`	`78`	`if(_currentPanelButton!=null) changePanelButton(artifaktRegular,new Color(1,1,1,1));`
	`79`	`+`
	`80`	`+ PanelAnalytics(lastOpenedPanel, "Closed");`
`60`	`81`	`}`
`61`	`82`	`private void changePanelButton(TMP_FontAsset f, Color c){ //changes color and font of the clicked button`
`62`	`83`	`//set font`
`@@ -92,7 +113,5 @@ private void changeTabButton(TMP_FontAsset f, float underlineHeight, Color c){`
`92`	`113`	`Image img = underline.GetComponent<Image>();`
`93`	`114`	`img.color = c;//color`
`94`	`115`	`}`
`95`		`-`
`96`		`-`
`97`	`116`	`}`
`98`	`117`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,14 +15,23 @@ public class AddItem : MonoBehaviour`
`15`	`15`	`GameObject p;`
`16`	`16`	`private bool _isRobot;`
`17`	`17`
	`18`	`+ private void ItemAnalytics(string item)`
	`19`	`+ {`
	`20`	`+ var update = new AnalyticsEvent(category: $"{item}", action: "Loaded", label: $"{item} Loaded");`
	`21`	`+ AnalyticsManager.LogEvent(update);`
	`22`	`+ AnalyticsManager.PostData();`
	`23`	`+ }`
	`24`	`+`
`18`	`25`	`public void AddModel(bool reverseSideMotors)`
`19`	`26`	`{`
`20`	`27`	`ModelManager.AddModel(_fullPath, reverseSideMotors);`
	`28`	`+ ItemAnalytics("Robot");`
`21`	`29`	`}`
`22`	`30`
`23`	`31`	`public void AddField()`
`24`	`32`	`{`
`25`	`33`	`ModelManager.SetField(_fullPath);`
	`34`	`+ ItemAnalytics("Field");`
`26`	`35`	`}`
`27`	`36`
`28`	`37`	`public void Init(string name, string path)`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,6 @@ public void LoadField()`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`
`83`		`-`
`84`	`83`	`void Start()`
`85`	`84`	`{`
`86`	`85`	`_root = ParsePath(Path.Combine("$appdata/Autodesk/Synthesis", Folder), '/');`
`@@ -117,7 +116,6 @@ private void ShowDirectory(string filePath)`
`117`	`116`	`ParsePath(path, '\\'));`
`118`	`117`	`}`
`119`	`118`	`}`
`120`		`-`
`121`	`119`	`}`
`122`	`120`
`123`	`121`	`private string ParsePath(string p, char c)`
`@@ -141,7 +139,5 @@ private string ParsePath(string p, char c)`
`141`	`139`	`// Debug.Log(b);`
`142`	`140`	`return b;`
`143`	`141`	`}`
`144`		`-`
`145`		`-`
`146`	`142`	`}`
`147`	`143`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,6 @@ void Start()`
`68`	`68`	`DisplaySettings();`
`69`	`69`	`}`
`70`	`70`
`71`		`-`
`72`	`71`	`public void disableSaveButton()`
`73`	`72`	`{`
`74`	`73`	`saveButton.GetComponent<Image>().color = disabledColor;`
`@@ -109,14 +108,16 @@ private void DisplaySettings()`
`109`	`108`	`setup = false;`
`110`	`109`	`}`
`111`	`110`
`112`		`-`
`113`		`-`
`114`	`111`	`public void SaveSettings()`
`115`	`112`	`{//writes settings back into preference manager when save button is clicked`
`116`	`113`	`Save();`
`117`	`114`	`LoadSettings();`
`118`	`115`	`disableSaveButton();`
`119`	`116`	`RepopulatePanel();`
	`117`	`+`
	`118`	`+ var update = new AnalyticsEvent(category: "Settings", action: "Saved", label: $"Saved Settings");`
	`119`	`+ AnalyticsManager.LogEvent(update);`
	`120`	`+ AnalyticsManager.PostData();`
`120`	`121`	`}`
`121`	`122`	`public void onValueChanged(SettingsInput si)`
`122`	`123`	`{`
`@@ -177,13 +178,21 @@ public override void Close()`
`177`	`178`	`{`
`178`	`179`	`Save();`
`179`	`180`	`base.Close();`
	`181`	`+`
	`182`	`+ var update = new AnalyticsEvent(category: "Settings", action: "Closed", label: $"Closed Settings");`
	`183`	`+ AnalyticsManager.LogEvent(update);`
	`184`	`+ AnalyticsManager.PostData();`
`180`	`185`	`}`
`181`	`186`
`182`	`187`	`public void ResetSettings()`
`183`	`188`	`{`
`184`	`189`	`SetDefaultPreferences();`
`185`	`190`	`LoadSettings();`
`186`	`191`	`RepopulatePanel();`
	`192`	`+`
	`193`	`+ var update = new AnalyticsEvent(category: "Settings", action: "Reset", label: $"Reset Settings");`
	`194`	`+ AnalyticsManager.LogEvent(update);`
	`195`	`+ AnalyticsManager.PostData();`
`187`	`196`	`}`
`188`	`197`	`private void SetMaxResolution()`
`189`	`198`	`{`