App Distro: fix async/await issue (#9634)

ryanwilson · web-flow · commit 2cbb18069710 · 2022-04-12T12:51:42.000-04:00
* App Distro: fix async/await issue

Right now we're calling a completion handler with `nil, nil` when
releases are fetched but none are marked as "latest". This shouldn't
happen, and is considered an error.

* Mark return type as optional

* Swfit tests

* Remove extra space

* Formatting

* Style again

* SwiftPM tests

* Revert version change

* [skip ci] Update CHANGELOG
diff --git a/FirebaseAppDistribution.podspec b/FirebaseAppDistribution.podspec
@@ -43,7 +43,10 @@ iOS SDK for App Distribution for Firebase.
 
   s.test_spec 'unit' do |unit_tests|
    unit_tests.scheme = { :code_coverage => true }
-   unit_tests.source_files = 'FirebaseAppDistribution/Tests/Unit*/*.[mh]'
+   unit_tests.source_files = [
+     'FirebaseAppDistribution/Tests/Unit*/*.[mh]',
+     'FirebaseAppDistribution/Tests/Unit/Swift*/*.swift',
+   ]
    unit_tests.resources = 'FirebaseAppDistribution/Tests/Unit/Resources/*'
    unit_tests.dependency 'OCMock'
   end
diff --git a/FirebaseAppDistribution/CHANGELOG.md b/FirebaseAppDistribution/CHANGELOG.md
@@ -1,5 +1,7 @@
 # v9.0.0-beta
-- [fixed] Marked `releaseNotes` as `nullable` as they don't always exist. (#8602)
+- [fixed] Marked `releaseNotes` as `nullable` as they don't always exist (#8602).
+- [fixed] **Breaking change:** Fixed an ObjC-to-Swift API conversion error where`checkForUpdate()`
+  returned a non-optional type. This change is breaking for Swift users only (#9604).
 
 # v8.3.0-beta
 - [changed] Sign out the Tester when the call to fetch releases fails with an unauthorized error (#8270).
diff --git a/FirebaseAppDistribution/Sources/Public/FirebaseAppDistribution/FIRAppDistribution.h b/FirebaseAppDistribution/Sources/Public/FirebaseAppDistribution/FIRAppDistribution.h
@@ -46,8 +46,8 @@ NS_SWIFT_NAME(AppDistribution)
 /**
  * Check to see whether a new distribution is available
  */
-- (void)checkForUpdateWithCompletion:
-    (void (^)(FIRAppDistributionRelease *_Nullable release, NSError *_Nullable error))completion
+- (void)checkForUpdateWithCompletion:(void (^)(FIRAppDistributionRelease *_Nullable_result release,
+                                               NSError *_Nullable error))completion
     NS_SWIFT_NAME(checkForUpdate(completion:));
 
 /**
diff --git a/FirebaseAppDistribution/Tests/Unit/Swift/AppDistributionAPITest.swift b/FirebaseAppDistribution/Tests/Unit/Swift/AppDistributionAPITest.swift
@@ -0,0 +1,27 @@
+// 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.
+
+import XCTest
+@testable import FirebaseAppDistribution
+
+class AppDistributionAPITests: XCTestCase {
+  @available(iOS 13.0.0, *)
+  func asyncAPIs() async throws {
+    let distro = AppDistribution.appDistribution()
+
+    // Release should be optional if there are no new releases.
+    let _: AppDistributionRelease? = try await distro.checkForUpdate()
+    try await distro.signInTester()
+  }
+}
diff --git a/Package.swift b/Package.swift
@@ -410,11 +410,20 @@ let package = Package(
       name: "AppDistributionUnit",
       dependencies: ["FirebaseAppDistribution", "OCMock"],
       path: "FirebaseAppDistribution/Tests/Unit",
+      exclude: ["Swift/"],
       resources: [.process("Resources")],
       cSettings: [
         .headerSearchPath("../../.."),
       ]
     ),
+    .testTarget(
+      name: "AppDistributionUnitSwift",
+      dependencies: ["FirebaseAppDistribution"],
+      path: "FirebaseAppDistribution/Tests/Unit/Swift",
+      cSettings: [
+        .headerSearchPath("../../../.."),
+      ]
+    ),
 
     .target(
       name: "FirebaseAuth",
