Merge pull request #1000 from firebase/colerogers.rtdb-gen2-samples

RTDB v2 Triggers

Author: colerogers

2nd-gen/uppercase/README.md

@@ -0,0 +1,30 @@
+# Firebase SDK for Cloud Functions 2nd Gen Quickstart - Realtime Database
+
+This quickstart demonstrates using **Firebase SDK for Cloud Functions** with **Firebase Realtime Database**.
+
+
+## Introduction
+
+This sample app does two things:
+ - Create messages in the Firebase Realtime Database using a simple HTTPS request which is handled by a v2 HTTPS function. Writing to the Realtime Database is done using the Firebase Admin SDK. 
+ - When a message gets added in the Realtime Database, a v2 function triggers and automatically makes these messages all uppercase.
+
+## Deploy and try out
+
+To deploy and try out the sample:
+
+ - Create a Firebase project using the [Firebase console](https://console.firebase.google.com)
+ - Install the required dependencies by running `npm install` in the `functions` directory
+ - Deploy your project's code using `firebase deploy`
+ - Create a message by opening the querying the functions URL from your browser.
+
+ The function executes and redirects the browser to the Firebase console at the database location where the text string was stored. You should see your text value displayed in the console and in uppercase.
+
+## Contributing
+
+We'd love you to contribute to the project. Before doing so please read our [Contributor guide](../../CONTRIBUTING.md).
+
+
+## License
+
+© Google, 2022. Licensed under an [Apache-2](../../LICENSE) license.

2nd-gen/uppercase/database.rules.json

@@ -0,0 +1,6 @@
+{
+  "rules": {
+    ".read": true,
+    ".write": true
+  }
+}

2nd-gen/uppercase/firebase.json

@@ -0,0 +1,14 @@
+{
+  "rulesFile": "database.rules.json",
+  "emulators": {
+    "functions": {
+      "port": 5001
+    },
+    "database": {
+      "port": 9000
+    },
+    "ui": {
+      "enabled": true
+    }
+  }
+}

2nd-gen/uppercase/functions/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "google",
+  ],
+  rules: {
+    quotes: ["error", "double"],
+  },
+};

2nd-gen/uppercase/functions/index.js

@@ -0,0 +1,62 @@
+/**
+ * Copyright 2022 Google Inc. All Rights Reserved.
+ *
+ * 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.
+ */
+'use strict';
+
+// [START all]
+// [START import]
+// The Cloud Functions for Firebase SDK to create v2 Cloud Functions and setup triggers.
+const { onRequest } = require('firebase-functions/v2/https');
+const { onValueCreated } = require('firebase-functions/v2/database');
+const { logger } = require('firebase-functions');
+
+// The Firebase Admin SDK to access the Firebase Realtime Database.
+const admin = require('firebase-admin');
+admin.initializeApp();
+// [END import]
+
+// [START addmessage]
+// Take the text parameter passed to this HTTP endpoint and insert it into the
+// Realtime Database under the path /messages/:pushId/original
+// [START addMessageTrigger]
+exports.addmessage = onRequest(async (req, resp) => {
+// [END addMessageTrigger]
+  // Grab the text parameter.
+  const original = req.query.text;
+  // [START adminSdkPush]
+  // Push the new message into the Realtime Database using the Firebase Admin SDK.
+  const snapshot = await admin.database().ref('/messages').push({original: original});
+  // Redirect with 303 SEE OTHER to the URL of the pushed object in the Firebase console.
+  res.redirect(303, snapshot.ref.toString());
+  // [END adminSdkPush]
+});
+// [END addmessage]
+
+// [START makeuppercase]
+// Listens for new messages added to /messages/:pushId/original and creates an
+// uppercase version of the message to /messages/:pushId/uppercase
+// for all databases in 'us-central1'
+exports.makeuppercase = onValueCreated('/messages/{pushId}/original', (event) => {
+      // Grab the current value of what was written to the Realtime Database.
+      const original = event.data.val();
+      logger.log('Uppercasing', event.params.pushId, original);
+      const uppercase = original.toUpperCase();
+      // You must return a Promise when performing asynchronous tasks inside a function, such as
+      // writing to the Firebase Realtime Database.
+      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
+      return event.data.ref.parent.child('uppercase').set(uppercase);
+    });
+// [END makeuppercase]
+// [END all]

2nd-gen/uppercase/functions/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "functions",
+  "description": "Cloud Functions for Firebase",
+  "scripts": {
+    "lint": "eslint .",
+    "serve": "firebase emulators:start --only functions",
+    "shell": "firebase functions:shell",
+    "start": "npm run shell",
+    "deploy": "firebase deploy --only functions",
+    "logs": "firebase functions:log"
+  },
+  "engines": {
+    "node": "16"
+  },
+  "main": "index.js",
+  "dependencies": {
+    "firebase-admin": "^10.0.2",
+    "firebase-functions": "^3.22.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.9.0",
+    "eslint-config-google": "^0.14.0",
+    "firebase-functions-test": "^0.2.0"
+  },
+  "private": true
+}