From 57647f7c79cc923a9b04e7d9c46c3055c42c3419 Mon Sep 17 00:00:00 2001 From: Jeff Huleatt <3759507+jhuleatt@users.noreply.github.com> Date: Tue, 7 Apr 2026 14:29:23 -0400 Subject: [PATCH 1/2] callable sample --- .github/workflows/test_dart.yml | 23 +++--- .../quickstarts/callable-functions/.gitignore | 5 ++ Dart/quickstarts/callable-functions/README.md | 29 ++++++++ .../callable-functions/bin/server.dart | 70 +++++++++++++++++++ .../callable-functions/firebase.json | 6 ++ .../callable-functions/pubspec.yaml | 32 +++++++++ 6 files changed, 154 insertions(+), 11 deletions(-) create mode 100644 Dart/quickstarts/callable-functions/.gitignore create mode 100644 Dart/quickstarts/callable-functions/README.md create mode 100644 Dart/quickstarts/callable-functions/bin/server.dart create mode 100644 Dart/quickstarts/callable-functions/firebase.json create mode 100644 Dart/quickstarts/callable-functions/pubspec.yaml diff --git a/.github/workflows/test_dart.yml b/.github/workflows/test_dart.yml index 943a717241..751df78226 100644 --- a/.github/workflows/test_dart.yml +++ b/.github/workflows/test_dart.yml @@ -43,14 +43,15 @@ jobs: with: sdk: ${{ matrix.dart-version }} - - name: HTTPS Time Server - Install dependencies - working-directory: ./Dart/quickstarts/https-time-server - run: dart pub get - - - name: HTTPS Time Server - Format - working-directory: ./Dart/quickstarts/https-time-server - run: dart format --set-exit-if-changed . - - - name: HTTPS Time Server - Analyze - working-directory: ./Dart/quickstarts/https-time-server - run: dart analyze . + - name: Test Dart Samples + run: | + set -e + for dir in $(find Dart -name pubspec.yaml -exec dirname {} \;); do + echo "::group::Testing $dir" + cd "$dir" + dart pub get + dart format --set-exit-if-changed . + dart analyze . + cd - > /dev/null + echo "::endgroup::" + done diff --git a/Dart/quickstarts/callable-functions/.gitignore b/Dart/quickstarts/callable-functions/.gitignore new file mode 100644 index 0000000000..8ae1a6ef6d --- /dev/null +++ b/Dart/quickstarts/callable-functions/.gitignore @@ -0,0 +1,5 @@ +.dart_tool/ +.packages +build/ +*.dart_tool +pubspec.lock diff --git a/Dart/quickstarts/callable-functions/README.md b/Dart/quickstarts/callable-functions/README.md new file mode 100644 index 0000000000..fc96b7843a --- /dev/null +++ b/Dart/quickstarts/callable-functions/README.md @@ -0,0 +1,29 @@ +# Firebase SDK for Cloud Functions Quickstart - Callable Functions + +This quickstart demonstrates how to send requests to a server-side function and get a response back using one of the Client SDKs. + +## Introduction + +The function `addNumbers` Returns the sum of two numbers. + +Further reading: + + - [Read more about Cloud Functions for Firebase](https://firebase.google.com/docs/functions/) + +## Deploy the app to prod + +First you need to get the `dart` dependencies of the functions: + +```bash +dart pub get +``` + +Deploy to Firebase using the following command: + +```bash +firebase deploy --only functions +``` + +## License + +© Google, 2026. Licensed under an [Apache-2](../../../LICENSE) license. diff --git a/Dart/quickstarts/callable-functions/bin/server.dart b/Dart/quickstarts/callable-functions/bin/server.dart new file mode 100644 index 0000000000..5feeb7f68a --- /dev/null +++ b/Dart/quickstarts/callable-functions/bin/server.dart @@ -0,0 +1,70 @@ +// Copyright 2026 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// [START imports] +// Dependencies for callable functions. +import 'package:firebase_functions/firebase_functions.dart'; +// [END imports] + +void main(List args) async { + await fireUp(args, (firebase) { + // [START allAdd] + // [START addFunctionTrigger] + // Adds two numbers to each other. + firebase.https.onCall(name: 'addNumbers', (request, response) async { + // [END addFunctionTrigger] + // [START readAddData] + // Numbers passed from the client. + final data = request.data as Map?; + final firstNumber = data?['firstNumber']; + final secondNumber = data?['secondNumber']; + // [END readAddData] + + // [START addHttpsError] + // Checking that attributes are present and are numbers. + if (firstNumber is! num || secondNumber is! num) { + // Throwing an HttpsError so that the client gets the error details. + throw InvalidArgumentError( + 'The function must be called with two arguments "firstNumber" and "secondNumber" which must both be numbers.', + ); + } + // [END addHttpsError] + + // [START authIntegration] + // Authentication / user information is automatically added to the request. + final uid = request.auth?.uid; + final token = request.auth?.token; + final name = token?['name']; + final picture = token?['picture']; + final email = token?['email']; + + // Use variables to suppress 'unused' lint warnings + print( + 'User details: uid=$uid, name=$name, picture=$picture, email=$email', + ); + // [END authIntegration] + + // [START returnAddData] + // returning result. + return CallableResult({ + 'firstNumber': firstNumber, + 'secondNumber': secondNumber, + 'operator': '+', + 'operationResult': firstNumber + secondNumber, + }); + // [END returnAddData] + }); + // [END allAdd] + }); +} diff --git a/Dart/quickstarts/callable-functions/firebase.json b/Dart/quickstarts/callable-functions/firebase.json new file mode 100644 index 0000000000..fd5f337b9d --- /dev/null +++ b/Dart/quickstarts/callable-functions/firebase.json @@ -0,0 +1,6 @@ +{ + "functions": { + "source": ".", + "codebase": "dart-quickstarts-callable-functions" + } +} diff --git a/Dart/quickstarts/callable-functions/pubspec.yaml b/Dart/quickstarts/callable-functions/pubspec.yaml new file mode 100644 index 0000000000..edd292f0c0 --- /dev/null +++ b/Dart/quickstarts/callable-functions/pubspec.yaml @@ -0,0 +1,32 @@ +name: callable_functions +description: Callable examples for Firebase Functions for Dart +publish_to: none + +environment: + sdk: ^3.11.0 + +dependencies: + firebase_functions: + git: + url: https://github.com/firebase/firebase-functions-dart + ref: main + +dev_dependencies: + build_runner: ^2.10.5 + lints: ^6.0.0 + +dependency_overrides: + firebase_functions: + git: + url: https://github.com/firebase/firebase-functions-dart + ref: main + dart_firebase_admin: + git: + url: https://github.com/firebase/firebase-admin-dart + path: packages/dart_firebase_admin + ref: main + google_cloud_firestore: + git: + url: https://github.com/firebase/firebase-admin-dart + path: packages/google_cloud_firestore + ref: main From 6ad2f6e1381421bb6bc522c5466468d33c259a4f Mon Sep 17 00:00:00 2001 From: Jeff Huleatt <3759507+jhuleatt@users.noreply.github.com> Date: Tue, 7 Apr 2026 14:40:38 -0400 Subject: [PATCH 2/2] add streaming callable sample --- .../callable-functions-streaming/.gitignore | 5 + .../callable-functions-streaming/README.md | 31 +++++++ .../bin/server.dart | 92 +++++++++++++++++++ .../firebase.json | 6 ++ .../callable-functions-streaming/pubspec.yaml | 33 +++++++ README.md | 6 ++ 6 files changed, 173 insertions(+) create mode 100644 Dart/quickstarts/callable-functions-streaming/.gitignore create mode 100644 Dart/quickstarts/callable-functions-streaming/README.md create mode 100644 Dart/quickstarts/callable-functions-streaming/bin/server.dart create mode 100644 Dart/quickstarts/callable-functions-streaming/firebase.json create mode 100644 Dart/quickstarts/callable-functions-streaming/pubspec.yaml diff --git a/Dart/quickstarts/callable-functions-streaming/.gitignore b/Dart/quickstarts/callable-functions-streaming/.gitignore new file mode 100644 index 0000000000..8ae1a6ef6d --- /dev/null +++ b/Dart/quickstarts/callable-functions-streaming/.gitignore @@ -0,0 +1,5 @@ +.dart_tool/ +.packages +build/ +*.dart_tool +pubspec.lock diff --git a/Dart/quickstarts/callable-functions-streaming/README.md b/Dart/quickstarts/callable-functions-streaming/README.md new file mode 100644 index 0000000000..c2a4c5f1a4 --- /dev/null +++ b/Dart/quickstarts/callable-functions-streaming/README.md @@ -0,0 +1,31 @@ +# Firebase SDK for Cloud Functions Quickstart - Callable Functions Streaming + +This quickstart demonstrates how to send requests to a server-side function and _stream_ a response to a client SDK using Dart. + +[Read more about Cloud Functions for Firebase](https://firebase.google.com/docs/functions/) + + +## Frontend Client + +You can find the frontend code in [`../../../Node/quickstarts/callable-functions-streaming/website`](../../../Node/quickstarts/callable-functions-streaming/website). + +**IMPORTANT NOTE**: Due to limitations during the experimental release of Dart support in Cloud Functions for Firebase, the code in the website must be modified. Instead of using `httpsCallable`, you must use [`httpsCallableFromURL`](https://firebase.google.com/docs/reference/js/functions.md#httpscallablefromurl_7af6987) and pass the full function url (`https://.run.app` or the emulator equivalent), which can be found in the Cloud console or the emulator logs. + + +## Deploy the app to prod + +First you need to get the `dart` dependencies of the functions: + +```bash +dart pub get +``` + +Deploy to Firebase using the following command: + +```bash +firebase deploy --only functions +``` + +## License + +© Google, 2026. Licensed under an [Apache-2](../../../LICENSE) license. diff --git a/Dart/quickstarts/callable-functions-streaming/bin/server.dart b/Dart/quickstarts/callable-functions-streaming/bin/server.dart new file mode 100644 index 0000000000..eb73c36d32 --- /dev/null +++ b/Dart/quickstarts/callable-functions-streaming/bin/server.dart @@ -0,0 +1,92 @@ +// Copyright 2026 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// [START full-sample] +// Dependencies for callable functions. +import 'dart:convert'; +import 'dart:math'; + +import 'package:firebase_functions/firebase_functions.dart'; +import 'package:http/http.dart' as http; + +/// Gets the weather from the national weather service +/// https://www.weather.gov/documentation/services-web-api +Future weatherForecastApi(num lat, num lng) async { + final resp = await http.get( + Uri.parse('https://api.weather.gov/points/$lat,$lng'), + ); + + if (resp.statusCode >= 400) { + return 'error: ${resp.statusCode}'; + } + + final pointData = jsonDecode(resp.body) as Map; + final forecastUrl = pointData['properties']['forecast'] as String; + final forecastResp = await http.get(Uri.parse(forecastUrl)); + + if (forecastResp.statusCode >= 400) { + return 'error: ${forecastResp.statusCode}'; + } + + // add an artificial wait to emphasize stream-iness + final randomWait = Random().nextDouble() * 1500; + await Future.delayed(Duration(milliseconds: randomWait.toInt())); + + return jsonDecode(forecastResp.body); +} + +void main(List args) async { + await fireUp(args, (firebase) { + // [START streaming-callable] + firebase.https.onCall(name: 'getForecast', (request, response) async { + final data = request.data as Map?; + final locations = data?['locations'] as List?; + + if (locations == null || locations.isEmpty) { + throw InvalidArgumentError('Missing locations to forecast'); + } + + // fetch forecast data for all requested locations + final allRequests = locations.map((location) async { + if (location case { + 'latitude': num latitude, + 'longitude': num longitude, + }) { + final forecast = await weatherForecastApi(latitude, longitude); + final result = { + 'latitude': latitude, + 'longitude': longitude, + 'forecast': forecast, + }; + + // clients that support streaming will have each + // forecast streamed to them as they complete + if (request.acceptsStreaming) { + await response.sendChunk(result); + } + + return result; + } + + throw InvalidArgumentError('Invalid location format'); + }); + + // Return the full set of data to all clients + return CallableResult(await Future.wait(allRequests)); + }); + // [END streaming-callable] + }); +} + +// [END full-sample] diff --git a/Dart/quickstarts/callable-functions-streaming/firebase.json b/Dart/quickstarts/callable-functions-streaming/firebase.json new file mode 100644 index 0000000000..817dd26e03 --- /dev/null +++ b/Dart/quickstarts/callable-functions-streaming/firebase.json @@ -0,0 +1,6 @@ +{ + "functions": { + "source": ".", + "codebase": "dart-quickstarts-callable-functions-streaming" + } +} diff --git a/Dart/quickstarts/callable-functions-streaming/pubspec.yaml b/Dart/quickstarts/callable-functions-streaming/pubspec.yaml new file mode 100644 index 0000000000..6e8a85407c --- /dev/null +++ b/Dart/quickstarts/callable-functions-streaming/pubspec.yaml @@ -0,0 +1,33 @@ +name: callable_functions_streaming +description: Streaming callable examples for Firebase Functions for Dart +publish_to: none + +environment: + sdk: ^3.11.0 + +dependencies: + firebase_functions: + git: + url: https://github.com/firebase/firebase-functions-dart + ref: main + http: ^1.2.0 + +dev_dependencies: + build_runner: ^2.10.5 + lints: ^6.0.0 + +dependency_overrides: + firebase_functions: + git: + url: https://github.com/firebase/firebase-functions-dart + ref: main + dart_firebase_admin: + git: + url: https://github.com/firebase/firebase-admin-dart + path: packages/dart_firebase_admin + ref: main + google_cloud_firestore: + git: + url: https://github.com/firebase/firebase-admin-dart + path: packages/google_cloud_firestore + ref: main diff --git a/README.md b/README.md index ea03afdc16..9ecbdf405d 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,16 @@ This quickstart sample demonstrates using **Cloud Functions** triggered by **Fir ### Quickstart: Add numbers and sanitize text with callable functions +- [Dart](/Dart/quickstarts/callable-functions/) - [Node 2nd gen](/Node/quickstarts/callable-functions/) - [Python](/Python/quickstarts/callable-functions) - [Node 1st gen](/Node-1st-gen/quickstarts/callable-functions/) +### Quickstart: Stream responses with callable functions + +- [Dart](/Dart/quickstarts/callable-functions-streaming/) +- [Node 2nd gen](/Node/quickstarts/callable-functions-streaming/) + ### HTTPS trigger quickstart: Time Server - [Dart](/Dart/quickstarts/https-time-server/)