ref: Inject dependencies for ViewHierarchyProvider (#5460)

Instead of retrieving the dependencies in the
SentryViewHierarchyProvider via the SentryDependencyContainer, clearly
specify them in the initializer, which is better for testability and
readability. Another benefit is that the
SentryViewHierarchyProviderTests don't need to call
SentryDependencyContainer.reset.

Author: philipphofmann

Sources/Sentry/SentryDependencyContainer.m

@@ -297,7 +297,9 @@ - (SentryViewHierarchyProvider *)viewHierarchyProvider SENTRY_THREAD_SANITIZER_D
 {
 #    if SENTRY_HAS_UIKIT
 
-    SENTRY_LAZY_INIT(_viewHierarchyProvider, [[SentryViewHierarchyProvider alloc] init]);
+    SENTRY_LAZY_INIT(_viewHierarchyProvider,
+        [[SentryViewHierarchyProvider alloc] initWithDispatchQueueWrapper:self.dispatchQueueWrapper
+                                                      sentryUIApplication:self.application]);
 #    else
     SENTRY_LOG_DEBUG(
         @"SentryDependencyContainer.viewHierarchyProvider only works with UIKit "

Sources/Sentry/SentryViewHierarchyProvider.m

@@ -4,7 +4,6 @@
 
 #    import "SentryCrashFileUtils.h"
 #    import "SentryCrashJSONCodec.h"
-#    import "SentryDependencyContainer.h"
 #    import "SentryDispatchQueueWrapper.h"
 #    import "SentryLog.h"
 #    import "SentrySwift.h"
@@ -27,19 +26,29 @@
     return SentryCrashJSON_OK;
 }
 
+@interface SentryViewHierarchyProvider ()
+
+@property (nonatomic, strong) SentryDispatchQueueWrapper *dispatchQueueWrapper;
+@property (nonatomic, strong) SentryUIApplication *sentryUIApplication;
+
+@end
+
 @implementation SentryViewHierarchyProvider
 
-- (instancetype)init
+- (instancetype)initWithDispatchQueueWrapper:(SentryDispatchQueueWrapper *)dispatchQueueWrapper
+                         sentryUIApplication:(SentryUIApplication *)sentryUIApplication
 {
     if (self = [super init]) {
         self.reportAccessibilityIdentifier = YES;
+        self.dispatchQueueWrapper = dispatchQueueWrapper;
+        self.sentryUIApplication = sentryUIApplication;
     }
     return self;
 }
 
 - (BOOL)saveViewHierarchy:(NSString *)filePath
 {
-    NSArray<UIWindow *> *windows = [SentryDependencyContainer.sharedInstance.application windows];
+    NSArray<UIWindow *> *windows = [self.sentryUIApplication windows];
 
     const char *path = [filePath UTF8String];
     int fd = open(path, O_RDWR | O_CREAT | O_TRUNC, 0644);
@@ -62,8 +71,7 @@ - (NSData *)appViewHierarchyFromMainThread
 
     SENTRY_LOG_INFO(@"Starting to fetch the view hierarchy from the main thread.");
 
-    [[SentryDependencyContainer sharedInstance].dispatchQueueWrapper
-        dispatchSyncOnMainQueue:fetchViewHierarchy];
+    [self.dispatchQueueWrapper dispatchSyncOnMainQueue:fetchViewHierarchy];
 
     SENTRY_LOG_INFO(@"Finished fetching the view hierarchy from the main thread.");
 
@@ -73,7 +81,7 @@ - (NSData *)appViewHierarchyFromMainThread
 - (NSData *)appViewHierarchy
 {
     NSMutableData *result = [[NSMutableData alloc] init];
-    NSArray<UIWindow *> *windows = [SentryDependencyContainer.sharedInstance.application windows];
+    NSArray<UIWindow *> *windows = [self.sentryUIApplication windows];
 
     if (![self processViewHierarchy:windows
                         addFunction:writeJSONDataToMemory

Sources/Sentry/include/SentryViewHierarchyProvider.h

@@ -4,8 +4,14 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+@class SentryDispatchQueueWrapper;
+@class SentryUIApplication;
+
 @interface SentryViewHierarchyProvider : NSObject
 
+- (instancetype)initWithDispatchQueueWrapper:(SentryDispatchQueueWrapper *)dispatchQueueWrapper
+                         sentryUIApplication:(SentryUIApplication *)sentryUIApplication;
+
 /**
  * Whether we should add `accessibilityIdentifier` to the view hierarchy.
  */

Tests/SentryTests/SentryViewHierarchyProviderTests.swift

@@ -7,7 +7,7 @@ class SentryViewHierarchyProviderTests: XCTestCase {
         let uiApplication = TestSentryUIApplication()
 
         var sut: SentryViewHierarchyProvider {
-            return SentryViewHierarchyProvider()
+            return SentryViewHierarchyProvider(dispatchQueueWrapper: SentryDispatchQueueWrapper(), sentryUIApplication: uiApplication)
         }
     }
 
@@ -17,7 +17,6 @@ class SentryViewHierarchyProviderTests: XCTestCase {
         super.setUp()
 
         fixture = Fixture()
-        SentryDependencyContainer.sharedInstance().application = fixture.uiApplication
     }
 
     override func setUpWithError() throws {
@@ -35,11 +34,6 @@ class SentryViewHierarchyProviderTests: XCTestCase {
         }
     }
 
-    override func tearDown() {
-        super.tearDown()
-        SentryDependencyContainer.reset()
-    }
-
     func test_Multiple_Window() {
         let firstWindow = UIWindow(frame: CGRect(x: 0, y: 0, width: 10, height: 10))
         let secondWindow = UIWindow(frame: CGRect(x: 0, y: 0, width: 10, height: 10))
@@ -175,7 +169,7 @@ class SentryViewHierarchyProviderTests: XCTestCase {
     }
 
     func test_invalidSerialization() {
-        let sut = TestSentryViewHierarchyProvider()
+        let sut = TestSentryViewHierarchyProvider(dispatchQueueWrapper: SentryDispatchQueueWrapper(), sentryUIApplication: fixture.uiApplication)
         sut.viewHierarchyResult = -1
         let window = UIWindow(frame: CGRect(x: 0, y: 0, width: 10, height: 10))
         window.accessibilityIdentifier = "WindowId"
@@ -186,7 +180,7 @@ class SentryViewHierarchyProviderTests: XCTestCase {
     }
 
     func test_appViewHierarchyFromBackgroundTest() {
-        let sut = TestSentryViewHierarchyProvider()
+        let sut = TestSentryViewHierarchyProvider(dispatchQueueWrapper: SentryDispatchQueueWrapper(), sentryUIApplication: fixture.uiApplication)
         let window = UIWindow(frame: CGRect(x: 0, y: 0, width: 10, height: 10))
         fixture.uiApplication.windows = [window]
 
@@ -205,7 +199,7 @@ class SentryViewHierarchyProviderTests: XCTestCase {
     }
 
     func test_appViewHierarchy_usesMainThread() {
-        let sut = TestSentryViewHierarchyProvider()
+        let sut = TestSentryViewHierarchyProvider(dispatchQueueWrapper: SentryDispatchQueueWrapper(), sentryUIApplication: fixture.uiApplication)
         let window = UIWindow(frame: CGRect(x: 0, y: 0, width: 10, height: 10))
         fixture.uiApplication.windows = [window]