Merge pull request #505 from OneSignal/release/3.0.2

Release 3.0.2

Author: adamschlesinger

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,57 @@
+<!-- START -->
+# READ AND DELETE THIS SECTION BEFORE SUBMITTING PR
+* **Fill out each _REQUIRED_ section**
+* **Fill out _OPTIONAL_ sections, remove section if it doesn't apply to your PR**
+* **Read and fill out each of the checklists below**
+* **Remove this section after reading**
+<!-- END -->
+
+# Description
+## One Line Summary
+**REQUIRED** - Very short description that summaries the changes in this PR.
+
+## Details
+
+### Motivation
+**REQUIRED -** Why is this code change being made? Or what is the goal of this PR? Examples: Fixes a specific bug, provides additional logging to debug future issues, feature to allow X.
+
+### Scope
+**RECOMMEND - OPTIONAL -** What is intended to be effected. What is known not to change. Example: Notifications are grouped when parameter X is set, not enabled by default.
+
+# Testing
+## Unit testing
+**OPTIONAL -**  Explain unit tests added, if not clear in the code.
+
+## Manual testing
+**RECOMMEND - OPTIONAL -** Explain what scenarios were tested and the environment.
+Example: Tested opening a notification while the app was foregrounded, app build with Android Studio 2020.3 with a fresh install of the OneSignal example app on a Pixel 6 with Android 12.
+
+# Affected code checklist
+   - [ ] Notifications
+      - [ ] Display
+      - [ ] Open
+      - [ ] Push Processing
+      - [ ] Confirm Deliveries
+   - [ ] Outcomes
+   - [ ] Sessions
+   - [ ] In-App Messaging
+   - [ ] REST API requests
+   - [ ] Public API changes
+
+# Checklist
+## Overview
+   - [ ] I have filled out all **REQUIRED** sections above
+   - [ ] PR does one thing
+     - If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
+   - [ ] Any Public API changes are explained in the PR details and conform to existing APIs
+
+## Testing
+   - [ ] I have included test coverage for these changes, or explained why they are not needed
+   - [ ] All automated tests pass, or I explained why that is not possible
+   - [ ] I have personally tested this on my device, or explained why that is not possible
+
+## Final pass
+   - [ ] Code is as readable as possible.
+      - Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
+   - [ ] I have reviewed this PR myself, ensuring it meets each checklist item
+      - WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

OneSignalExample/Assets/OneSignal/CHANGELOG.md

@@ -5,6 +5,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [3.0.2]
+### Changed
+- Updated included Android SDK to [4.7.1](https://github.com/OneSignal/OneSignal-Android-SDK/releases/tag/4.7.1)
+- Explicitly check for a diff and handle overwrites for the `AndroidManifest.xml` between the project's and package's `OneSignalConfig.plugin`
+- `InstallEdm4uStep` checks for version number to determine if step is completed
+### Fixed
+- iOS build post processor checks for complete presence of extension
+- iOS publishing error 90206 when uploading app to Apple.
+- iOS builds on Unity on Windows failing on Entitlements file path. Fixes [#491](https://github.com/OneSignal/OneSignal-Unity-SDK/issues/442)
+- `OneSignalXCFramework` pod version of `OneSignalNotificationServiceExtension` target in Podfile of iOS builds will be upgraded if target is present during post processing
+
 ## [3.0.1]
 ### Added
 - [Migration guide](../../../MIGRATION.md) for updating from 2.x.x to 3.x.x
@@ -124,7 +135,7 @@ If you run into any problems, please don’t hesitate to [open an issue](https:/
 
 ## [2.14.1]
 ### Fixed
-- Corrected directory separators in post processor when building for iOS in a 
+- Corrected directory separators in post processor when building for iOS in a
   Windows environment. From PR [#376](https://github.com/OneSignal/OneSignal-Unity-SDK/pull/376)
   by [@SplenectomY](https://github.com/SplenectomY). Fixes [#375](https://github.com/OneSignal/OneSignal-Unity-SDK/issues/375), [#377](https://github.com/OneSignal/OneSignal-Unity-SDK/issues/377), [#380](https://github.com/OneSignal/OneSignal-Unity-SDK/issues/380)
 
@@ -136,7 +147,8 @@ If you run into any problems, please don’t hesitate to [open an issue](https:/
   - If you are updating from a previous version of the OneSignal Unity SDK please follow the Unity Asset Store instructions in
       the [README](https://github.com/OneSignal/OneSignal-Unity-SDK/README.md#unity-asset-store) to ensure a smooth transition.
 
-[Unreleased]: https://github.com/OneSignal/OneSignal-Unity-SDK/compare/3.0.1...HEAD
+[Unreleased]: https://github.com/OneSignal/OneSignal-Unity-SDK/compare/3.0.2...HEAD
+[3.0.2]: https://github.com/OneSignal/OneSignal-Unity-SDK/compare/3.0.1...3.0.2
 [3.0.1]: https://github.com/OneSignal/OneSignal-Unity-SDK/compare/3.0.0...3.0.1
 [3.0.0]: https://github.com/OneSignal/OneSignal-Unity-SDK/compare/3.0.0-beta.6...3.0.0
 [3.0.0-beta.6]: https://github.com/OneSignal/OneSignal-Unity-SDK/compare/3.0.0-beta.5...3.0.0-beta.6

OneSignalExample/Assets/OneSignal/VERSION

@@ -1 +1 @@
-3.0.1
+3.0.2

OneSignalExample/ProjectSettings/ProjectSettings.asset

@@ -134,7 +134,7 @@ PlayerSettings:
     16:10: 1
     16:9: 1
     Others: 1
-  bundleVersion: 3.0.1
+  bundleVersion: 3.0.2
   preloadedAssets: []
   metroInputSource: 0
   wsaTransparentSwapchain: 0

com.onesignal.unity.android/Editor/OneSignalAndroidDependencies.xml

@@ -3,6 +3,6 @@
     <repositories>
       <repository>https://repo.maven.apache.org/maven2</repository>
     </repositories>
-    <androidPackage spec="com.onesignal:OneSignal:4.6.5" />
+    <androidPackage spec="com.onesignal:OneSignal:4.7.1" />
   </androidPackages>
 </dependencies>

com.onesignal.unity.android/Editor/SetupSteps/ExportAndroidResourcesStep.cs

@@ -56,7 +56,13 @@ protected override bool _getIsStepCompleted() {
 
             var fileDiff = packagePaths.Except(exportPaths);
 
-            return !fileDiff.Any();
+            if (fileDiff.Any())
+                return false;
+
+            var pluginManifest = File.ReadAllText(_manifestPackagePath);
+            var projectManifest = File.ReadAllText(_manifestExportPath);
+            
+            return pluginManifest == projectManifest;
         }
 
         protected override void _runStep() {
@@ -76,8 +82,10 @@ protected override void _runStep() {
 
                 if (!Directory.Exists(containingPath))
                     Directory.CreateDirectory(containingPath);
-
-                if (!File.Exists(fileExportPath))
+                
+                if (!fileExportPath.Contains(".png")) // always refresh non-pngs
+                    File.Copy(file, fileExportPath, true);
+                else if (!File.Exists(fileExportPath)) // don't copy over existing png files
                     File.Copy(file, fileExportPath);
             }
 
@@ -87,7 +95,11 @@ protected override void _runStep() {
         private const string _pluginName = "OneSignalConfig.plugin";
         private static readonly string _packagePath = Path.Combine("Packages", "com.onesignal.unity.android", "Editor");
         private static readonly string _androidPluginsPath = Path.Combine("Assets", "Plugins", "Android");
+        
         private static readonly string _pluginPackagePath = Path.Combine(_packagePath, _pluginName);
         private static readonly string _pluginExportPath = Path.Combine(_androidPluginsPath, _pluginName);
+        
+        private static readonly string _manifestPackagePath = Path.Combine(_pluginPackagePath, "AndroidManifest.xml");
+        private static readonly string _manifestExportPath = Path.Combine(_pluginExportPath, "AndroidManifest.xml");
     }
 }

com.onesignal.unity.android/package.json

@@ -1,11 +1,11 @@
 {
   "name": "com.onesignal.unity.android",
   "displayName": "OneSignal Unity SDK - Android",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "unity": "2018.4",
   "description": "OneSignal is the market leader in customer engagement, powering mobile push, web push, email, and in-app messages.",
   "dependencies": {
-    "com.onesignal.unity.core": "3.0.1"
+    "com.onesignal.unity.core": "3.0.2"
   },
   "keywords": [
     "push-notifications",

com.onesignal.unity.core/Editor/SetupSteps/InstallEdm4uStep.cs

@@ -27,6 +27,9 @@
 
 using System.Linq;
 using UnityEditor.Compilation;
+using System;
+using System.IO;
+using System.Text.RegularExpressions;
 
 namespace OneSignalSDK {
     /// <summary>
@@ -43,10 +46,42 @@ public override string Details
         public override bool IsRequired
             => true;
 
-        protected override bool _getIsStepCompleted()
-            => CompilationPipeline.GetPrecompiledAssemblyNames()
+        protected override bool _getIsStepCompleted() {
+            var isInstalled = CompilationPipeline.GetPrecompiledAssemblyNames()
                .Any(assemblyName => assemblyName.StartsWith("Google.VersionHandler"));
 
+            if (!isInstalled)
+                return false;
+
+            var path = "Assets/ExternalDependencyManager/Editor";
+            var directoryInfo = new DirectoryInfo(path);
+
+            if (!directoryInfo.Exists)
+                return false;
+
+            FileInfo[] files;
+
+            try {
+                files = directoryInfo.GetFiles("external-dependency-manager_version-*_manifest.txt");
+            } catch (Exception) {
+                return false;
+            }
+
+            if (files.Length != 1) {
+                SDKDebug.Warn("EDM4U version number could not be determined.");
+                return false;
+            }
+
+            var file = files[0];
+            var pattern = @"external-dependency-manager_version-(.+)_manifest\.txt";
+            var match = Regex.Match(file.Name, pattern);
+            var version = new Version(match.Groups[1].Value);
+
+            var expectedVersion = new Version(_edm4UVersion);
+
+            return version >= expectedVersion;
+        }
+
         protected override void _runStep() {
             const string msg = "Downloading Google External Dependency Manager";
             UnityPackageInstaller.DownloadAndInstall(_edm4UPackageDownloadUrl, msg, result => {

com.onesignal.unity.core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "com.onesignal.unity.core",
   "displayName": "OneSignal Unity SDK - Core",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "unity": "2018.4",
   "description": "OneSignal is the market leader in customer engagement, powering mobile push, web push, email, and in-app messages.",
   "dependencies": {

com.onesignal.unity.ios/Editor/BuildPostProcessor.cs

@@ -138,7 +138,7 @@ private string GetEntitlementsPath(string targetGuid, string targetName) {
             _project.AddFile(relativeDestination, entitlementFileName);
             _project.SetBuildProperty(targetGuid, "CODE_SIGN_ENTITLEMENTS", relativeDestination);
 
-            return entitlementsPath;
+            return relativeDestination;
         }
 
         /// <summary>
@@ -163,15 +163,17 @@ private void AddProjectCapabilities() {
         /// </summary>
         private void AddNotificationServiceExtension() {
 #if !UNITY_CLOUD_BUILD
-            // If file exists then the below has been completed before from another build
-            // The below will not be updated on Append builds
-            // Changes would most likely need to be made to support Append builds
-            if (ExtensionCreatePlist(_outputPath)) {
-                ExtensionAddPodsToTarget();
+            // refresh plist and podfile on appends
+            ExtensionCreatePlist(_outputPath);
+            ExtensionAddPodsToTarget();
+
+            var extensionGuid = _project.TargetGuidByName(ServiceExtensionTargetName);
+
+            // skip target setup if already present
+            if (!string.IsNullOrEmpty(extensionGuid))
                 return;
-            }
 
-            var extensionGuid = _project.AddAppExtension(_project.GetMainTargetGuid(),
+            extensionGuid = _project.AddAppExtension(_project.GetMainTargetGuid(),
                 ServiceExtensionTargetName,
                 PlayerSettings.GetApplicationIdentifier(BuildTargetGroup.iOS) + "." + ServiceExtensionTargetName,
                 ServiceExtensionTargetName + "/" + "Info.plist" // Unix path as it's used by Xcode
@@ -198,8 +200,6 @@ private void AddNotificationServiceExtension() {
             projCapability.AddAppGroups(new[] { _appGroupName });
 
             projCapability.WriteToFile();
-            
-            ExtensionAddPodsToTarget();
 #endif
         }
 
@@ -248,13 +248,6 @@ private void ExtensionAddPodsToTarget() {
                 return;
             }
 
-            var podfile = File.ReadAllText(podfilePath);
-
-            var extensionEntryRegex = new Regex($@"target '{ServiceExtensionTargetName}' do\n(.+)\nend");
-            if (extensionEntryRegex.IsMatch(podfile))
-                return;
-
-            var versionRegex = new Regex("(?<=<iosPod name=\"OneSignalXCFramework\" version=\").+(?=\" addToAllTargets=\"true\" />)");
             var dependenciesFilePath = Path.Combine(EditorFilesPath, DependenciesFilename);
 
             if (!File.Exists(dependenciesFilePath)) {
@@ -263,16 +256,26 @@ private void ExtensionAddPodsToTarget() {
             }
 
             var dependenciesFile = File.ReadAllText(dependenciesFilePath);
+            var dependenciesRegex = new Regex("(?<=<iosPod name=\"OneSignalXCFramework\" version=\").+(?=\" addToAllTargets=\"true\" />)");
 
-            if (!versionRegex.IsMatch(dependenciesFile)) {
+            if (!dependenciesRegex.IsMatch(dependenciesFile)) {
                 Debug.LogError($"Could not read current iOS framework dependency version from {DependenciesFilename}");
                 return;
             }
 
-            var version = versionRegex.Match(dependenciesFile)
-                .ToString();
+            var podfile = File.ReadAllText(podfilePath);
+            var podfileRegex = new Regex($@"target '{ServiceExtensionTargetName}' do\n  pod 'OneSignalXCFramework', '(.+)'\nend\n");
+            
+            var requiredVersion = dependenciesRegex.Match(dependenciesFile).ToString();
+            var requiredTarget = $"target '{ServiceExtensionTargetName}' do\n  pod 'OneSignalXCFramework', '{requiredVersion}'\nend\n";
+
+            if (!podfileRegex.IsMatch(podfile))
+                podfile += requiredTarget;
+            else {
+                var podfileTarget = podfileRegex.Match(podfile).ToString();
+                podfile = podfile.Replace(podfileTarget, requiredTarget);
+            }
 
-            podfile += $"target '{ServiceExtensionTargetName}' do\n  pod 'OneSignalXCFramework', '{version}'\nend\n";
             File.WriteAllText(podfilePath, podfile);
         }
     }

com.onesignal.unity.ios/Runtime/Plugins/iOS/NotificationService.swift.meta

@@ -1,11 +1,11 @@
 {
   "name": "com.onesignal.unity.ios",
   "displayName": "OneSignal Unity SDK - iOS",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "unity": "2018.4",
   "description": "OneSignal is the market leader in customer engagement, powering mobile push, web push, email, and in-app messages.",
   "dependencies": {
-    "com.onesignal.unity.core": "3.0.1"
+    "com.onesignal.unity.core": "3.0.2"
   },
   "keywords": [
     "push-notifications",