Merge pull request #336 from OneSignal/fix/onesignal_config_rename_on_upgrade

Rename OneSignalConfig -> OneSignalConfig.plugin via an editor script - Fix up to PR #335

Author: jkasten2

OneSignalExample/.gitignore

@@ -61,4 +61,4 @@ Assets/Root
 
 /ProjectSettings/GoogleDependencyOneSignal.xml
 
-/Assets/Plugins/Android/OneSignalConfig/AndroidManifest.xml*
+**/OneSignalConfig.plugin/AndroidManifest.xml*

OneSignalExample/Assets/OneSignal/Editor/OSUnityEditorUtils.cs

@@ -0,0 +1,34 @@
+using System;
+using System.IO;
+
+using UnityEditor;
+using UnityEngine;
+
+internal class OSUnityEditorUtils {
+
+    // Searches for a list of file names accross the whole Unity project and provides
+    // the the GUID of the first found result.
+    internal static string FindFirstFileGUIDByName(String[] filenames) {
+        foreach (var filename in filenames) {
+            var pathGUIDs = AssetDatabase.FindAssets(filename);
+            if (pathGUIDs.Length > 0)
+                return pathGUIDs[0];
+        }
+        return null;
+    }
+
+    internal static void AppendFileExtensionIfMissing(string pathedFile, string extension) {
+        if (pathedFile == null) {
+            Debug.LogError($"AppendFileExtensionIfMissing: pathedFile can not be null");
+            return;
+        }
+
+        var pathParts = pathedFile.Split(Path.DirectorySeparatorChar);
+        var fileName = pathParts[pathParts.Length - 1];
+        if (!fileName.Contains("." + extension)) {
+            var result = AssetDatabase.MoveAsset(pathedFile, $"{pathedFile}.{extension}");
+            if (!String.IsNullOrEmpty(result))
+                Debug.LogError($"Could not add '.{extension}' to '{pathedFile}' due to error: {result}");
+        }
+    }
+}

OneSignalExample/Assets/OneSignal/Editor/OSUnityEditorUtils.cs.meta

@@ -32,22 +32,14 @@
 using OneSignalPush.MiniJSON;
 using System.Collections;
 
-#if !UNITY_CLOUD_BUILD && UNITY_EDITOR && UNITY_2017_1_OR_NEWER
-
-[InitializeOnLoad]
-public class OneSignalEditorCheckUpdateScript : AssetPostprocessor
+internal class OneSignalEditorCheckUpdateScript
 {
    //this key is used for the current unity session only
    public static string sessionState = "onesignal_checked_update";
 
    static OneSignalUpdateRequest request;
 
-   static OneSignalEditorCheckUpdateScript()
-   {
-      Request();
-   }
-
-   static void Request()
+   internal static void Request()
    {
       //if the SDK already checked for an update during this session, no need to do so again
       if (SessionState.GetBool(sessionState, false)) {
@@ -127,6 +119,4 @@ IEnumerator FetchCurrentVersion(string url)
 
       yield break;
    }
-}
-
-#endif
+}

OneSignalExample/Assets/OneSignal/Editor/OneSignalEditorCheckUpdateScript.cs

@@ -0,0 +1,16 @@
+#if UNITY_EDITOR
+using UnityEditor;
+
+[InitializeOnLoad]
+public class OneSignalEditorScriptInit : AssetPostprocessor {
+    static OneSignalEditorScriptInit() {
+        OneSignalFileStructureUpgrade.DoUpgrade();
+        #if UNITY_ANDROID
+        OneSignalEditorScriptAndroid.createOneSignalAndroidManifest();
+        #endif
+        #if !UNITY_CLOUD_BUILD && UNITY_2017_1_OR_NEWER
+        OneSignalEditorCheckUpdateScript.Request();
+        #endif
+    }
+}
+#endif

OneSignalExample/Assets/OneSignal/Editor/OneSignalEditorScriptInit.cs

@@ -33,17 +33,12 @@
 #if UNITY_ANDROID && UNITY_EDITOR
 using System.Collections.Generic;
 
-[InitializeOnLoad]
-public class OneSignalEditorScriptAndroid : AssetPostprocessor {
+internal class OneSignalEditorScriptAndroid {
 
-   static OneSignalEditorScriptAndroid() {
-      createOneSignalAndroidManifest();
-   }
-   
    // Copies `AndroidManifestTemplate.xml` to `AndroidManifest.xml`
    //   then replace `${manifestApplicationId}` with current packagename in the Unity settings.
-   private static void createOneSignalAndroidManifest() {
-      string oneSignalConfigPath = "Assets/Plugins/Android/OneSignalConfig.plugin/";
+   internal static void createOneSignalAndroidManifest() {
+      var oneSignalConfigPath = OneSignalFileLocator.GetOneSignalConfigFolderNameWithPath() + "/";
       string manifestFullPath = oneSignalConfigPath + "AndroidManifest.xml";
 
       File.Copy(oneSignalConfigPath + "AndroidManifestTemplate.xml", manifestFullPath, true);

OneSignalExample/Assets/OneSignal/Editor/OneSignalEditorScriptInit.cs.meta

@@ -0,0 +1,60 @@
+using System;
+
+using UnityEditor;
+using UnityEngine;
+
+internal class OneSignalFileLocator {
+
+    // Returns the full path of the OneSignalConfig folder.
+    // The folder contains a AndroidManifest.xml file which is required
+    // for Android push notifications to be received by the app.
+    internal static string GetOneSignalConfigFolderNameWithPath() {
+        var guid = GetOneSignalConfigGUID();
+        if (guid != null)
+            return AssetDatabase.GUIDToAssetPath(guid);
+
+        Debug.LogError($"OneSignal could not find required OneSignalConfig folder, push notifications will NOT display on Android!");
+        return null;
+    }
+
+    private static string GetOneSignalConfigGUID() {
+        // 1. Attempt to get GUID for folder
+        //    - This will be successful unless the Unity Dev deletes the matching .meta file or
+        //    moves the folder outside of Unity.
+        var guid = GetOneSignalConfigGUIDIfAvailable();
+        if (guid != null)
+            return guid;
+       
+        Debug.Log($"Didn't find '{FOLDER_NAME_V1_ONESIGNAL_CONFIG_NAME}' by GUID '{FOLDER_GUID_ONESIGNAL_CONFIG}', seaching by name.");
+    
+        // 2. Attempt by name if GUID look up fails
+        return GetOneSignalConfigGUIDByName();
+    }
+
+    // This is a static GUID defined in the OneSignalConfig.plugin.meta file in this repo.
+    private static readonly string FOLDER_GUID_ONESIGNAL_CONFIG = "4913d3bd89f197541850fb5382f2456d";
+    // Only provides GUID if it is found in project
+    private static string GetOneSignalConfigGUIDIfAvailable() {
+        var path = AssetDatabase.GUIDToAssetPath(FOLDER_GUID_ONESIGNAL_CONFIG);
+        if (!String.IsNullOrEmpty(path))
+            return FOLDER_GUID_ONESIGNAL_CONFIG;
+        return null;
+    }
+
+    private static readonly string FOLDER_NAME_V1_ONESIGNAL_CONFIG_NAME = "OneSignalConfig";
+    private static readonly string FOLDER_NAME_V2_ONESIGNAL_CONFIG_NAME = "OneSignalConfig.plugin";
+    private static readonly string[] FOLDER_NAME_ONESIGNAL_CONFIG_NAMES = new String[] {
+        FOLDER_NAME_V2_ONESIGNAL_CONFIG_NAME,
+        FOLDER_NAME_V1_ONESIGNAL_CONFIG_NAME
+    };
+    // Returns GUID of first found folder by name, null if not found.
+    private static string GetOneSignalConfigGUIDByName() {
+        var guid = OSUnityEditorUtils.FindFirstFileGUIDByName(FOLDER_NAME_ONESIGNAL_CONFIG_NAMES);
+        if (guid != null)
+            return guid;
+
+        var folderNames = String.Join(",", FOLDER_NAME_ONESIGNAL_CONFIG_NAMES);
+        Debug.LogError($"OneSignal - Could not find required Android folder from list of names; '{folderNames}'");
+        return null;
+    }
+}

OneSignalExample/Assets/OneSignal/Editor/OneSignalEditorScript_Android.cs

@@ -0,0 +1,27 @@
+#if UNITY_EDITOR
+
+// Add any files or folders that need to be rename, moved, or deleted in
+// as part of the process when updating this SDK.
+internal class OneSignalFileStructureUpgrade {
+
+   internal static void DoUpgrade() {
+      UpgradeToSDKVersion2_13_3();
+   }
+
+   private static void UpgradeToSDKVersion2_13_3() {
+      #if UNITY_ANDROID
+      RenameAndroidOneSignalConfig();
+      #endif
+   }
+
+   // This renames the folder "OneSignalConfig" to "OneSignal.plugin".
+   // ".plugin" is Unity documented folder post-fix required for some plugins features.
+   //    - This is required to fix Unity 2020+ capability.
+   // This is done via a script since .unitypackage files do not support renaming
+   // and so this is required for those upgrading from an older version of the SDK.
+   private static void RenameAndroidOneSignalConfig() {
+      var path = OneSignalFileLocator.GetOneSignalConfigFolderNameWithPath();
+      OSUnityEditorUtils.AppendFileExtensionIfMissing(path, "plugin");
+   }
+}
+#endif

OneSignalExample/Assets/OneSignal/Editor/OneSignalFileLocator.cs

@@ -17,7 +17,7 @@ temp_location=$(pwd)/onesignal_temp
 icons_location=$project_path/Assets/AppIcons
 icons_temp_location=$(pwd)/onesignal_temp/tempAppIcons
 android_location=$project_path/Assets/Plugins/Android
-config_location=$android_location/OneSignalConfig
+config_location=$android_location/OneSignalConfig.plugin
 package_manifest=$project_path/Packages/manifest.json
 temp_package_manifest=$temp_location/Packages/manifest.json
 
@@ -40,16 +40,16 @@ mv $icons_location.meta $icons_temp_location.meta
 # This removes any .aar files we don't want to bundle in our package
 
 # temporarily move some necessary files
-mv $config_location $temp_location/OneSignalConfig
-mv $config_location.meta $temp_location/OneSignalConfig.meta
+mv $config_location $temp_location/OneSignalConfig.plugin
+mv $config_location.meta $temp_location/OneSignalConfig.plugin.meta
 
 # get rid of a bunch of unnecessary files
 rm -r $android_location
 mkdir $android_location
 
 # put the config files back
-mv $temp_location/OneSignalConfig $config_location
-mv $temp_location/OneSignalConfig.meta $config_location.meta
+mv $temp_location/OneSignalConfig.plugin $config_location
+mv $temp_location/OneSignalConfig.plugin.meta $config_location.meta
 
 ## END - Clean Android files