Fix Crashlytics stack frame address selector (#119)

Author: AdamEssenmacher

source/Firebase/Crashlytics/ApiDefinition.cs

@@ -102,7 +102,7 @@ interface StackFrame
 
 		// + (instancetype)stackFrameWithAddress:(NSUInteger)address;
 		[Static]
-		[Export ("stackFrameWithAddress:address")]
+		[Export ("stackFrameWithAddress:")]
 		StackFrame Create (nuint address);
 
 		// +(instancetype _Nonnull)stackFrameWithSymbol:(NSString * _Nonnull)symbol file:(NSString * _Nonnull)file line:(NSInteger)line __attribute__((availability(swift, unavailable)));

tests/E2E/Firebase.Foundation/FirebaseFoundationE2E/FirebaseRuntimeDriftCases.cs

@@ -42,6 +42,11 @@
 using ObjCRuntime;
 #endif
 
+#if ENABLE_RUNTIME_DRIFT_CASE_CRASHLYTICS_STACKFRAMEWITHADDRESS
+using Firebase.Crashlytics;
+using ObjCRuntime;
+#endif
+
 namespace FirebaseFoundationE2E;
 
 static class FirebaseRuntimeDriftCases
@@ -681,6 +686,72 @@ void OnMarshalObjectiveCException(object? sender, MarshalObjectiveCExceptionEven
     }
 #endif
 
+#if ENABLE_RUNTIME_DRIFT_CASE_CRASHLYTICS_STACKFRAMEWITHADDRESS
+    static Task<string> VerifyCrashlyticsStackFrameWithAddressAsync()
+    {
+        const string staleSelector = "stackFrameWithAddress:address";
+        const string liveSelector = "stackFrameWithAddress:";
+
+        var signature = typeof(StackFrame).GetMethod(
+            nameof(StackFrame.Create),
+            BindingFlags.Static | BindingFlags.Public,
+            binder: null,
+            types: new[] { typeof(nuint) },
+            modifiers: null);
+        if (signature is null)
+        {
+            throw new InvalidOperationException(
+                $"Expected managed API '{nameof(StackFrame.Create)}({typeof(nuint).FullName})' was not found.");
+        }
+
+        var marshaledExceptionCaptured = false;
+        MarshalObjectiveCExceptionMode? marshaledExceptionMode = null;
+
+        void OnMarshalObjectiveCException(object? sender, MarshalObjectiveCExceptionEventArgs args)
+        {
+            marshaledExceptionCaptured = true;
+            marshaledExceptionMode ??= args.ExceptionMode;
+        }
+
+        Runtime.MarshalObjectiveCException += OnMarshalObjectiveCException;
+        try
+        {
+            try
+            {
+                using var stackFrame = StackFrame.Create((nuint)1);
+                if (stackFrame is null)
+                {
+                    throw new InvalidOperationException(
+                        $"Selector '{liveSelector}' returned null after the binding fix. Runtime address argument type: {typeof(nuint).FullName}.");
+                }
+            }
+            catch (ObjCException ex)
+            {
+                throw new InvalidOperationException(
+                    $"Selector '{liveSelector}' should not throw after the binding fix, but observed {ex.GetType().FullName}. " +
+                    $"Stale selector was '{staleSelector}'. " +
+                    $"Runtime address argument type: {typeof(nuint).FullName}. " +
+                    $"Marshal mode: {FormatDetail(marshaledExceptionMode?.ToString())}.");
+            }
+
+            if (marshaledExceptionCaptured)
+            {
+                throw new InvalidOperationException(
+                    $"Selector '{liveSelector}' completed, but Runtime.MarshalObjectiveCException captured an unexpected Objective-C exception. " +
+                    $"Marshal mode: {FormatDetail(marshaledExceptionMode?.ToString())}.");
+            }
+
+            return Task.FromResult(
+                $"Corrected stale selector '{staleSelector}' to native selector '{liveSelector}'. " +
+                $"Runtime address argument type: {typeof(nuint).FullName}; StackFrame.Create returned without ObjC exception.");
+        }
+        finally
+        {
+            Runtime.MarshalObjectiveCException -= OnMarshalObjectiveCException;
+        }
+    }
+#endif
+
     static string FormatDetail(string? value)
     {
         return string.IsNullOrWhiteSpace(value) ? "<empty>" : value;

tests/E2E/Firebase.Foundation/runtime-drift-cases.json

@@ -71,6 +71,17 @@
           "version": "12.6.0"
         }
       ]
+    },
+    {
+      "id": "crashlytics-stackframewithaddress",
+      "method": "VerifyCrashlyticsStackFrameWithAddressAsync",
+      "bindingPackage": "AdamE.Firebase.iOS.Crashlytics",
+      "packages": [
+        {
+          "id": "AdamE.Firebase.iOS.Crashlytics",
+          "version": "12.6.0"
+        }
+      ]
     }
   ]
 }