FlutterNinjas 2024: Exploring Full-Stack Dart for Firebase Server-Side Development
0 likes146 views
The document discusses full-stack Dart development for Firebase server-side processes, highlighting the use of Cloud Run and various Dart packages like functions_framework and dart_firebase_admin. It includes examples of deploying HTTP functions and handling Cloud events, as well as showcasing the capabilities of the Dart Firebase Functions package. The summary emphasizes the integration of Dart, Cloud Run, and Firebase services to enable developers to create server-side applications effectively.
![Run in Container
Dockerfile
FROM dart:stable AS build
WORKDIR /app
COPY . .
RUN dart pub get
RUN dart pub run build_runner build -d
RUN dart compile exe bin/server.dart -o bin/server
FROM scratch
COPY --from=build /runtime/ /
COPY --from=build /app/bin/server /app/bin/
EXPOSE 8080
ENTRYPOINT ["/app/bin/server", "--target=hello", "--signature-type=http"]
FlutterNinjas 2024
kosukesaigusa 15](https://image.slidesharecdn.com/slide-240806020447-daabc96b/85/FlutterNinjas-2024-Exploring-Full-Stack-Dart-for-Firebase-Server-Side-Development-15-320.jpg)
![Deploy CloudEvents triggered Function on Cloud Run
Set --signature-type=cloudevent to ENTRYPOINT option:
FROM dart:stable AS build
WORKDIR /app
COPY . .
RUN dart pub get
RUN dart pub run build_runner build -d
RUN dart compile exe bin/server.dart -o bin/server
FROM scratch
COPY --from=build /runtime/ /
COPY --from=build /app/bin/server /app/bin/
EXPOSE 8080
ENTRYPOINT ["/app/bin/server", "--target=oncreateevent", "--signature-type=cloudevent"]
FlutterNinjas 2024
kosukesaigusa 33](https://image.slidesharecdn.com/slide-240806020447-daabc96b/85/FlutterNinjas-2024-Exploring-Full-Stack-Dart-for-Firebase-Server-Side-Development-33-320.jpg)
![How to handle Raw CloudEvents data?
Request body is in application/protobuf byte data format:
[10, 195, 3, 10, 84, 112, 114, 111, 106, 101, 99, 116, 115, 47, 102, 117 ...]
FlutterNinjas 2024
kosukesaigusa 38](https://image.slidesharecdn.com/slide-240806020447-daabc96b/85/FlutterNinjas-2024-Exploring-Full-Stack-Dart-for-Firebase-Server-Side-Development-38-320.jpg)
![onCreate
@OnDocumentCreated('todos/{todoId}')
Future<void> oncreatetodo(
({String todoId}) params,
QueryDocumentSnapshot snapshot,
RequestContext context,
) async {
final todoId = params.todoId;
final data = snapshot.data();
final title = data?['title'];
// ...
}
const onCreateTodo = functions
.region(`asia-northeast1`)
.firestore.document(`todos/{todoId}`)
.onCreate(async (snapshot, context) => {
const todoId = context.params.todoId
const data = snapshot.data()
const title = data.title
// ...
})
FlutterNinjas 2024
kosukesaigusa 43](https://image.slidesharecdn.com/slide-240806020447-daabc96b/85/FlutterNinjas-2024-Exploring-Full-Stack-Dart-for-Firebase-Server-Side-Development-43-320.jpg)
![Deploy it on Cloud Run
Set --signature-type=cloudevent to ENTRYPOINT option:
FROM dart:stable AS build
WORKDIR /app
COPY . .
RUN dart pub get
RUN dart pub run build_runner build -d
RUN dart compile exe bin/server.dart -o bin/server
FROM scratch
COPY --from=build /runtime/ /
COPY --from=build /app/bin/server /app/bin/
EXPOSE 8080
ENTRYPOINT ["/app/bin/server", "--target=oncreateevent", "--signature-type=cloudevent"]
FlutterNinjas 2024
kosukesaigusa 49](https://image.slidesharecdn.com/slide-240806020447-daabc96b/85/FlutterNinjas-2024-Exploring-Full-Stack-Dart-for-Firebase-Server-Side-Development-49-320.jpg)
FlutterNinjas 2024: Exploring Full-Stack Dart for Firebase Server-Side Development
- 1. FlutterNinjas 2024 Exploring Full-Stack Dart for Firebase Server-Side Development Kosuke (@kosukesaigusa) Hello, Flutter Ninjas! FlutterNinjas 2024 kosukesaigusa 1
- 2. About me Kosuke Saigusa (@kosukesaigusa) Application Engineer located in Japan Flutter, Dart Lover OSS & Community Contributor pub.dev geoflutterfire_plus flutterfire_gen ... Hold & Speak at Tech Conferences in Japan FlutterNinjas 2024 kosukesaigusa 2
- 3. Explore Full-Stack Dart FlutterNinjas 2024 kosukesaigusa 3
- 4. Goal Exploring Full-Stack Dart for Firebase Server-Side Development Develop server-side processes for Firebase using Dart Integration of various GCP services Implement solutions with pub.dev packages: functions_framework dart_firebase_admin FlutterNinjas 2024 kosukesaigusa 4
- 5. First Demo Let's see sample app! FlutterNinjas 2024 kosukesaigusa 5
- 8. Cloud Run FlutterNinjas 2024 Cloud Run is a managed compute platform that lets you run containers directly on top of Google's scalable infrastructure. You can deploy code written in any programming language on Cloud Run if you can build a container image from it. “ “ kosukesaigusa 8
- 9. Compile Dart Program to Executable bin/hello.dart void main(List<String> arguments) { print('Hello, Flutter Ninjas!'); } Compile to executable: dart compile exe bin/hello.dart -o bin/hello Run: $ ./bin/hello Hello, Flutter Ninjas! FlutterNinjas 2024 kosukesaigusa 9
- 11. functions_framework package Developed by GoogleCloudPlatform organization Provides a framework to write Dart functions and deploy it on Cloud Run, GAE, ...etc FlutterNinjas 2024 kosukesaigusa 11
- 12. Write HTTP Function in Dart Write function with @CloudFunction in bin/functions.dart : import 'package:functions_framework/functions_framework.dart'; import 'package:shelf/shelf.dart'; @CloudFunction() Response hello(Request request) => Response.ok('Hello, Flutter Ninjas!'); Generate code: dart pub run build_runner build -d FlutterNinjas 2024 kosukesaigusa 12
- 13. Generated code bin/server.dart : import 'package:functions_framework/serve.dart'; import 'package:hello_server/functions.dart' as function_library; Future<void> main(List<String> args) async { await serve(args, _nameToFunctionTarget); } FunctionTarget? _nameToFunctionTarget(String name) => switch (name) { 'hello' => FunctionTarget.http(function_library.hello), _ => null }; FlutterNinjas 2024 kosukesaigusa 13
- 14. Launch server: $ dart run bin/server.dart Listening on :8080 Request to server: $ curl http://localhost:8080 Hello, Flutter Ninjas! FlutterNinjas 2024 kosukesaigusa 14
- 15. Run in Container Dockerfile FROM dart:stable AS build WORKDIR /app COPY . . RUN dart pub get RUN dart pub run build_runner build -d RUN dart compile exe bin/server.dart -o bin/server FROM scratch COPY --from=build /runtime/ / COPY --from=build /app/bin/server /app/bin/ EXPOSE 8080 ENTRYPOINT ["/app/bin/server", "--target=hello", "--signature-type=http"] FlutterNinjas 2024 kosukesaigusa 15
- 16. Build container: docker build -t hello . Run it: $ docker run -it -p 8080:8080 --name app hello Listening on :8080 Request to server: $ curl http://localhost:8080 Hello, Flutter Ninjas! FlutterNinjas 2024 kosukesaigusa 16
- 17. Demo Try to run hello function on local machine! FlutterNinjas 2024 kosukesaigusa 17
- 18. Deploy HTTP Function on Cloud Run Deploy on Cloud Run with Dockerfile using gcloud CLI: gcloud run deploy hello # Function (service) name --source=. # Path to Dockerfile --platform=managed # For Cloud Run --allow-unauthenticated # For public access Request to Cloud Run: $ curl https://hello-<generated-url>-an.a.run.app Hello, Flutter Ninjas! Be careful of unauthenticated functions. FlutterNinjas 2024 kosukesaigusa 18
- 20. Demo Deploy hello function to Cloud Run! FlutterNinjas 2024 kosukesaigusa 20
- 23. dart_firebase_admin package Developed by invertase organization Remi is the main contributor FlutterNinjas 2024 kosukesaigusa 23
- 24. dart_firebase_admin package final adminApp = FirebaseAdminApp.initializeApp( 'your-project-id', Credential.fromServiceAccountParams( clientId: 'your-client-id', privateKey: 'your-private-key', email: 'your-email', ), ); final firestore = Firestore(adminApp); final auth = Auth(adminApp); final messaging = Messaging(adminApp); FlutterNinjas 2024 kosukesaigusa 24
- 25. Example: Send Cloud Messaging Future<void> main async { final messaging = Messaging(adminApp); await messaging.send( TokenMessage( token: 'some-fcm-token', notification: Notification( title: 'FlutterNinjas 2024!', body: 'Welcome to FlutterNinjas!', ), ), ); } FlutterNinjas 2024 kosukesaigusa 25
- 26. Demo Send FCM to mobile app from local admin SDK! FlutterNinjas 2024 kosukesaigusa 26
- 28. Transfer Cloud Firestore event to Cloud Run FlutterNinjas 2024 kosukesaigusa 28
- 29. Eventarc FlutterNinjas 2024 Eventarc lets you build event- driven architectures without having to implement, customize, or maintain the underlying infrastructure. Eventarc offers a standardized solution to manage the flow of state changes, called events, between decoupled microservices. “ “ kosukesaigusa 29
- 30. CloudEvents FlutterNinjas 2024 CloudEvents is a specification for describing event data in a common way. CloudEvents seeks to dramatically simplify event declaration and delivery across services, platforms, and beyond! “ “ kosukesaigusa 30
- 31. Write CloudEvents triggered Function in Dart FlutterNinjas 2024 kosukesaigusa 31
- 32. Write CloudEvents triggered Function in Dart Define function with @CloudFunction() , and give two parameters: CloudEvent event RequestContext context @CloudFunction() void oncreateevent(CloudEvent event, RequestContext context) => Response.ok('Hello, Flutter Ninjas!'); Only lowercase letters, numbers and '-' are allowed for function name. FlutterNinjas 2024 kosukesaigusa 32
- 33. Deploy CloudEvents triggered Function on Cloud Run Set --signature-type=cloudevent to ENTRYPOINT option: FROM dart:stable AS build WORKDIR /app COPY . . RUN dart pub get RUN dart pub run build_runner build -d RUN dart compile exe bin/server.dart -o bin/server FROM scratch COPY --from=build /runtime/ / COPY --from=build /app/bin/server /app/bin/ EXPOSE 8080 ENTRYPOINT ["/app/bin/server", "--target=oncreateevent", "--signature-type=cloudevent"] FlutterNinjas 2024 kosukesaigusa 33
- 34. Deploy Eventarc trigger Deploy Eventarc trigger using gcloud CLI Transfer: from Cloud Firestore: type=google.cloud.firestore.document.v1.created to Cloud Run: oncreateevent gcloud eventarc triggers create oncreateevent # Trigger name --destination-run-service=oncreateevent # Destination function name --event-filters="type=google.cloud.firestore.document.v1.created" # Event type --event-filters="database=(default)" --event-filters="namespace=(default)" --event-filters-path-pattern="document=events/{eventId}" # Target path --event-data-content-type="application/protobuf" --service-account="your-service-account-name@project-id.iam.gserviceaccount.com" FlutterNinjas 2024 kosukesaigusa 34
- 36. Demo Deploy Eventarc trigger! FlutterNinjas 2024 kosukesaigusa 36
- 38. How to handle Raw CloudEvents data? Request body is in application/protobuf byte data format: [10, 195, 3, 10, 84, 112, 114, 111, 106, 101, 99, 116, 115, 47, 102, 117 ...] FlutterNinjas 2024 kosukesaigusa 38
- 39. How to handle Raw CloudEvents data? CloudEvents metadata found in header such as: Triggered document Triggered event type { "ce-dataschema": "https://github.com/googleapis/.../events/cloud/firestore/v1/data.proto", "authorization": "Bearer ...", "ce-subject": "documents/todos/6iGrCr5nJar6NNB8gPog", "ce-source": "//firestore.googleapis.com/.../databases/(default)", "ce-type": "google.cloud.firestore.document.v1.created", // Triggered event type "content-type": "application/protobuf", "ce-document": "todos/6iGrCr5nJar6NNB8gPog", // Triggered document "ce-project": "...", ... } FlutterNinjas 2024 kosukesaigusa 39
- 40. firebase-functions (Node.js) Node.js SDK provides: Document path parameters from context.params.documentId Triggered DocumentSnapshot snapshot import * as functions from 'firebase-functions' const onCreateTodo = functions .region(`asia-northeast1`) .firestore.document(`todos/{todoId}`) .onCreate(async (snapshot, context) => { const todoId = context.params.todoId const data = snapshot.data() const title = data.title // ... }) FlutterNinjas 2024 kosukesaigusa 40
- 41. Possible to write in Dart? FlutterNinjas 2024 kosukesaigusa 41
- 42. dart_firebase_functions package Still in early stages Provides Node.js-like Firebase functions capability in Dart! FlutterNinjas 2024 kosukesaigusa 42
- 43. onCreate @OnDocumentCreated('todos/{todoId}') Future<void> oncreatetodo( ({String todoId}) params, QueryDocumentSnapshot snapshot, RequestContext context, ) async { final todoId = params.todoId; final data = snapshot.data(); final title = data?['title']; // ... } const onCreateTodo = functions .region(`asia-northeast1`) .firestore.document(`todos/{todoId}`) .onCreate(async (snapshot, context) => { const todoId = context.params.todoId const data = snapshot.data() const title = data.title // ... }) FlutterNinjas 2024 kosukesaigusa 43
- 44. onUpdate @OnDocumentUpdated('todos/{todoId}') Future<void> onupdatetodo( ({String todoId}) params, ({ QueryDocumentSnapshot before, QueryDocumentSnapshot after, }) snapshot, RequestContext context, ) async { final todoId = params.todoId; final before = snapshot.before.data(); final after = snapshot.after.data(); final newTitle = after.title; // ... } const onUpdateTodo = functions .region(`asia-northeast1`) .firestore.document(`todos/{todoId}`) .onUpdate(async (snapshot, context) => { const todoId = context.params.todoId const before = snapshot.before.data() const after = snapshot.after.data() const newTitle = after.title // ... }) FlutterNinjas 2024 kosukesaigusa 44
- 45. onDelete @OnDocumentDeleted('todos/{todoId}') Future<void> ondeletetodo( ({String todoId}) params, QueryDocumentSnapshot snapshot, RequestContext context, ) async { final todoId = params.todoId; final data = snapshot.data(); final title = data?.title; // ... } const onDeleteTodo = functions .region(`asia-northeast1`) .firestore.document(`todos/{todoId}`) .onUpdate(async (snapshot, context) => { const todoId = context.params.todoId const data = snapshot.data() const title = data.title // ... }) FlutterNinjas 2024 kosukesaigusa 45
- 46. onWrite @OnDocumentUpdated('todos/{todoId}') Future<void> onwritetodo( ({String todoId}) params, ({ QueryDocumentSnapshot before, QueryDocumentSnapshot after, }) snapshot, RequestContext context, ) async { final todoId = params.todoId; final before = snapshot.before.data(); final after = snapshot.after.data(); final newTitle = after.title; // ... } const onWriteTodo = functions .region(`asia-northeast1`) .firestore.document(`todos/{todoId}`) .onWrite(async (snapshot, context) => { const todoId = context.params.todoId const before = snapshot.before.data() const after = snapshot.after.data() const newTitle = after?.title // ... }) FlutterNinjas 2024 kosukesaigusa 46
- 47. Nested Collection @OnDocumentCreated('foos/{fooId}/bars/{barId}') Future<void> oncreatebar( ({String fooId, String barId}) params, QueryDocumentSnapshot snapshot, RequestContext context, ) async { final fooId = params.fooId; final barId = params.barId; final data = snapshot.data(); // ... } FlutterNinjas 2024 kosukesaigusa 47
- 48. Write Firestore triggered function in Dart: @OnDocumentCreated('todos/{todoId}') Future<void> oncreatetodo( ({String todoId}) params, QueryDocumentSnapshot snapshot, RequestContext context, ) async { // Use Dart Firebase Admin SDK here. } Generate code: dart pub run build_runner build -d FlutterNinjas 2024 kosukesaigusa 48
- 49. Deploy it on Cloud Run Set --signature-type=cloudevent to ENTRYPOINT option: FROM dart:stable AS build WORKDIR /app COPY . . RUN dart pub get RUN dart pub run build_runner build -d RUN dart compile exe bin/server.dart -o bin/server FROM scratch COPY --from=build /runtime/ / COPY --from=build /app/bin/server /app/bin/ EXPOSE 8080 ENTRYPOINT ["/app/bin/server", "--target=oncreateevent", "--signature-type=cloudevent"] FlutterNinjas 2024 kosukesaigusa 49
- 50. Final Demo Let's see sample app's server-side code! FlutterNinjas 2024 kosukesaigusa 50
- 51. Summary In container, Dart executable can be run (Cloud Run) HTTP and CloudEvents triggered functions are available in Dart, thanks to functions_framework package Firebase Admin SDK is available, thanks to dart_firebase_admin package Eventarc transfers CloudEvents from Cloud Firestore to Cloud Run dart_firebase_function package provides Node.js-like Firebase functions capability in Dart FlutterNinjas 2024 kosukesaigusa 51
- 52. Explore Full-Stack Dart FlutterNinjas 2024 kosukesaigusa 52