Streamable HTTPCallable functions #14290

eBlender · 2024-12-27T21:53:40Z

Hey there! So you want to contribute to a Firebase SDK?
Before you file this pull request, please read these guidelines:

Discussion

Read the contribution guidelines (CONTRIBUTING.md).
If this has been discussed in an issue, make sure to link to the issue here.
If not, go file an issue about this before creating a pull request to discuss.

Testing

Make sure all existing tests in the repository pass after your change.
If you fixed a bug or added a feature, add a new test to cover your code.

API Changes

At this time we cannot accept changes that affect the public API. If you'd like to help
us make Firebase APIs better, please propose your change in a feature request so that we
can discuss it together.

…irebase#14051)

Add initial support for Streamable functions.

Change call to AsyncThrowingStream<HTTPSCallableResult, Error>

testing check.sh

Remove old test function.

Remove old test

Add a full working test for stremableFunction. Refactor.

google-cla · 2024-12-27T21:53:44Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Add Json capabilities to parse an HTTP result back and forth. Updating Unit tests.

Cleanup

Add doc for processResponseDataForStreamableContent.

Update func to have a callback. Update UnitTests

Remove test.

Remove spaces.

paulb777

Thanks for the PR. We'll need an approved API review before doing a detailed code review. However, in the meantime, it would be helpful to make this PR a clean diff to main that can run CI.

eBlender · 2025-01-06T22:44:29Z

@paulb777 Thanks Paul, Done.

Fetch Main branch.

Project clean up.

…/firebase-ios-sdk into iOS-Stremable-Functions

Updated to renamed code. From callableResultFromResponse to callableResult

Run style.sh

Fix concurrency " mutation of captured var 'response' in concurrently-executing code" and typos.

FirebaseFunctions/Tests/Unit/FunctionsTests.swift

This file is not needed.

Add throws Remove DO - CATCH

…/firebase-ios-sdk into iOS-Stremable-Functions

FirebaseFunctions/Tests/Unit/FunctionsTests.swift

Accept suggestion. Thanks. Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

FirebaseFunctions/Tests/Unit/FunctionsTests.swift

Remove optionals.

…/firebase-ios-sdk into iOS-Stremable-Functions

@ncooke3

Revert func to non DISPACTCH. Will work on a fix with @ncooke3

FirebaseFunctions/Tests/Unit/FunctionsTests.swift

ncooke3 · 2025-01-16T00:30:22Z

For the check CI failure, use the scripts/style.sh script.

You can use it a few ways, but I like to either pass it a list of files:

scripts/style.sh FirebaseFunctions/Tests/Unit/FunctionsTests.swift

Or periodically style all of the files I touched in my branch:

git diff --name-only main | xargs scripts/style.sh

Then git add and commit the result.

If the script fails, it's likely due to missing packages, you'll need:

brew install clang-format@19
brew install mint

eBlender · 2025-01-16T01:15:14Z

@paulb777 and @ncooke3 Thanks for your comments and help.

Lint.

ncooke3

nit: make result a constant since it doesn't need to change past initialization

FirebaseFunctions/Tests/Unit/FunctionsTests.swift

Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

FirebaseFunctions/Sources/Functions.swift

Accepted suggestion. Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

ncooke3 · 2025-01-16T23:24:01Z

FirebaseFunctions/Sources/Functions.swift

+      let rawData = try await fetcher.beginFetch()
+      return try callableResultFromResponseAsync(data: rawData, error: nil)


I just came across one subtle issue is that GTMSessionFetcher is returning the entire data result at once rather than chunks of the stream. It doesn't look like GTMSessionFetcher supports receiving streams so we may have to change this up and use the standard library's URLSession and URLSession.AsyncBytes

Sure, I'll get to it. I was trying to keep it as closest as possible to HTTPCallable. It is subtle but quite important.

I'd recommend following what the Vertex SDK does. Here is the method that loads the request stream: https://github.com/firebase/firebase-ios-sdk/blob/main/FirebaseVertexAI/Sources/GenerativeAIService.swift#L82-L176

I'm thinking the implementation here won't be as complex.

FirebaseFunctions/Sources/Functions.swift

ncooke3 · 2025-01-16T23:48:27Z

FirebaseFunctions/Tests/Unit/FunctionsTests.swift

@@ -358,4 +358,73 @@ class FunctionsTests: XCTestCase {
    }
    waitForExpectations(timeout: 1.5)
  }
+


I think another good test case would be to test when an error is thrown.

I think we would have (genStream, genStreamError, genStreamNoReturn)
So I will add genStreamError and genStreamNoReturn cases as well.

SG??

Mark it as public. Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

ncooke3 · 2025-01-16T23:57:40Z

FirebaseFunctions/Tests/Unit/FunctionsTests.swift

+        "chunk this",
+        "chunk is",
+        "chunk cool",
+        "hello world this is cool",


I suspect this final concatenation was a result of GTMSessionFetcher handling the streamed results. I don't expect it with URLSession and AsyncBytes

ncooke3 · 2025-01-17T14:48:50Z

FirebaseFunctions/Tests/Unit/FunctionsTests.swift

With #14357 merged, we should be able to get these passing in CI now. This can be done by moving these new tests to the integration test file and use the emulatorURL helper method for the stream API's at URL: URL property. https://github.com/firebase/firebase-ios-sdk/blob/main/FirebaseFunctions/Tests/Integration/IntegrationTests.swift

eBlender added 7 commits December 19, 2024 14:32

[Infra] Update functions workflow to use macOS 15 for Xcode 16 jobs (f…

231d602

…irebase#14051)

Stremable Functions.

a14d964

Add initial support for Streamable functions.

Changed return type.

a92d7c2

Change call to AsyncThrowingStream<HTTPSCallableResult, Error>

Lint test

10bec1d

testing check.sh

Remove test function

53a2aab

Remove old test function.

Remove old test.

758fbed

Remove old test

Updated function, add full test.

93b6c8b

Add a full working test for stremableFunction. Refactor.

eBlender added 10 commits January 2, 2025 16:02

Update functions

a7e8fe8

Add Json capabilities to parse an HTTP result back and forth. Updating Unit tests.

Update FunctionsTests.swift

6d59fcd

Cleanup HTTPCallable

51f02b8

Cleanup

Add documentation for processResponseDataForStreamableContent

7b61076

Add doc for processResponseDataForStreamableContent.

Update Functions.swift

a95449e

Update Functions.swift

cdc49ee

Update FunctionsTests.swift

426b6bc

Update and Cleanup

9cb0a5e

Update func to have a callback. Update UnitTests

Update IntegrationTests.swift

ad31052

Remove test.

Clean up

6ee9000

Remove spaces.

eBlender changed the title ~~I os stremable functions~~ iOS streamable HTTPCallabe functions Jan 3, 2025

Update check.sh

1ffe73d

mikehardy mentioned this pull request Jan 4, 2025

🐛 [@react-native-firebase/functions] Missing stream implementation for httpsCallable functions invertase/react-native-firebase#8210

Open

paulb777 reviewed Jan 6, 2025

View reviewed changes

eBlender added 7 commits January 6, 2025 17:27

Bump to Main.

9fcd91e

Fetch Main branch.

Merge branch 'main' into iOS-Stremable-Functions

177aa8e

Cleanup

f4d678b

Project clean up.

Merge branch 'iOS-Stremable-Functions' of https://github.com/eBlender…

74557e7

…/firebase-ios-sdk into iOS-Stremable-Functions

Update Functions.swift

18f748b

Updated to renamed code. From callableResultFromResponse to callableResult

Lint check

4f956fb

Run style.sh

Function concurrency error

4edc0ad

Fix concurrency " mutation of captured var 'response' in concurrently-executing code" and typos.

ncooke3 reviewed Jan 15, 2025

View reviewed changes

FirebaseFunctions/Tests/Unit/FunctionsTests.swift Outdated Show resolved Hide resolved

eBlender and others added 4 commits January 15, 2025 17:52

Delete firebase-database-emulator.log

aed47d6

This file is not needed.

Delete firebase-database-emulator.pid

f6c6cff

This file is not needed.

Update function error handling.

75a7574

Add throws Remove DO - CATCH

Merge branch 'iOS-Stremable-Functions' of https://github.com/eBlender…

adf7366

…/firebase-ios-sdk into iOS-Stremable-Functions

ncooke3 reviewed Jan 16, 2025

View reviewed changes

FirebaseFunctions/Tests/Unit/FunctionsTests.swift Outdated Show resolved Hide resolved

FirebaseFunctions/Tests/Unit/FunctionsTests.swift Outdated Show resolved Hide resolved

Update FirebaseFunctions/Tests/Unit/FunctionsTests.swift

9ef7411

Accept suggestion. Thanks. Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

ncooke3 reviewed Jan 16, 2025

View reviewed changes

FirebaseFunctions/Tests/Unit/FunctionsTests.swift Outdated Show resolved Hide resolved

eBlender added 3 commits January 15, 2025 18:12

Update FunctionsTests.swift

4ee820e

Remove optionals.

Merge branch 'iOS-Stremable-Functions' of https://github.com/eBlender…

fd68f01

…/firebase-ios-sdk into iOS-Stremable-Functions

Update FunctionsTests.swift

f27bf07

Revert func to non DISPACTCH. Will work on a fix with @ncooke3

ncooke3 reviewed Jan 16, 2025

View reviewed changes

FirebaseFunctions/Tests/Unit/FunctionsTests.swift Outdated Show resolved Hide resolved

Format and refactoring.

1ffa4f0

Lint.

eBlender changed the title ~~iOS streamable HTTPCallabe functions~~ Streamable HTTPCallabe functions Jan 16, 2025

ncooke3 reviewed Jan 16, 2025

View reviewed changes

eBlender and others added 4 commits January 16, 2025 14:45

Update FirebaseFunctions/Tests/Unit/FunctionsTests.swift

80f0991

Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

Update FirebaseFunctions/Tests/Unit/FunctionsTests.swift

756dc26

Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

Update FirebaseFunctions/Tests/Unit/FunctionsTests.swift

f031c1f

Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

Update FirebaseFunctions/Tests/Unit/FunctionsTests.swift

0df7f8d

Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

ncooke3 reviewed Jan 16, 2025

View reviewed changes

FirebaseFunctions/Sources/Functions.swift Outdated Show resolved Hide resolved

Update FirebaseFunctions/Sources/Functions.swift

231c7dd

Accepted suggestion. Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

ncooke3 reviewed Jan 16, 2025

View reviewed changes

FirebaseFunctions/Sources/Functions.swift Outdated Show resolved Hide resolved

ncooke3 reviewed Jan 16, 2025

View reviewed changes

Update FirebaseFunctions/Sources/Functions.swift

be80d63

Mark it as public. Co-authored-by: Nick Cooke <36927374+ncooke3@users.noreply.github.com>

ncooke3 reviewed Jan 16, 2025

View reviewed changes

ncooke3 reviewed Jan 17, 2025

View reviewed changes

paulb777 changed the title ~~Streamable HTTPCallabe functions~~ Streamable HTTPCallable functions Jan 17, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Streamable HTTPCallable functions #14290

Streamable HTTPCallable functions #14290

eBlender commented Dec 27, 2024

google-cla bot commented Dec 27, 2024

paulb777 left a comment

eBlender commented Jan 6, 2025 •

edited

Loading

ncooke3 commented Jan 16, 2025 •

edited

Loading

eBlender commented Jan 16, 2025 •

edited

Loading

ncooke3 left a comment

ncooke3 Jan 16, 2025

eBlender Jan 16, 2025 •

edited

Loading

ncooke3 Jan 16, 2025

eBlender Jan 16, 2025

ncooke3 Jan 16, 2025

eBlender Jan 16, 2025

ncooke3 Jan 17, 2025

ncooke3 Jan 16, 2025

ncooke3 Jan 17, 2025

		let rawData = try await fetcher.beginFetch()
		return try callableResultFromResponseAsync(data: rawData, error: nil)

Streamable HTTPCallable functions #14290

Are you sure you want to change the base?

Streamable HTTPCallable functions #14290

Conversation

eBlender commented Dec 27, 2024

Discussion

Testing

API Changes

google-cla bot commented Dec 27, 2024

paulb777 left a comment

Choose a reason for hiding this comment

eBlender commented Jan 6, 2025 • edited Loading

ncooke3 commented Jan 16, 2025 • edited Loading

eBlender commented Jan 16, 2025 • edited Loading

ncooke3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eBlender Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eBlender commented Jan 6, 2025 •

edited

Loading

ncooke3 commented Jan 16, 2025 •

edited

Loading

eBlender commented Jan 16, 2025 •

edited

Loading

eBlender Jan 16, 2025 •

edited

Loading