chore: [SDK-4406] prepare Unity demo app for Appium E2E tests (#869)

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: fadi-george

com.onesignal.unity.android/Editor/OneSignalConfig.androidlib/consumer-proguard.pro

@@ -1,4 +1,4 @@
 -keep class com.onesignal.** { *; }
 
 # Work around for IllegalStateException with kotlinx-coroutines-android
--keep class kotlinx.coroutines.android.AndroidDispatcherFactory {*;}
+-keep class kotlinx.coroutines.android.AndroidDispatcherFactory {*;}

com.onesignal.unity.android/Editor/OneSignalConfig.androidlib/src/main/res/raw/notification.wav

@@ -1 +1,8 @@
+# Default App ID (used when ONESIGNAL_APP_ID is empty or missing): 77e32082-ea27-42e3-a898-c72e141824ef
+ONESIGNAL_APP_ID=your-onesignal-app-id
 ONESIGNAL_API_KEY=your_rest_api_key
+E2E_MODE=false
+
+# Optional: Android Notification Channel ID for the WITH SOUND test notification.
+# Create one in your OneSignal dashboard under Settings > Android Notification Categories.
+ONESIGNAL_ANDROID_CHANNEL_ID=

com.onesignal.unity.android/Editor/OneSignalConfig.androidlib/src/main/res/raw/notification.wav.meta

@@ -34,6 +34,7 @@
 using UnityEditor.iOS.Xcode.Extensions;
 using System.IO;
 using System.Linq;
+using System.Text.RegularExpressions;
 
 namespace App.Editor.iOS
 {
@@ -53,6 +54,9 @@ public class BuildPostProcessor : IPostprocessBuildWithReport
             "OneSignalWidgetLiveActivity.swift",
         };
 
+        private static readonly string SoundsSourceDir = Path.Combine("iOS", "Sounds");
+        private static readonly string[] CustomSoundFiles = new string[] { "vine_boom.wav" };
+
         /// <summary>
         /// must be between 40 and 50 to ensure that it's not overriden by Podfile generation (40) and that it's
         /// added before "pod install" (50)
@@ -76,6 +80,7 @@ public void OnPostprocessBuild(BuildReport report)
 
             EnableAppForLiveActivities(report.summary.outputPath);
             CreateWidgetExtension(report.summary.outputPath);
+            AddCustomSoundsToMainTarget(report.summary.outputPath);
 
             Debug.Log("BuildPostProcessor.OnPostprocessBuild complete");
         }
@@ -102,6 +107,43 @@ static void CreateWidgetExtension(string outputPath)
             AddWidgetExtensionToPodFile(outputPath);
         }
 
+        /// <summary>
+        /// Copies bundled .wav files into the Xcode project and registers them on the main
+        /// target's Resources build phase so `ios_sound` payload values resolve to a real
+        /// `UNNotificationSound` resource in the .app bundle.
+        /// </summary>
+        static void AddCustomSoundsToMainTarget(string outputPath)
+        {
+            var project = new PBXProject();
+            var projectPath = PBXProject.GetPBXProjectPath(outputPath);
+            project.ReadFromString(File.ReadAllText(projectPath));
+
+            var mainTargetGuid = project.GetUnityMainTargetGuid();
+
+            foreach (var fileName in CustomSoundFiles)
+            {
+                var sourcePath = Path.Combine(SoundsSourceDir, fileName);
+                if (!File.Exists(sourcePath))
+                {
+                    Debug.LogWarning(
+                        $"Custom sound asset missing at {sourcePath}; skipping iOS bundling."
+                    );
+                    continue;
+                }
+
+                var destAbsolutePath = Path.Combine(outputPath, fileName);
+                File.Copy(sourcePath, destAbsolutePath, true);
+
+                if (!string.IsNullOrEmpty(project.FindFileGuidByProjectPath(fileName)))
+                    continue;
+
+                var fileGuid = project.AddFile(fileName, fileName);
+                project.AddFileToBuild(mainTargetGuid, fileGuid);
+            }
+
+            project.WriteToFile(projectPath);
+        }
+
         static void AddWidgetExtensionToProject(string outputPath)
         {
             var project = new PBXProject();
@@ -159,12 +201,63 @@ static void AddWidgetExtensionToPodFile(string outputPath)
                 return;
             }
 
+            // Keep the widget extension pinned to the same OneSignalXCFramework version as the
+            // core plugin so CocoaPods can resolve a single shared version across targets.
+            var requiredVersion = ResolveOneSignalXCFrameworkVersion();
+            var versionConstraint =
+                requiredVersion != null ? $"'{requiredVersion}'" : "'>= 5.0.2', '< 6.0.0'";
+            var requiredTarget =
+                $"target '{WidgetExtensionTargetName}' do\n  pod 'OneSignalXCFramework', {versionConstraint}\nend\n";
+
             var podfile = File.ReadAllText(podfilePath);
-            podfile +=
-                $"target '{WidgetExtensionTargetName}' do\n  pod 'OneSignalXCFramework', '>= 5.0.2', '< 6.0.0'\nend\n";
+            var podfileRegex = new Regex(
+                $@"target '{WidgetExtensionTargetName}' do\n  pod 'OneSignalXCFramework', '(.+)'\nend\n"
+            );
+
+            if (!podfileRegex.IsMatch(podfile))
+                podfile += requiredTarget;
+            else
+            {
+                var podfileTarget = podfileRegex.Match(podfile).ToString();
+                podfile = podfile.Replace(podfileTarget, requiredTarget);
+            }
+
             File.WriteAllText(podfilePath, podfile);
         }
 
+        static string ResolveOneSignalXCFrameworkVersion()
+        {
+            var dependenciesFilePath = Path.Combine(
+                "Packages",
+                "com.onesignal.unity.ios",
+                "Editor",
+                "OneSignaliOSDependencies.xml"
+            );
+
+            if (!File.Exists(dependenciesFilePath))
+            {
+                Debug.LogWarning(
+                    $"Could not find {dependenciesFilePath}; falling back to default OneSignalXCFramework version range."
+                );
+                return null;
+            }
+
+            var dependenciesFile = File.ReadAllText(dependenciesFilePath);
+            var dependenciesRegex = new Regex(
+                "(?<=<iosPod name=\"OneSignalXCFramework\" version=\")[^\"]+(?=\" addToAllTargets=\"true\" />)"
+            );
+
+            if (!dependenciesRegex.IsMatch(dependenciesFile))
+            {
+                Debug.LogWarning(
+                    $"Could not read OneSignalXCFramework version from {dependenciesFilePath}; falling back to default version range."
+                );
+                return null;
+            }
+
+            return dependenciesRegex.Match(dependenciesFile).ToString();
+        }
+
         static void CopyFileOrDirectory(string sourcePath, string destinationPath)
         {
             var file = new FileInfo(sourcePath);

examples/demo/.env.example

@@ -0,0 +1,154 @@
+#if UNITY_IOS
+
+using System.IO;
+using UnityEditor;
+using UnityEditor.Build;
+using UnityEditor.Build.Reporting;
+using UnityEditor.iOS.Xcode;
+using UnityEngine;
+
+namespace App.Editor.iOS
+{
+    /// <summary>
+    /// Final iOS post-processor for the demo app. Runs AFTER the OneSignal
+    /// SDK and demo widget post-processors so it can correct things they set:
+    ///
+    ///  1. Flips the main target's aps-environment from "production" (the SDK
+    ///     default) to "development". The demo only ever runs on simulator or
+    ///     a development device; "production" mismatches the simulator's APNS
+    ///     environment and triggers iOS's "Keep receiving notifications?"
+    ///     tuning prompt on first delivery (matches what the Flutter demo
+    ///     ships with).
+    ///
+    ///  2. Normalizes extension bundle IDs to short suffixes (`.NSE`, `.LA`)
+    ///     to match the Flutter demo and keep provisioning profile names
+    ///     consistent across SDKs.
+    ///
+    ///  3. Pins DEVELOPMENT_TEAM on all targets so a future Manual signing
+    ///     setup with the OneSignal-owned profiles works without manual
+    ///     fix-up in Xcode.
+    /// </summary>
+    public class SigningPostProcessor : IPostprocessBuildWithReport
+    {
+        private const string AppleTeamId = "99SW8E36CT";
+        private const string ApsEnvironment = "development";
+
+        private const string NseTargetName = "OneSignalNotificationServiceExtension";
+        private const string WidgetTargetName = "OneSignalWidgetExtension";
+
+        // Short bundle-id suffixes (match the Flutter demo).
+        private const string NseBundleSuffix = "NSE";
+        private const string WidgetBundleSuffix = "LA";
+
+        // Run after both demo widget post-processor (45) and SDK
+        // post-processor (45). 100 puts us after pod install (50) too.
+        public int callbackOrder => 100;
+
+        public void OnPostprocessBuild(BuildReport report)
+        {
+            if (report.summary.platform != BuildTarget.iOS)
+                return;
+
+            var outputPath = report.summary.outputPath;
+            FixupApsEnvironment(outputPath);
+            FixupSigningAndBundleIds(outputPath);
+        }
+
+        private static void FixupApsEnvironment(string outputPath)
+        {
+            var project = new PBXProject();
+            var projectPath = PBXProject.GetPBXProjectPath(outputPath);
+            project.ReadFromString(File.ReadAllText(projectPath));
+
+            var mainTargetGuid = project.GetUnityMainTargetGuid();
+            var relPath = project.GetBuildPropertyForAnyConfig(
+                mainTargetGuid,
+                "CODE_SIGN_ENTITLEMENTS"
+            );
+
+            if (string.IsNullOrEmpty(relPath))
+            {
+                Debug.LogWarning(
+                    "[SigningPostProcessor] Main target has no CODE_SIGN_ENTITLEMENTS; "
+                        + "skipping aps-environment fixup."
+                );
+                return;
+            }
+
+            var fullPath = Path.Combine(outputPath, relPath);
+            if (!File.Exists(fullPath))
+            {
+                Debug.LogWarning(
+                    $"[SigningPostProcessor] Entitlements file not found at {fullPath}; skipping."
+                );
+                return;
+            }
+
+            var plist = new PlistDocument();
+            plist.ReadFromFile(fullPath);
+            plist.root.SetString("aps-environment", ApsEnvironment);
+            plist.WriteToFile(fullPath);
+
+            Debug.Log(
+                $"[SigningPostProcessor] Set aps-environment=\"{ApsEnvironment}\" in {relPath}"
+            );
+        }
+
+        private static void FixupSigningAndBundleIds(string outputPath)
+        {
+            var project = new PBXProject();
+            var projectPath = PBXProject.GetPBXProjectPath(outputPath);
+            project.ReadFromString(File.ReadAllText(projectPath));
+
+            var appId = PlayerSettings.GetApplicationIdentifier(BuildTargetGroup.iOS);
+
+            ApplyTeamId(project, project.GetUnityMainTargetGuid(), "Unity-iPhone");
+
+            ApplyExtensionFixup(
+                project,
+                NseTargetName,
+                $"{appId}.{NseBundleSuffix}"
+            );
+            ApplyExtensionFixup(
+                project,
+                WidgetTargetName,
+                $"{appId}.{WidgetBundleSuffix}"
+            );
+
+            File.WriteAllText(projectPath, project.WriteToString());
+        }
+
+        private static void ApplyTeamId(PBXProject project, string targetGuid, string label)
+        {
+            if (string.IsNullOrEmpty(targetGuid))
+                return;
+
+            project.SetBuildProperty(targetGuid, "DEVELOPMENT_TEAM", AppleTeamId);
+            Debug.Log($"[SigningPostProcessor] Pinned DEVELOPMENT_TEAM={AppleTeamId} on {label}");
+        }
+
+        private static void ApplyExtensionFixup(
+            PBXProject project,
+            string targetName,
+            string bundleId
+        )
+        {
+            var guid = project.TargetGuidByName(targetName);
+            if (string.IsNullOrEmpty(guid))
+            {
+                Debug.LogWarning(
+                    $"[SigningPostProcessor] Target '{targetName}' not found; skipping."
+                );
+                return;
+            }
+
+            project.SetBuildProperty(guid, "PRODUCT_BUNDLE_IDENTIFIER", bundleId);
+            ApplyTeamId(project, guid, targetName);
+            Debug.Log(
+                $"[SigningPostProcessor] Set {targetName} PRODUCT_BUNDLE_IDENTIFIER={bundleId}"
+            );
+        }
+    }
+}
+
+#endif

examples/demo/Assets/App/Editor/iOS/BuildPostProcessor.cs

@@ -1,4 +1,9 @@
 -keep class com.onesignal.** { *; }
 
 # Work around for IllegalStateException with kotlinx-coroutines-android
--keep class kotlinx.coroutines.android.AndroidDispatcherFactory {*;}
+-keep class kotlinx.coroutines.android.AndroidDispatcherFactory {*;}
+
+# WorkManager initializes a Room database through AndroidX Startup before Unity starts.
+# Unity release builds run R8, so keep the generated database implementation reachable.
+-keep class androidx.work.impl.WorkDatabase* { *; }
+-keep class androidx.work.impl.model.** { *; }