Skip to content

Commit 509e0f3

Browse files
SelaseKaySelaseKay
authored
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
1 parent d41f6de commit 509e0f3

File tree

27 files changed

+2145
-2029
lines changed

27 files changed

+2145
-2029
lines changed

‎.github/workflows/scripts/functions/package-lock.json‎

Lines changed: 971 additions & 1952 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
},
1515
"main": "lib/index.js",
1616
"dependencies": {
17-
"firebase-admin": "^11.5.0",
18-
"firebase-functions": "^4.5.0"
17+
"firebase-admin": "^13.2.0",
18+
"firebase-functions": "^6.3.2"
1919
},
2020
"devDependencies": {
2121
"firebase-functions-test": "^0.2.0",

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

Lines changed: 95 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,72 +2,99 @@ import * as assert from 'assert';
22
import * as functions from 'firebase-functions';
33
import * as functionsv2 from 'firebase-functions/v2';
44

5+
56
// For example app.
67
// noinspection JSUnusedGlobalSymbols
78
export const listFruit = functions.https.onCall(() => {
89
return ['Apple', 'Banana', 'Cherry', 'Date', 'Fig', 'Grapes'];
910
});
1011

11-
export const listfruits2ndgen = functionsv2.https.onCall(() => {
12-
return ['Apple', 'Banana', 'Cherry', 'Date', 'Fig', 'Grapes'];
12+
export const listfruits2ndgen = functionsv2.https.onCall((res, req) => {
13+
const fruitList = ['Apple', 'Banana', 'Cherry', 'Date', 'Fig', 'Grapes'];
14+
const allFruits = fruitList.map(async (fruit) => {
15+
if (res.acceptsStreaming) {
16+
req?.sendChunk(fruit)
17+
}
18+
})
19+
return Promise.all(allFruits);
1320
});
1421

1522
// For e2e testing a custom region.
1623
// noinspection JSUnusedGlobalSymbols
17-
export const testFunctionCustomRegion = functions
18-
.region('europe-west1')
19-
.https.onCall(() => 'europe-west1');
24+
25+
export const testFunctionCustomRegion = functions.https.onCall(
26+
{
27+
region: 'europe-west1'
28+
},
29+
() => 'europe-west1'
30+
);
2031

2132
// For e2e testing timeouts.
22-
export const testFunctionTimeout = functions.https.onCall((data) => {
33+
export const testFunctionTimeout = functions.https.onCall((req, res) => {
34+
const data = req.data
2335
console.log(JSON.stringify({ data }));
24-
return new Promise((resolve, reject) => {
25-
if (data && data.testTimeout) {
26-
setTimeout(
27-
() => resolve({ timeLimit: 'exceeded' }),
28-
parseInt(data.testTimeout, 10)
29-
);
30-
} else {
31-
reject(
32-
new functions.https.HttpsError(
33-
'invalid-argument',
34-
'testTimeout must be provided.'
35-
)
36-
);
37-
}
36+
37+
const timeoutMs = parseInt(data?.testTimeout, 10);
38+
39+
if (isNaN(timeoutMs)) {
40+
throw new functions.https.HttpsError(
41+
'invalid-argument',
42+
'testTimeout must be provided.'
43+
);
44+
}
45+
46+
if (req.acceptsStreaming) {
47+
setTimeout(() => {
48+
res?.sendChunk({ timeLimit: 'exceeded' });
49+
}, timeoutMs);
50+
51+
return new Promise((resolve) => {
52+
setTimeout(resolve, timeoutMs + 100);
53+
});
54+
}
55+
56+
return new Promise((resolve) => {
57+
setTimeout(() => resolve({ timeLimit: 'exceeded' }), timeoutMs);
3858
});
59+
3960
});
4061

4162
// For e2e testing errors & return values.
4263
// noinspection JSUnusedGlobalSymbols
43-
export const testFunctionDefaultRegion = functions.https.onCall((data) => {
64+
export const testFunctionDefaultRegion = functions.https.onCall((req, res) => {
65+
const data = req.data;
4466
console.log(JSON.stringify({ data }));
45-
if (typeof data === 'undefined') {
46-
return 'undefined';
47-
}
67+
68+
const sendResponse = (value: any) => {
69+
if (req.acceptsStreaming && res) {
70+
res.sendChunk(value);
71+
return value;
72+
}
73+
return value;
74+
};
4875

4976
if (typeof data === 'string') {
50-
return 'string';
77+
return sendResponse('string');
5178
}
5279

5380
if (typeof data === 'number') {
54-
return 'number';
81+
return sendResponse('number');
5582
}
5683

5784
if (typeof data === 'boolean') {
58-
return 'boolean';
85+
return sendResponse('boolean');
5986
}
6087

6188
if (data === null) {
62-
return 'null';
89+
return sendResponse('null');
6390
}
6491

6592
if (Array.isArray(data)) {
66-
return 'array';
93+
return sendResponse('array');
6794
}
6895

69-
if(data.type === 'rawData') {
70-
return data;
96+
if (data.type === 'rawData') {
97+
return sendResponse(data);
7198
}
7299

73100
const sampleData: {
@@ -153,9 +180,45 @@ export const testFunctionDefaultRegion = functions.https.onCall((data) => {
153180
);
154181
}
155182

156-
return outputData;
183+
return sendResponse(outputData);
157184
});
158185

159186
export const testMapConvertType = functions.https.onCall((data) => ({
160187
foo: 'bar',
161188
}));
189+
190+
export const testStream = functions.https.onCall((req, res) => {
191+
const data = req.data;
192+
if (data === null || undefined) {
193+
if (req.acceptsStreaming) {
194+
res?.sendChunk('null');
195+
}
196+
return
197+
}
198+
199+
const results = [];
200+
results.push(data)
201+
202+
const allResults = results.map(async (result) => {
203+
if (req.acceptsStreaming) {
204+
res?.sendChunk(result);
205+
}
206+
return result;
207+
});
208+
return Promise.all(allResults);
209+
})
210+
211+
export const testStreamResponse = functions.https.onCall(async (request, response) => {
212+
const fruits = ['Apple', 'Mango', 'Banana']
213+
214+
const allFruits = fruits.map(async (fruit) => {
215+
// Stream each fruit as it resolves!
216+
if (request.acceptsStreaming) {
217+
response?.sendChunk(fruit);
218+
}
219+
return fruit;
220+
});
221+
222+
// Fallback for non-streaming clients
223+
return Promise.all(allFruits);
224+
});

‎packages/cloud_functions/cloud_functions/android/build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ android {
6464
implementation platform("com.google.firebase:firebase-bom:${getRootProjectExtOrCoreProperty("FirebaseSDKVersion", firebaseCoreProject)}")
6565
implementation 'com.google.firebase:firebase-functions'
6666
implementation 'androidx.annotation:annotation:1.7.0'
67+
implementation 'org.reactivestreams:reactive-streams:1.0.4'
6768
}
6869
}
6970

‎packages/cloud_functions/cloud_functions/android/src/main/java/io/flutter/plugins/firebase/functions/FirebaseFunctionsStreamHandler.java‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
// Copyright 2025 The Chromium Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
package io.flutter.plugins.firebase.functions;
6+
7+
import android.net.Uri;
8+
import com.google.firebase.functions.FirebaseFunctions;
9+
import com.google.firebase.functions.HttpsCallableOptions;
10+
import com.google.firebase.functions.HttpsCallableReference;
11+
import com.google.firebase.functions.StreamResponse;
12+
import io.flutter.plugin.common.EventChannel;
13+
import io.flutter.plugin.common.EventChannel.StreamHandler;
14+
import java.net.URL;
15+
import java.util.Map;
16+
import java.util.Objects;
17+
import java.util.concurrent.TimeUnit;
18+
import org.reactivestreams.Publisher;
19+
20+
public class FirebaseFunctionsStreamHandler implements StreamHandler {
21+
22+
private final FirebaseFunctions firebaseFunctions;
23+
24+
private StreamResponseSubscriber subscriber;
25+
26+
public FirebaseFunctionsStreamHandler(FirebaseFunctions functions) {
27+
this.firebaseFunctions = functions;
28+
}
29+
30+
@Override
31+
public void onListen(Object arguments, EventChannel.EventSink events) {
32+
@SuppressWarnings("unchecked")
33+
Map<String, Object> argumentsMap = (Map<String, Object>) arguments;
34+
httpsStreamCall(argumentsMap, events);
35+
}
36+
37+
@Override
38+
public void onCancel(Object arguments) {
39+
subscriber.cancel();
40+
}
41+
42+
private void httpsStreamCall(Map<String, Object> arguments, EventChannel.EventSink events) {
43+
try {
44+
45+
String functionName = (String) arguments.get("functionName");
46+
String functionUri = (String) arguments.get("functionUri");
47+
String origin = (String) arguments.get("origin");
48+
Integer timeout = (Integer) arguments.get("timeout");
49+
Object parameters = arguments.get("parameters");
50+
boolean limitedUseAppCheckToken =
51+
(boolean) Objects.requireNonNull(arguments.get("limitedUseAppCheckToken"));
52+
53+
if (origin != null) {
54+
Uri originUri = Uri.parse(origin);
55+
firebaseFunctions.useEmulator(originUri.getHost(), originUri.getPort());
56+
}
57+
58+
HttpsCallableReference httpsCallableReference;
59+
HttpsCallableOptions options =
60+
new HttpsCallableOptions.Builder()
61+
.setLimitedUseAppCheckTokens(limitedUseAppCheckToken)
62+
.build();
63+
64+
Publisher<StreamResponse> publisher;
65+
if (functionName != null) {
66+
httpsCallableReference = firebaseFunctions.getHttpsCallable(functionName, options);
67+
publisher = httpsCallableReference.stream(parameters);
68+
} else if (functionUri != null) {
69+
httpsCallableReference =
70+
firebaseFunctions.getHttpsCallableFromUrl(new URL(functionUri), options);
71+
publisher = httpsCallableReference.stream();
72+
} else {
73+
throw new IllegalArgumentException("Either functionName or functionUri must be set");
74+
}
75+
76+
if (timeout != null) {
77+
httpsCallableReference.setTimeout(timeout.longValue(), TimeUnit.MILLISECONDS);
78+
}
79+
subscriber = new StreamResponseSubscriber(events);
80+
publisher.subscribe(subscriber);
81+
} catch (Exception e) {
82+
events.error("firebase_functions", e.getMessage(), null);
83+
}
84+
}
85+
}

‎packages/cloud_functions/cloud_functions/android/src/main/java/io/flutter/plugins/firebase/functions/FlutterFirebaseFunctionsPlugin.java‎

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import com.google.firebase.functions.HttpsCallableReference;
1818
import com.google.firebase.functions.HttpsCallableResult;
1919
import io.flutter.embedding.engine.plugins.FlutterPlugin;
20+
import io.flutter.plugin.common.EventChannel;
2021
import io.flutter.plugin.common.MethodCall;
2122
import io.flutter.plugin.common.MethodChannel;
2223
import io.flutter.plugin.common.MethodChannel.MethodCallHandler;
@@ -35,6 +36,7 @@ public class FlutterFirebaseFunctionsPlugin
3536

3637
private static final String METHOD_CHANNEL_NAME = "plugins.flutter.io/firebase_functions";
3738
private MethodChannel channel;
39+
private FlutterPluginBinding pluginBinding;
3840

3941
/**
4042
* Default Constructor.
@@ -45,6 +47,7 @@ public FlutterFirebaseFunctionsPlugin() {}
4547

4648
@Override
4749
public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
50+
pluginBinding = binding;
4851
channel = new MethodChannel(binding.getBinaryMessenger(), METHOD_CHANNEL_NAME);
4952
channel.setMethodCallHandler(this);
5053
}
@@ -55,6 +58,16 @@ public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {
5558
channel = null;
5659
}
5760

61+
private void registerEventChannel(Map<String, Object> arguments) {
62+
final String eventId = (String) Objects.requireNonNull(arguments.get("eventChannelId"));
63+
final String eventChannelName = METHOD_CHANNEL_NAME + "/" + eventId;
64+
final EventChannel eventChannel =
65+
new EventChannel(pluginBinding.getBinaryMessenger(), eventChannelName);
66+
FirebaseFunctions functions = getFunctions(arguments);
67+
FirebaseFunctionsStreamHandler streamHandler = new FirebaseFunctionsStreamHandler(functions);
68+
eventChannel.setStreamHandler(streamHandler);
69+
}
70+
5871
private FirebaseFunctions getFunctions(Map<String, Object> arguments) {
5972
String appName = (String) Objects.requireNonNull(arguments.get("appName"));
6073
String region = (String) Objects.requireNonNull(arguments.get("region"));
@@ -116,24 +129,26 @@ private Task<Object> httpsFunctionCall(Map<String, Object> arguments) {
116129

117130
@Override
118131
public void onMethodCall(MethodCall call, @NonNull final Result result) {
119-
if (!call.method.equals("FirebaseFunctions#call")) {
132+
if (call.method.equals("FirebaseFunctions#registerEventChannel")) {
133+
registerEventChannel(call.arguments());
134+
result.success(null);
135+
} else if (call.method.equals("FirebaseFunctions#call")) {
136+
httpsFunctionCall(call.arguments())
137+
.addOnCompleteListener(
138+
task -> {
139+
if (task.isSuccessful()) {
140+
result.success(task.getResult());
141+
} else {
142+
Exception exception = task.getException();
143+
result.error(
144+
"firebase_functions",
145+
exception != null ? exception.getMessage() : null,
146+
getExceptionDetails(exception));
147+
}
148+
});
149+
} else {
120150
result.notImplemented();
121-
return;
122151
}
123-
124-
httpsFunctionCall(call.arguments())
125-
.addOnCompleteListener(
126-
task -> {
127-
if (task.isSuccessful()) {
128-
result.success(task.getResult());
129-
} else {
130-
Exception exception = task.getException();
131-
result.error(
132-
"firebase_functions",
133-
exception != null ? exception.getMessage() : null,
134-
getExceptionDetails(exception));
135-
}
136-
});
137152
}
138153

139154
private Map<String, Object> getExceptionDetails(@Nullable Exception exception) {

0 commit comments

Comments
 (0)