refactor: Change SentryFrame.function default from <redacted> to nil (#6608)

Co-authored-by: Philipp Hofmann <[email protected]>

Author: philprime

CHANGELOG.md

@@ -23,6 +23,7 @@
 - Remove unused `SentryFrame.instruction` property (#6504)
 - Remove `uuid` and `name` of `SentryDebugMeta` (#6512) Use `debugID` instead of `uuid` and `codeFile` instead of `name`.
 - Enable enablePreWarmedAppStartTracing by default (#6508). With this option enabled, the SDK collects [prewarmed app starts](https://docs.sentry.io/platforms/apple/tracing/instrumentation/automatic-instrumentation/#prewarmed-app-start-tracing).
+- Set `SentryFrame.function` default to `nil` instead of `<redacted>` (#6608)
 - Change `value` and `type` of `SentryException` to be nullable (#6563)
 - Change the default trace context status to "ok" instead of "undefined" (#6611)
 - Remove `getHash` from SentryDsn (#6605)

Sources/Sentry/Public/SentryFrame.h

@@ -99,7 +99,6 @@ NS_SWIFT_NAME(Frame)
 @property (nonatomic, copy) NSDictionary<NSString *, id> *_Nullable vars;
 
 - (instancetype)init;
-+ (instancetype)new NS_UNAVAILABLE;
 
 @end
 

Sources/Sentry/SentryFrame.m

@@ -8,9 +8,7 @@ @implementation SentryFrame
 
 - (instancetype)init
 {
-    if (self = [super init]) {
-        self.function = @"<redacted>";
-    }
+    self = [super init];
     return self;
 }
 

Tests/SentryTests/Integrations/MetricKit/SentryMetricKitIntegrationTests.swift

@@ -201,7 +201,7 @@ final class SentryMetricKitIntegrationTests: SentrySDKIntegrationTestsBase {
 
                 XCTAssertEqual(1, sentryFrames.count)
                 let frame = sentryFrames.first
-                XCTAssertEqual("<redacted>", frame?.function)
+                XCTAssertNil(frame?.function)
                 XCTAssertEqual("0x000000021f1a0001", frame?.imageAddress)
                 XCTAssertEqual("libsystem_pthread.dylib", frame?.package)
                 XCTAssertFalse(frame?.inApp?.boolValue ?? true)

Tests/SentryTests/Protocol/SentryFrameTests.swift

@@ -120,7 +120,7 @@ class SentryFrameTests: XCTestCase {
         // Assert
         XCTAssertNil(decoded.symbolAddress)
         XCTAssertNil(decoded.fileName)
-        XCTAssertEqual("<redacted>", decoded.function)
+        XCTAssertNil(decoded.function)
         XCTAssertNil(decoded.module)
         XCTAssertNil(decoded.lineNumber)
         XCTAssertNil(decoded.columnNumber)

Tests/SentryTests/SentryCrash/SentryCrashStackEntryMapperTests.swift

@@ -49,7 +49,7 @@ class SentryCrashStackEntryMapperTests: XCTestCase {
     func testSymbolNameIsNull() {
         let frame = sut.mapStackEntry(with: SentryCrashStackCursor())
 
-        XCTAssertEqual("<redacted>", frame.function)
+        XCTAssertNil(frame.function)
     }
 
     func testSymbolName() {

Tests/SentryTests/SentryCrash/SentryDefaultThreadInspectorTests.swift

@@ -220,7 +220,7 @@ class SentryDefaultThreadInspectorTests: XCTestCase {
 
         XCTAssertNotNil(stackTrace)
         XCTAssertGreaterThan(stackTrace.frames.count, 0)
-        XCTAssertEqual(stackTrace.frames.first?.function, "<redacted>")
+        XCTAssertNil(stackTrace.frames.first?.function)
     }
 
     func testOnlyCurrentThreadHasStacktrace() throws {

Tests/SentryTests/SentryCrashReportConverterTests.m

@@ -255,7 +255,7 @@ - (void)testNXPage
         [[SentryCrashReportConverter alloc] initWithReport:rawCrash inAppLogic:self.inAppLogic];
     SentryEvent *event = [reportConverter convertReportToEvent];
     SentryException *exception = event.exceptions.firstObject;
-    XCTAssertEqualObjects(exception.stacktrace.frames.lastObject.function, @"<redacted>");
+    XCTAssertNil(exception.stacktrace.frames.lastObject.function);
 }
 
 - (void)testReactNative

Tests/SentryTests/SentryInterfacesTests.m

@@ -24,7 +24,7 @@ - (void)testFrame
     SentryFrame *frame = [[SentryFrame alloc] init];
     frame.symbolAddress = @"0x01";
     XCTAssertNotNil(frame.symbolAddress);
-    NSDictionary *serialized = @{ @"symbol_addr" : @"0x01", @"function" : @"<redacted>" };
+    NSDictionary *serialized = @{ @"symbol_addr" : @"0x01" };
     XCTAssertEqualObjects([frame serialize], serialized);
 
     SentryFrame *frame2 = [[SentryFrame alloc] init];
@@ -223,10 +223,8 @@ - (void)testStacktrace
     XCTAssertNotNil(stacktrace.frames);
     XCTAssertNotNil(stacktrace.registers);
     [stacktrace fixDuplicateFrames];
-    NSDictionary *serialized = @{
-        @"frames" : @[ @{ @"symbol_addr" : @"0x01", @"function" : @"<redacted>" } ],
-        @"registers" : @ { @"a" : @"1" }
-    };
+    NSDictionary *serialized =
+        @{ @"frames" : @[ @{ @"symbol_addr" : @"0x01" } ], @"registers" : @ { @"a" : @"1" } };
     XCTAssertEqualObjects([stacktrace serialize], serialized);
 }
 
@@ -251,10 +249,8 @@ - (void)testThread
         @"crashed" : @(YES),
         @"current" : @(NO),
         @"name" : @"name",
-        @"stacktrace" : @ {
-            @"frames" : @[ @{ @"symbol_addr" : @"0x01", @"function" : @"<redacted>" } ],
-            @"registers" : @ { @"a" : @"1" }
-        }
+        @"stacktrace" :
+            @ { @"frames" : @[ @{ @"symbol_addr" : @"0x01" } ], @"registers" : @ { @"a" : @"1" } }
     };
     XCTAssertEqualObjects([thread2 serialize], serialized2);
 }
@@ -344,10 +340,8 @@ - (void)testException
         @"value" : @"value",
         @"type" : @"type",
         @"thread_id" : @(2),
-        @"stacktrace" : @ {
-            @"frames" : @[ @{ @"symbol_addr" : @"0x01", @"function" : @"<redacted>" } ],
-            @"registers" : @ { @"a" : @"1" }
-        },
+        @"stacktrace" :
+            @ { @"frames" : @[ @{ @"symbol_addr" : @"0x01" } ], @"registers" : @ { @"a" : @"1" } },
         @"module" : @"module",
         @"mechanism" : @ { @"type" : @"test" }
     };