feat(cloud_functions): add support for cloud functions stream #17214
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SelaseKay
changed the title
russellwheatley
requested changes
Mar 21, 2025
packages/cloud_functions/cloud_functions/lib/src/firebase_functions.dart
Outdated
Show resolved
Hide resolved
...nctions_platform_interface/lib/src/method_channel/method_channel_https_callable_streams.dart
Outdated
Show resolved
Hide resolved
russellwheatley
requested changes
Mar 21, 2025
Lyokone
reviewed
Mar 24, 2025
| @@ -64,6 +64,7 @@ android { | |||
| implementation platform("com.google.firebase:firebase-bom:${getRootProjectExtOrCoreProperty("FirebaseSDKVersion", firebaseCoreProject)}") | |||
| implementation 'com.google.firebase:firebase-functions' | |||
| implementation 'androidx.annotation:annotation:1.7.0' | |||
| implementation 'org.reactivestreams:reactive-streams:1.0.4' | |||
There was a problem hiding this comment.
I'm not sure why we would need an external library to handle this? We managed to do all the other implementations without it AFAIK/
There was a problem hiding this comment.
Yes. The other ones provided a way to add listeners directly (eg. addOnConfigUpdatedListener) whereas this one doesn't. It returns a Publisher so this is the only way around it AFAIK.
Reference: https://firebase.google.com/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference#summary
Lyokone
reviewed
Mar 24, 2025
| final String eventChannelName = METHOD_CHANNEL_NAME + "/" + eventId; | ||
| final EventChannel eventChannel = | ||
| new EventChannel(pluginBinding.getBinaryMessenger(), eventChannelName); | ||
| eventChannel.setStreamHandler(this); |
There was a problem hiding this comment.
I would rather have another class that implements EventChannel.StreamHandler so it's properly separated and easier to review
There was a problem hiding this comment.
Okay. I'll update the PR
…base/flutterfire into feat/cloud_functions_stream_support
Lyokone
requested changes
Apr 3, 2025
...oud_functions/cloud_functions/ios/cloud_functions/Sources/cloud_functions/CodecUtility.swift
Show resolved
Hide resolved
packages/cloud_functions/cloud_functions/lib/src/https_callable_stream_result.dart
Show resolved
Hide resolved
packages/cloud_functions/cloud_functions/lib/src/https_callable_stream_result.dart
Show resolved
Hide resolved
packages/cloud_functions/cloud_functions/lib/src/firebase_functions.dart
Outdated
Show resolved
Hide resolved
packages/cloud_functions/cloud_functions/lib/src/firebase_functions.dart
Outdated
Show resolved
Hide resolved
packages/cloud_functions/cloud_functions/lib/src/https_callable_stream.dart
Outdated
Show resolved
Hide resolved
...ons_platform_interface/lib/src/platform_interface/platform_interface_firebase_functions.dart
Outdated
Show resolved
Hide resolved
...platform_interface/lib/src/platform_interface/platform_interface_https_callable_streams.dart
Outdated
Show resolved
Hide resolved
cynthiajoan
reviewed
Apr 16, 2025
...ns/android/src/main/java/io/flutter/plugins/firebase/functions/StreamResponseSubscriber.java
Outdated
Show resolved
Hide resolved
cynthiajoan
reviewed
Apr 16, 2025
...oud_functions/cloud_functions/ios/cloud_functions/Sources/cloud_functions/CodecUtility.swift
Outdated
Show resolved
Hide resolved
cynthiajoan
reviewed
Apr 16, 2025
...ons/cloud_functions/ios/cloud_functions/Sources/cloud_functions/FunctionsStreamHandler.swift
Outdated
Show resolved
Hide resolved
cynthiajoan
reviewed
Apr 16, 2025
packages/cloud_functions/cloud_functions/lib/src/https_callable_stream_result.dart
Outdated
Show resolved
Hide resolved
cynthiajoan
reviewed
Apr 16, 2025
| @@ -0,0 +1,85 @@ | |||
| // Copyright 2018 The Chromium Authors. All rights reserved. | |||
There was a problem hiding this comment.
sorry missed to catch this one in the last round
cynthiajoan
reviewed
Apr 17, 2025
| /// automatically includes a Firebase Instance ID token to identify the app | ||
| /// instance. If a user is logged in with Firebase Auth, an auth ID token for | ||
| /// the user is also automatically included. | ||
| Stream<StreamResponse> stream<T, R>([Object? input]) async* { |
There was a problem hiding this comment.
In the API doc, there's HttpsCallableStreamOptions as an optional parameter, but I don't find the code in this PR. Anything changed?
There was a problem hiding this comment.
Yes, I had forgotten to update the documentation earlier. The original plan was to match the JS SDK’s stream signature, but we later decided to follow the native (Android/Java) convention instead. I’ve just updated the docs to reflect this change.
Lyokone
reviewed
Apr 17, 2025
packages/cloud_functions/cloud_functions_platform_interface/lib/src/https_callable_options.dart
Outdated
Show resolved
Hide resolved
packages/cloud_functions/cloud_functions_platform_interface/lib/src/https_callable_options.dart
Outdated
Show resolved
Hide resolved
Lyokone
approved these changes
Apr 18, 2025
russellwheatley
approved these changes
Apr 28, 2025
|
Wowwww thank you so much @SelaseKay and everyone else ;) |
cynthiajoan
added a commit
that referenced
this pull request
May 8, 2025
* chore(ci): bump macos-14 to macos-15 (#17311) * feat(cloud_functions): add support for cloud functions stream (#17214) * chore: add platform interface and method channel implementation for Cloud Functions stream * chore: add `httpsCallableStreamFromUrl` and `httpsStreamCallableWithUri` * chore: resolve comments * chore: add Android implementation for Cloud Functions stream * chore: resolve formatting issues * chore: correct variable name * chore: add support for Cloud Functions Stream(Android) * chore: create dedicated StreamHandler class * chore: add streamhandler implementation for ios * chore: add iOS implementation for Cloud Functions stream * chore: add license header to stream handler files * chore: web Cloud Functions stream wip * chore: push all * chore: update functions based on API Doc modification * chore: clean up code * chore: add web package * chore: add streaming example * chore: fix ci issues * chore: fix ci * chore: fix cloud function test * chore: add missing doc * chore: fixes and clean up * chore: add e2e for Cloud Functions Stream * chore: fix formatting issue * chore: add more tests and fix timeout for Android * chore: add test for map and list * chore: fix test * chore: update year to 2025 in files * chore(web): add support for abort signal * chore: resolve comments and add test for Abort * chore: fix test * chore: fix test * chore: update copyright year * chore: print error to console * chore(release): publish packages (#17314) * chore(release): publish packages - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected]+1 * chore: BoM Version 3.10.0 * constants * fix(auth,apple): prevent EXC_BAD_ACCESS crash in Apple Sign-In completion handler (#17273) - Locally captures completion handler to prevent deallocation - Fixes crash during async Apple Sign-In operations * chore(docs): Update Extension Helper Docs (#17327) * feat(vertexai): Add HarmBlockThreshold.OFF (#17325) * Add HarmBlockThreshold.OFF. Add unit test for api. Fix the schema output json. * fix a nit * feat(fdc): Included platform detection changes (#17308) * feat(vertexai): Add responseModality (#17326) * Add responseModality * review comments * handle omit tokenCount nicely (#17336) * Add new attributes for schema (#17340) * tweak after merge main * fix analyzer for vertexai/api_test.dart * remove dependency_overrides in pubspec.yaml --------- Co-authored-by: MichaelV00 <[email protected]> Co-authored-by: Jude Selase Kwashie <[email protected]> Co-authored-by: Guillaume Bernos <[email protected]> Co-authored-by: Luke Memet <[email protected]> Co-authored-by: Maneesh Tewani <[email protected]>
cynthiajoan
added a commit
that referenced
this pull request
May 13, 2025
* feat(vertexai): Allow serializing to Developer API models (#17294) Move parsing from top level methods, and serialization from a method on the model,into instance methods on a new `SerializationStrategy` class. Use the existing parsing code for the vertex strategy and copy over code form the developer SDK for the Google AI strategy. Add a `_ModelUri` class to allow a vertex and developer specialization for the different backends. Copy the serialization and parsing tests from the developer SDK, skip a few tests that rely on arguments or methods that are unsupported in the vertex model. Tests skipped for content embedding and extra arguments passed to countTokens. * chore(vertexai): update sample for developer api and fix the instance key for FirebaseVertexAI (#17319) * add imagen developer api support (#17321) * feat(vertexai): Add a new package firebase_ai (#17332) * Add a new package firebase_ai Copy all the code from firebase_vertexai and rename with "Vertex" removed or replaced with "Firebase". Make firebase_vertexai an export package, retaining only the FirebaseVertexAI implementation and adding `typedef` aliases for 2 renamed exception types. Replace the rest with exports from `package:firebase_ai`. Revert the examples changes to use googleAI - the example in the `firebase_ai` package will show both while the old example shows only the usage of vertex.. Import from src across the packages to keep existing tests as close to identical as possible despite doubling up test cases with the upstream package. * Move to new directory * Add ::vertexai and ::googlai instance key suffixes * Use ovrride and new SpeaechConfig API * Remove export of TaskType * Remove duplicate testing of the base model * Use 2.0.0 as initial version * Reformat * Add a failing test - check if CI is already running * Remove failing test CI is confirmed running for this package. * Add a copy of the analysis options in the new parent directory * Revert to latest version of example app Minor code changes for the interface change. * Restore the same example app in both packages Minor code changes in the _vertexai example app for the interface differences --------- Co-authored-by: Cynthia J <[email protected]> * add all_link_rules.yaml to the root of new package * chore(firebaseai): merge main into developer api branch (#17341) * chore(ci): bump macos-14 to macos-15 (#17311) * feat(cloud_functions): add support for cloud functions stream (#17214) * chore: add platform interface and method channel implementation for Cloud Functions stream * chore: add `httpsCallableStreamFromUrl` and `httpsStreamCallableWithUri` * chore: resolve comments * chore: add Android implementation for Cloud Functions stream * chore: resolve formatting issues * chore: correct variable name * chore: add support for Cloud Functions Stream(Android) * chore: create dedicated StreamHandler class * chore: add streamhandler implementation for ios * chore: add iOS implementation for Cloud Functions stream * chore: add license header to stream handler files * chore: web Cloud Functions stream wip * chore: push all * chore: update functions based on API Doc modification * chore: clean up code * chore: add web package * chore: add streaming example * chore: fix ci issues * chore: fix ci * chore: fix cloud function test * chore: add missing doc * chore: fixes and clean up * chore: add e2e for Cloud Functions Stream * chore: fix formatting issue * chore: add more tests and fix timeout for Android * chore: add test for map and list * chore: fix test * chore: update year to 2025 in files * chore(web): add support for abort signal * chore: resolve comments and add test for Abort * chore: fix test * chore: fix test * chore: update copyright year * chore: print error to console * chore(release): publish packages (#17314) * chore(release): publish packages - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected] - [email protected]+1 * chore: BoM Version 3.10.0 * constants * fix(auth,apple): prevent EXC_BAD_ACCESS crash in Apple Sign-In completion handler (#17273) - Locally captures completion handler to prevent deallocation - Fixes crash during async Apple Sign-In operations * chore(docs): Update Extension Helper Docs (#17327) * feat(vertexai): Add HarmBlockThreshold.OFF (#17325) * Add HarmBlockThreshold.OFF. Add unit test for api. Fix the schema output json. * fix a nit * feat(fdc): Included platform detection changes (#17308) * feat(vertexai): Add responseModality (#17326) * Add responseModality * review comments * handle omit tokenCount nicely (#17336) * Add new attributes for schema (#17340) * tweak after merge main * fix analyzer for vertexai/api_test.dart * remove dependency_overrides in pubspec.yaml --------- Co-authored-by: MichaelV00 <[email protected]> Co-authored-by: Jude Selase Kwashie <[email protected]> Co-authored-by: Guillaume Bernos <[email protected]> Co-authored-by: Luke Memet <[email protected]> Co-authored-by: Maneesh Tewani <[email protected]> * manually update the schema_test with main code * add the deprecation document (#17344) * ignore deprecated_member_use for example in firebase_vertexai * fix bidi web socket channel connect for chrome * review comments * readme words update * try ignore the deprecation in the whole package analysis_options --------- Co-authored-by: Nate Bosch <[email protected]> Co-authored-by: MichaelV00 <[email protected]> Co-authored-by: Jude Selase Kwashie <[email protected]> Co-authored-by: Guillaume Bernos <[email protected]> Co-authored-by: Luke Memet <[email protected]> Co-authored-by: Maneesh Tewani <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Replace this paragraph with a description of what this PR is doing. If you're modifying existing behavior, describe the existing behavior, how this PR is changing it, and what motivated the change.
Related Issues
Closes #17076
Checklist
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (
[x]).This will ensure a smooth and quick review process. Updating the
pubspec.yamland changelogs is not required.///).melos run analyze) does not report any problems on my PR.Breaking Change
Does your PR require plugin users to manually update their apps to accommodate your change?