Merge pull request #2449 from DataDog/simaoseica/RUM-9494/remove-locales

RUM-9494: Discard locales from span events

Author: simaoseica-dd

DatadogCore/Tests/Datadog/CrashReporting/CrashContext/CrashContextProviderTests.swift

@@ -308,7 +308,7 @@ class CrashContextProviderTests: XCTestCase {
         XCTAssertEqual(crashContext.env, sdkContext.env, file: file, line: line)
         XCTAssertEqual(crashContext.version, sdkContext.version, file: file, line: line)
         XCTAssertEqual(crashContext.buildNumber, sdkContext.buildNumber, file: file, line: line)
-        DDAssertReflectionEqual(crashContext.device, sdkContext.normalizedDevice, file: file, line: line)
+        DDAssertReflectionEqual(crashContext.device, sdkContext.normalizedDevice(), file: file, line: line)
         DDAssertReflectionEqual(crashContext.os, sdkContext.os, file: file, line: line)
         XCTAssertEqual(crashContext.sdkVersion, sdkContext.sdkVersion, file: file, line: line)
         XCTAssertEqual(crashContext.source, sdkContext.source, file: file, line: line)

DatadogCore/Tests/Datadog/TracerTests.swift

@@ -85,7 +85,6 @@ class TracerTests: XCTestCase {
                 "brand": "Apple",
                 "brightness_level": 0,
                 "locale": "en-US",
-                "locales": ["en"],
                 "model": "iPhone10,1",
                 "name": "iPhone",
                 "power_saving_mode": 0,

DatadogInternal/Sources/Context/DeviceInfo.swift

@@ -227,24 +227,34 @@ extension DatadogExtension where ExtendedType == _UIDevice {
 
 extension DatadogContext {
     /// Current device information to send in the events.
-    public var normalizedDevice: Device {
+    ///
+    /// - Parameter addLocales: Temporary boolean to remove locales from events that don't support array parameters.
+    /// NOTE: RUM-9494 only basic types (boolean, string, number) are supported for `meta.*` attributes.
+    ///
+    /// - Returns: The device model for the events.
+    public func normalizedDevice(addLocales: Bool = true) -> Device {
         var battery: Double?
         if let batteryLevel = batteryStatus?.level {
             battery = Double(batteryLevel)
         }
 
-        var brightness: Double? = nil
+        var brightness: Double?
         if let brightnessLevel = brightnessLevel {
             brightness = Double(brightnessLevel)
         }
 
+        var locales: [String]?
+        if addLocales {
+            locales = localeInfo.locales
+        }
+
         return .init(
             architecture: device.architecture,
             batteryLevel: battery,
             brand: device.brand,
             brightnessLevel: brightness,
             locale: localeInfo.currentLocale,
-            locales: localeInfo.locales,
+            locales: locales,
             model: device.model,
             name: device.name,
             powerSavingMode: isLowPowerModeEnabled,

DatadogInternal/Sources/Models/CrashReporting/CrashContext.swift

@@ -141,7 +141,7 @@ public struct CrashContext: Codable, Equatable {
         self.env = context.env
         self.version = context.version
         self.buildNumber = context.buildNumber
-        self.device = context.normalizedDevice
+        self.device = context.normalizedDevice()
         self.os = context.os
         self.sdkVersion = context.sdkVersion
         self.source = context.source

DatadogLogs/Sources/Log/LogEventBuilder.swift

@@ -81,7 +81,7 @@ internal struct LogEventBuilder {
             dd: LogEvent.Dd(
                 device: .init(architecture: context.device.architecture)
             ),
-            device: context.normalizedDevice,
+            device: context.normalizedDevice(),
             os: context.os,
             userInfo: context.userInfo ?? .empty,
             accountInfo: context.accountInfo,

DatadogRUM/Sources/RUMMonitor/Scopes/RUMResourceScope.swift

@@ -189,7 +189,7 @@ internal class RUMResourceScope: RUMScope {
             container: nil,
             context: .init(contextInfo: command.globalAttributes.merging(parent.attributes) { $1 }.merging(attributes) { $1 }),
             date: resourceStartTime.addingTimeInterval(serverTimeOffset).timeIntervalSince1970.toInt64Milliseconds,
-            device: context.normalizedDevice,
+            device: context.normalizedDevice(),
             display: nil,
             os: context.os,
             resource: .init(
@@ -304,7 +304,7 @@ internal class RUMResourceScope: RUMScope {
             container: nil,
             context: .init(contextInfo: command.globalAttributes.merging(parent.attributes) { $1 }.merging(attributes) { $1 }),
             date: command.time.addingTimeInterval(serverTimeOffset).timeIntervalSince1970.toInt64Milliseconds,
-            device: context.normalizedDevice,
+            device: context.normalizedDevice(),
             display: nil,
             error: .init(
                 binaryImages: nil,

DatadogRUM/Sources/RUMMonitor/Scopes/RUMUserActionScope.swift

@@ -181,7 +181,7 @@ internal class RUMUserActionScope: RUMScope, RUMContextProvider {
             container: nil,
             context: .init(contextInfo: command.globalAttributes.merging(parent.attributes) { $1 }.merging(attributes) { $1 }),
             date: actionStartTime.addingTimeInterval(serverTimeOffset).timeIntervalSince1970.toInt64Milliseconds,
-            device: context.normalizedDevice,
+            device: context.normalizedDevice(),
             display: nil,
             os: context.os,
             service: context.service,

DatadogRUM/Sources/RUMMonitor/Scopes/RUMViewScope.swift

@@ -551,7 +551,7 @@ extension RUMViewScope {
             container: nil,
             context: .init(contextInfo: commandAttributes),
             date: viewStartTime.addingTimeInterval(serverTimeOffset).timeIntervalSince1970.toInt64Milliseconds,
-            device: context.normalizedDevice,
+            device: context.normalizedDevice(),
             display: nil,
             os: context.os,
             service: context.service,
@@ -679,7 +679,7 @@ extension RUMViewScope {
             container: nil,
             context: .init(contextInfo: localAttributes),
             date: viewStartTime.addingTimeInterval(serverTimeOffset).timeIntervalSince1970.toInt64Milliseconds,
-            device: context.normalizedDevice,
+            device: context.normalizedDevice(),
             display: nil,
             featureFlags: .init(featureFlagsInfo: featureFlags),
             os: context.os,
@@ -825,7 +825,7 @@ extension RUMViewScope {
             container: nil,
             context: .init(contextInfo: commandAttributes),
             date: command.time.addingTimeInterval(serverTimeOffset).timeIntervalSince1970.toInt64Milliseconds,
-            device: context.normalizedDevice,
+            device: context.normalizedDevice(),
             display: nil,
             error: .init(
                 binaryImages: binaryImages,
@@ -912,7 +912,7 @@ extension RUMViewScope {
             container: nil,
             context: .init(contextInfo: commandAttributes),
             date: (command.time - command.duration).addingTimeInterval(serverTimeOffset).timeIntervalSince1970.toInt64Milliseconds,
-            device: context.normalizedDevice,
+            device: context.normalizedDevice(),
             display: nil,
             longTask: .init(
                 blockingDuration: nil,

DatadogTrace/Sources/Span/SpanEventBuilder.swift

@@ -97,7 +97,7 @@ internal struct SpanEventBuilder {
             applicationVersion: context.version,
             networkConnectionInfo: networkInfoEnabled ? context.networkConnectionInfo : nil,
             mobileCarrierInfo: networkInfoEnabled ? context.carrierInfo : nil,
-            device: context.normalizedDevice,
+            device: context.normalizedDevice(addLocales: false),
             os: context.os,
             userInfo: spanUserInfo,
             accountInfo: spanEventAccountInfo,

DatadogTrace/Sources/Span/SpanEventEncoder.swift

@@ -213,7 +213,7 @@ internal struct SpanEventEncoder {
 
     /// Encodes default `meta.*` attributes
     private func encodeDefaultMeta(_ span: SpanEvent, to container: inout KeyedEncodingContainer<StaticCodingKeys>) throws {
-        // NOTE: RUMM-299 only string values are supported for `meta.*` attributes
+        // NOTE: RUM-9494 only basic types (boolean, string, number) are supported for `meta.*` attributes
         try container.encode(span.source, forKey: .source)
         try container.encode(span.tracerVersion, forKey: .tracerVersion)
         try container.encode(span.applicationVersion, forKey: .applicationVersion)
@@ -270,7 +270,7 @@ internal struct SpanEventEncoder {
 
     /// Encodes `meta.*` attributes coming from user
     private func encodeCustomMeta(_ span: SpanEvent, to container: inout KeyedEncodingContainer<DynamicCodingKey>) throws {
-        // NOTE: RUMM-299 only string values are supported for `meta.*` attributes
+        // NOTE: RUM-9494 only basic types (boolean, string, number) are supported for `meta.*` attributes
         try span.userInfo.extraInfo.forEach {
             let metaKey = "meta.usr.\($0.key)"
             try container.encode($0.value, forKey: DynamicCodingKey(metaKey))