feat: add culture context to event (#2036)

Added culture context to event payload

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Report App Memory Usage (#2027)
 - Include app permissions with event (#1984)
+- Add culture context to event (#2036)
 
 ## 7.23.0
 

Sentry.xcodeproj/project.pbxproj

@@ -39,6 +39,8 @@
 		03F9D37C2819A65C00602916 /* SentryProfilerTests.mm in Sources */ = {isa = PBXBuildFile; fileRef = 03F9D37B2819A65C00602916 /* SentryProfilerTests.mm */; };
 		0A1C3592287D7107007D01E3 /* SentryMetaTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0A1C3591287D7107007D01E3 /* SentryMetaTests.swift */; };
 		0A2690B72885C2E000E4432D /* TestSentryPermissionsObserver.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0AABE2EF2885C2120057ED69 /* TestSentryPermissionsObserver.swift */; };
+		0A2D8D9628997845008720F6 /* NSLocale+Sentry.m in Sources */ = {isa = PBXBuildFile; fileRef = 0A2D8D9428997845008720F6 /* NSLocale+Sentry.m */; };
+		0A2D8D9828997887008720F6 /* NSLocale+Sentry.h in Headers */ = {isa = PBXBuildFile; fileRef = 0A2D8D9728997887008720F6 /* NSLocale+Sentry.h */; };
 		0A8F0A392886CC70000B15F6 /* SentryPermissionsObserver.h in Headers */ = {isa = PBXBuildFile; fileRef = 0AABE2EE288592750057ED69 /* SentryPermissionsObserver.h */; };
 		0AABE2ED2885924A0057ED69 /* SentryPermissionsObserver.m in Sources */ = {isa = PBXBuildFile; fileRef = 0AABE2EC2885924A0057ED69 /* SentryPermissionsObserver.m */; };
 		15360CCF2432777500112302 /* SentrySessionTracker.m in Sources */ = {isa = PBXBuildFile; fileRef = 15360CCE2432777400112302 /* SentrySessionTracker.m */; };
@@ -716,6 +718,8 @@
 		03F84D3127DD4191008FE43F /* SentryBacktrace.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = SentryBacktrace.cpp; path = Sources/Sentry/SentryBacktrace.cpp; sourceTree = SOURCE_ROOT; };
 		03F9D37B2819A65C00602916 /* SentryProfilerTests.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = SentryProfilerTests.mm; sourceTree = "<group>"; };
 		0A1C3591287D7107007D01E3 /* SentryMetaTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryMetaTests.swift; sourceTree = "<group>"; };
+		0A2D8D9428997845008720F6 /* NSLocale+Sentry.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "NSLocale+Sentry.m"; sourceTree = "<group>"; };
+		0A2D8D9728997887008720F6 /* NSLocale+Sentry.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "NSLocale+Sentry.h"; path = "include/NSLocale+Sentry.h"; sourceTree = "<group>"; };
 		0AABE2EC2885924A0057ED69 /* SentryPermissionsObserver.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryPermissionsObserver.m; sourceTree = "<group>"; };
 		0AABE2EE288592750057ED69 /* SentryPermissionsObserver.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryPermissionsObserver.h; path = include/SentryPermissionsObserver.h; sourceTree = "<group>"; };
 		0AABE2EF2885C2120057ED69 /* TestSentryPermissionsObserver.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestSentryPermissionsObserver.swift; sourceTree = "<group>"; };
@@ -1555,6 +1559,8 @@
 				861265F82404EC1500C4AFDE /* NSArray+SentrySanitize.m */,
 				7B6438A826A70F24000D0F65 /* UIViewController+Sentry.h */,
 				7B6438A926A70F24000D0F65 /* UIViewController+Sentry.m */,
+				0A2D8D9728997887008720F6 /* NSLocale+Sentry.h */,
+				0A2D8D9428997845008720F6 /* NSLocale+Sentry.m */,
 			);
 			name = Categories;
 			sourceTree = "<group>";
@@ -3012,6 +3018,7 @@
 				7BD729962463E83300EA3610 /* SentryDateUtil.h in Headers */,
 				63FE707B20DA4C1000CDBAE8 /* Container+SentryDeepSearch.h in Headers */,
 				6344DDB91EC3115C00D9160D /* SentryCrashReportConverter.h in Headers */,
+				0A2D8D9828997887008720F6 /* NSLocale+Sentry.h in Headers */,
 				71F116E8F40D530BB68A2987 /* SentryCrashUUIDConversion.h in Headers */,
 				A2475E1725FB63AF007D9080 /* SentryHook.h in Headers */,
 			);
@@ -3127,6 +3134,7 @@
 				63FE717B20DA4C1100CDBAE8 /* SentryCrashReport.c in Sources */,
 				7B7A599726B692F00060A676 /* SentryScreenFrames.m in Sources */,
 				7B3398652459C15200BD9C96 /* SentryEnvelopeRateLimit.m in Sources */,
+				0A2D8D9628997845008720F6 /* NSLocale+Sentry.m in Sources */,
 				A2475E1F25FB648B007D9080 /* fishhook.c in Sources */,
 				7BD4BD4527EB29F50071F4FF /* SentryClientReport.m in Sources */,
 				631E6D341EBC679C00712345 /* SentryQueueableRequestManager.m in Sources */,

Sources/Sentry/NSLocale+Sentry.m

@@ -0,0 +1,18 @@
+#import "NSLocale+Sentry.h"
+
+@implementation
+NSLocale (Sentry)
+
+- (BOOL)timeIs24HourFormat
+{
+    NSDateFormatter *formatter = [[NSDateFormatter alloc] init];
+    [formatter setDateStyle:NSDateFormatterNoStyle];
+    [formatter setTimeStyle:NSDateFormatterShortStyle];
+    NSString *dateString = [formatter stringFromDate:[NSDate date]];
+    NSRange amRange = [dateString rangeOfString:[formatter AMSymbol]];
+    NSRange pmRange = [dateString rangeOfString:[formatter PMSymbol]];
+    BOOL is24Hour = amRange.location == NSNotFound && pmRange.location == NSNotFound;
+    return is24Hour;
+}
+
+@end

Sources/Sentry/SentryClient.m

@@ -1,5 +1,6 @@
 #import "SentryClient.h"
 #import "NSDictionary+SentrySanitize.h"
+#import "NSLocale+Sentry.h"
 #import "SentryAttachment.h"
 #import "SentryClient+Private.h"
 #import "SentryCrashDefaultMachineContextWrapper.h"
@@ -59,6 +60,8 @@
 @property (nonatomic, weak) id<SentryClientAttachmentProcessor> attachmentProcessor;
 @property (nonatomic, strong) SentryCrashWrapper *crashWrapper;
 @property (nonatomic, strong) SentryPermissionsObserver *permissionsObserver;
+@property (nonatomic, strong) NSLocale *locale;
+@property (nonatomic, strong) NSTimeZone *timezone;
 
 @end
 
@@ -111,7 +114,9 @@ - (_Nullable instancetype)initWithOptions:(SentryOptions *)options
                  threadInspector:threadInspector
                           random:[SentryDependencyContainer sharedInstance].random
                     crashWrapper:[SentryCrashWrapper sharedInstance]
-             permissionsObserver:permissionsObserver];
+             permissionsObserver:permissionsObserver
+                          locale:[NSLocale autoupdatingCurrentLocale]
+                        timezone:[NSCalendar autoupdatingCurrentCalendar].timeZone];
 }
 
 - (instancetype)initWithOptions:(SentryOptions *)options
@@ -121,6 +126,8 @@ - (instancetype)initWithOptions:(SentryOptions *)options
                          random:(id<SentryRandom>)random
                    crashWrapper:(SentryCrashWrapper *)crashWrapper
             permissionsObserver:(SentryPermissionsObserver *)permissionsObserver
+                         locale:(NSLocale *)locale
+                       timezone:(NSTimeZone *)timezone
 {
     if (self = [super init]) {
         self.options = options;
@@ -131,6 +138,8 @@ - (instancetype)initWithOptions:(SentryOptions *)options
         self.crashWrapper = crashWrapper;
         self.permissionsObserver = permissionsObserver;
         self.debugImageProvider = [SentryDependencyContainer sharedInstance].debugImageProvider;
+        self.locale = locale;
+        self.timezone = timezone;
     }
     return self;
 }
@@ -510,6 +519,7 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
     }
 
     [self applyPermissionsToEvent:event];
+    [self applyCultureContextToEvent:event];
 
     // With scope applied, before running callbacks run:
     if (nil == event.environment) {
@@ -695,6 +705,23 @@ - (NSString *)stringForPermissionStatus:(SentryPermissionStatus)status
     }
 }
 
+- (void)applyCultureContextToEvent:(SentryEvent *)event
+{
+    [self modifyContext:event
+                    key:@"culture"
+                  block:^(NSMutableDictionary *culture) {
+                      if (@available(iOS 10, macOS 10.12, watchOS 3, tvOS 10, macCatalyst 13, *)) {
+                          culture[@"calendar"] = [self.locale
+                              localizedStringForCalendarIdentifier:self.locale.calendarIdentifier];
+                          culture[@"display_name"] = [self.locale
+                              localizedStringForLocaleIdentifier:self.locale.localeIdentifier];
+                      }
+                      culture[@"locale"] = self.locale.localeIdentifier;
+                      culture[@"is_24_hour_format"] = @(self.locale.timeIs24HourFormat);
+                      culture[@"timezone"] = self.timezone.name;
+                  }];
+}
+
 - (void)storeFreeMemoryToDeviceContext:(SentryEvent *)event
 {
     [self modifyContext:event

Sources/Sentry/include/NSLocale+Sentry.h

@@ -0,0 +1,8 @@
+#import <Foundation/Foundation.h>
+
+@interface
+NSLocale (Sentry)
+
+- (BOOL)timeIs24HourFormat;
+
+@end

Tests/SentryTests/Protocol/SentryDebugMetaEquality.swift

@@ -5,8 +5,7 @@ extension DebugMeta {
         if  let other = object as? DebugMeta {
             return  uuid == other.uuid &&
                 type == other.type &&
-                name == other.name  &&
-                imageSize == other.imageSize &&
+                name == other.name && imageSize == other.imageSize &&
                 imageAddress == other.imageAddress &&
                 imageVmAddress == other.imageVmAddress
         } else {

Tests/SentryTests/Protocol/SentryThreadEquality.swift

@@ -6,8 +6,7 @@ extension Sentry.Thread {
             return  threadId == other.threadId &&
                 name == other.name &&
                 stacktrace == other.stacktrace &&
-                crashed == other.crashed  &&
-                current == other.current
+                crashed == other.crashed && current == other.current
         } else {
             return false
         }

Tests/SentryTests/SentryClient+TestInit.h

@@ -20,7 +20,9 @@ SentryClient (TestInit)
                 threadInspector:(SentryThreadInspector *)threadInspector
                          random:(id<SentryRandom>)random
                    crashWrapper:(SentryCrashWrapper *)crashWrapper
-            permissionsObserver:(SentryPermissionsObserver *)permissionsObserver;
+            permissionsObserver:(SentryPermissionsObserver *)permissionsObserver
+                         locale:(NSLocale *)locale
+                       timezone:(NSTimeZone *)timezone;
 
 @end
 

Tests/SentryTests/SentryClientTests.swift

@@ -29,6 +29,8 @@ class SentryClientTest: XCTestCase {
         let transaction: Transaction
         let crashWrapper = TestSentryCrashWrapper.sharedInstance()
         let permissionsObserver = TestSentryPermissionsObserver()
+        let locale = Locale(identifier: "en_US")
+        let timezone = TimeZone(identifier: "Europe/Vienna")!
 
         init() {
             session = SentrySession(releaseName: "release")
@@ -68,7 +70,9 @@ class SentryClientTest: XCTestCase {
                     threadInspector: threadInspector,
                     random: random,
                     crashWrapper: crashWrapper,
-                    permissionsObserver: permissionsObserver
+                    permissionsObserver: permissionsObserver,
+                    locale: locale,
+                    timezone: timezone
                 )
             } catch {
                 XCTFail("Options could not be created")
@@ -557,6 +561,23 @@ class SentryClientTest: XCTestCase {
         }
     }
 
+    func testCaptureCrash_Culture() {
+        let event = TestData.event
+        event.threads = nil
+        event.debugMeta = nil
+
+        fixture.getSut().captureCrash(event, with: fixture.scope)
+
+        assertLastSentEventWithAttachment { actual in
+            let culture = actual.context?["culture"]
+            XCTAssertEqual(culture?["calendar"] as? String, "Gregorian Calendar")
+            XCTAssertEqual(culture?["display_name"] as? String, "English (United States)")
+            XCTAssertEqual(culture?["locale"] as? String, "en_US")
+            XCTAssertEqual(culture?["is_24_hour_format"] as? Bool, false)
+            XCTAssertEqual(culture?["timezone"] as? String, "Europe/Vienna")
+        }
+    }
+
     func testCaptureErrorWithUserInfo() {
         let expectedValue = "val"
         let error = NSError(domain: "domain", code: 0, userInfo: ["key": expectedValue])

Tests/SentryTests/TestClient.swift

@@ -11,9 +11,19 @@ class TestClient: Client {
 
     // Without this override we get a fatal error: use of unimplemented initializer
     // see https://stackoverflow.com/questions/28187261/ios-swift-fatal-error-use-of-unimplemented-initializer-init
-    override init(options: Options, transportAdapter: SentryTransportAdapter, fileManager: SentryFileManager, threadInspector: SentryThreadInspector, random: SentryRandomProtocol, crashWrapper: SentryCrashWrapper, permissionsObserver: SentryPermissionsObserver) {
+    override init(options: Options, transportAdapter: SentryTransportAdapter, fileManager: SentryFileManager, threadInspector: SentryThreadInspector, random: SentryRandomProtocol, crashWrapper: SentryCrashWrapper, permissionsObserver: SentryPermissionsObserver, locale: Locale, timezone: TimeZone) {
         sentryFileManager = try! SentryFileManager(options: options, andCurrentDateProvider: TestCurrentDateProvider())
-        super.init(options: options, transportAdapter: transportAdapter, fileManager: fileManager, threadInspector: threadInspector, random: random, crashWrapper: crashWrapper, permissionsObserver: permissionsObserver)
+        super.init(
+            options: options,
+            transportAdapter: transportAdapter,
+            fileManager: fileManager,
+            threadInspector: threadInspector,
+            random: random,
+            crashWrapper: crashWrapper,
+            permissionsObserver: permissionsObserver,
+            locale: locale,
+            timezone: timezone
+        )
     }
 
     override func fileManager() -> SentryFileManager {