Feat: Add culture context (#491)

* add culture context

* Update CHANGELOG.md

* Update dart/lib/src/protocol/sentry_culture.dart

* fix formatting

* fix to json

Author: ueman

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased
 
+* Feat: Add Culture Context (#491)
 * Remove `Sentry.currentHub` (#490)
 
 # 5.1.0

dart/lib/src/protocol.dart

@@ -22,3 +22,4 @@ export 'protocol/sentry_runtime.dart';
 export 'protocol/sentry_stack_frame.dart';
 export 'protocol/sentry_stack_trace.dart';
 export 'protocol/sentry_user.dart';
+export 'protocol/sentry_culture.dart';

dart/lib/src/protocol/contexts.dart

@@ -16,13 +16,15 @@ class Contexts extends MapView<String, dynamic> {
     SentryApp? app,
     SentryBrowser? browser,
     SentryGpu? gpu,
+    SentryCulture? culture,
   }) : super({
           SentryDevice.type: device,
           SentryOperatingSystem.type: operatingSystem,
           SentryRuntime.listType: runtimes ?? [],
           SentryApp.type: app,
           SentryBrowser.type: browser,
           SentryGpu.type: gpu,
+          SentryCulture.type: culture,
         });
 
   factory Contexts.fromJson(Map<String, dynamic> data) {
@@ -40,6 +42,9 @@ class Contexts extends MapView<String, dynamic> {
       browser: data[SentryBrowser.type] != null
           ? SentryBrowser.fromJson(Map.from(data[SentryBrowser.type]))
           : null,
+      culture: data[SentryCulture.type] != null
+          ? SentryCulture.fromJson(Map.from(data[SentryCulture.type]))
+          : null,
       gpu: data[SentryGpu.type] != null
           ? SentryGpu.fromJson(Map.from(data[SentryGpu.type]))
           : null,
@@ -99,6 +104,12 @@ class Contexts extends MapView<String, dynamic> {
 
   set browser(SentryBrowser? browser) => this[SentryBrowser.type] = browser;
 
+  /// Culture Context describes certain properties of the culture in which the
+  /// software is used.
+  SentryCulture? get culture => this[SentryCulture.type];
+
+  set culture(SentryCulture? culture) => this[SentryCulture.type] = culture;
+
   /// GPU context describes the GPU of the device.
   SentryGpu? get gpu => this[SentryGpu.type];
 
@@ -138,6 +149,13 @@ class Contexts extends MapView<String, dynamic> {
           }
           break;
 
+        case SentryCulture.type:
+          final cultureMap = culture?.toJson();
+          if (cultureMap?.isNotEmpty ?? false) {
+            json[SentryCulture.type] = cultureMap;
+          }
+          break;
+
         case SentryGpu.type:
           final gpuMap = gpu?.toJson();
           if (gpuMap?.isNotEmpty ?? false) {
@@ -191,6 +209,7 @@ class Contexts extends MapView<String, dynamic> {
       operatingSystem: operatingSystem?.clone(),
       app: app?.clone(),
       browser: browser?.clone(),
+      culture: culture?.clone(),
       gpu: gpu?.clone(),
       runtimes: runtimes.map((runtime) => runtime.clone()).toList(),
     )..addEntries(
@@ -206,6 +225,7 @@ class Contexts extends MapView<String, dynamic> {
     List<SentryRuntime>? runtimes,
     SentryApp? app,
     SentryBrowser? browser,
+    SentryCulture? culture,
     SentryGpu? gpu,
   }) =>
       Contexts(
@@ -215,6 +235,7 @@ class Contexts extends MapView<String, dynamic> {
         app: app ?? this.app,
         browser: browser ?? this.browser,
         gpu: gpu ?? this.gpu,
+        culture: culture ?? this.culture,
       )..addEntries(
           entries.where((element) => !_defaultFields.contains(element.key)),
         );
@@ -227,5 +248,6 @@ class Contexts extends MapView<String, dynamic> {
     SentryRuntime.type,
     SentryGpu.type,
     SentryBrowser.type,
+    SentryCulture.type,
   ];
 }

dart/lib/src/protocol/sentry_culture.dart

@@ -0,0 +1,75 @@
+import 'package:meta/meta.dart';
+
+/// Culture Context describes certain properties of the culture in which the
+/// software is used.
+@immutable
+class SentryCulture {
+  static const type = 'culture';
+
+  const SentryCulture({
+    this.calendar,
+    this.displayName,
+    this.locale,
+    this.is24HourFormat,
+    this.timezone,
+  });
+
+  factory SentryCulture.fromJson(Map<String, dynamic> data) => SentryCulture(
+        calendar: data['calendar'],
+        displayName: data['display_name'],
+        locale: data['locale'],
+        is24HourFormat: data['is_24_hour_format'],
+        timezone: data['timezone'],
+      );
+
+  /// Optional: For example `GregorianCalendar`. Free form string.
+  final String? calendar;
+
+  /// Optional: Human readable name of the culture.
+  /// For example `English (United States)`
+  final String? displayName;
+
+  /// Optional. The name identifier, usually following the RFC 4646.
+  /// For example `en-US` or `pt-BR`.
+  final String? locale;
+
+  /// Optional. boolean, either true or false.
+  final bool? is24HourFormat;
+
+  /// Optional. The timezone of the locale. For example, `Europe/Vienna`.
+  final String? timezone;
+
+  /// Produces a [Map] that can be serialized to JSON.
+  Map<String, dynamic> toJson() {
+    return <String, dynamic>{
+      if (calendar != null) 'calendar': calendar!,
+      if (displayName != null) 'display_name': displayName!,
+      if (locale != null) 'locale': locale!,
+      if (is24HourFormat != null) 'is_24_hour_format': is24HourFormat!,
+      if (timezone != null) 'timezone': timezone!,
+    };
+  }
+
+  SentryCulture clone() => SentryCulture(
+        calendar: calendar,
+        displayName: displayName,
+        locale: locale,
+        is24HourFormat: is24HourFormat,
+        timezone: timezone,
+      );
+
+  SentryCulture copyWith({
+    String? calendar,
+    String? displayName,
+    String? locale,
+    bool? is24HourFormat,
+    String? timezone,
+  }) =>
+      SentryCulture(
+        calendar: calendar ?? this.calendar,
+        displayName: displayName ?? this.displayName,
+        locale: locale ?? this.locale,
+        is24HourFormat: is24HourFormat ?? this.is24HourFormat,
+        timezone: timezone ?? this.timezone,
+      );
+}

dart/test/protocol/contexts_test.dart

@@ -22,6 +22,7 @@ void main() {
     final app = SentryApp(name: 'name1');
     final browser = SentryBrowser(name: 'name1');
     final gpu = SentryGpu(id: 2);
+    final culture = SentryCulture(locale: 'foo-bar');
 
     final copy = data.copyWith(
       device: device,
@@ -30,6 +31,7 @@ void main() {
       app: app,
       browser: browser,
       gpu: gpu,
+      culture: culture,
     );
 
     expect(device.toJson(), copy.device!.toJson());
@@ -40,6 +42,7 @@ void main() {
     );
     expect(app.toJson(), copy.app!.toJson());
     expect(browser.toJson(), copy.browser!.toJson());
+    expect(culture.toJson(), copy.culture!.toJson());
     expect(gpu.toJson(), copy.gpu!.toJson());
     expect('value', copy['extra']);
   });
@@ -52,4 +55,5 @@ Contexts _generate() => Contexts(
       app: SentryApp(name: 'name'),
       browser: SentryBrowser(name: 'name'),
       gpu: SentryGpu(id: 1),
+      culture: SentryCulture(locale: 'foo-bar'),
     );

dart/test/protocol/culture_test.dart

@@ -0,0 +1,56 @@
+import 'package:collection/collection.dart';
+import 'package:sentry/sentry.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group(SentryCulture, () {
+    test('copyWith keeps unchanged', () {
+      final data = _generate();
+
+      final copy = data.copyWith();
+
+      expect(
+        MapEquality().equals(data.toJson(), copy.toJson()),
+        true,
+      );
+    });
+
+    test('copyWith takes new values', () {
+      final data = _generate();
+
+      final copy = data.copyWith(
+        calendar: 'calendar',
+        displayName: 'displayName',
+        is24HourFormat: false, // opposite of the value from _generate
+        locale: 'locale',
+        timezone: 'timezone',
+      );
+
+      expect('calendar', copy.calendar);
+      expect('displayName', copy.displayName);
+      expect(false, copy.is24HourFormat);
+      expect('locale', copy.locale);
+      expect('timezone', copy.timezone);
+    });
+
+    test('toJson', () {
+      final data = _generate();
+
+      expect(data.toJson(), <String, dynamic>{
+        'calendar': 'FooCalendar',
+        'display_name': 'FooLanguage',
+        'is_24_hour_format': true,
+        'locale': 'fo-ba',
+        'timezone': 'best-timezone',
+      });
+    });
+  });
+}
+
+SentryCulture _generate() => SentryCulture(
+      calendar: 'FooCalendar',
+      displayName: 'FooLanguage',
+      is24HourFormat: true,
+      locale: 'fo-ba',
+      timezone: 'best-timezone',
+    );