fix(ios): stub Performance and In-App Messaging when Catalyst SPM headers absent

Author: mikehardy

okf-bundle/ios-spm-native-imports.md

@@ -70,12 +70,31 @@ Adding the real per-product header branch fixes products that actually publish a
 usable Objective-C header. It does not fix Firebase products whose public
 Objective-C class interface is generated from Swift.
 
-When neither the CocoaPods umbrella nor the SPM product header is present — for
-example Firebase App Distribution on Mac Catalyst under SPM — a `.mm`
-TurboModule must compile a stub that rejects at runtime with a clear
+When neither the CocoaPods umbrella nor the SPM product header is present, a
+`.mm` TurboModule must compile a stub that rejects at runtime with a clear
 unsupported/unavailable error. Falling through to `@import` is never allowed;
 do not enable `-fcxx-modules` to make the module import work.
 
+### Mac Catalyst stubs (mirroring upstream `Package.swift` gates)
+
+This is **not** an SPM integration bug in RNFB. Upstream
+`firebase-ios-sdk` `Package.swift` wrap targets omit `.macCatalyst` for some
+products, so Catalyst + SPM links only the empty `SwiftPM-PlatformExclude/*Wrap`
+dummies and never builds the real modules. CocoaPods-era Catalyst builds
+compiled through the `Firebase/Firebase.h` umbrella and therefore masked the
+same platform exclusion.
+
+| Product | Upstream SPM Catalyst gate | RNFB stub | Notes |
+| --- | --- | --- | --- |
+| App Distribution | `FirebaseAppDistributionTarget` is `.iOS` only | `RNFBAppDistributionModule.mm` (`RNFB_APP_DISTRIBUTION_SDK_AVAILABLE`) | Intentionally iOS-tester-only; not proposed for Catalyst |
+| Performance | `FirebasePerformanceTarget` omits `.macCatalyst` | `RNFBPerfModule.mm` (`RNFB_PERF_SDK_AVAILABLE`) | Speculative enablement: [firebase-ios-sdk#16468](https://github.com/firebase/firebase-ios-sdk/pull/16468) |
+| In-App Messaging | `FirebaseInAppMessagingTarget` omits `.macCatalyst` | `RNFBFiamHelper.m` (`RNFB_FIAM_SDK_AVAILABLE`; Catalyst skips `@import`) | Same speculative PR; helper stays plain `.m` so iOS/tvOS SPM can `@import` |
+
+Until/unless #16468 lands (or upstream declines and the stubs become permanent),
+RNFB must compile on Catalyst SPM without those product headers/modules. Do not
+stub Auth, Analytics, Crashlytics, Messaging, or other products that upstream
+already includes for Catalyst under SPM.
+
 ## Swift-product boundary
 
 `FirebaseStorage`, `FirebaseRemoteConfig`, `FirebaseDatabase`, and
@@ -257,8 +276,10 @@ When native Firebase imports or SPM products change, review the diff for these
 invariants:
 
 - no umbrella-header-to-`@import` fallback without a real product-header branch;
-- when product headers are absent on a platform (e.g. App Distribution on
-  Catalyst), stub/reject in `.mm` — never `@import` and never `-fcxx-modules`;
+- when product headers/modules are absent on a platform because upstream SPM
+  wrap targets omit `.macCatalyst` (App Distribution, Performance, In-App
+  Messaging — see table above), stub/reject — never `@import` from `.mm` and
+  never `-fcxx-modules`;
 - no direct Swift-product Firebase import, Firebase-typed declaration, or
   Firebase-bearing shared header in a `.mm` translation unit;
 - no `-fcxx-modules` build setting;

packages/in-app-messaging/ios/RNFBFiam/RNFBFiamHelper.h

@@ -30,7 +30,10 @@ NS_ASSUME_NONNULL_BEGIN
 /// breaks React Native's own jsi/React modules. Isolating all
 /// FirebaseInAppMessaging usage in this plain Objective-C (.m) file avoids
 /// that requirement entirely, since `@import` only needs `-fmodules`
-/// (already enabled) for plain ObjC. See okf-bundle/ios-spm-native-imports.md.
+/// (already enabled) for plain ObjC. On Mac Catalyst + SPM the upstream
+/// wrap target omits the real module — see RNFBFiamHelper.m stubs and
+/// https://github.com/firebase/firebase-ios-sdk/pull/16468. See
+/// okf-bundle/ios-spm-native-imports.md.
 @interface RNFBFiamHelper : NSObject
 
 + (BOOL)isMessageDisplaySuppressed;

packages/in-app-messaging/ios/RNFBFiam/RNFBFiamHelper.m

@@ -17,33 +17,66 @@
 
 #if __has_include(<Firebase/Firebase.h>)
 #import <Firebase/Firebase.h>
-#else
+#define RNFB_FIAM_SDK_AVAILABLE 1
+#elif !TARGET_OS_MACCATALYST
+// SPM on iOS/tvOS: FirebaseInAppMessaging is a Swift product — use @import in
+// this plain .m (needs -fmodules only). Do not move @import into the .mm
+// TurboModule (that would require -fcxx-modules).
 @import FirebaseCore;
 @import FirebaseInAppMessaging;
+#define RNFB_FIAM_SDK_AVAILABLE 1
+#else
+// Product module absent under Mac Catalyst + SPM. Upstream Package.swift omits
+// .macCatalyst from FirebaseInAppMessagingTarget; CocoaPods historically
+// masked this via the Firebase umbrella. Temporary stubs pending
+// https://github.com/firebase/firebase-ios-sdk/pull/16468 (or permanent if
+// upstream declines). When that PR lands, drop the TARGET_OS_MACCATALYST
+// gate and use the @import path on Catalyst too.
+#define RNFB_FIAM_SDK_AVAILABLE 0
 #endif
 
 #import "RNFBFiamHelper.h"
 
 @implementation RNFBFiamHelper
 
 + (BOOL)isMessageDisplaySuppressed {
+#if RNFB_FIAM_SDK_AVAILABLE
   return [FIRInAppMessaging inAppMessaging].messageDisplaySuppressed;
+#else
+  return NO;
+#endif
 }
 
 + (BOOL)isAutomaticDataCollectionEnabled {
+#if RNFB_FIAM_SDK_AVAILABLE
   return [FIRInAppMessaging inAppMessaging].automaticDataCollectionEnabled;
+#else
+  return NO;
+#endif
 }
 
 + (void)setAutomaticDataCollectionEnabled:(BOOL)enabled {
+#if RNFB_FIAM_SDK_AVAILABLE
   [FIRInAppMessaging inAppMessaging].automaticDataCollectionEnabled = enabled;
+#else
+  (void)enabled;
+#endif
 }
 
 + (void)setMessageDisplaySuppressed:(BOOL)enabled {
+#if RNFB_FIAM_SDK_AVAILABLE
   [FIRInAppMessaging inAppMessaging].messageDisplaySuppressed = enabled;
+#else
+  (void)enabled;
+#endif
 }
 
 + (void)triggerEvent:(NSString *)eventId {
+#if RNFB_FIAM_SDK_AVAILABLE
   [[FIRInAppMessaging inAppMessaging] triggerEvent:eventId];
+#else
+  (void)eventId;
+#endif
 }
 
 @end

packages/perf/ios/RNFBPerf/RNFBPerfModule.mm

@@ -20,13 +20,21 @@
 
 #if __has_include(<Firebase/Firebase.h>)
 #import <Firebase/Firebase.h>
+#define RNFB_PERF_SDK_AVAILABLE 1
 #elif __has_include(<FirebasePerformance/FirebasePerformance.h>)
 #import <FirebaseCore/FirebaseCore.h>
 #import <FirebasePerformance/FirebasePerformance.h>
+#define RNFB_PERF_SDK_AVAILABLE 1
 #else
-@import FirebaseCore;
-@import FirebasePerformance;
+// Product headers absent (typical Mac Catalyst + SPM). Upstream Package.swift
+// omits .macCatalyst from FirebasePerformanceTarget; CocoaPods historically
+// masked this via the Firebase umbrella. Temporary stubs pending
+// https://github.com/firebase/firebase-ios-sdk/pull/16468 (or permanent if
+// upstream declines). Never fall through to @import in this .mm — that
+// requires -fcxx-modules and breaks RN C++/JSI.
+#define RNFB_PERF_SDK_AVAILABLE 0
 #endif
+#import "RNFBApp/RNFBSharedUtils.h"
 #import "RNFBPerfModule.h"
 
 static __strong NSMutableDictionary *traces;
@@ -64,12 +72,28 @@ - (void)invalidate {
   }
 }
 
+#if !RNFB_PERF_SDK_AVAILABLE
+- (void)rejectUnavailable:(RCTPromiseRejectBlock)reject {
+  [RNFBSharedUtils rejectPromiseWithUserInfo:reject
+                                    userInfo:(NSMutableDictionary *)@{
+                                      @"code" : @"unsupported",
+                                      @"message" : @"Firebase Performance is not available on "
+                                                   @"this platform or dependency configuration.",
+                                    }];
+}
+#endif
+
 - (NSDictionary *)perfConstantsDictionary {
   NSMutableDictionary *constants = [NSMutableDictionary new];
+#if RNFB_PERF_SDK_AVAILABLE
   constants[@"isPerformanceCollectionEnabled"] =
       @([RCTConvert BOOL:@([FIRPerformance sharedInstance].dataCollectionEnabled)]);
   constants[@"isInstrumentationEnabled"] =
       @([RCTConvert BOOL:@([FIRPerformance sharedInstance].instrumentationEnabled)]);
+#else
+  constants[@"isPerformanceCollectionEnabled"] = @(NO);
+  constants[@"isInstrumentationEnabled"] = @(NO);
+#endif
   return constants;
 }
 
@@ -89,27 +113,45 @@ - (NSDictionary *)perfConstantsDictionary {
 - (void)setPerformanceCollectionEnabled:(BOOL)enabled
                                 resolve:(RCTPromiseResolveBlock)resolve
                                  reject:(RCTPromiseRejectBlock)reject {
+#if RNFB_PERF_SDK_AVAILABLE
   [FIRPerformance sharedInstance].dataCollectionEnabled = (BOOL)enabled;
   resolve([NSNull null]);
+#else
+  (void)enabled;
+  (void)resolve;
+  [self rejectUnavailable:reject];
+#endif
 }
 
 - (void)instrumentationEnabled:(BOOL)enabled
                        resolve:(RCTPromiseResolveBlock)resolve
                         reject:(RCTPromiseRejectBlock)reject {
+#if RNFB_PERF_SDK_AVAILABLE
   [FIRPerformance sharedInstance].instrumentationEnabled = (BOOL)enabled;
   resolve([NSNull null]);
+#else
+  (void)enabled;
+  (void)resolve;
+  [self rejectUnavailable:reject];
+#endif
 }
 
 - (void)startTrace:(double)id identifier:(NSString *)identifier {
+#if RNFB_PERF_SDK_AVAILABLE
   FIRTrace *trace = [[FIRPerformance sharedInstance] traceWithName:identifier];
   [trace start];
 
   @synchronized([self class]) {
     traces[@((int)id)] = trace;
   }
+#else
+  (void)id;
+  (void)identifier;
+#endif
 }
 
 - (void)stopTrace:(double)id traceData:(JS::NativeRNFBTurboPerf::TraceData &)traceData {
+#if RNFB_PERF_SDK_AVAILABLE
   FIRTrace *trace;
   @synchronized([self class]) {
     trace = traces[@((int)id)];
@@ -132,17 +174,25 @@ - (void)stopTrace:(double)id traceData:(JS::NativeRNFBTurboPerf::TraceData &)tra
   @synchronized([self class]) {
     [traces removeObjectForKey:@((int)id)];
   }
+#else
+  (void)id;
+  (void)traceData;
+#endif
 }
 
 - (void)startScreenTrace:(double)id identifier:(NSString *)identifier {
   // Custom screen traces are not supported on iOS.
+  (void)id;
+  (void)identifier;
 }
 
 - (void)stopScreenTrace:(double)id {
   // Custom screen traces are not supported on iOS.
+  (void)id;
 }
 
 - (void)startHttpMetric:(double)id url:(NSString *)url httpMethod:(NSString *)httpMethod {
+#if RNFB_PERF_SDK_AVAILABLE
   FIRHTTPMethod method = FIRHTTPMethodGET;
   NSURL *toNSURL = [NSURL URLWithString:url];
   if ([httpMethod compare:@"put" options:NSCaseInsensitiveSearch] == NSOrderedSame)
@@ -168,9 +218,15 @@ - (void)startHttpMetric:(double)id url:(NSString *)url httpMethod:(NSString *)ht
   @synchronized([self class]) {
     httpMetrics[@((int)id)] = httpMetric;
   }
+#else
+  (void)id;
+  (void)url;
+  (void)httpMethod;
+#endif
 }
 
 - (void)stopHttpMetric:(double)id metricData:(JS::NativeRNFBTurboPerf::HttpMetricData &)metricData {
+#if RNFB_PERF_SDK_AVAILABLE
   FIRHTTPMetric *httpMetric;
   @synchronized([self class]) {
     httpMetric = httpMetrics[@((int)id)];
@@ -203,6 +259,10 @@ - (void)stopHttpMetric:(double)id metricData:(JS::NativeRNFBTurboPerf::HttpMetri
   @synchronized([self class]) {
     [httpMetrics removeObjectForKey:@((int)id)];
   }
+#else
+  (void)id;
+  (void)metricData;
+#endif
 }
 
 @end