Merge pull request #412 from OneSignal/feature/vsp

Add VSP to 2.x.x and exclude from locally generated package

Author: adamschlesinger

OneSignalExample/Assets/OneSignal/Attribution.meta

@@ -0,0 +1,26 @@
+{
+  "name": "OneSignal.UnityPackage.Attribution",
+  "rootNamespace": "",
+  "references": [
+    "OneSignal.Core"
+  ],
+  "includePlatforms": [
+    "Android",
+    "Editor",
+    "iOS"
+  ],
+  "excludePlatforms": [],
+  "allowUnsafeCode": false,
+  "overrideReferences": false,
+  "precompiledReferences": [],
+  "autoReferenced": true,
+  "defineConstraints": [],
+  "versionDefines": [
+    {
+      "name": "com.onesignal.unity.core",
+      "expression": "0.0.1-preview",
+      "define": "ONE_SIGNAL_INSTALLED"
+    }
+  ],
+  "noEngineReferences": false
+}

OneSignalExample/Assets/OneSignal/Attribution/OneSignal.UnityPackage.Attribution.asmdef

@@ -0,0 +1,103 @@
+using System;
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.Analytics;
+
+namespace OneSignalSDK
+{
+	internal static class VspAttribution
+	{
+		const int k_MaxEventsPerHour = 1000;
+		const int k_MaxNumberOfElements = 1000;
+
+		const string k_VendorKey = "unity.vsp-attribution";
+		const string k_EventName = "vspAttribution";
+
+		static bool RegisterEvent()
+		{
+#if UNITY_EDITOR
+			AnalyticsResult result = EditorAnalytics.RegisterEventWithLimit(k_EventName, k_MaxEventsPerHour,
+				k_MaxNumberOfElements, k_VendorKey);
+#else // IF !UNITY_EDITOR
+			AnalyticsResult result = Analytics.RegisterEvent(k_EventName, k_MaxEventsPerHour,
+				k_MaxNumberOfElements, k_VendorKey);
+#endif
+
+			bool isResultOk = result == AnalyticsResult.Ok;
+			return isResultOk;
+		}
+
+		[Serializable]
+		struct VspAttributionData
+		{
+			public string actionName;
+			public string partnerName;
+			public string customerUid;
+			public string extra;
+		}
+
+		/// <summary>
+		/// Registers and attempts to send a VSP Attribution event.
+		/// </summary>
+		/// <param name="actionName">Name of the action, identifying a place this event was called from.</param>
+		/// <param name="partnerName">Identifiable Verified Solutions Partner name.</param>
+		/// <param name="customerUid">Unique identifier of the customer using Partner's Verified Solution.</param>
+		public static AnalyticsResult SendAttributionEvent(string actionName, string partnerName, string customerUid)
+		{
+			try
+			{
+#if UNITY_EDITOR
+				// Are Editor Analytics enabled ? (Preferences)
+				// The event shouldn't be able to report if this is disabled but if we know we're not going to report
+				// lets early out and not spend time gathering all the data
+				bool isEditorAnalyticsEnabled = EditorAnalytics.enabled;
+
+				if (!isEditorAnalyticsEnabled)
+					return AnalyticsResult.AnalyticsDisabled;
+#else // IF !UNITY_EDITOR
+				bool isRuntimeAnalyticsEnabled = Analytics.enabled;
+				
+				if (!isRuntimeAnalyticsEnabled)
+					return AnalyticsResult.AnalyticsDisabled;
+				
+				if (!Debug.isDebugBuild)
+					return AnalyticsResult.UnsupportedPlatform;
+#endif
+
+				// Can an event be registered?
+				bool isEventRegistered = RegisterEvent();
+				
+				if (!isEventRegistered)
+					return AnalyticsResult.InvalidData;
+
+				// Create an expected data object
+				var eventData = new VspAttributionData
+				{
+					actionName = actionName,
+					partnerName = partnerName,
+					customerUid = customerUid,
+					extra = "{}"
+				};
+
+#if UNITY_EDITOR
+				// Send the Attribution Event
+				var eventResult = EditorAnalytics.SendEventWithLimit(k_EventName, eventData);
+#else // IF !UNITY_EDITOR
+				var eventResult = Analytics.SendEvent(k_EventName, eventData);
+#endif
+				return eventResult;
+			}
+			catch
+			{
+				// Fail silently
+				return AnalyticsResult.AnalyticsDisabled;
+			}
+		}
+		
+#if ONE_SIGNAL_INSTALLED
+		[RuntimeInitializeOnLoadMethod]
+		public static void AttachToInit()
+			=> OneSignal.OnInitialize += appId => SendAttributionEvent("Login", "OneSignal", appId);
+#endif
+	}
+}

OneSignalExample/Assets/OneSignal/Attribution/OneSignal.UnityPackage.Attribution.asmdef.meta

@@ -13,6 +13,7 @@ MonoBehaviour:
   m_Name: OneSignalFileInventory
   m_EditorClassIdentifier: 
   DistributedPaths:
+  - Assets/OneSignal/Attribution.meta
   - Assets/OneSignal/CHANGELOG.md
   - Assets/OneSignal/CHANGELOG.md.meta
   - Assets/OneSignal/Editor.meta
@@ -23,6 +24,10 @@ MonoBehaviour:
   - Assets/OneSignal/README.md.meta
   - Assets/OneSignal/VERSION
   - Assets/OneSignal/VERSION.meta
+  - Assets/OneSignal/Attribution/OneSignal.UnityPackage.Attribution.asmdef
+  - Assets/OneSignal/Attribution/OneSignal.UnityPackage.Attribution.asmdef.meta
+  - Assets/OneSignal/Attribution/VSPAttribution.cs
+  - Assets/OneSignal/Attribution/VSPAttribution.cs.meta
   - Assets/OneSignal/Documentation~/asset_listing.png
   - Assets/OneSignal/Documentation~/menu_import_package.png
   - Assets/OneSignal/Documentation~/menu_import_package.png.meta

OneSignalExample/Assets/OneSignal/Attribution/VSPAttribution.cs

@@ -1,32 +1,46 @@
 using System.IO;
+using System.Linq;
 using UnityEditor;
-using UnityEditorInternal;
-using UnityEngine;
 
 /// <summary>
 /// Creates a unitypackage file for publishing
 /// </summary>
-public static class OneSignalPackagePublisher
-{
-    public static void UpdateProjectVersion()
-    {
-        var packageVersion = File.ReadAllText(_versionFilePath);
+public static class OneSignalPackagePublisher {
+    public static void UpdateProjectVersion() {
+        var packageVersion = File.ReadAllText(VersionFilePath);
         PlayerSettings.bundleVersion = packageVersion;
     }
 
-    public static void ExportUnityPackage()
-    {
+    [MenuItem("OneSignal/ExportUnityPackage")]
+    public static void ExportUnityPackage() {
         AssetDatabase.Refresh();
-        var packageVersion = File.ReadAllText(_versionFilePath);
+        var packageVersion = File.ReadAllText(VersionFilePath);
         var packageName = $"OneSignal-v{packageVersion}.unitypackage";
 
         AssetDatabase.ExportPackage(
-            _filesPath,
+            _filePaths(),
             packageName,
             ExportPackageOptions.Recurse | ExportPackageOptions.IncludeDependencies
         );
     }
 
-    private const string _versionFilePath = "Assets/OneSignal/VERSION";
-    private const string _filesPath = "Assets/OneSignal";
+    private static readonly string PackagePath = Path.Combine("Assets", "OneSignal");
+    private static readonly string VersionFilePath = Path.Combine(PackagePath, "VERSION");
+    
+    private static readonly string[] Exclusions = {
+        Path.Combine(PackagePath, "Attribution"),
+        ".DS_Store"
+    };
+
+    private static string[] _filePaths() {
+        var files = Directory.GetFileSystemEntries(PackagePath);
+        var pathsToInclude = files.Where(file => {
+            if (file.EndsWith(".meta"))
+                file = file.Substring(0, file.Length - 5);
+
+            return !Exclusions.Contains(file);
+        });
+
+        return pathsToInclude.ToArray();
+    }
 }

OneSignalExample/Assets/OneSignal/Attribution/VSPAttribution.cs.meta

@@ -3,3 +3,4 @@
 [assembly: InternalsVisibleTo("OneSignal.iOS")]
 [assembly: InternalsVisibleTo("OneSignal.Android")]
 [assembly: InternalsVisibleTo("OneSignal.Core.Editor")]
+[assembly: InternalsVisibleTo("OneSignal.UnityPackage.Attribution")]

OneSignalExample/Assets/OneSignal/Editor/Resources/OneSignalFileInventory.asset

@@ -383,6 +383,7 @@ public UnityBuilder Settings(Dictionary<string, bool> settings)
         public void EndInit()
         {
             Init();
+            OnInitialize?.Invoke(appID);
         }
 
         /// <summary>
@@ -400,6 +401,8 @@ public UnityBuilder SetRequiresUserPrivacyConsent(bool required)
         }
     }
 
+
+    internal static event Action<string> OnInitialize;
     internal static UnityBuilder builder = null;
 
     /// <summary>