Auth and Messaging Interop for Swift (firebase#9314)

Author: paulb777

.github/workflows/auth.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
     paths:
     - 'FirebaseAuth**'
-    - 'Interop/Auth/Public/*.h'
+    - 'FirebaseAuth/Interop/*.h'
     - '.github/workflows/auth.yml'
     - 'Gemfile*'
   schedule:

.github/workflows/database.yml

@@ -7,7 +7,7 @@ on:
     - 'Firebase/Database/**'
     - 'FirebaseSharedSwift**'
     - 'Example/Database/**'
-    - 'Interop/Auth/Public/*.h'
+    - 'FirebaseAuth/Interop/*.h'
     - '.github/workflows/database.yml'
     - 'Gemfile*'
     - 'scripts/run_database_emulator.sh'

.github/workflows/firestore.yml

@@ -21,7 +21,7 @@ on:
     - 'Firestore/**'
 
     # Interop headers
-    - 'Interop/Auth/Public/*.h'
+    - 'FirebaseAuth/Interop/*.h'
 
     # FirebaseCore header change
     - 'FirebaseCore/Internal'

.github/workflows/functions.yml

@@ -6,8 +6,8 @@ on:
     - 'FirebaseFunctions**'
     - 'FirebaseSharedSwift**'
     - '.github/workflows/functions.yml'
-    - 'Interop/Auth/Public/*.h'
-    - 'FirebaseMessaging/Sources/Interop/*.h'
+    - 'FirebaseAuth/Interop/*.h'
+    - 'FirebaseMessaging/Interop/*.h'
     - 'FirebaseTestingSupport/Functions/**'
     - 'FirebaseCombineSwift/Sources/Functions/**'
     - 'scripts/setup_quickstart.sh'

.github/workflows/storage.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
     paths:
     - 'FirebaseStorage**'
-    - 'Interop/Auth/Public/*.h'
+    - 'FirebaseAuth/Interop/*.h'
     - '.github/workflows/storage.yml'
     - 'scripts/**'
     # Rebuild on Ruby infrastructure changes.

CMakeLists.txt

@@ -261,8 +261,8 @@ if(FIREBASE_IOS_BUILD_TESTS)
   enable_testing()
 endif()
 
-add_subdirectory(FirebaseAppCheck/Interop/)
+add_subdirectory(FirebaseAppCheck/Interop)
 add_subdirectory(FirebaseCore)
 add_subdirectory(Firestore)
-add_subdirectory(Interop/Auth)
+add_subdirectory(FirebaseAuth/Interop)
 add_subdirectory(Interop/CoreDiagnostics)

FirebaseAppCheckInterop.podspec

@@ -27,4 +27,4 @@ Pod::Spec.new do |s|
 
   s.source_files = 'FirebaseAppCheck/Interop/*.[hm]'
   s.public_header_files = 'FirebaseAppCheck/Interop/*.h'
-end
+end

FirebaseAuth.podspec

@@ -36,7 +36,7 @@ supports email and password accounts, as well as several 3rd party authenticatio
   s.source_files = [
     source + '**/*.[mh]',
     'FirebaseCore/Internal/*.h',
-    'Interop/Auth/Public/*.h',
+    'FirebaseAuth/Interop/*.h',
   ]
   s.public_header_files = source + 'Public/FirebaseAuth/*.h'
   s.preserve_paths = [

Interop/Auth/CMakeLists.txt renamed to FirebaseAuth/Interop/CMakeLists.txt

@@ -32,7 +32,9 @@ NS_SWIFT_NAME(AuthInterop)
 @protocol FIRAuthInterop
 
 /// Retrieves the Firebase authentication token, possibly refreshing it if it has expired.
-- (void)getTokenForcingRefresh:(BOOL)forceRefresh withCallback:(FIRTokenCallback)callback;
+- (void)getTokenForcingRefresh:(BOOL)forceRefresh
+                  withCallback:(FIRTokenCallback)callback
+    NS_SWIFT_NAME(getToken(forcingRefresh:completion:));
 
 /// Get the current Auth user's UID. Returns nil if there is no user signed in.
 - (nullable NSString *)getUserID;

Interop/Auth/Public/FIRAuthInterop.h renamed to FirebaseAuth/Interop/FIRAuthInterop.h

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// Swift Package Manager needs at least one source file.

FirebaseAuth/Interop/dummy.m

@@ -15,9 +15,9 @@
  */
 
 #import <Foundation/Foundation.h>
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
 #import "FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuth.h"
 #import "FirebaseCore/Internal/FIRLogger.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
 
 @class FIRAuthRequestConfiguration;
 @class FIRAuthURLPresenter;

FirebaseAuth/Sources/Auth/FIRAuth_Internal.h

@@ -16,8 +16,8 @@
 
 #import <XCTest/XCTest.h>
 
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
 #import "FirebaseCore/Internal/FirebaseCoreInternal.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
 
 #import "FirebaseAuth/Sources/Auth/FIRAuth_Internal.h"
 #import "FirebaseAuth/Sources/Backend/FIRAuthRequestConfiguration.h"

FirebaseAuth/Tests/Unit/FIRAuthLifeCycleTests.m

@@ -19,6 +19,7 @@
 #import <XCTest/XCTest.h>
 
 #import <GoogleUtilities/GULAppDelegateSwizzler.h>
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
 #import "FirebaseAuth/Sources/Public/FirebaseAuth/FIRActionCodeSettings.h"
 #import "FirebaseAuth/Sources/Public/FirebaseAuth/FIRAdditionalUserInfo.h"
 #import "FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuthSettings.h"
@@ -27,7 +28,6 @@
 #import "FirebaseAuth/Sources/Public/FirebaseAuth/FIRGoogleAuthProvider.h"
 #import "FirebaseAuth/Sources/Public/FirebaseAuth/FIROAuthProvider.h"
 #import "FirebaseCore/Internal/FirebaseCoreInternal.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
 
 #import "FirebaseAuth/Sources/Auth/FIRAuthDispatcher.h"
 #import "FirebaseAuth/Sources/Auth/FIRAuthGlobalWorkQueue.h"

FirebaseAuth/Tests/Unit/FIRAuthTests.m

@@ -0,0 +1,30 @@
+Pod::Spec.new do |s|
+  s.name             = 'FirebaseAuthInterop'
+  s.version          = '8.12.0'
+  s.summary          = 'Interfaces that allow other Firebase SDKs to use Auth functionality.'
+
+  s.description      = <<-DESC
+  Not for public use.
+  A set of protocols that other Firebase SDKs can use to interoperate with FirebaseAuth in a safe
+  and reliable manner.
+                       DESC
+
+  s.homepage         = 'https://firebase.google.com'
+  s.license          = { :type => 'Apache', :file => 'LICENSE' }
+  s.authors          = 'Google, Inc.'
+
+  # NOTE that these should not be used externally, this is for Firebase pods to depend on each
+  # other.
+  s.source           = {
+    :git => 'https://github.com/firebase/firebase-ios-sdk.git',
+    :tag => 'CocoaPods-' + s.version.to_s
+  }
+  s.social_media_url = 'https://twitter.com/Firebase'
+  s.ios.deployment_target = '10.0'
+  s.osx.deployment_target = '10.12'
+  s.tvos.deployment_target = '10.0'
+  s.watchos.deployment_target = '6.0'
+
+  s.source_files = 'FirebaseAuth/Interop/*.[hm]'
+  s.public_header_files = 'FirebaseAuth/Interop/*.h'
+end

FirebaseAuthInterop.podspec

@@ -35,7 +35,7 @@ Simplify your iOS development, grow your user base, and monetize more effectivel
     base_dir + '**/*.[mh]',
     base_dir + 'third_party/Wrap-leveldb/APLevelDB.mm',
     base_dir + 'third_party/SocketRocket/fbase64.c',
-    'Interop/Auth/Public/*.h',
+    'FirebaseAuth/Interop/*.h',
     'FirebaseAppCheck/Interop/*.h',
     'FirebaseCore/Internal/*.h',
   ]

FirebaseDatabase.podspec

@@ -16,8 +16,8 @@
 
 #import <Foundation/Foundation.h>
 
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
 #import "FirebaseCore/Internal/FirebaseCoreInternal.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
 
 #import "FirebaseDatabase/Sources/Api/FIRDatabaseComponent.h"
 #import "FirebaseDatabase/Sources/Api/Private/FIRDatabaseQuery_Private.h"

FirebaseDatabase/Sources/Api/FIRDatabase.m

@@ -21,8 +21,8 @@
 #import "FirebaseDatabase/Sources/FIRDatabaseConfig_Private.h"
 
 #import "FirebaseAppCheck/Interop/FIRAppCheckInterop.h"
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
 #import "FirebaseCore/Internal/FirebaseCoreInternal.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

FirebaseDatabase/Sources/Api/FIRDatabaseComponent.m

@@ -20,7 +20,7 @@
 
 #import "FirebaseAppCheck/Interop/FIRAppCheckInterop.h"
 #import "FirebaseAppCheck/Interop/FIRAppCheckTokenResultInterop.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
 
 #import "FirebaseDatabase/Sources/Api/Private/FIRDatabaseQuery_Private.h"
 #import "FirebaseDatabase/Sources/Utilities/FUtilities.h"

FirebaseDatabase/Sources/Login/FIRDatabaseConnectionContextProvider.m

@@ -16,8 +16,8 @@
 
 #import "FirebaseDatabase/Tests/Helpers/FTestHelpers.h"
 
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
 #import "FirebaseCore/Internal/FirebaseCoreInternal.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
 
 #import "FirebaseDatabase/Sources/Api/Private/FIRDatabase_Private.h"
 #import "FirebaseDatabase/Sources/Constants/FConstants.h"

FirebaseDatabase/Tests/Helpers/FTestHelpers.m

@@ -16,8 +16,8 @@
 
 #import <XCTest/XCTest.h>
 
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
 #import "FirebaseCore/Internal/FirebaseCoreInternal.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
 
 #import "FirebaseDatabase/Sources/FIRDatabaseConfig_Private.h"
 #import "FirebaseDatabase/Tests/Helpers/FTestBase.h"

FirebaseDatabase/Tests/Integration/FIRAuthTests.m

@@ -49,7 +49,7 @@ Google Cloud Firestore is a NoSQL document database built for automatic scaling,
     'Firestore/Protos/nanopb/**/*.cc',
     'Firestore/core/include/**/*.{cc,mm}',
     'Firestore/core/src/**/*.{cc,mm}',
-    'Interop/Auth/Public/*.h',
+    'FirebaseAuth/Interop/*.h',
   ]
 
   # Internal headers that aren't necessarily globally unique. Most C++ internal

FirebaseFirestore.podspec

@@ -25,10 +25,10 @@ Cloud Functions for Firebase.
 
   s.source_files = [
     'FirebaseFunctions/Sources/**/*',
-    'Interop/Auth/Public/*.h',
+    'FirebaseAuth/Interop/*.h',
     'FirebaseAppCheck/Interop/*.h',
     'FirebaseCore/Internal/*.h',
-    'FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h',
+    'FirebaseMessaging/Interop/FIRMessagingInterop.h',
   ]
   s.public_header_files = 'FirebaseFunctions/Sources/Public/FirebaseFunctions/*.h'
 

FirebaseFunctions.podspec

@@ -18,9 +18,9 @@
 #import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRFunctions.h"
 
 #import "FirebaseAppCheck/Interop/FIRAppCheckInterop.h"
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
 #import "FirebaseFunctions/Sources/FIRFunctionsComponent.h"
-#import "FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
+#import "FirebaseMessaging/Interop/FIRMessagingInterop.h"
 
 #import "FirebaseFunctions/Sources/FIRHTTPSCallable+Internal.h"
 #import "FirebaseFunctions/Sources/FUNContext.h"

FirebaseFunctions/Sources/FIRFunctions.m

@@ -21,8 +21,8 @@
 #import "FirebaseCore/Internal/FirebaseCoreInternal.h"
 
 #import "FirebaseAppCheck/Interop/FIRAppCheckInterop.h"
-#import "FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
+#import "FirebaseMessaging/Interop/FIRMessagingInterop.h"
 
 @interface FIRFunctionsComponent () <FIRLibrary, FIRFunctionsProvider>
 

FirebaseFunctions/Sources/FIRFunctionsComponent.m

@@ -17,8 +17,8 @@
 
 #import "FirebaseAppCheck/Interop/FIRAppCheckInterop.h"
 #import "FirebaseAppCheck/Interop/FIRAppCheckTokenResultInterop.h"
-#import "FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h"
-#import "Interop/Auth/Public/FIRAuthInterop.h"
+#import "FirebaseAuth/Interop/FIRAuthInterop.h"
+#import "FirebaseMessaging/Interop/FIRMessagingInterop.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

FirebaseFunctions/Sources/FUNContext.m

@@ -38,6 +38,8 @@ Swift SDK Extensions for Cloud Functions for Firebase.
   s.dependency 'FirebaseCore', '~> 8.12'
   s.dependency 'FirebaseCoreInternal', '~> 8.12'
   s.dependency 'FirebaseAppCheckInterop', '~> 8.12'
+  s.dependency 'FirebaseAuthInterop', '~> 8.12'
+  s.dependency 'FirebaseMessagingInterop', '~> 8.12'
   s.dependency 'FirebaseSharedSwift', '~> 8.12'
   s.dependency 'GTMSessionFetcher/Core', '~> 1.5'
 

FirebaseFunctionsSwift.podspec

@@ -14,26 +14,17 @@
 
 import Foundation
 import FirebaseAppCheckInterop
+import FirebaseAuthInterop
 import FirebaseCore
 import FirebaseCoreInternal
+import FirebaseMessagingInterop
 import FirebaseSharedSwift
 #if COCOAPODS
   import GTMSessionFetcher
 #else
   import GTMSessionFetcherCore
 #endif
 
-// PLACEHOLDERS
-@objc public protocol AuthInterop {
-  func getToken(forcingRefresh: Bool, callback: (String?, Error?) -> Void)
-}
-
-@objc public protocol MessagingInterop {
-  var fcmToken: String { get }
-}
-
-// END PLACEHOLDERS
-
 /// File specific constants.
 private enum Constants {
   static let appCheckTokenHeader = "X-Firebase-AppCheck"

FirebaseFunctionsSwift/Sources/Functions.swift

@@ -14,6 +14,8 @@
 
 import Foundation
 import FirebaseAppCheckInterop
+import FirebaseAuthInterop
+import FirebaseMessagingInterop
 
 /// FunctionsContext is a helper class for gathering metadata for a function call.
 internal class FunctionsContext: NSObject {
@@ -67,7 +69,10 @@ internal class FunctionsContextProvider: NSObject {
       dispatchGroup.enter()
 
       appCheck.getToken(forcingRefresh: false) { tokenResult in
-        appCheckToken = tokenResult.token
+        // Send only valid token to functions.
+        if tokenResult.error == nil {
+          appCheckToken = tokenResult.token
+        }
         dispatchGroup.leave()
       }
     }

FirebaseFunctionsSwift/Sources/FunctionsContext.swift

@@ -15,6 +15,8 @@
 import Foundation
 
 @testable import FirebaseFunctionsSwift
+import FirebaseAuthInterop
+import FirebaseMessagingInterop
 import XCTest
 
 /// This file was intitialized as a direct port of `FirebaseFunctionsSwift/Tests/IntegrationTests.swift`
@@ -658,17 +660,21 @@ class IntegrationTests: XCTestCase {
 }
 
 private class AuthTokenProvider: AuthInterop {
+  func getUserID() -> String? {
+    return "fake user"
+  }
+
   let token: String
 
   init(token: String) {
     self.token = token
   }
 
-  func getToken(forcingRefresh: Bool, callback: (String?, Error?) -> Void) {
-    callback(token, nil)
+  func getToken(forcingRefresh: Bool, completion: (String?, Error?) -> Void) {
+    completion(token, nil)
   }
 }
 
-private class MessagingTokenProvider: MessagingInterop {
-  var fcmToken: String { return "fakeFCMToken" }
+private class MessagingTokenProvider: NSObject, MessagingInterop {
+  var fcmToken: String? { return "fakeFCMToken" }
 }