Add runtime options sample (#862)

Author: jhuleatt

lerna.json

@@ -33,6 +33,7 @@
     "quickstarts/big-ben/functions",
     "quickstarts/email-users/functions",
     "quickstarts/pubsub-helloworld/functions",
+    "quickstarts/runtime-options/functions",
     "quickstarts/thumbnails/functions",
     "quickstarts/time-server/functions",
     "quickstarts/uppercase-firestore/functions",

quickstarts/runtime-options/.gitignore

@@ -0,0 +1,66 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+firebase-debug.*.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env

quickstarts/runtime-options/firebase.json

@@ -0,0 +1,8 @@
+{
+  "functions": {
+    "source": "functions",
+    "predeploy": [
+      "npm --prefix \"$RESOURCE_DIR\" run lint"
+    ]
+  }
+}

quickstarts/runtime-options/functions/.eslintrc.js

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

quickstarts/runtime-options/functions/.gitignore

@@ -0,0 +1 @@
+node_modules/

quickstarts/runtime-options/functions/index.js

@@ -0,0 +1,44 @@
+const functions = require("firebase-functions");
+
+// [START runtimeMinInstances]
+exports.getAutocompleteResponse = functions
+    .runWith(
+        // Keep 5 instances warm for this latency-critical function
+        {
+          minInstances: 5,
+        }
+    )
+    .https.onCall((data, context) => {
+      // Autocomplete a user's search term
+    });
+// [END runtimeMinInstances]
+
+// [START runtimeMaxInstances]
+exports.mirrorOrdersToLegacyDatabase = functions
+    .runWith(
+        // Legacy database only supports 100 simultaneous connections
+        {
+          maxInstances: 100,
+        }
+    )
+    .firestore.document("orders/{orderId}")
+    .onWrite((change, context) => {
+      // Connect to legacy database
+    });
+// [END runtimeMaxInstances]
+
+// [START runtimeTimeoutMemory]
+exports.convertLargeFile = functions
+    .runWith(
+        // Ensure the function has enough memory and time
+        // to process large files
+        {
+          timeoutSeconds: 300,
+          memory: "1GB",
+        }
+    )
+    .storage.object()
+    .onFinalize((object) => {
+      // Do some complicated things that take a lot of memory and time
+    });
+// [END runtimeTimeoutMemory]

quickstarts/runtime-options/functions/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "functions-runtime-options",
+  "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": "12"
+  },
+  "main": "index.js",
+  "dependencies": {
+    "firebase-admin": "^9.2.0",
+    "firebase-functions": "^3.11.0"
+  },
+  "devDependencies": {
+    "eslint": "^7.6.0",
+    "eslint-config-google": "^0.14.0",
+    "firebase-functions-test": "^0.2.0"
+  },
+  "private": true
+}