C API for Firebase Version (#6690)

paulb777 · web-flow · commit 672256e11e9f · 2020-10-07T15:03:20.000-07:00
diff --git a/FirebaseAuth/CHANGELOG.md b/FirebaseAuth/CHANGELOG.md
@@ -2,7 +2,7 @@
 - [removed] Remove deprecated APIs `dataForKey`,`fetchProvidersForEmail:completion`, `signInAndRetrieveDataWithCredential:completion`, `reauthenticateAndRetrieveDataWithCredential:completion`, `linkAndRetrieveDataWithCredential:completion`. (#6607)
 - [added] Add support for the auth emulator. (#6624)
 - [changed] The global variables `FirebaseAuthVersionNum` and `FirebaseAuthVersionStr` are deleted.
-  `FirebaseVersion.version()` or `[FIRVersion version]` should be used instead.
+  `FirebaseVersion()` or `FIRFirebaseVersion()` should be used instead.
 
 # v6.9.1
 - [fixed] Internal source documentation. (#6371)
diff --git a/FirebaseAuth/Sources/Backend/FIRAuthBackend.m b/FirebaseAuth/Sources/Backend/FIRAuthBackend.m
@@ -596,7 +596,7 @@ + (void)resetPassword:(FIRResetPasswordRequest *)request
 }
 
 + (NSString *)authUserAgent {
-  return [NSString stringWithFormat:@"FirebaseAuth.iOS/%@ %@", [FIRVersion version],
+  return [NSString stringWithFormat:@"FirebaseAuth.iOS/%@ %@", FIRFirebaseVersion(),
                                     GTMFetcherStandardUserAgentString(nil)];
 }
 
@@ -636,7 +636,7 @@ - (void)asyncPostToURLWithRequestConfiguration:(FIRAuthRequestConfiguration *)re
   NSString *additionalFrameworkMarker =
       requestConfiguration.additionalFrameworkMarker ?: kFirebaseAuthCoreFrameworkMarker;
   NSString *clientVersion = [NSString
-      stringWithFormat:@"iOS/FirebaseSDK/%@/%@", [FIRVersion version], additionalFrameworkMarker];
+      stringWithFormat:@"iOS/FirebaseSDK/%@/%@", FIRFirebaseVersion(), additionalFrameworkMarker];
   [request setValue:clientVersion forHTTPHeaderField:kClientVersionHeader];
   NSString *bundleID = [[NSBundle mainBundle] bundleIdentifier];
   [request setValue:bundleID forHTTPHeaderField:kIosBundleIdentifierHeader];
diff --git a/FirebaseAuth/Tests/Sample/Sample/SettingsViewController.m b/FirebaseAuth/Tests/Sample/Sample/SettingsViewController.m
@@ -159,7 +159,7 @@ - (void)loadTableView {
   _tableViewManager.contents = [StaticContentTableViewContent contentWithSections:@[
     [StaticContentTableViewSection sectionWithTitle:@"Versions" cells:@[
       [StaticContentTableViewCell cellWithTitle:@"FirebaseAuth"
-                                          value:[FIRVersion version]],
+                                          value:FIRFirebaseVersion()],
     ]],
     [StaticContentTableViewSection sectionWithTitle:@"API Hosts" cells:@[
       [StaticContentTableViewCell cellWithTitle:@"Identity Toolkit"
diff --git a/FirebaseCore/CHANGELOG.md b/FirebaseCore/CHANGELOG.md
@@ -14,7 +14,7 @@
   is appended to the product name.
 - [changed] The version must now be specified for the two Swift-only Firebase CocoaPods in the
   Podfile like `pod 'FirebaseFirestoreSwift', '~> 7.0-beta'`.
-- [added] `FirebaseVersion.version()` or `[FIRVersion version]` API to access the Firebase
+- [added] `FirebaseVersion()` - Swift `FIRFirebaseVersion()` - ObjC API to access the Firebase
   installation version.
 
 # Firebase 6.34.0
diff --git a/FirebaseCore/Sources/FIRApp.m b/FirebaseCore/Sources/FIRApp.m
@@ -526,7 +526,7 @@ + (void)registerLibrary:(nonnull NSString *)name withVersion:(nonnull NSString *
 
 + (void)registerInternalLibrary:(nonnull Class<FIRLibrary>)library
                        withName:(nonnull NSString *)name {
-  [self registerInternalLibrary:library withName:name withVersion:[FIRVersion version]];
+  [self registerInternalLibrary:library withName:name withVersion:FIRFirebaseVersion()];
 }
 
 + (void)registerInternalLibrary:(nonnull Class<FIRLibrary>)library
@@ -560,7 +560,7 @@ + (NSString *)firebaseUserAgent {
   @synchronized(self) {
     dispatch_once(&sFirebaseUserAgentOnceToken, ^{
       // Report Firebase version for useragent string
-      [FIRApp registerLibrary:@"fire-ios" withVersion:[FIRVersion version]];
+      [FIRApp registerLibrary:@"fire-ios" withVersion:FIRFirebaseVersion()];
 
       NSDictionary<NSString *, id> *info = [[NSBundle mainBundle] infoDictionary];
       NSString *xcodeVersion = info[@"DTXcodeBuild"];
diff --git a/FirebaseCore/Sources/FIRLogger.m b/FirebaseCore/Sources/FIRLogger.m
@@ -58,7 +58,7 @@
 void FIRLoggerInitializeASL() {
   dispatch_once(&sFIRLoggerOnceToken, ^{
     // Register Firebase Version with GULLogger.
-    GULLoggerRegisterVersion([[FIRVersion version] UTF8String]);
+    GULLoggerRegisterVersion([FIRFirebaseVersion() UTF8String]);
 
     // Override the aslOptions to ASL_OPT_STDERR if the override argument is passed in.
     NSArray *arguments = [NSProcessInfo processInfo].arguments;
diff --git a/FirebaseCore/Sources/FIROptions.m b/FirebaseCore/Sources/FIROptions.m
@@ -285,7 +285,7 @@ - (NSString *)libraryVersionID {
   static dispatch_once_t onceToken;
   dispatch_once(&onceToken, ^{
     // The unit tests are set up to catch anything that does not properly convert.
-    NSString *version = [FIRVersion version];
+    NSString *version = FIRFirebaseVersion();
     NSArray *components = [version componentsSeparatedByString:@"."];
     NSString *major = [components objectAtIndex:0];
     NSString *minor = [NSString stringWithFormat:@"%02d", [[components objectAtIndex:1] intValue]];
diff --git a/FirebaseCore/Sources/FIRVersion.m b/FirebaseCore/Sources/FIRVersion.m
@@ -27,10 +27,6 @@
 #define STR(x) STR_EXPAND(x)
 #define STR_EXPAND(x) #x
 
-@implementation FIRVersion
-
-+ (NSString *)version {
-  return [NSString stringWithUTF8String:(const char *const)STR(Firebase_VERSION)];
+NSString* FIRFirebaseVersion(void) {
+  return [NSString stringWithUTF8String:(const char* const)STR(Firebase_VERSION)];
 }
-
-@end
diff --git a/FirebaseCore/Sources/Public/FirebaseCore/FIRVersion.h b/FirebaseCore/Sources/Public/FirebaseCore/FIRVersion.h
@@ -18,20 +18,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/**
- * This class provides internal access to the Firebase version for any Firebase pod.
- */
-NS_SWIFT_NAME(FirebaseVersion)
-@interface FIRVersion : NSObject
-
-/**
- * Returns the version string.
- */
-+ (NSString *)version;
-
-/** Unavailable. Class method only */
-- (instancetype)init NS_UNAVAILABLE;
-
-@end
+NS_SWIFT_NAME(FirebaseVersion())
+NSString* FIRFirebaseVersion(void);
 
 NS_ASSUME_NONNULL_END
diff --git a/FirebaseCore/Tests/Unit/FIROptionsTest.m b/FirebaseCore/Tests/Unit/FIROptionsTest.m
@@ -640,7 +640,7 @@ - (void)testVersionConsistency {
   int minor = (versionString[1] - '0') * 10 + versionString[2] - '0';
   int patch = (versionString[3] - '0') * 10 + versionString[4] - '0';
   NSString *str = [NSString stringWithFormat:@"%d.%d.%d", major, minor, patch];
-  XCTAssertEqualObjects(str, [FIRVersion version]);
+  XCTAssertEqualObjects(str, FIRFirebaseVersion());
 }
 
 // Repeat test with more Objective-C.
@@ -659,7 +659,7 @@ - (void)testVersionConsistency2 {
       [NSString stringWithFormat:@"%@.%d.%d", [kFIRLibraryVersionID substringWithRange:major],
                                  [[kFIRLibraryVersionID substringWithRange:minor] intValue],
                                  [[kFIRLibraryVersionID substringWithRange:patch] intValue]];
-  XCTAssertEqualObjects(str, [FIRVersion version]);
+  XCTAssertEqualObjects(str, FIRFirebaseVersion());
 }
 
 #pragma mark - Helpers
diff --git a/FirebaseDatabase/Sources/Api/FIRDatabase.m b/FirebaseDatabase/Sources/Api/FIRDatabase.m
@@ -96,7 +96,7 @@ + (FIRDatabase *)databaseForApp:(FIRApp *)app URL:(NSString *)url {
 
 + (NSString *)buildVersion {
     // TODO: Restore git hash when build moves back to git
-    return [NSString stringWithFormat:@"%@_%s", [FIRVersion version], __DATE__];
+    return [NSString stringWithFormat:@"%@_%s", FIRFirebaseVersion(), __DATE__];
 }
 
 + (FIRDatabase *)createDatabaseForTests:(FRepoInfo *)repoInfo
@@ -109,7 +109,7 @@ + (FIRDatabase *)createDatabaseForTests:(FRepoInfo *)repoInfo
 }
 
 + (NSString *)sdkVersion {
-    return [FIRVersion version];
+    return FIRFirebaseVersion();
 }
 
 + (void)setLoggingEnabled:(BOOL)enabled {
diff --git a/FirebaseDynamicLinks/Sources/FIRDynamicLinks.m b/FirebaseDynamicLinks/Sources/FIRDynamicLinks.m
@@ -303,7 +303,7 @@ - (void)checkForPendingDynamicLink {
       [[FIRDLRetrievalProcessFactory alloc] initWithNetworkingService:self.dynamicLinkNetworking
                                                             URLScheme:_URLScheme
                                                                APIKey:_APIKey
-                                                        FDLSDKVersion:[FIRVersion version]
+                                                        FDLSDKVersion:FIRFirebaseVersion()
                                                              delegate:self];
   _retrievalProcess = [factory automaticRetrievalProcess];
   [_retrievalProcess retrievePendingDynamicLink];
@@ -411,7 +411,7 @@ - (nullable FIRDynamicLink *)dynamicLinkFromUniversalLinkURL:(NSURL *)url {
           // TODO: Create dedicated logging function to prevent this.
           [self.dynamicLinkNetworking
               resolveShortLink:url
-                 FDLSDKVersion:[FIRVersion version]
+                 FDLSDKVersion:FIRFirebaseVersion()
                     completion:^(NSURL *_Nullable resolverURL, NSError *_Nullable resolverError){
                         // Nothing to do
                     }];
@@ -458,7 +458,7 @@ - (BOOL)handleUniversalLink:(NSURL *)universalLinkURL
 
 - (void)resolveShortLink:(NSURL *)url completion:(FIRDynamicLinkResolverHandler)completion {
   [self.dynamicLinkNetworking resolveShortLink:url
-                                 FDLSDKVersion:[FIRVersion version]
+                                 FDLSDKVersion:FIRFirebaseVersion()
                                     completion:completion];
 }
 
@@ -550,7 +550,7 @@ + (NSString *)genericDiagnosticInformation {
   NSMutableString *genericDiagnosticInfo = [[NSMutableString alloc] init];
 
   [genericDiagnosticInfo
-      appendFormat:@"Firebase Dynamic Links framework version %@\n", [FIRVersion version]];
+      appendFormat:@"Firebase Dynamic Links framework version %@\n", FIRFirebaseVersion()];
   [genericDiagnosticInfo appendFormat:@"System information: OS %@, OS version %@, model %@\n",
                                       [UIDevice currentDevice].systemName,
                                       [UIDevice currentDevice].systemVersion,
diff --git a/FirebaseInAppMessaging/Sources/Flows/FIRIAMClientInfoFetcher.m b/FirebaseInAppMessaging/Sources/Flows/FIRIAMClientInfoFetcher.m
@@ -129,7 +129,7 @@ - (nullable NSString *)getTimezone {
 
 - (NSString *)getIAMSDKVersion {
   // FIRInAppMessaging_LIB_VERSION macro comes from pod definition
-  return [FIRVersion version];
+  return FIRFirebaseVersion();
 }
 @end
 
diff --git a/FirebaseInstallations/CHANGELOG.md b/FirebaseInstallations/CHANGELOG.md
@@ -1,6 +1,6 @@
 # v7.0.0 -- M82
 - [changed] The global variable `FIRInstallationsVersionStr` is deleted.
-  `FirebaseVersion.version()` or `[FIRVersion version]` should be used instead.
+  `FirebaseVersion()` or `FIRFirebaseVersion()` should be used instead.
 - [changed] Throw an exception if `FIROptions.projectID` is missing or
   `FIROptions.APIKey` has incorrect format to catch critical configuration
   issues earlier. (#4692)
diff --git a/FirebaseInstallations/Source/Library/InstallationsAPI/FIRInstallationsAPIService.m b/FirebaseInstallations/Source/Library/InstallationsAPI/FIRInstallationsAPIService.m
@@ -346,7 +346,7 @@ - (instancetype)initWithURLSession:(NSURLSession *)URLSession
 }
 
 - (NSString *)SDKVersion {
-  return [NSString stringWithFormat:@"i:%@", [FIRVersion version]];
+  return [NSString stringWithFormat:@"i:%@", FIRFirebaseVersion()];
 }
 
 #pragma mark - Validation
diff --git a/FirebaseInstallations/Source/Tests/Unit/FIRInstallationsAPIServiceTests.m b/FirebaseInstallations/Source/Tests/Unit/FIRInstallationsAPIServiceTests.m
@@ -654,7 +654,7 @@ - (void)assertRegisterInstallationSuccessWithResponseFixtureName:(NSString *)fix
 }
 
 - (NSString *)SDKVersion {
-  return [NSString stringWithFormat:@"i:%@", [FIRVersion version]];
+  return [NSString stringWithFormat:@"i:%@", FIRFirebaseVersion()];
 }
 
 @end
diff --git a/FirebaseMessaging/Sources/FIRMessaging.m b/FirebaseMessaging/Sources/FIRMessaging.m
@@ -233,7 +233,7 @@ - (void)start {
 
 #if !TARGET_OS_WATCH
   // Print the library version for logging.
-  NSString *currentLibraryVersion = [FIRVersion version];
+  NSString *currentLibraryVersion = FIRFirebaseVersion();
   FIRMessagingLoggerInfo(kFIRMessagingMessageCodeMessagingPrintLibraryVersion,
                          @"FIRMessaging library version %@", currentLibraryVersion);
 
@@ -731,7 +731,7 @@ - (void)unsubscribeFromTopic:(NSString *)topic
 #pragma mark - IID dependencies
 
 + (NSString *)FIRMessagingSDKVersion {
-  return [FIRVersion version];
+  return FIRFirebaseVersion();
 }
 
 + (NSString *)FIRMessagingSDKCurrentLocale {
diff --git a/FirebaseStorage/CHANGELOG.md b/FirebaseStorage/CHANGELOG.md
@@ -1,6 +1,6 @@
 # 7.0.0
 - [changed] The global variable `FIRStorageVersionString` is deleted.
-  `FirebaseVersion.version()` or `[FIRVersion version]` should be used instead.
+  `FirebaseVersion()` or `FIRFirebaseVersion()` should be used instead.
 
 # 3.8.1
 - [fixed] Fixed typo in doc comments (#6485).
diff --git a/FirebaseStorage/Sources/FIRStorageTokenAuthorizer.m b/FirebaseStorage/Sources/FIRStorageTokenAuthorizer.m
@@ -53,7 +53,7 @@ - (void)authorizeRequest:(NSMutableURLRequest *)request
                 delegate:(id)delegate
        didFinishSelector:(SEL)sel {
   // Set version header on each request
-  NSString *versionString = [NSString stringWithFormat:@"ios/%@", [FIRVersion version]];
+  NSString *versionString = [NSString stringWithFormat:@"ios/%@", FIRFirebaseVersion()];
   [request setValue:versionString forHTTPHeaderField:@"x-firebase-storage-version"];
 
   // Set GMP ID on each request
diff --git a/SwiftPMTests/swift-test/main.swift b/SwiftPMTests/swift-test/main.swift
@@ -54,7 +54,7 @@ class importTest: XCTestCase {
     XCTAssertNil(FirebaseApp.app())
     XCTAssertEqual(GULAppEnvironmentUtil.deviceModel(), "x86_64")
 
-    let versionParts = FirebaseVersion.version().split(separator: ".")
+    let versionParts = FirebaseVersion().split(separator: ".")
     XCTAssert(versionParts.count == 3)
     XCTAssertEqual(Int(versionParts[0]), 7)
     XCTAssertNotNil(Int(versionParts[1]))
diff --git a/SwiftPMTests/version-test/versionTest.m b/SwiftPMTests/version-test/versionTest.m
@@ -31,7 +31,7 @@ @implementation VersionTest
 
 - (void)testVersion {
   NSString *version = [NSString stringWithUTF8String:(const char *const)STR(FIR_VERSION)];
-  XCTAssertEqualObjects([FIRVersion version], version);
+  XCTAssertEqualObjects(FIRFirebaseVersion(), version);
 }
 
 @end
