Merge pull request #2705 from DataDog/nogorodnikov/support-generated-rum-objc-rename

Add support of renaming Objective-C runtime classes for generated RUM models

Co-authored-by: 0xnm <nikita.ogorodnikov@datadoghq.com>

Author: gh-worker-dd-mergequeue-cf854d[bot]

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Unreleased
 
+- [IMPROVEMENT] Rename `DDRUMErrorEventErrorMeta` to `DDRUMErrorEventErrorMetaInfo`, add support of custom Objective-C runtime names for generated RUM models. See [#2705][]
+
 # 3.7.0 / 18-02-2026
 
 - [FEATURE] Add evaluation logging to `DatadogFlags` module. See [#2646][]
@@ -1057,6 +1059,7 @@ Release `2.0` introduces breaking changes. Follow the [Migration Guide](MIGRATIO
 [#2674]: https://github.com/DataDog/dd-sdk-ios/pull/2674
 [#2676]: https://github.com/DataDog/dd-sdk-ios/pull/2676
 [#2688]: https://github.com/DataDog/dd-sdk-ios/pull/2688
+[#2705]: https://github.com/DataDog/dd-sdk-ios/pull/2705
 
 [@00fa9a]: https://github.com/00FA9A
 [@britton-earnin]: https://github.com/Britton-Earnin

DatadogRUM/Sources/DataModels/RUMDataModels+objc.swift

@@ -2261,7 +2261,7 @@ public enum objc_RUMErrorEventErrorHandling: Int {
     case unhandled
 }
 
-@objc(DDRUMErrorEventErrorMeta)
+@objc(DDRUMErrorEventErrorMetaInfo)
 @objcMembers
 @_spi(objc)
 public class objc_RUMErrorEventErrorMeta: NSObject {

tools/rum-models-generator/Sources/CodeGeneration/Print/ObjcInteropPrinter.swift

@@ -36,8 +36,12 @@ import Foundation
 ///     }
 ///
 public class ObjcInteropPrinter: BasePrinter, CodePrinter {
-    public init(objcTypeNamesPrefix: String) {
+    public init(
+        objcTypeNamesPrefix: String,
+        objcRuntimeNameOverrides: [String: String] = [:]
+    ) {
         self.objcTypeNamesPrefix = objcTypeNamesPrefix
+        self.objcRuntimeNameOverrides = objcRuntimeNameOverrides
     }
 
     // MARK: - CodePrinter
@@ -52,6 +56,9 @@ public class ObjcInteropPrinter: BasePrinter, CodePrinter {
 
     /// The prefix used for types exposed to Obj-c.
     private let objcTypeNamesPrefix: String
+    /// Overrides for generated `@objc(...)` runtime names.
+    /// Keys are generated type names (e.g. `objc_RUMErrorEventErrorMeta`), values are runtime names (e.g. `DDRUMErrorEventMeta`).
+    private let objcRuntimeNameOverrides: [String: String]
 
     func print(objcInteropTypes: [ObjcInteropType]) throws -> String {
         reset()
@@ -81,7 +88,7 @@ public class ObjcInteropPrinter: BasePrinter, CodePrinter {
     private func print(objcInteropRootClass: ObjcInteropRootClass) throws {
         let className = objcTypeNamesPrefix + objcInteropRootClass.objcTypeName
         writeEmptyLine()
-        writeLine("@objc(\(className.objcNaming))")
+        writeLine("@objc(\(objcRuntimeName(for: className)))")
         writeLine("@objcMembers")
         writeLine("@_spi(objc)")
         writeLine("public class \(className): NSObject {")
@@ -123,7 +130,7 @@ public class ObjcInteropPrinter: BasePrinter, CodePrinter {
         }
 
         writeEmptyLine()
-        writeLine("@objc(\(objcTypeName.objcNaming))")
+        writeLine("@objc(\(objcRuntimeName(for: objcTypeName)))")
         writeLine("@objcMembers")
         writeLine("@_spi(objc)")
         writeLine("public class \(objcTypeName): NSObject {")
@@ -161,7 +168,7 @@ public class ObjcInteropPrinter: BasePrinter, CodePrinter {
         let className = objcTypeNamesPrefix + objcInteropNestedTransitiveClass.objcTypeName
         let rootClassName = objcTypeNamesPrefix + objcInteropNestedTransitiveClass.objcRootClass.objcTypeName
         writeEmptyLine()
-        writeLine("@objc(\(className.objcNaming))")
+        writeLine("@objc(\(objcRuntimeName(for: className)))")
         writeLine("@objcMembers")
         writeLine("@_spi(objc)")
         writeLine("public class \(className): NSObject {")
@@ -203,7 +210,7 @@ public class ObjcInteropPrinter: BasePrinter, CodePrinter {
         let managesOptionalEnum = objcInteropNestedEnum.parentProperty.bridgedSwiftProperty.isOptional
         let objcEnumOptionality = managesOptionalEnum ? "?" : ""
         writeEmptyLine()
-        writeLine("@objc(\(enumName.objcNaming))")
+        writeLine("@objc(\(objcRuntimeName(for: enumName)))")
         writeLine("@_spi(objc)")
         writeLine("public enum \(enumName): Int {")
         indentRight()
@@ -254,7 +261,7 @@ public class ObjcInteropPrinter: BasePrinter, CodePrinter {
         }
 
         writeEmptyLine()
-        writeLine("@objc(\(className.objcNaming))")
+        writeLine("@objc(\(objcRuntimeName(for: className)))")
         writeLine("@objcMembers")
         writeLine("@_spi(objc)")
         writeLine("public class \(className): NSObject {")
@@ -574,6 +581,10 @@ public class ObjcInteropPrinter: BasePrinter, CodePrinter {
 
     // MARK: - Generating names
 
+    private func objcRuntimeName(for generatedObjcTypeName: String) -> String {
+        objcRuntimeNameOverrides[generatedObjcTypeName] ?? generatedObjcTypeName.objcNaming
+    }
+
     private func objcInteropTypeName(for objcType: ObjcInteropType) throws -> String {
         switch objcType {
         case is ObjcInteropNSNumber:

tools/rum-models-generator/Sources/rum-models-generator/GenerateRUMModels.swift

@@ -43,6 +43,9 @@ internal func generateRUMSwiftModels(from schema: URL) throws -> String {
 
 internal func generateRUMObjcInteropModels(from schema: URL, skip typesToSkip: Set<String>) throws -> String {
     let generator = ModelsGenerator()
+    let objcRuntimeNameOverrides = [
+        "objc_RUMErrorEventErrorMeta": "DDRUMErrorEventErrorMetaInfo"
+    ]
 
     let template = OutputTemplate(
         header: """
@@ -66,7 +69,10 @@ internal func generateRUMObjcInteropModels(from schema: URL, skip typesToSkip: S
 
             """
     )
-    let printer = ObjcInteropPrinter(objcTypeNamesPrefix: "objc_")
+    let printer = ObjcInteropPrinter(
+        objcTypeNamesPrefix: "objc_",
+        objcRuntimeNameOverrides: objcRuntimeNameOverrides
+    )
 
     return try generator
         .generateCode(from: schema)

tools/rum-models-generator/Tests/CodeGenerationTests/Print/ObjcInteropPrinterTests.swift

@@ -129,6 +129,26 @@ final class ObjcInteropPrinterTests: XCTestCase {
         XCTAssertEqual(expected, actual)
     }
 
+    func testPrintingObjcInteropWithCustomObjcRuntimeNameOverride() throws {
+        let fooStruct = SwiftStruct(
+            name: "Foo",
+            comment: nil,
+            properties: [],
+            conformance: []
+        )
+
+        let objcInteropTypes = try SwiftToObjcInteropTypeTransformer()
+            .transform(swiftTypes: [fooStruct])
+        let objcInteropPrinter = ObjcInteropPrinter(
+            objcTypeNamesPrefix: "objc_",
+            objcRuntimeNameOverrides: ["objc_Foo": "DDCustomFoo"]
+        )
+        let output = try objcInteropPrinter.print(objcInteropTypes: objcInteropTypes)
+
+        XCTAssertTrue(output.contains("@objc(DDCustomFoo)"))
+        XCTAssertFalse(output.contains("@objc(DDFoo)"))
+    }
+
     func testPrintingObjcInteropForSwiftStructWithIntProperties() throws {
         let fooStruct = SwiftStruct(
             name: "Foo",