Support streaming streaming responses for callable functions. #8609

taeold · 2024-10-25T22:26:41Z

The new .stream() API allows the client to consume streaming responses from the WIP streaming callable functions in Firebase Functions Node.js SDK.

When client makes a request to the callable function w/ header Accept: text/event-stream, the callable function responds with response chunks in Server-Sent Event format.

The sdk changes here abstracts over the wire-protocol by parsing the response chunks and returning an instance of a AsyncIterable to consume to data:

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const generateText = httpsCallable(functions, 'generateText');
const resp = await generateText.stream(
  { text: 'What is your favorite Firebase service and why?' },
  { signal: AbortSignal.timeout(60_000) },
);
try {
  for await (const message of resp.stream) {
     console.log(message); // prints "foo", "bar"
  }
  console.log(await resp.data) // prints "foo bar"
} catch (e) {
  // FirebaseError(code='cancelled', message='Request was cancelled.');
  console.error(e)
}

changeset-bot · 2024-10-25T22:26:44Z

🦋 Changeset detected

Latest commit: 9ea463d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@firebase/functions	Minor
firebase	Minor
@firebase/functions-compat	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

google-oss-bot · 2024-10-25T23:14:02Z

Size Report ¹

Affected Products

@firebase/functions
Type Base (ffbf5a6) Merge (482c8d3) Diff
browser 9.72 kB 13.7 kB +3.95 kB (+40.7%)
main 10.3 kB 14.2 kB +3.95 kB (+38.4%)
module 9.72 kB 13.7 kB +3.95 kB (+40.7%)
bundle
Type Base (ffbf5a6) Merge (482c8d3) Diff
functions (call) 32.0 kB 34.4 kB +2.36 kB (+7.4%)
firebase
Type Base (ffbf5a6) Merge (482c8d3) Diff
firebase-compat.js 794 kB 797 kB +2.23 kB (+0.3%)
firebase-functions-compat.js 8.21 kB 10.4 kB +2.20 kB (+26.8%)
firebase-functions.js 12.0 kB 14.6 kB +2.58 kB (+21.5%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/mUAD8zptI3.html

google-oss-bot · 2024-10-25T23:25:51Z

Size Analysis Report ¹

Affected Products

`@firebase/functions`

FunctionsError
Size
Type Base (ffbf5a6) Merge (482c8d3) Diff
size 2.48 kB 2.52 kB +41 B (+1.7%)
size-with-ext-deps 20.3 kB 20.3 kB +41 B (+0.2%)
connectFunctionsEmulator
Size
Type Base (ffbf5a6) Merge (482c8d3) Diff
size 2.46 kB 2.50 kB +41 B (+1.7%)
size-with-ext-deps 20.3 kB 20.4 kB +41 B (+0.2%)
getFunctions
Size
Type Base (ffbf5a6) Merge (482c8d3) Diff
size 2.64 kB 2.68 kB +41 B (+1.6%)
size-with-ext-deps 28.1 kB 28.2 kB +41 B (+0.1%)

`httpsCallable`

Size

Type	Base (`ffbf5a6`)	Merge (`482c8d3`)	Diff
size	6.12 kB	8.45 kB	+2.33 kB (+38.1%)
size-with-ext-deps	24.0 kB	26.4 kB	+2.36 kB (+9.8%)

Dependency

Type Base (ffbf5a6) Merge (482c8d3) Diff

functions

12 dependencies

_errorForResponse
call
callAtURL
codeForHTTPStatus
decode
encode
failAfter
httpsCallable
httpsCallable$1
mapValues
postJSON
registerFunctions

16 dependencies

_errorForResponse
call
callAtURL
codeForHTTPStatus
createResponseStream
decode
encode
failAfter
httpsCallable
httpsCallable$1
makeAuthHeaders
mapValues
postJSON
registerFunctions
stream
streamAtURL

+ createResponseStream
+ makeAuthHeaders
+ stream
+ streamAtURL

variables

APP_CHECK_INTERNAL_NAME
AUTH_INTERNAL_NAME
DEFAULT_REGION
FUNCTIONS_TYPE
LONG_TYPE
MESSAGING_INTERNAL_NAME
UNSIGNED_LONG_TYPE
errorCodeMap
name
version

11 dependencies

APP_CHECK_INTERNAL_NAME
AUTH_INTERNAL_NAME
DEFAULT_REGION
FUNCTIONS_TYPE
LONG_TYPE
MESSAGING_INTERNAL_NAME
UNSIGNED_LONG_TYPE
errorCodeMap
name
responseLineRE
version

+ responseLineRE

`httpsCallableFromURL`

Size

Type	Base (`ffbf5a6`)	Merge (`482c8d3`)	Diff
size	6.07 kB	8.35 kB	+2.28 kB (+37.5%)
size-with-ext-deps	23.9 kB	26.2 kB	+2.30 kB (+9.6%)

Dependency

Type Base (ffbf5a6) Merge (482c8d3) Diff

functions

11 dependencies

_errorForResponse
callAtURL
codeForHTTPStatus
decode
encode
failAfter
httpsCallableFromURL
httpsCallableFromURL$1
mapValues
postJSON
registerFunctions

14 dependencies

_errorForResponse
callAtURL
codeForHTTPStatus
createResponseStream
decode
encode
failAfter
httpsCallableFromURL
httpsCallableFromURL$1
makeAuthHeaders
mapValues
postJSON
registerFunctions
streamAtURL

+ createResponseStream
+ makeAuthHeaders
+ streamAtURL

variables

APP_CHECK_INTERNAL_NAME
AUTH_INTERNAL_NAME
DEFAULT_REGION
FUNCTIONS_TYPE
LONG_TYPE
MESSAGING_INTERNAL_NAME
UNSIGNED_LONG_TYPE
errorCodeMap
name
version

11 dependencies

APP_CHECK_INTERNAL_NAME
AUTH_INTERNAL_NAME
DEFAULT_REGION
FUNCTIONS_TYPE
LONG_TYPE
MESSAGING_INTERNAL_NAME
UNSIGNED_LONG_TYPE
errorCodeMap
name
responseLineRE
version

+ responseLineRE

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/gmxX7gK98g.html

…e-js-sdk into dl-fn-streaming

packages/functions/src/service.ts

…e-js-sdk into dl-fn-streaming

github-actions · 2024-11-09T20:03:57Z

Changeset File Check ✅

No modified packages are missing from the changeset file.
No changeset formatting errors detected.

hsubox76

CI stuff that you want to do before you finalize and merge:

(1) To address the formatting CI failure, run yarn format locally.
(2) To address the docgen failure, run yarn docgen:all locally. This will modify some files in docs-devsite which will require a techwriter review approval in addition to a JS core team review. go/firebase-contacts tells me the techwriter assigned to CF3 is Eric Gilmore.

packages/functions-types/index.d.ts

hsubox76 · 2024-11-22T21:16:13Z

packages/functions/package.json

@@ -37,7 +37,8 @@
    "test:browser": "karma start",
    "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
    "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'src/{,!(browser)/**/}*.test.ts' --file src/index.ts --config ../../config/mocharc.node.js",
-    "test:emulator": "env FIREBASE_FUNCTIONS_EMULATOR_ORIGIN=http://localhost:5005 run-p --npm-path npm test:node",
+    "test:emulator": "env FIREBASE_FUNCTIONS_EMULATOR_ORIGIN=http://127.0.0.1:5005 run-p test:node",
+    "test:emulator": "env FIREBASE_FUNCTIONS_EMULATOR_ORIGIN=http://127.0.0.1:5005 run-p --npm-path npm test:node",


Is my github diff wonky or are these two lines with the same script name?

whoops i think this is an artifact of a merge gone wrong. Reverted.

Should this change to use 127.0.0.1 instead of localhost still be here?

On my dev machine, only 127.0.0.1 works (due to changes in recent Mac version that resolves localhost to ipv6), but I can revert the change if preferred.

.changeset/bright-scissors-care.md

DellaBitta · 2024-11-25T18:12:33Z

packages/functions/package.json

@@ -37,7 +37,8 @@
    "test:browser": "karma start",
    "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
    "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'src/{,!(browser)/**/}*.test.ts' --file src/index.ts --config ../../config/mocharc.node.js",
-    "test:emulator": "env FIREBASE_FUNCTIONS_EMULATOR_ORIGIN=http://localhost:5005 run-p --npm-path npm test:node",
+    "test:emulator": "env FIREBASE_FUNCTIONS_EMULATOR_ORIGIN=http://127.0.0.1:5005 run-p test:node",
+    "test:emulator": "env FIREBASE_FUNCTIONS_EMULATOR_ORIGIN=http://127.0.0.1:5005 run-p --npm-path npm test:node",


Should this change to use 127.0.0.1 instead of localhost still be here?

packages/functions/src/callable.test.ts

packages/functions/src/public-types.ts

packages/functions/src/service.ts

…e-js-sdk into dl-fn-streaming

egilmorez

A few thoughts and tweaks, thanks!

packages/functions/src/public-types.ts

egilmorez · 2024-12-03T20:12:26Z

docs-devsite/functions.httpscallable.md

+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# HttpsCallable interface


I'm puzzled about why this is new/green/add when it seems to have existed already in line 43 of public_types.ts, iiuc.

In any case, it would be great to have clarity on whether we really mean "Google Cloud Functions" or whether we should stick with just "Cloud Functions" or even "Cloud Functions for Firebase."

It's been a while since we made significant changes to this code, and it's possible the these type definition preceeds the devsite doc generation process I'm running here.

I'll stick with Cloud Functions?

SG, thanks!

egilmorez · 2024-12-03T20:42:48Z

docs-devsite/functions.httpscallable.md

+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# HttpsCallable interface


SG, thanks!

Support streaming streaming responses for callable functions.

48eca40

taeold and others added 3 commits October 25, 2024 15:27

Merge branch 'main' into dl-fn-streaming

21db516

Support AbortSignal

d28863c

Update API reports

a02b25f

taeold and others added 6 commits October 26, 2024 20:48

Re-introduce fetchImpl.

ab99970

Merge branch 'dl-fn-streaming' of https://github.com/firebase/firebas…

8ec2787

…e-js-sdk into dl-fn-streaming

Add more tests.

4aee03e

Update API reports

fdc70d8

Add comment.

55d9266

Merge branch 'dl-fn-streaming' of https://github.com/firebase/firebas…

9a430cc

…e-js-sdk into dl-fn-streaming

pavelgj reviewed Nov 6, 2024

View reviewed changes

packages/functions/src/service.ts Outdated Show resolved Hide resolved

taeold and others added 8 commits November 6, 2024 15:34

Allow reading multiple data chunks from single read() chunk.

785e906

Fix lint errors.

861edce

Don't swallow errors.

4b188d0

Fix linter issues.

39c44d5

Update API reports

1c1f533

Merge remote-tracking branch 'origin/main' into dl-fn-streaming

b481220

Merge branch 'dl-fn-streaming' of https://github.com/firebase/firebas…

9f4c973

…e-js-sdk into dl-fn-streaming

Add changeset.

ebd74cb

taeold added 4 commits November 21, 2024 16:25

Update code to use pump() patter.

cf56623

Refactor implementation for better readability.

cfbcd46

Nits.

1801c53

More nits.

bf4f5e9

hsubox76 reviewed Nov 22, 2024

View reviewed changes

taeold added 2 commits November 22, 2024 15:42

Merge branch 'main' into dl-fn-streaming

c6ef6a0

Revert changes to the functions-type package.

31998c2

taeold and others added 6 commits November 22, 2024 15:49

Remove duplicate entry in the package script for functions.

72e87b4

Run formatter.

d8ebbb8

Generate updated docs.

fd2cb15

Refactor code to make auth headers.

9a85bb2

Fix misc.

f581b61

Update API reports

b9a42e5

taeold marked this pull request as ready for review November 24, 2024 20:04

taeold requested review from a team as code owners November 24, 2024 20:04

DellaBitta reviewed Nov 26, 2024

View reviewed changes

taeold added 6 commits December 2, 2024 20:37

Revert uninteded changes to untouched test case.

d0cc907

Add docstring comments to utility functions.

f773110

Merge branch 'dl-fn-streaming' of https://github.com/firebase/firebas…

aa993f0

…e-js-sdk into dl-fn-streaming

Correct documentation on AbortSignal.

9ae31c0

Run formatter

327c1cb

Update docs.

5fb40f1

taeold requested review from hsubox76, DellaBitta and egilmorez December 3, 2024 05:01

hsubox76 approved these changes Dec 3, 2024

View reviewed changes

egilmorez reviewed Dec 3, 2024

View reviewed changes

Update docs per comments.

9ea463d

taeold requested a review from egilmorez December 3, 2024 20:30

egilmorez approved these changes Dec 3, 2024

View reviewed changes

taeold merged commit f05509e into main Dec 4, 2024
39 checks passed

taeold deleted the dl-fn-streaming branch December 4, 2024 17:48

google-oss-bot mentioned this pull request Dec 10, 2024

Version Packages #8672

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support streaming streaming responses for callable functions. #8609

Support streaming streaming responses for callable functions. #8609

taeold commented Oct 25, 2024 •

edited

Loading

changeset-bot bot commented Oct 25, 2024 •

edited

Loading

google-oss-bot commented Oct 25, 2024 •

edited

Loading

`@firebase/functions`

`bundle`

`firebase`

google-oss-bot commented Oct 25, 2024 •

edited

Loading

`@firebase/functions`

`FunctionsError`

`connectFunctionsEmulator`

`getFunctions`

`httpsCallable`

`httpsCallableFromURL`

github-actions bot commented Nov 9, 2024 •

edited

Loading

hsubox76 left a comment

hsubox76 Nov 22, 2024

taeold Nov 22, 2024

DellaBitta Nov 25, 2024

taeold Dec 3, 2024

DellaBitta Nov 25, 2024

egilmorez left a comment

egilmorez Dec 3, 2024

taeold Dec 3, 2024

taeold Dec 3, 2024

egilmorez Dec 3, 2024

egilmorez Dec 3, 2024

Support streaming streaming responses for callable functions. #8609

Support streaming streaming responses for callable functions. #8609

Conversation

taeold commented Oct 25, 2024 • edited Loading

changeset-bot bot commented Oct 25, 2024 • edited Loading

🦋 Changeset detected

google-oss-bot commented Oct 25, 2024 • edited Loading

Size Report 1

Affected Products

@firebase/functions

bundle

firebase

Test Logs

google-oss-bot commented Oct 25, 2024 • edited Loading

Size Analysis Report 1

Affected Products

@firebase/functions

FunctionsError

connectFunctionsEmulator

getFunctions

httpsCallable

httpsCallableFromURL

Test Logs

github-actions bot commented Nov 9, 2024 • edited Loading

Changeset File Check ✅

hsubox76 left a 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

egilmorez left a 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

taeold commented Oct 25, 2024 •

edited

Loading

changeset-bot bot commented Oct 25, 2024 •

edited

Loading

google-oss-bot commented Oct 25, 2024 •

edited

Loading

Size Report ¹

`@firebase/functions`

`bundle`

`firebase`

google-oss-bot commented Oct 25, 2024 •

edited

Loading

Size Analysis Report ¹

`@firebase/functions`

`FunctionsError`

`connectFunctionsEmulator`

`getFunctions`

`httpsCallable`

`httpsCallableFromURL`

github-actions bot commented Nov 9, 2024 •

edited

Loading