Merge pull request #2155 from DataDog/maxep/RUM-7484/swiftui-placeholder

dd-mergequeue[bot] · maxep · web-flow · commit 92ef71f20342 · 2024-12-18T19:31:36.000Z
RUM-7484 Add placeholder for unknown SwiftUI content

Co-authored-by: maxep &lt;maxime.epain@datadoghq.com&gt;
diff --git a/Datadog/Datadog.xcodeproj/project.pbxproj b/Datadog/Datadog.xcodeproj/project.pbxproj
@@ -799,6 +799,7 @@
 		D20FD9D12ACC02F9004D3569 /* DatadogWebViewTracking.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3CE119FE29F7BE0100202522 /* DatadogWebViewTracking.framework */; };
 		D20FD9D32ACC08D1004D3569 /* WebKitMocks.swift in Sources */ = {isa = PBXBuildFile; fileRef = D20FD9D22ACC08D1004D3569 /* WebKitMocks.swift */; };
 		D20FD9D62ACC0934004D3569 /* WebLogIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D20FD9D52ACC0934004D3569 /* WebLogIntegrationTests.swift */; };
+		D21331C12D132F0600E4A6A1 /* SwiftUIWireframesBuilderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D21331C02D132F0600E4A6A1 /* SwiftUIWireframesBuilderTests.swift */; };
 		D214DA8129DF2D5E004D0AE8 /* CrashReportingPlugin.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61DE333525C8278A008E3EC2 /* CrashReportingPlugin.swift */; };
 		D214DA8229DF2D5E004D0AE8 /* CrashReportingPlugin.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61DE333525C8278A008E3EC2 /* CrashReportingPlugin.swift */; };
 		D214DA8329DF2D5E004D0AE8 /* CrashReporting.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6161247825CA9CA6009901BE /* CrashReporting.swift */; };
@@ -2869,6 +2870,7 @@
 		D20FD9CE2AC6FF42004D3569 /* WebViewLogReceiverTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WebViewLogReceiverTests.swift; sourceTree = "<group>"; };
 		D20FD9D22ACC08D1004D3569 /* WebKitMocks.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WebKitMocks.swift; sourceTree = "<group>"; };
 		D20FD9D52ACC0934004D3569 /* WebLogIntegrationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WebLogIntegrationTests.swift; sourceTree = "<group>"; };
+		D21331C02D132F0600E4A6A1 /* SwiftUIWireframesBuilderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwiftUIWireframesBuilderTests.swift; sourceTree = "<group>"; };
 		D213532F270CA722000315AD /* DataCompressionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DataCompressionTests.swift; sourceTree = "<group>"; };
 		D214DAA429E072D7004D0AE8 /* MessageBus.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MessageBus.swift; sourceTree = "<group>"; };
 		D214DAA729E54CB4004D0AE8 /* TelemetryReceiver.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TelemetryReceiver.swift; sourceTree = "<group>"; };
@@ -5733,6 +5735,7 @@
 		960B26BA2D03541900D7196F /* SwiftUI */ = {
 			isa = PBXGroup;
 			children = (
+				D21331C02D132F0600E4A6A1 /* SwiftUIWireframesBuilderTests.swift */,
 				962D72C42CF7806300F86EF0 /* GraphicsImageReflectionTests.swift */,
 				96867B982D08826B004AE0BC /* TextReflectionTests.swift */,
 				96867B9A2D0883DD004AE0BC /* ColorReflectionTests.swift */,
@@ -8606,6 +8609,7 @@
 				61054FC72A6EE1BA00AAA894 /* SRDataModelsMocks.swift in Sources */,
 				D218B0482D072CF300E3F82C /* SessionReplayTelemetryTests.swift in Sources */,
 				61054FC82A6EE1BA00AAA894 /* SnapshotProcessorSpy.swift in Sources */,
+				D21331C12D132F0600E4A6A1 /* SwiftUIWireframesBuilderTests.swift in Sources */,
 				A74A72872B10CE4100771FEB /* ResourceMocks.swift in Sources */,
 				61054FA42A6EE1BA00AAA894 /* DiffTests.swift in Sources */,
 				61054FA02A6EE1BA00AAA894 /* SRCompressionTests.swift in Sources */,
diff --git a/DatadogSessionReplay/Sources/Recorder/ViewTreeSnapshotProducer/ViewTreeSnapshot/NodeRecorders/SwiftUI/SwiftUIWireframesBuilder.swift b/DatadogSessionReplay/Sources/Recorder/ViewTreeSnapshotProducer/ViewTreeSnapshot/NodeRecorders/SwiftUI/SwiftUIWireframesBuilder.swift
@@ -173,7 +173,12 @@ internal struct SwiftUIWireframesBuilder: NodeWireframesBuilder {
         case .platformView:
             return nil // Should be recorder by UIKit recorder
         case .unknown:
-            return nil // Need a placeholder
+            return context.builder.createPlaceholderWireframe(
+                id: Int64(content.seed.value),
+                frame: context.convert(frame: item.frame),
+                clip: context.clip,
+                label: "Unsupported SwiftUI component"
+            )
         }
     }
 }
diff --git a/DatadogSessionReplay/Sources/Utilities/Reflector.swift b/DatadogSessionReplay/Sources/Utilities/Reflector.swift
@@ -26,7 +26,8 @@ internal struct Reflector {
 
     /// A `Lazy` reflection allows reflecting the subject at a later time.
     struct Lazy<T> where T: Reflection {
-        private let reflector: Reflector
+        /// Relect to the type `T`.
+        let reflect: () throws -> T
     }
 
     private let mirror: ReflectionMirror
@@ -293,11 +294,12 @@ extension Reflection {
 
 extension Reflector.Lazy: Reflection {
     init(from reflector: Reflector) throws {
-        self.reflector = reflector
+        reflect = { try T(from: reflector) }
     }
+}
 
-    /// Relect to the type `T`.
-    func reflect() throws -> T {
-        try T(from: reflector)
+extension Reflector.Lazy {
+    init(_ reflection: T) {
+        reflect = { reflection }
     }
 }
diff --git a/DatadogSessionReplay/Tests/Recorder/ViewTreeSnapshotProducer/ViewTreeSnapshot/NodeRecorders/SwiftUI/SwiftUIWireframesBuilderTests.swift b/DatadogSessionReplay/Tests/Recorder/ViewTreeSnapshotProducer/ViewTreeSnapshot/NodeRecorders/SwiftUI/SwiftUIWireframesBuilderTests.swift
@@ -0,0 +1,57 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2019-Present Datadog, Inc.
+ */
+
+import XCTest
+
+#if os(iOS)
+import XCTest
+import SwiftUI
+import DatadogInternal
+import TestUtilities
+
+@_spi(Internal)
+@testable import DatadogSessionReplay
+
+@available(iOS 13.0, tvOS 13.0, *)
+class SwiftUIWireframesBuilderTests: XCTestCase {
+    func testDisplayListWithUnknownContent_itReturnsAPlaceholder() throws {
+        // Given
+        // - DisplayList with unknown content
+        let renderer = DisplayList.ViewUpdater(
+            viewCache: DisplayList.ViewUpdater.ViewCache(map: [:]),
+            lastList: DisplayList.Lazy(
+                DisplayList(items: [
+                    DisplayList.Item(
+                        identity: DisplayList.Identity(value: .mockRandom()),
+                        frame: .mockAny(),
+                        value: .content(DisplayList.Content(
+                            seed: DisplayList.Seed(value: .mockRandom()),
+                            value: .unknown
+                        ))
+                    )
+                ])
+            )
+        )
+
+        let builder = SwiftUIWireframesBuilder(
+            wireframeID: .mockRandom(),
+            renderer: renderer,
+            textObfuscator: TextObfuscatorMock(),
+            fontScalingEnabled: true,
+            imagePrivacyLevel: .maskNone,
+            attributes: .mockRandom()
+        )
+
+        // When
+        let wireframes = builder.buildWireframes(with: WireframesBuilder())
+
+        // Then
+        let wireframe = try XCTUnwrap(wireframes.last?.placeholderWireframe)
+        XCTAssertEqual(wireframe.label, "Unsupported SwiftUI component")
+    }
+}
+
+#endif

Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,12 @@ internal struct SwiftUIWireframesBuilder: NodeWireframesBuilder {`
`173`	`173`	`case .platformView:`
`174`	`174`	`return nil // Should be recorder by UIKit recorder`
`175`	`175`	`case .unknown:`
`176`		`- return nil // Need a placeholder`
	`176`	`+ return context.builder.createPlaceholderWireframe(`
	`177`	`+ id: Int64(content.seed.value),`
	`178`	`+ frame: context.convert(frame: item.frame),`
	`179`	`+ clip: context.clip,`
	`180`	`+ label: "Unsupported SwiftUI component"`
	`181`	`+ )`
`177`	`182`	`}`
`178`	`183`	`}`
`179`	`184`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,8 @@ internal struct Reflector {`
`26`	`26`
`27`	`27`	/// A `Lazy` reflection allows reflecting the subject at a later time.
`28`	`28`	`struct Lazy<T> where T: Reflection {`
`29`		`- private let reflector: Reflector`
	`29`	+ /// Relect to the type `T`.
	`30`	`+ let reflect: () throws -> T`
`30`	`31`	`}`
`31`	`32`
`32`	`33`	`private let mirror: ReflectionMirror`
`@@ -293,11 +294,12 @@ extension Reflection {`
`293`	`294`
`294`	`295`	`extension Reflector.Lazy: Reflection {`
`295`	`296`	`init(from reflector: Reflector) throws {`
`296`		`- self.reflector = reflector`
	`297`	`+ reflect = { try T(from: reflector) }`
`297`	`298`	`}`
	`299`	`+}`
`298`	`300`
`299`		- /// Relect to the type `T`.
`300`		`- func reflect() throws -> T {`
`301`		`- try T(from: reflector)`
	`301`	`+extension Reflector.Lazy {`
	`302`	`+ init(_ reflection: T) {`
	`303`	`+ reflect = { reflection }`
`302`	`304`	`}`
`303`	`305`	`}`