Storage async await by paulb777 · Pull Request #8289 · firebase/firebase-ios-sdk · GitHub

Storage Integration Tests are converted to async/await and four new APIs are added to cover cases that don't get an automatic Xcode conversion.

If you want to experiment, the test infra is green here.

Use Xcode 13
Update Credentials.swift
Add a GoogleService-Info.plist to the AppHost target
pod gen FirebaseStorageSwift --auto-open --local-sources=./ --platforms=ios
Xcode 13+ automatically converts Objective C APIs that return void and take a completion block parameter to an additional async API.

Googlers can see the API proposal at go/firebase-storage-async-await1. An excerpt follows:

The automatic API conversions for Storage are shown in Column G of this spreadsheet designed by @peterfriese. Note that the APIs that return a StorageDownloadTask or StorageUploadTask are not converted.

For Storage, Xcode automatically converts the following APIs to async versions as shown here:

open func downloadURL(completion: @escaping (URL?, Error?) -> Void) open func downloadURL() async throws -> URL

open func listAll(completion: @escaping (StorageListResult, Error?) -> Void) open func listAll() async throws -> StorageListResult

open func list(maxResults: Int64, completion: @escaping (StorageListResult, Error?) -> Void) open func list(maxResults: Int64) async throws -> StorageListResult

open func list(maxResults: Int64, pageToken: String, completion: @escaping (StorageListResult, Error?) -> Void) open func list(maxResults: Int64, pageToken: String) async throws -> StorageListResult

open func getMetadata(completion: @escaping (StorageMetadata?, Error?) -> Void) open func getMetadata() async throws -> StorageMetadata

open func updateMetadata(_ metadata: StorageMetadata, completion: ((StorageMetadata?, Error?) -> Void)? = nil) open func updateMetadata(_ metadata: StorageMetadata) async throws -> StorageMetadata

open func delete(completion: ((Error?) -> Void)? = nil) open func delete() async throws

The following APIs have completion parameters but do not get an automatic async API generated because they do not have a Void return value:

I implemented the following four APIs (full implementation here) to fill in the gap by providing APIs to do the implementation without the task handle return value:

The functions are renamed to avoid collisions with the existing API.

Coverage Report

Affected SDKs

No changes between base commit (d550a72) and head commit (2bffe65).

Test Logs

Base (d550a72e): https://github.com/firebase/firebase-ios-sdk/actions/runs/1060185663
Head (2bffe65a): https://github.com/firebase/firebase-ios-sdk/actions/runs/1061169060

This is looking really neat! 😎

API change is now approved. The PR is ready for final review and merge.

Thanks for the thorough review @ncooke3 . Lots of good catches! 💯

LGTM 🚀

google-cla Bot added the cla: yes label Jun 22, 2021

google-oss-bot added api: storage public-api-change labels Jun 22, 2021

paulb777 marked this pull request as draft June 22, 2021 22:50

maksymmalyhin reviewed Jun 23, 2021

View reviewed changes

Comment thread FirebaseStorage/Sources/FIRStorageReference.m Outdated

Comment thread FirebaseStorageSwift/Sources/AsyncAwait.swift Outdated

paulb777 referenced this pull request Jun 23, 2021

Gate async/await code

9edafc3

paulb777 force-pushed the pb-storage-async branch 2 times, most recently from 4007610 to ffdbc7b Compare July 1, 2021 14:31

ncooke3 reviewed Jul 1, 2021

View reviewed changes

paulb777 mentioned this pull request Jul 9, 2021

Add async/await functionality to abtesting [SwiftUI] firebase/quickstart-ios#1214

Merged

paulb777 requested review from peterfriese, ryanwilson and schmidt-sebastian July 12, 2021 16:44

paulb777 marked this pull request as ready for review July 12, 2021 16:45

paulb777 changed the title Storage async await WIP Storage async await Jul 12, 2021

ryanwilson reviewed Jul 12, 2021

View reviewed changes

Comment thread FirebaseStorageSwift/Sources/AsyncAwait.swift Outdated

maksymmalyhin reviewed Jul 13, 2021

View reviewed changes

Comment thread FirebaseStorageSwift/Tests/Integration/StorageAsyncAwait.swift Outdated

paulb777 force-pushed the pb-storage-async branch from 96d60a6 to 8235e4d Compare July 20, 2021 22:41

paulb777 assigned ryanwilson Jul 20, 2021

paulb777 assigned ncooke3 and unassigned ryanwilson Jul 22, 2021

ncooke3 reviewed Jul 23, 2021

View reviewed changes

paulb777 added 6 commits July 23, 2021 09:51

Storage async await WIP

11d52f7

Style and available

6dbdd0f

Fix build for Xcode 12.5

cff5439

style

fe4475c

Use continuations

b5fea43

style

7950d7e

paulb777 added 11 commits July 23, 2021 09:51

more tests

2ce439e

more tests

fe66e51

Add writeAwait

49775c0

Resume with

e863361

APIs with Async not Await

967e8ae

typo

8284cf5

Docs for new APIs

33de2d7

style

7467a8c

Xcode 13 Beta 3 update

1d19bd1

Only Task

25d0386

Update Changelog

c47f35f

paulb777 commented Jul 23, 2021

View reviewed changes

Address review feedback

f8acfda

paulb777 force-pushed the pb-storage-async branch from 8235e4d to f8acfda Compare July 23, 2021 22:17

paulb777 requested a review from ncooke3 July 23, 2021 22:34

ncooke3 approved these changes Jul 23, 2021

View reviewed changes

paulb777 merged commit 2d4e139 into master Jul 23, 2021

paulb777 deleted the pb-storage-async branch July 23, 2021 22:45

firebase locked and limited conversation to collaborators Aug 23, 2021

open func downloadURL(completion: @escaping (URL?, Error?) -> Void)	open func downloadURL() async throws -> URL
open func listAll(completion: @escaping (StorageListResult, Error?) -> Void)	open func listAll() async throws -> StorageListResult
open func list(maxResults: Int64, completion: @escaping (StorageListResult, Error?) -> Void)	open func list(maxResults: Int64) async throws -> StorageListResult
open func list(maxResults: Int64, pageToken: String, completion: @escaping (StorageListResult, Error?) -> Void)	open func list(maxResults: Int64, pageToken: String) async throws -> StorageListResult
open func getMetadata(completion: @escaping (StorageMetadata?, Error?) -> Void)	open func getMetadata() async throws -> StorageMetadata
open func updateMetadata(_ metadata: StorageMetadata, completion: ((StorageMetadata?, Error?) -> Void)? = nil)	open func updateMetadata(_ metadata: StorageMetadata) async throws -> StorageMetadata
open func delete(completion: ((Error?) -> Void)? = nil)	open func delete() async throws

Storage async await by paulb777 · Pull Request #8289 · firebase/firebase-ios-sdk · GitHub

Uh oh!

Storage async await - #8289

Storage async await#8289paulb777 merged 18 commits intomasterfirebase/firebase-ios-sdk:masterfrom pb-storage-asyncfirebase/firebase-ios-sdk:pb-storage-asyncCopy head branch name to clipboard

Conversation

paulb777 commented Jun 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-oss-bot commented Jun 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Affected SDKs

Test Logs

Uh oh!

Uh oh!

Uh oh!

ncooke3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

paulb777 commented Jul 20, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

paulb777 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ncooke3 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Storage async await#8289
paulb777 merged 18 commits into
masterfrom
pb-storage-async

paulb777 commented Jun 22, 2021 •
edited
Loading

google-oss-bot commented Jun 22, 2021 •
edited
Loading