ref: SentryClient and SentryHub in Swift (#6627)

* ref: SentryClient and SentryHub in Swift

* Undo rename

Author: noahsmartin

Samples/iOS-Swift/iOS-Swift/Tools/SentryExposure.h

@@ -2,7 +2,7 @@
 #import <Sentry/SentryScope.h>
 #import <UIKit/UIKit.h>
 
-@class SentryHub;
+@class SentryOptions;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -13,11 +13,23 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
+@interface SentryClientInternal : NSObject
+
+@property (nonatomic) SentryOptions *options;
+
+@end
+
+@interface SentryHubInternal : NSObject
+
+- (nullable SentryClientInternal *)getClient;
+
+@end
+
 @interface SentrySDKInternal : NSObject
 
 + (nullable NSArray<NSString *> *)relevantViewControllersNames;
 
-+ (SentryHub *)currentHub;
++ (SentryHubInternal *)currentHub;
 
 @end
 

Sentry.xcodeproj/project.pbxproj

@@ -3,13 +3,14 @@
 @class SentryClient;
 @class SentryCrashWrapper;
 @class SentryDispatchQueueWrapper;
+@class SentryClientInternal;
 @protocol SentryIntegrationProtocol;
 NS_ASSUME_NONNULL_BEGIN
 
 /** Expose the internal test init for testing. */
-@interface SentryHub ()
+@interface SentryHubInternal ()
 
-- (instancetype)initWithClient:(SentryClient *_Nullable)client
+- (instancetype)initWithClient:(SentryClientInternal *_Nullable)client
                       andScope:(SentryScope *_Nullable)scope
                andCrashWrapper:(SentryCrashWrapper *)crashAdapter
               andDispatchQueue:(SentryDispatchQueueWrapper *)dispatchQueue;

SentryTestUtils/SentryHub+Test.h

@@ -2,7 +2,7 @@ import _SentryPrivate
 import Foundation
 @_spi(Private) import Sentry
 
-public class TestClient: SentryClient {
+public class TestClient: SentryClientInternal {
     public override init?(options: Options) {
         super.init(
             options: options,

SentryTestUtils/TestClient.swift

@@ -2,7 +2,7 @@ import _SentryPrivate
 import Foundation
 @_spi(Private) @testable import Sentry
 
-public class TestHub: SentryHub {
+public class TestHub: SentryHubInternal {
 
     public var startSessionInvocations: Int = 0
     public var closeCachedSessionInvocations: Int = 0

SentryTestUtils/TestHub.swift

@@ -349,7 +349,7 @@
 }
 
 void
-sentry_stopAndDiscardLaunchProfileTracer(SentryHub *_Nullable hub)
+sentry_stopAndDiscardLaunchProfileTracer(SentryHubInternal *_Nullable hub)
 {
     SENTRY_LOG_DEBUG(@"Finishing launch tracer.");
     sentry_launchTracer.hub = hub;

Sources/Sentry/Profiling/SentryLaunchProfiling.m

@@ -167,7 +167,7 @@
 }
 
 void
-sentry_discardProfilerCorrelatedToTrace(SentryId *internalTraceId, SentryHub *hub)
+sentry_discardProfilerCorrelatedToTrace(SentryId *internalTraceId, SentryHubInternal *hub)
 {
     std::lock_guard<std::mutex> l(_gStateLock);
 
@@ -238,9 +238,9 @@
 }
 
 void
-sentry_stopProfilerDueToFinishedTransaction(
-    SentryHub *hub, SentryDispatchQueueWrapper *dispatchQueue, SentryTransaction *transaction,
-    BOOL isProfiling, NSDate *_Nullable traceStartTimestamp, uint64_t startSystemTime
+sentry_stopProfilerDueToFinishedTransaction(SentryHubInternal *hub,
+    SentryDispatchQueueWrapper *dispatchQueue, SentryTransaction *transaction, BOOL isProfiling,
+    NSDate *_Nullable traceStartTimestamp, uint64_t startSystemTime
 #    if SENTRY_HAS_UIKIT
     ,
     SentryAppStartMeasurement *appStartMeasurement
@@ -256,10 +256,11 @@
         return;
     }
 
-    SentryClient *_Nullable client = hub.getClient;
+    SentryClientInternal *_Nullable client = hub.getClient;
     if (isProfiling && client != nil
-        && sentry_isContinuousProfilingEnabled(SENTRY_UNWRAP_NULLABLE(SentryClient, client))
-        && sentry_isProfilingCorrelatedToTraces(SENTRY_UNWRAP_NULLABLE(SentryClient, client))) {
+        && sentry_isContinuousProfilingEnabled(SENTRY_UNWRAP_NULLABLE(SentryClientInternal, client))
+        && sentry_isProfilingCorrelatedToTraces(
+            SENTRY_UNWRAP_NULLABLE(SentryClientInternal, client))) {
         SENTRY_LOG_DEBUG(@"Stopping tracking root span tracer with profilerReferenceId %@",
             sentry_stringFromSentryID(transaction.trace.profilerReferenceID));
         sentry_stopTrackingRootSpanForContinuousProfilerV2();
@@ -334,24 +335,25 @@
 }
 
 SentryId *_Nullable sentry_startProfilerForTrace(SentryTracerConfiguration *configuration,
-    SentryHub *_Nullable hub, SentryTransactionContext *transactionContext)
+    SentryHubInternal *_Nullable hub, SentryTransactionContext *transactionContext)
 {
     if (sentry_profileConfiguration.profileOptions != nil) {
         // launch profile; there's no hub to get options from, so they're read from the launch
         // profile config file
         return _sentry_startContinuousProfilerV2ForTrace(
             sentry_profileConfiguration.profileOptions, transactionContext);
     }
-    SentryClient *_Nullable client = hub.getClient;
+    SentryClientInternal *_Nullable client = hub.getClient;
     if (client != nil
-        && sentry_isContinuousProfilingEnabled(SENTRY_UNWRAP_NULLABLE(SentryClient, client))) {
+        && sentry_isContinuousProfilingEnabled(
+            SENTRY_UNWRAP_NULLABLE(SentryClientInternal, client))) {
         // non launch profile
         if (sentry_getParentSpanID(transactionContext) != nil) {
             SENTRY_LOG_DEBUG(@"Not a root span, will not start automatically for trace lifecycle.");
             return nil;
         }
         SentryProfileOptions *_Nullable profilingOptions
-            = sentry_getProfiling(SENTRY_UNWRAP_NULLABLE(SentryClient, client));
+            = sentry_getProfiling(SENTRY_UNWRAP_NULLABLE(SentryClientInternal, client));
         if (profilingOptions == nil) {
             SENTRY_LOG_DEBUG(@"No profiling options found, will not start profiler.");
             return nil;

Sources/Sentry/Profiling/SentryProfiledTracerConcurrency.mm

@@ -8,7 +8,7 @@
 #        import "SentryProfiler+Private.h"
 
 @class SentryDebugMeta;
-@class SentryHub;
+@class SentryHubInternal;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -26,7 +26,7 @@ SENTRY_EXTERN NSString *sentry_profilerTruncationReasonName(SentryProfilerTrunca
 SENTRY_EXTERN NSMutableDictionary<NSString *, id> *sentry_serializedTraceProfileData(
     NSDictionary<NSString *, id> *profileData, uint64_t startSystemTime, uint64_t endSystemTime,
     NSString *truncationReason, NSDictionary<NSString *, id> *serializedMetrics,
-    NSArray<SentryDebugMeta *> *debugMeta, SentryHub *hub
+    NSArray<SentryDebugMeta *> *debugMeta, SentryHubInternal *hub
 #        if SENTRY_HAS_UIKIT
     ,
     SentryScreenFrames *gpuData

Sources/Sentry/Profiling/SentryProfilerSerialization+Test.h

@@ -8,6 +8,7 @@
 #    import "SentryEnvelopeItemHeader.h"
 #    import "SentryEvent+Private.h"
 #    import "SentryFormatter.h"
+#    import "SentryHub.h"
 #    import "SentryInternalDefines.h"
 #    import "SentryLogC.h"
 #    import "SentryMeta.h"
@@ -110,7 +111,7 @@
 sentry_serializedTraceProfileData(
     NSDictionary<NSString *, id> *profileData, uint64_t startSystemTime, uint64_t endSystemTime,
     NSString *truncationReason, NSDictionary<NSString *, id> *serializedMetrics,
-    NSArray<SentryDebugMeta *> *debugMeta, SentryHub *hub
+    NSArray<SentryDebugMeta *> *debugMeta, SentryHubInternal *hub
 #    if SENTRY_HAS_UIKIT
     ,
     SentryScreenFrames *gpuData
@@ -222,7 +223,7 @@
 NSMutableDictionary<NSString *, id> *
 sentry_serializedContinuousProfileChunk(SentryId *profileID, SentryId *chunkID,
     NSDictionary<NSString *, id> *profileData, NSDictionary<NSString *, id> *serializedMetrics,
-    NSArray<SentryDebugMeta *> *debugMeta, SentryHub *hub
+    NSArray<SentryDebugMeta *> *debugMeta, SentryHubInternal *hub
 #    if SENTRY_HAS_UIKIT
     ,
     SentryScreenFrames *gpuData
@@ -358,7 +359,7 @@
 #    pragma clang diagnostic pop
 }
 
-SentryEnvelopeItem *_Nullable sentry_traceProfileEnvelopeItem(SentryHub *hub,
+SentryEnvelopeItem *_Nullable sentry_traceProfileEnvelopeItem(SentryHubInternal *hub,
     SentryProfiler *profiler, NSDictionary<NSString *, id> *profilingData,
     SentryTransaction *transaction, NSDate *startTimestamp)
 {
@@ -414,7 +415,7 @@
 }
 
 NSMutableDictionary<NSString *, id> *_Nullable sentry_collectProfileDataHybridSDK(
-    uint64_t startSystemTime, uint64_t endSystemTime, SentryId *traceId, SentryHub *hub)
+    uint64_t startSystemTime, uint64_t endSystemTime, SentryId *traceId, SentryHubInternal *hub)
 {
     SentryProfiler *profiler = sentry_profilerForFinishedTracer(traceId);
     if (!profiler) {

Sources/Sentry/Profiling/SentryProfilerSerialization.m

@@ -1,25 +1,26 @@
 #import "SentryProfilingSwiftHelpers.h"
 #if SENTRY_TARGET_PROFILING_SUPPORTED
 
+#    import "SentryClient.h"
 #    import "SentryLogC.h"
 #    import "SentryOptions+Private.h"
 #    import "SentryProfiler+Private.h"
 #    import "SentrySamplerDecision.h"
 #    import "SentrySwift.h"
 
 BOOL
-sentry_isContinuousProfilingEnabled(SentryClient *client)
+sentry_isContinuousProfilingEnabled(SentryClientInternal *client)
 {
     return [client.options isContinuousProfilingEnabled];
 }
 
 BOOL
-sentry_isProfilingCorrelatedToTraces(SentryClient *client)
+sentry_isProfilingCorrelatedToTraces(SentryClientInternal *client)
 {
     return [client.options isProfilingCorrelatedToTraces];
 }
 
-SentryProfileOptions *_Nullable sentry_getProfiling(SentryClient *client)
+SentryProfileOptions *_Nullable sentry_getProfiling(SentryClientInternal *client)
 {
     return client.options.profiling;
 }