feat(cloud_functions): add support for cloud functions stream #17214

SelaseKay · 2025-03-20T08:56:58Z

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.yaml and changelogs is not required.

I read the Contributor Guide and followed the process outlined there for submitting PRs.
My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
All existing and new tests are passing.
I updated/added relevant documentation (doc comments with ///).
The analyzer (melos run analyze) does not report any problems on my PR.
I read and followed the Flutter Style Guide.
I signed the CLA.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

Yes, this is a breaking change.
No, this is not a breaking change.

…loud Functions stream

packages/cloud_functions/cloud_functions/lib/src/firebase_functions.dart

russellwheatley · 2025-03-21T10:07:05Z

...nctions_platform_interface/lib/src/method_channel/method_channel_https_callable_streams.dart

+class MethodChannelHttpsCallableStreams<R>
+    extends HttpsCallableStreamsPlatform<R> {
+  MethodChannelHttpsCallableStreams(String? name, String? origin, Uri? uri)
+      : _channel = EventChannel('plugins.flutter.io/firebase_functions/$name'),


you have name as first argument but it should probably be origin. You are passing in origin as first arg here: https://github.com/firebase/flutterfire/pull/17214/files#diff-39179fb42585c5c75b6cfd6b3e5cd34e92705b1df98759afa825ef6ccadeb4eeR57

and here: https://github.com/firebase/flutterfire/pull/17214/files#diff-39179fb42585c5c75b6cfd6b3e5cd34e92705b1df98759afa825ef6ccadeb4eeR62

Need to do an assert here as name could be null. If name and uri are null, need to throw assertion error. The last segment of event channel name should be either name or uri depending on what is not null. Double check if there are any characters that could be a problem in event channel name as a uri might not be possible.

The assertion is already handled on the parent(HttpsCallableStreamsPlatform) class: here

Wonderful, is the assertion correct? Shouldn't it be if both are null? (i.e. &&)

No, at any given time, one of the two variables will be set, depending on which method was called: httpsStreamCallable or httpsStreamCallableWithUri.

russellwheatley · 2025-03-21T13:28:22Z

packages/firebase_core/firebase_core/android/gradle.properties

@@ -1,2 +1,2 @@
 # https://firebase.google.com/support/release-notes/android
-FirebaseSDKVersion=33.9.0
+FirebaseSDKVersion=33.11.0


do this in a separate PR for bumping android SDK

Lyokone · 2025-03-24T08:42:28Z

packages/cloud_functions/cloud_functions/android/build.gradle

@@ -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'


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/

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 · 2025-03-24T08:43:12Z

...roid/src/main/java/io/flutter/plugins/firebase/functions/FlutterFirebaseFunctionsPlugin.java

+    final String eventChannelName = METHOD_CHANNEL_NAME + "/" + eventId;
+    final EventChannel eventChannel =
+        new EventChannel(pluginBinding.getBinaryMessenger(), eventChannelName);
+    eventChannel.setStreamHandler(this);


I would rather have another class that implements EventChannel.StreamHandler so it's properly separated and easier to review

Okay. I'll update the PR

…base/flutterfire into feat/cloud_functions_stream_support

Lyokone

Doc and some nit.
The main thing missing are e2e tests

Really good job

.github/workflows/scripts/functions/package.json

.github/workflows/scripts/functions/src/index.ts

Lyokone · 2025-04-03T12:45:52Z

...oud_functions/cloud_functions/ios/cloud_functions/Sources/cloud_functions/CodecUtility.swift

+public struct AnyEncodable: Encodable {
+  private let value: Any?
+
+  public init(_ value: Any?) {
+    self.value = value ?? NSNull()
+  }
+


what is the use of this file? Have we written that ourselves?

I added this as the stream function in iOS requires an Encodable type. Had to create this util class so I could do var function: Callable<AnyEncodable, StreamResponse<AnyDecodable, AnyDecodable>> in order to handle all types.

Lyokone · 2025-04-03T12:46:28Z

packages/cloud_functions/cloud_functions/lib/src/https_callable_stream_result.dart

+
+/// A chunk received during the stream.
+class Chunk<T> extends StreamResponse {
+  final T partialData;


We need doc for partialData

Lyokone · 2025-04-03T12:46:34Z

packages/cloud_functions/cloud_functions/lib/src/https_callable_stream_result.dart

+
+/// The final result of the computation, marking the end of the stream.
+class Result<R> extends StreamResponse {
+  final HttpsCallableResult<R> result;


same we need doc here

Lyokone · 2025-04-03T12:47:39Z

packages/cloud_functions/cloud_functions/lib/src/firebase_functions.dart

+  /// A reference to the streaming Callable HTTPS trigger with the given name.
+  ///
+  /// Should be URL of the 2nd gen Callable function in Firebase.
+  HttpsCallableStream httpsCallableStreamFromUrl(


Here we should copy the entire doc from the java implementation (and adapt it if needed)

Lyokone · 2025-04-03T12:47:43Z

packages/cloud_functions/cloud_functions/lib/src/firebase_functions.dart

+  /// A reference to the streaming Callable HTTPS trigger with the given name.
+  ///
+  /// Should be Uri of the 2nd gen Callable function in Firebase.
+  HttpsCallableStream httpsCallableStreamFromUri(


Here we should copy the entire doc from the java implementation (and adapt it if needed)

Lyokone · 2025-04-03T12:47:51Z

packages/cloud_functions/cloud_functions/lib/src/https_callable_stream.dart

+  @visibleForTesting
+  final HttpsCallableStreamsPlatform delegate;
+
+  Stream<StreamResponse> stream<T, R>([Object? input]) async* {


We need doc here

Lyokone · 2025-04-03T12:48:11Z

...ons_platform_interface/lib/src/platform_interface/platform_interface_firebase_functions.dart

+  HttpsCallableStreamsPlatform httpsStreamCallable(
+      String? origin, String name, HttpsCallableOptions options) {
+    throw UnimplementedError('httpsStreamCallable() is not implemented');
+  }
+
+  HttpsCallableStreamsPlatform httpsStreamCallableWithUri(


We need some doc

Lyokone · 2025-04-03T12:48:20Z

...platform_interface/lib/src/platform_interface/platform_interface_https_callable_streams.dart

+import 'package:cloud_functions_platform_interface/cloud_functions_platform_interface.dart';
+import 'package:plugin_platform_interface/plugin_platform_interface.dart';
+
+abstract class HttpsCallableStreamsPlatform<R> extends PlatformInterface {


A bit of doc

SelaseKay added 2 commits March 18, 2025 10:59

chore: add platform interface and method channel implementation for C…

5bbf13d

…loud Functions stream

chore: add httpsCallableStreamFromUrl and httpsStreamCallableWithUri

24acdda

SelaseKay changed the title ~~Feat/cloud functions stream support~~ feat(cloud_functions): add support for cloud functions stream Mar 20, 2025

russellwheatley requested changes Mar 21, 2025

View reviewed changes

chore: resolve comments

fa00dd9

russellwheatley requested changes Mar 21, 2025

View reviewed changes

SelaseKay added 4 commits March 21, 2025 16:12

chore: add Android implementation for Cloud Functions stream

fa750ed

chore: resolve formatting issues

3e8ac29

chore: correct variable name

c248cd6

chore: add support for Cloud Functions Stream(Android)

1ac4533

Lyokone reviewed Mar 24, 2025

View reviewed changes

SelaseKay and others added 15 commits March 24, 2025 12:32

Merge branch 'main' into feat/cloud_functions_stream_support

d8e0fce

chore: create dedicated StreamHandler class

95236c8

Merge branch 'main' into feat/cloud_functions_stream_support

785e019

chore: add streamhandler implementation for ios

6161988

Merge branch 'main' into feat/cloud_functions_stream_support

debdc46

chore: add iOS implementation for Cloud Functions stream

4d0c10e

chore: add license header to stream handler files

1190fde

chore: web Cloud Functions stream wip

6bbde2f

chore: push all

66be89b

chore: update functions based on API Doc modification

4804ab9

chore: clean up code

4f83c36

chore: add web package

213e283

Merge branch 'main' into feat/cloud_functions_stream_support

de10bcc

chore: add streaming example

794d441

Merge branch 'feat/cloud_functions_stream_support' of github.com:fire…

560e3eb

…base/flutterfire into feat/cloud_functions_stream_support

SelaseKay marked this pull request as ready for review April 3, 2025 12:42

SelaseKay requested a review from Salakar as a code owner April 3, 2025 12:42

Lyokone requested changes Apr 3, 2025

View reviewed changes

SelaseKay added 4 commits April 3, 2025 20:54

chore: fix ci issues

6ad0820

chore: fix ci

a9819db

chore: fix cloud function test

295c6c6

chore: add missing doc

7a5ad4e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cloud_functions): add support for cloud functions stream #17214

feat(cloud_functions): add support for cloud functions stream #17214

SelaseKay commented Mar 20, 2025 •

edited

Loading

russellwheatley Mar 21, 2025

SelaseKay Mar 21, 2025

russellwheatley Mar 21, 2025

SelaseKay Mar 21, 2025

russellwheatley Mar 21, 2025

Lyokone Mar 24, 2025

SelaseKay Mar 24, 2025

Lyokone Mar 24, 2025

SelaseKay Mar 24, 2025

Lyokone left a comment

Lyokone Apr 3, 2025

SelaseKay Apr 3, 2025 •

edited

Loading

Lyokone Apr 3, 2025

Lyokone Apr 3, 2025

Lyokone Apr 3, 2025

Lyokone Apr 3, 2025

Lyokone Apr 3, 2025

Lyokone Apr 3, 2025

Lyokone Apr 3, 2025

feat(cloud_functions): add support for cloud functions stream #17214

Are you sure you want to change the base?

feat(cloud_functions): add support for cloud functions stream #17214

Conversation

SelaseKay commented Mar 20, 2025 • edited Loading

Description

Related Issues

Checklist

Breaking Change

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

Choose a reason for hiding this comment

Lyokone left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SelaseKay Apr 3, 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

SelaseKay commented Mar 20, 2025 •

edited

Loading

SelaseKay Apr 3, 2025 •

edited

Loading