Fix FIROptions module organization

firebase · Oct 1, 2024 · 47bfe02 · 47bfe02
1 parent bb71115
commit 47bfe02
Show file tree

Hide file tree

Showing 26 changed files with 64 additions and 42 deletions.
diff --git a/FirebaseAppCheck/Tests/Unit/Core/FIRAppCheckValidatorTests.m b/FirebaseAppCheck/Tests/Unit/Core/FIRAppCheckValidatorTests.m
@@ -17,19 +17,18 @@
 #import <XCTest/XCTest.h>
 
 #import "FirebaseAppCheck/Sources/Core/FIRAppCheckValidator.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
 
 @interface FIRAppCheckValidatorTests : XCTestCase
 @end
 
 @implementation FIRAppCheckValidatorTests
 
 - (void)test_tokenExchangeMissingFieldsInOptions_noMissingFields {
-  FIROptions *options = [[FIROptions alloc] initInternalWithOptionsDictionary:@{
-    kFIRGoogleAppID : @"TEST_GoogleAppID",
-    kFIRAPIKey : @"TEST_APIKey",
-    kFIRProjectID : @"TEST_ProjectID"
-  }];
+  FIROptions *options = [[FIROptions alloc] initWithGoogleAppID:@"TEST_GoogleAppID"
+                                                    GCMSenderID:@"TEST_GCMSenderID"];
+  options.APIKey = @"TEST_APIKey";
+  options.projectID = @"TEST_ProjectID";
 
   NSArray *missingFields = [FIRAppCheckValidator tokenExchangeMissingFieldsInOptions:options];
 
@@ -38,11 +37,10 @@ - (void)test_tokenExchangeMissingFieldsInOptions_noMissingFields {
 
 - (void)test_tokenExchangeMissingFieldsInOptions_singleMissingField {
   // Google App ID is empty:
-  FIROptions *options = [[FIROptions alloc] initInternalWithOptionsDictionary:@{
-    kFIRGoogleAppID : @"",
-    kFIRAPIKey : @"TEST_APIKey",
-    kFIRProjectID : @"TEST_ProjectID"
-  }];
+  FIROptions *options = [[FIROptions alloc] initWithGoogleAppID:@""
+                                                    GCMSenderID:@"TEST_GCMSenderID"];
+  options.APIKey = @"TEST_APIKey";
+  options.projectID = @"TEST_ProjectID";
 
   NSArray *missingFields = [FIRAppCheckValidator tokenExchangeMissingFieldsInOptions:options];
 
@@ -51,8 +49,8 @@ - (void)test_tokenExchangeMissingFieldsInOptions_singleMissingField {
 
 - (void)test_tokenExchangeMissingFieldsInOptions_multipleMissingFields {
   // Google App ID is empty, and API Key and Project ID are not set:
-  FIROptions *options =
-      [[FIROptions alloc] initInternalWithOptionsDictionary:@{kFIRGoogleAppID : @""}];
+  FIROptions *options = [[FIROptions alloc] initWithGoogleAppID:@""
+                                                    GCMSenderID:@"TEST_GCMSenderID"];
 
   NSArray *missingFields = [FIRAppCheckValidator tokenExchangeMissingFieldsInOptions:options];
 

diff --git a/FirebaseAuth.podspec b/FirebaseAuth.podspec
@@ -58,8 +58,8 @@ supports email and password accounts, as well as several 3rd party authenticatio
   s.ios.framework = 'SafariServices'
   s.dependency 'FirebaseAuthInterop', '~> 11.0'
   s.dependency 'FirebaseAppCheckInterop', '~> 11.0'
-  s.dependency 'FirebaseCore', '~> 11.0'
-  s.dependency 'FirebaseCoreExtension', '~> 11.0'
+  s.dependency 'FirebaseCore', '~> 11.4'
+  s.dependency 'FirebaseCoreExtension', '~> 11.4'
   s.dependency 'GoogleUtilities/AppDelegateSwizzler', '~> 8.0'
   s.dependency 'GoogleUtilities/Environment', '~> 8.0'
   s.dependency 'GTMSessionFetcher/Core', '>= 3.4', '< 5.0'

diff --git a/FirebaseCore/Extension/FIRLogger.h b/FirebaseCore/Extension/FIRLogger.h
@@ -16,7 +16,7 @@
 
 #import <Foundation/Foundation.h>
 
-#import <FirebaseCore/FIRLoggerLevel.h>
+typedef NS_ENUM(NSInteger, FIRLoggerLevel);
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -132,7 +132,7 @@ NS_SWIFT_NAME(FirebaseLogger)
 ///
 /// - Parameters:
 ///   - level: The log level to use (defined by `FirebaseLoggerLevel` enum values).
-///   - service: The service name of type `FirebaseLoggerService`.
+///   - category: The service name of type `FirebaseLoggerService`.
 ///   - code: The message code. Starting with "I-" which means iOS, followed by a capitalized
 ///   three-character service identifier and a six digit integer message ID that is unique within
 ///   the service. An example of the message code is @"I-COR000001".

diff --git a/FirebaseCore/Extension/FirebaseCoreInternal.h b/FirebaseCore/Extension/FirebaseCoreInternal.h
@@ -21,4 +21,3 @@
 #import "FIRHeartbeatLogger.h"
 #import "FIRLibrary.h"
 #import "FIRLogger.h"
-#import "FIROptionsInternal.h"
diff --git a/FirebaseCore/Sources/FIRApp.m b/FirebaseCore/Sources/FIRApp.m
@@ -38,7 +38,8 @@
 #import "FirebaseCore/Extension/FIRHeartbeatLogger.h"
 #import "FirebaseCore/Extension/FIRLibrary.h"
 #import "FirebaseCore/Extension/FIRLogger.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
 #import "FirebaseCore/Sources/Public/FirebaseCore/FIRVersion.h"
 
 #import <GoogleUtilities/GULAppEnvironmentUtil.h>

diff --git a/FirebaseCore/Sources/FIRComponentContainer.m b/FirebaseCore/Sources/FIRComponentContainer.m
@@ -20,7 +20,8 @@
 #import "FirebaseCore/Extension/FIRComponent.h"
 #import "FirebaseCore/Extension/FIRLibrary.h"
 #import "FirebaseCore/Extension/FIRLogger.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

diff --git a/FirebaseCore/Sources/FIROptions.m b/FirebaseCore/Sources/FIROptions.m
@@ -14,8 +14,8 @@
 
 #import "FirebaseCore/Extension/FIRAppInternal.h"
 #import "FirebaseCore/Extension/FIRLogger.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
 #import "FirebaseCore/Sources/FIRBundleUtil.h"
+#import "FirebaseCore/Sources/FIROptionsInternal.h"
 #import "FirebaseCore/Sources/Public/FirebaseCore/FIRVersion.h"
 
 // Keys for the strings in the plist file.

diff --git a/FirebaseCore/Extension/FIROptionsInternal.h → FirebaseCore/Sources/FIROptionsInternal.h b/FirebaseCore/Extension/FIROptionsInternal.h → FirebaseCore/Sources/FIROptionsInternal.h
diff --git a/FirebaseCore/Tests/Unit/FIRAppTest.m b/FirebaseCore/Tests/Unit/FIRAppTest.m
@@ -31,8 +31,8 @@
 #import "FirebaseCore/Extension/FIRAppInternal.h"
 #import "FirebaseCore/Extension/FIRComponentType.h"
 #import "FirebaseCore/Extension/FIRHeartbeatLogger.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
 #import "FirebaseCore/Sources/FIRAnalyticsConfiguration.h"
+#import "FirebaseCore/Sources/FIROptionsInternal.h"
 #import "SharedTestUtilities/FIROptionsMock.h"
 
 NSString *const kFIRTestAppName1 = @"test_app_name_1";

diff --git a/FirebaseCore/Tests/Unit/FIRLoggerTest.m b/FirebaseCore/Tests/Unit/FIRLoggerTest.m
@@ -21,6 +21,7 @@
 // No test should include both includes.
 #import <GoogleUtilities/GULLogger.h>
 #import "FirebaseCore/Extension/FIRLogger.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIRLoggerLevel.h"
 
 #import <asl.h>
 

diff --git a/FirebaseCore/Tests/Unit/FIROptionsTest.m b/FirebaseCore/Tests/Unit/FIROptionsTest.m
@@ -15,8 +15,8 @@
 #import "FirebaseCore/Tests/Unit/FIRTestCase.h"
 
 #import "FirebaseCore/Extension/FIRAppInternal.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
 #import "FirebaseCore/Sources/FIRBundleUtil.h"
+#import "FirebaseCore/Sources/FIROptionsInternal.h"
 #import "FirebaseCore/Sources/Public/FirebaseCore/FIRVersion.h"
 #import "SharedTestUtilities/FIROptionsMock.h"
 

diff --git a/FirebaseCrashlytics.podspec b/FirebaseCrashlytics.podspec
@@ -59,7 +59,7 @@ Pod::Spec.new do |s|
     cp -f ./Crashlytics/CrashlyticsInputFiles.xcfilelist ./CrashlyticsInputFiles.xcfilelist
   PREPARE_COMMAND_END
 
-  s.dependency 'FirebaseCore', '~> 11.0'
+  s.dependency 'FirebaseCore', '~> 11.4'
   s.dependency 'FirebaseInstallations', '~> 11.0'
   s.dependency 'FirebaseSessions', '~> 11.0'
   s.dependency 'FirebaseRemoteConfigInterop', '~> 11.0'

diff --git a/FirebaseFirestore.podspec b/FirebaseFirestore.podspec
@@ -35,8 +35,8 @@ Google Cloud Firestore is a NoSQL document database built for automatic scaling,
     "#{s.module_name}_Privacy" => 'Firestore/Swift/Source/Resources/PrivacyInfo.xcprivacy'
   }
 
-  s.dependency 'FirebaseCore', '~> 11.0'
-  s.dependency 'FirebaseCoreExtension', '~> 11.0'
+  s.dependency 'FirebaseCore', '~> 11.4'
+  s.dependency 'FirebaseCoreExtension', '~> 11.4'
   s.dependency 'FirebaseFirestoreInternal', '11.4.0'
   s.dependency 'FirebaseSharedSwift', '~> 11.0'
 

diff --git a/FirebaseFunctions.podspec b/FirebaseFunctions.podspec
@@ -35,8 +35,8 @@ Cloud Functions for Firebase.
     'FirebaseFunctions/Sources/**/*.swift',
   ]
 
-  s.dependency 'FirebaseCore', '~> 11.0'
-  s.dependency 'FirebaseCoreExtension', '~> 11.0'
+  s.dependency 'FirebaseCore', '~> 11.4'
+  s.dependency 'FirebaseCoreExtension', '~> 11.4'
   s.dependency 'FirebaseAppCheckInterop', '~> 11.0'
   s.dependency 'FirebaseAuthInterop', '~> 11.0'
   s.dependency 'FirebaseMessagingInterop', '~> 11.0'

diff --git a/FirebaseMLModelDownloader.podspec b/FirebaseMLModelDownloader.podspec
@@ -36,8 +36,8 @@ Pod::Spec.new do |s|
   ]
 
   s.framework = 'Foundation'
-  s.dependency 'FirebaseCore', '~> 11.0'
-  s.dependency 'FirebaseCoreExtension', '~> 11.0'
+  s.dependency 'FirebaseCore', '~> 11.4'
+  s.dependency 'FirebaseCoreExtension', '~> 11.4'
   s.dependency 'FirebaseInstallations', '~> 11.0'
   s.dependency 'GoogleDataTransport', '~> 10.0'
   s.dependency 'GoogleUtilities/UserDefaults', '~> 8.0'

diff --git a/FirebaseSessions.podspec b/FirebaseSessions.podspec
@@ -39,8 +39,8 @@ Pod::Spec.new do |s|
     base_dir + 'SourcesObjC/**/*.{c,h,m,mm}',
   ]
 
-  s.dependency 'FirebaseCore', '~> 11.0'
-  s.dependency 'FirebaseCoreExtension', '~> 11.0'
+  s.dependency 'FirebaseCore', '~> 11.4'
+  s.dependency 'FirebaseCoreExtension', '~> 11.4'
   s.dependency 'FirebaseInstallations', '~> 11.0'
   s.dependency 'GoogleDataTransport', '~> 10.0'
   s.dependency 'GoogleUtilities/Environment', '~> 8.0'

diff --git a/FirebaseStorage.podspec b/FirebaseStorage.podspec
@@ -39,8 +39,8 @@ Firebase Storage provides robust, secure file uploads and downloads from Firebas
 
   s.dependency 'FirebaseAppCheckInterop', '~> 11.0'
   s.dependency 'FirebaseAuthInterop', '~> 11.0'
-  s.dependency 'FirebaseCore', '~> 11.0'
-  s.dependency 'FirebaseCoreExtension', '~> 11.0'
+  s.dependency 'FirebaseCore', '~> 11.4'
+  s.dependency 'FirebaseCoreExtension', '~> 11.4'
   s.dependency 'GTMSessionFetcher/Core', '>= 3.4', '< 5.0'
   s.dependency 'GoogleUtilities/Environment', '~> 8.0'
 

diff --git a/FirebaseVertexAI.podspec b/FirebaseVertexAI.podspec
@@ -46,8 +46,8 @@ the Vertex AI in Firebase SDK.
 
   s.dependency 'FirebaseAppCheckInterop', '~> 11.2'
   s.dependency 'FirebaseAuthInterop', '~> 11.2'
-  s.dependency 'FirebaseCore', '~> 11.2'
-  s.dependency 'FirebaseCoreExtension', '~> 11.2'
+  s.dependency 'FirebaseCore', '~> 11.4'
+  s.dependency 'FirebaseCoreExtension', '~> 11.4'
 
   s.test_spec 'unit' do |unit_tests|
     unit_tests_dir = 'FirebaseVertexAI/Tests/Unit/'

diff --git a/Firestore/Example/Tests/Integration/API/FIRValidationTests.mm b/Firestore/Example/Tests/Integration/API/FIRValidationTests.mm
@@ -20,7 +20,7 @@
 #include <limits>
 
 #import "FirebaseCore/Extension/FIRAppInternal.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
 #import "Firestore/Example/Tests/Util/FSTHelpers.h"
 #import "Firestore/Example/Tests/Util/FSTIntegrationTestCase.h"
 #import "Firestore/Source/API/FIRFirestore+Internal.h"

diff --git a/Firestore/Example/Tests/Util/FSTIntegrationTestCase.mm b/Firestore/Example/Tests/Util/FSTIntegrationTestCase.mm
@@ -34,7 +34,8 @@
 
 #import "FirebaseCore/Extension/FIRAppInternal.h"
 #import "FirebaseCore/Extension/FIRLogger.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIRLoggerLevel.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
 #import "Firestore/Example/Tests/Util/FIRFirestore+Testing.h"
 #import "Firestore/Example/Tests/Util/FSTEventAccumulator.h"
 #import "Firestore/Source/API/FIRAggregateQuery+Internal.h"

diff --git a/Firestore/Source/API/FSTFirestoreComponent.mm b/Firestore/Source/API/FSTFirestoreComponent.mm
@@ -28,7 +28,7 @@
 #import "FirebaseCore/Extension/FIRComponentContainer.h"
 #import "FirebaseCore/Extension/FIRComponentType.h"
 #import "FirebaseCore/Extension/FIRLibrary.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
 #import "Firestore/Source/API/FIRFirestore+Internal.h"
 
 #include "Firestore/core/include/firebase/firestore/firestore_version.h"

diff --git a/Firestore/core/src/remote/firebase_metadata_provider_apple.mm b/Firestore/core/src/remote/firebase_metadata_provider_apple.mm
@@ -18,7 +18,7 @@
 
 #import "FirebaseCore/Extension/FIRAppInternal.h"
 #import "FirebaseCore/Extension/FIRHeartbeatLogger.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
 
 #include "Firestore/core/src/util/string_apple.h"
 

diff --git a/Firestore/core/src/util/log_apple.mm b/Firestore/core/src/util/log_apple.mm
@@ -24,6 +24,7 @@
 #include <string>
 
 #import "FirebaseCore/Extension/FIRLogger.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIRLoggerLevel.h"
 
 #include "Firestore/core/src/util/string_apple.h"
 

diff --git a/Firestore/core/test/unit/testutil/app_testing.mm b/Firestore/core/test/unit/testutil/app_testing.mm
@@ -15,7 +15,7 @@
  */
 
 #import "FirebaseCore/Extension/FIRAppInternal.h"
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
 
 #include "Firestore/core/src/util/string_apple.h"
 #include "Firestore/core/test/unit/testutil/app_testing.h"

diff --git a/Gemfile b/Gemfile
@@ -2,6 +2,8 @@
 # commit Gemfile and Gemfile.lock.
 source 'https://rubygems.org'
 
+#TODO: revert before merge
+
 # To test CocoaPods pre-releases, update to a relevant commit or tag like below
 # cocoapods-core and xcodeproj may or may not also need tags. For additional
 # testing, enable the cron jobs with a global search and replace from your

diff --git a/SharedTestUtilities/FIROptionsMock.m b/SharedTestUtilities/FIROptionsMock.m
@@ -14,7 +14,7 @@
 
 #import <OCMock/OCMock.h>
 
-#import "FirebaseCore/Extension/FIROptionsInternal.h"
+#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
 #import "SharedTestUtilities/FIROptionsMock.h"
 
 NSString *const kAPIKey = @"correct_api_key";
@@ -31,6 +31,24 @@
 NSString *const kBundleID = @"com.google.FirebaseSDKTests";
 NSString *const kProjectID = @"abc-xyz-123";
 
+/**
+ * Keys for the strings in the plist file.
+ */
+extern NSString *const kFIRAPIKey;
+extern NSString *const kFIRTrackingID;
+extern NSString *const kFIRGoogleAppID;
+extern NSString *const kFIRClientID;
+extern NSString *const kFIRGCMSenderID;
+extern NSString *const kFIRAndroidClientID;
+extern NSString *const kFIRDatabaseURL;
+extern NSString *const kFIRStorageBucket;
+extern NSString *const kFIRBundleID;
+extern NSString *const kFIRProjectID;
+
+@interface FIROptions ()
++ (NSDictionary *)defaultOptionsDictionary;
+@end
+
 @interface FIROptionsMock ()
 
 @end