Rename

Author: noahsmartin

SentryTestUtils/Headers/SentryHub+Test.h

@@ -4,7 +4,7 @@
 @class SentryCrashWrapper;
 @class SentryDispatchQueueWrapper;
 @class SentryClientInternal;
-@protocol SentryBaseIntegrationProtocol;
+@protocol SentryIntegrationProtocol;
 NS_ASSUME_NONNULL_BEGIN
 
 /** Expose the internal test init for testing. */
@@ -15,7 +15,7 @@ NS_ASSUME_NONNULL_BEGIN
                andCrashWrapper:(SentryCrashWrapper *)crashAdapter
               andDispatchQueue:(SentryDispatchQueueWrapper *)dispatchQueue;
 
-- (NSArray<id<SentryBaseIntegrationProtocol>> *)installedIntegrations;
+- (NSArray<id<SentryIntegrationProtocol>> *)installedIntegrations;
 - (NSSet<NSString *> *)installedIntegrationNames;
 
 - (BOOL)eventContainsOnlyHandledErrors:(NSDictionary *)eventDictionary;

Sources/Sentry/SentryHub.m

@@ -621,7 +621,7 @@ - (void)configureScope:(void (^)(SentryScope *scope))callback
 - (BOOL)isIntegrationInstalled:(Class)integrationClass
 {
     @synchronized(_integrationsLock) {
-        for (id<SentryBaseIntegrationProtocol> item in _installedIntegrations) {
+        for (id<SentryIntegrationProtocol> item in _installedIntegrations) {
             if ([item isKindOfClass:integrationClass]) {
                 return YES;
             }
@@ -630,10 +630,10 @@ - (BOOL)isIntegrationInstalled:(Class)integrationClass
     }
 }
 
-- (nullable id<SentryBaseIntegrationProtocol>)getInstalledIntegration:(Class)integrationClass
+- (nullable id<SentryIntegrationProtocol>)getInstalledIntegration:(Class)integrationClass
 {
     @synchronized(_integrationsLock) {
-        for (id<SentryBaseIntegrationProtocol> item in _installedIntegrations) {
+        for (id<SentryIntegrationProtocol> item in _installedIntegrations) {
             if ([item isKindOfClass:integrationClass]) {
                 return item;
             }
@@ -651,7 +651,7 @@ - (BOOL)hasIntegration:(NSString *)integrationName
     }
 }
 
-- (void)addInstalledIntegration:(id<SentryBaseIntegrationProtocol>)integration name:(NSString *)name
+- (void)addInstalledIntegration:(id<SentryIntegrationProtocol>)integration name:(NSString *)name
 {
     @synchronized(_integrationsLock) {
         [_installedIntegrations addObject:integration];
@@ -661,7 +661,7 @@ - (void)addInstalledIntegration:(id<SentryBaseIntegrationProtocol>)integration n
 
 - (void)removeAllIntegrations
 {
-    for (NSObject<SentryBaseIntegrationProtocol> *integration in self.installedIntegrations) {
+    for (NSObject<SentryIntegrationProtocol> *integration in self.installedIntegrations) {
         if ([integration respondsToSelector:@selector(uninstall)]) {
             [integration uninstall];
         }
@@ -672,7 +672,7 @@ - (void)removeAllIntegrations
     }
 }
 
-- (NSArray<id<SentryBaseIntegrationProtocol>> *)installedIntegrations
+- (NSArray<id<SentryIntegrationProtocol>> *)installedIntegrations
 {
     @synchronized(_integrationsLock) {
         return _installedIntegrations.copy;

Sources/Sentry/include/HybridPublic/SentryBaseIntegration.h

@@ -34,7 +34,7 @@ typedef NS_OPTIONS(NSUInteger, SentryIntegrationOption) {
 
 @class SentryOptions;
 
-@interface SentryBaseIntegration : NSObject <SentryIntegrationProtocol>
+@interface SentryBaseIntegration : NSObject <SentryObjCIntegrationProtocol>
 
 - (NSString *)integrationName;
 - (BOOL)installWithOptions:(SentryOptions *)options;

Sources/Sentry/include/HybridPublic/SentryIntegrationProtocol.h

@@ -4,7 +4,9 @@ NS_ASSUME_NONNULL_BEGIN
 
 @class SentryOptions;
 
-@protocol SentryBaseIntegrationProtocol <NSObject>
+// All Integrations conform to this protocol so that the SDK
+// can uninstall them when the SDK is closed.
+@protocol SentryIntegrationProtocol <NSObject>
 
 /**
  * Uninstalls the integration.
@@ -13,7 +15,11 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
-@protocol SentryIntegrationProtocol <SentryBaseIntegrationProtocol>
+// ObjC integrations conform to this protocol. This should not be used for new
+// integrations. New ones should be written in Swift and use the `Sentry.Integration`
+// protocol. The main difference is that the ObjC protocol does not inject dependencies
+// so conformers need to access the singleton.
+@protocol SentryObjCIntegrationProtocol <SentryIntegrationProtocol>
 
 /**
  * Installs the integration and returns YES if successful.

Sources/Sentry/include/SentryBaseIntegration.h

@@ -0,0 +1,43 @@
+#import <Foundation/Foundation.h>
+#import "SentryIntegrationProtocol.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+typedef NS_OPTIONS(NSUInteger, SentryIntegrationOption) {
+    kIntegrationOptionNone = 0,
+    kIntegrationOptionEnableAutoSessionTracking = 1 << 0,
+    kIntegrationOptionEnableWatchdogTerminationTracking = 1 << 1,
+    kIntegrationOptionEnableAutoPerformanceTracing = 1 << 2,
+    kIntegrationOptionEnableUIViewControllerTracing = 1 << 3,
+    kIntegrationOptionAttachScreenshot = 1 << 4,
+    kIntegrationOptionEnableUserInteractionTracing = 1 << 5,
+    kIntegrationOptionEnableAppHangTracking = 1 << 6,
+    kIntegrationOptionEnableNetworkTracking = 1 << 7,
+    kIntegrationOptionEnableFileIOTracing = 1 << 8,
+    kIntegrationOptionEnableNetworkBreadcrumbs = 1 << 9,
+    kIntegrationOptionEnableCoreDataTracing = 1 << 10,
+    kIntegrationOptionEnableSwizzling = 1 << 11,
+    kIntegrationOptionEnableAutoBreadcrumbTracking = 1 << 12,
+    kIntegrationOptionIsTracingEnabled = 1 << 13,
+    kIntegrationOptionDebuggerNotAttached = 1 << 14,
+    kIntegrationOptionAttachViewHierarchy = 1 << 15,
+    kIntegrationOptionEnableCrashHandler = 1 << 16,
+    kIntegrationOptionEnableMetricKit = 1 << 17,
+    kIntegrationOptionEnableReplay = 1 << 18,
+    kIntegrationOptionStartFramesTracker = 1 << 19,
+};
+
+@class SentryOptions;
+
+@interface SentryBaseIntegration : NSObject <SentryIntegrationProtocol>
+
+- (NSString *)integrationName;
+- (BOOL)installWithOptions:(SentryOptions *)options;
+- (void)logWithOptionName:(NSString *)optionName;
+- (void)logWithReason:(NSString *)reason;
+- (BOOL)shouldBeEnabledWithOptions:(SentryOptions *)options;
+- (SentryIntegrationOption)integrationOptions;
+- (void)uninstall;
+@end
+
+NS_ASSUME_NONNULL_END

Sources/Sentry/include/SentryHub+Private.h

@@ -12,7 +12,7 @@
 @class SentryReplayEvent;
 @class SentryAttachment;
 @class SentryReplayRecording;
-@protocol SentryBaseIntegrationProtocol;
+@protocol SentryIntegrationProtocol;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -28,7 +28,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nullable, nonatomic, strong) SentrySession *session;
 
 @property (nonatomic, strong)
-    NSMutableArray<id<SentryBaseIntegrationProtocol>> *installedIntegrations;
+    NSMutableArray<id<SentryIntegrationProtocol>> *installedIntegrations;
 
 @property (nonatomic, readonly, strong) NSObject *_swiftLogger;
 
@@ -38,7 +38,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (NSArray<NSString *> *)trimmedInstalledIntegrationNames;
 
-- (void)addInstalledIntegration:(id<SentryBaseIntegrationProtocol>)integration
+- (void)addInstalledIntegration:(id<SentryIntegrationProtocol>)integration
                            name:(NSString *)name;
 - (void)removeAllIntegrations;
 
@@ -86,7 +86,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (void)registerSessionListener:(id<SentrySessionListener>)listener;
 - (void)unregisterSessionListener:(id<SentrySessionListener>)listener;
-- (nullable id<SentryBaseIntegrationProtocol>)getInstalledIntegration:(Class)integrationClass;
+- (nullable id<SentryIntegrationProtocol>)getInstalledIntegration:(Class)integrationClass;
 - (NSSet<NSString *> *)installedIntegrationNames;
 
 #if SENTRY_TARGET_REPLAY_SUPPORTED

Sources/Swift/Core/Integrations/Integrations.swift

@@ -1,6 +1,9 @@
 @_implementationOnly import _SentryPrivate
 
-protocol Integration: SentryBaseIntegrationProtocol {
+// The Swift counterpart to `SentryObjcIntegrationProtocol`. This protocol allows
+// injecting the dependencies in a way that does not require the Integration to
+// depend on SentryDependencyContainer.
+protocol Integration: SentryIntegrationProtocol {
     // The dependencies required for the integration. The easiest way to satisfy this requirement when migrating from ObjC
     // is to define it as `SentryDependencyContainer` with a typealias. However, a generic Swift class that has a protocol
     // constraint on the `Dependencies` type can make it easier to test and to use without a direct dependency on all
@@ -16,7 +19,7 @@ protocol Integration: SentryBaseIntegrationProtocol {
 
 // Type erases the `Integration` so that it can be stored in an array and used for `addInstalledIntegration`
 private struct AnyIntegration {
-    let start: (Options, SentryDependencyContainer) -> SentryBaseIntegrationProtocol?
+    let start: (Options, SentryDependencyContainer) -> SentryIntegrationProtocol?
     let name: String
 
     init<I: Integration>(_ integration: I.Type) where I.Dependencies == SentryDependencyContainer {