fix: Add masking for PDFView (#5766)

Co-authored-by: Philipp Hofmann <[email protected]>

Author: philprime

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Fixes
 
+- Add support for PDFKit views in session replay (#5750)
 - Fix Infinite Session Replay Processing Loop (#5765)
 - Fix memory leak in SessionReplayIntegration (#5770)
 - Fix reporting of energy used while profiling (#5768)

Samples/iOS-Swift/iOS-Swift/Base.lproj/Main.storyboard

@@ -0,0 +1,24 @@
+import PDFKit
+
+class SentryPDFViewController: UIViewController {
+    override func viewDidLoad() {
+        super.viewDidLoad()
+
+        let pdfView = PDFView()
+        view.addSubview(pdfView)
+
+        pdfView.translatesAutoresizingMaskIntoConstraints = false
+        NSLayoutConstraint.activate([
+            pdfView.leadingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.leadingAnchor),
+            pdfView.trailingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.trailingAnchor),
+            pdfView.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
+            pdfView.bottomAnchor.constraint(equalTo: view.safeAreaLayoutGuide.bottomAnchor)
+        ])
+
+        guard let fileUrl = Bundle.main.url(forResource: "ProjectProposal", withExtension: "pdf"),
+              let document = PDFDocument(url: fileUrl) else {
+            preconditionFailure("Failed to load PDF document from bundle.")
+        }
+        pdfView.document = document
+    }
+}

Samples/iOS-Swift/iOS-Swift/ProjectProposal.pdf

@@ -4,6 +4,7 @@ import Foundation
 import ObjectiveC.NSObjCRuntime
 import UIKit
 #if os(iOS)
+import PDFKit
 import WebKit
 #endif
 
@@ -57,7 +58,7 @@ final class SentryUIRedactBuilder {
         }
 
 #if os(iOS)
-        redactClasses += [ WKWebView.self ]
+        redactClasses += [ PDFView.self, WKWebView.self ]
 
         redactClasses += [
             // If we try to use 'UIWebView.self' it will not compile for macCatalyst, but the class does exists.

Samples/iOS-Swift/iOS-Swift/ViewControllers/SentryPDFViewController.swift

@@ -1,5 +1,6 @@
 #if os(iOS)
 import Foundation
+import PDFKit
 import SafariServices
 @testable import Sentry
 import SentryTestUtils
@@ -463,7 +464,7 @@ class SentryUIRedactBuilderTests: XCTestCase {
     func testRedactList() {
         let expectedList = ["_TtCOCV7SwiftUI11DisplayList11ViewUpdater8Platform13CGDrawingView",
             "_TtC7SwiftUIP33_A34643117F00277B93DEBAB70EC0697122_UIShapeHitTestingView",
-            "SwiftUI._UIGraphicsView", "SwiftUI.ImageLayer", "UIWebView", "SFSafariView", "UILabel", "UITextView", "UITextField", "WKWebView"
+            "SwiftUI._UIGraphicsView", "SwiftUI.ImageLayer", "UIWebView", "SFSafariView", "UILabel", "UITextView", "UITextField", "WKWebView", "PDFView"
         ].compactMap { NSClassFromString($0) }
 
         let sut = getSut()
@@ -573,6 +574,70 @@ class SentryUIRedactBuilderTests: XCTestCase {
         }
         #endif
     }
+
+    func testRedactPDFView() throws {
+        // -- Arrange --
+        let sut = getSut()
+        let pdfView = PDFView(frame: CGRect(x: 20, y: 20, width: 40, height: 40))
+        rootView.addSubview(pdfView)
+        
+        // -- Act --
+        let result = sut.redactRegionsFor(view: rootView)
+        
+        // -- Assert --
+        // Root View
+        // └ PDFView            (Public API)
+        //   └ PDFScrollView    (Private API)
+        XCTAssertEqual(result.count, 2)
+        let pdfRegion = try XCTUnwrap(result.element(at: 0))
+        XCTAssertEqual(pdfRegion.size, CGSize(width: 40, height: 40))
+        XCTAssertEqual(pdfRegion.type, .redact)
+        XCTAssertEqual(pdfRegion.transform, CGAffineTransform(a: 1, b: 0, c: 0, d: 1, tx: 20, ty: 20))
+        XCTAssertNil(pdfRegion.color)
+
+        let pdfScrollViewRegion = try XCTUnwrap(result.element(at: 1))
+        XCTAssertEqual(pdfScrollViewRegion.size, CGSize(width: 40, height: 40))
+        XCTAssertEqual(pdfScrollViewRegion.type, .redact)
+        XCTAssertEqual(pdfScrollViewRegion.transform, CGAffineTransform(a: 1, b: 0, c: 0, d: 1, tx: 20, ty: 20))
+        XCTAssertNil(pdfScrollViewRegion.color)
+    }
+
+    func testRedactPDFViewEvenWithMaskingDisabled() throws {
+        // -- Arrange --
+        // PDFView should always be redacted for security reasons,
+        // regardless of maskAllText and maskAllImages settings
+        let sut = getSut(TestRedactOptions(maskAllText: false, maskAllImages: false))
+        let pdfView = PDFView(frame: CGRect(x: 20, y: 20, width: 40, height: 40))
+        rootView.addSubview(pdfView)
+        
+        // -- Act --
+        let result = sut.redactRegionsFor(view: rootView)
+        
+        // -- Assert --
+        // Root View
+        // └ PDFView            (Public API)
+        //   └ PDFScrollView    (Private API)
+        XCTAssertEqual(result.count, 2)
+        let pdfRegion = try XCTUnwrap(result.element(at: 0))
+        XCTAssertEqual(pdfRegion.size, CGSize(width: 40, height: 40))
+        XCTAssertEqual(pdfRegion.type, .redact)
+        XCTAssertEqual(pdfRegion.transform, CGAffineTransform(a: 1, b: 0, c: 0, d: 1, tx: 20, ty: 20))
+        XCTAssertNil(pdfRegion.color)
+
+        let pdfScrollViewRegion = try XCTUnwrap(result.element(at: 1))
+        XCTAssertEqual(pdfScrollViewRegion.size, CGSize(width: 40, height: 40))
+        XCTAssertEqual(pdfScrollViewRegion.type, .redact)
+        XCTAssertEqual(pdfScrollViewRegion.transform, CGAffineTransform(a: 1, b: 0, c: 0, d: 1, tx: 20, ty: 20))
+        XCTAssertNil(pdfScrollViewRegion.color)
+    }
+
+    func testPDFViewInRedactList() {
+        // -- Arrange --
+        let sut = getSut()
+        
+        // -- Act & Assert --
+        XCTAssertTrue(sut.containsRedactClass(PDFView.self), "PDFView should be in the redact class list")
+    }
 }
 
 #endif

Sources/Swift/Core/Tools/ViewCapture/SentryUIRedactBuilder.swift

@@ -41693,6 +41693,13 @@
         "declKind": "Import",
         "moduleName": "Sentry"
       },
+      {
+        "kind": "Import",
+        "name": "PDFKit",
+        "printedName": "PDFKit",
+        "declKind": "Import",
+        "moduleName": "Sentry"
+      },
       {
         "kind": "Import",
         "name": "Sentry",

Tests/SentryTests/ViewCapture/SentryUIRedactBuilderTests.swift

@@ -39013,6 +39013,13 @@
         "declKind": "Import",
         "moduleName": "Sentry"
       },
+      {
+        "kind": "Import",
+        "name": "PDFKit",
+        "printedName": "PDFKit",
+        "declKind": "Import",
+        "moduleName": "Sentry"
+      },
       {
         "kind": "Import",
         "name": "Sentry",