feat(cloud_functions): add support for cloud functions stream #17214
Conversation
SelaseKay
changed the title
packages/cloud_functions/cloud_functions/lib/src/firebase_functions.dart
Outdated
Show resolved
Hide resolved
| class MethodChannelHttpsCallableStreams<R> | ||
| extends HttpsCallableStreamsPlatform<R> { | ||
| MethodChannelHttpsCallableStreams(String? name, String? origin, Uri? uri) | ||
| : _channel = EventChannel('plugins.flutter.io/firebase_functions/$name'), |
There was a problem hiding this comment.
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
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.
There was a problem hiding this comment.
The assertion is already handled on the parent(HttpsCallableStreamsPlatform) class: here
There was a problem hiding this comment.
Wonderful, is the assertion correct? Shouldn't it be if both are null? (i.e. &&)
There was a problem hiding this comment.
No, at any given time, one of the two variables will be set, depending on which method was called: httpsStreamCallable or httpsStreamCallableWithUri.
| @@ -1,2 +1,2 @@ | |||
| # https://firebase.google.com/support/release-notes/android | |||
| FirebaseSDKVersion=33.9.0 | |||
| FirebaseSDKVersion=33.11.0 | |||
There was a problem hiding this comment.
do this in a separate PR for bumping android SDK
| @@ -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
| 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
| public struct AnyEncodable: Encodable { | ||
| private let value: Any? | ||
|
|
||
| public init(_ value: Any?) { | ||
| self.value = value ?? NSNull() | ||
| } | ||
|
|
There was a problem hiding this comment.
what is the use of this file? Have we written that ourselves?
There was a problem hiding this comment.
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.
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
| /// 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( |
There was a problem hiding this comment.
Here we should copy the entire doc from the java implementation (and adapt it if needed)
| /// 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( |
There was a problem hiding this comment.
Here we should copy the entire doc from the java implementation (and adapt it if needed)
| @visibleForTesting | ||
| final HttpsCallableStreamsPlatform delegate; | ||
|
|
||
| Stream<StreamResponse> stream<T, R>([Object? input]) async* { |
| HttpsCallableStreamsPlatform httpsStreamCallable( | ||
| String? origin, String name, HttpsCallableOptions options) { | ||
| throw UnimplementedError('httpsStreamCallable() is not implemented'); | ||
| } | ||
|
|
||
| HttpsCallableStreamsPlatform httpsStreamCallableWithUri( |
| 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 { |
...ns/android/src/main/java/io/flutter/plugins/firebase/functions/StreamResponseSubscriber.java
Outdated
Show resolved
Hide resolved
...oud_functions/cloud_functions/ios/cloud_functions/Sources/cloud_functions/CodecUtility.swift
Outdated
Show resolved
Hide resolved
...ons/cloud_functions/ios/cloud_functions/Sources/cloud_functions/FunctionsStreamHandler.swift
Outdated
Show resolved
Hide resolved
packages/cloud_functions/cloud_functions/lib/src/https_callable_stream_result.dart
Outdated
Show resolved
Hide resolved
| @@ -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
| /// 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.
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
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?