first draft of streaming sample

Author: jhuleatt

Node/quickstarts/callable-functions-streaming/.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

Node/quickstarts/callable-functions-streaming/README.md

@@ -0,0 +1,21 @@
+Firebase HTTPS Callable functions Quickstart
+================================================
+
+The HTTPS Callable functions Quickstart demonstrates how to send requests to a server-side function and get a response back using one of the Client SDKs. It interoperates with the Web, iOS and Android quickstarts.
+
+
+[Read more about Cloud Functions for Firebase](https://firebase.google.com/docs/functions/)
+
+
+Getting Started
+---------------
+
+1. Install dependencies with `npm install` and deploy with `firebase deploy --only functions`
+1. Set up a client (import the functions client SDK, initializeApp, init the functions sdk)
+2. Call the function
+
+
+License
+-------
+
+© Google, 2022. Licensed under an [Apache-2](../../../LICENSE) license.

Node/quickstarts/callable-functions-streaming/firebase.json

@@ -0,0 +1,11 @@
+{
+  "functions": {
+    "codebase": "callable-functions",
+    "predeploy": [
+      "npm --prefix \"$RESOURCE_DIR\" run lint"
+    ]
+  },
+  "hosting": {
+    "public": "website"
+  }
+}

Node/quickstarts/callable-functions-streaming/functions/.eslintrc.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2023 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.
+ */
+
+module.exports = {
+  root: true,
+  env: {
+    es2020: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "google",
+  ],
+  rules: {
+    quotes: ["error", "double"],
+  },
+};

Node/quickstarts/callable-functions-streaming/functions/.gitignore

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

Node/quickstarts/callable-functions-streaming/functions/index.js

@@ -0,0 +1,63 @@
+/**
+ * Copyright 2022 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
+ *
+ *     https://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.
+const {onCall, HttpsError} = require("firebase-functions/v2/https");
+const {logger} = require("firebase-functions/v2");
+// [END imports]
+
+/**
+ * Mock api for streaming response
+ */
+async function generateStream() {
+  // simulate some latency for a remote API call
+  await new Promise((resolve) => setTimeout(resolve, 100));
+
+  /**
+   * Fake a few async responses
+   */
+  async function* mockAsyncIterable() {
+    const sentence = "Hello from Cloud Functions for Firebase!";
+
+    for (const word of sentence.split(" ")) {
+      await new Promise((resolve) => setTimeout(resolve, Math.random() * 500));
+      yield {text: () => " " + word};
+    }
+  }
+
+  return {
+    metadata: {
+      acceptsStreaming: true},
+    stream: mockAsyncIterable,
+  };
+}
+
+exports.streamResponse = onCall(async (request, response) => {
+  console.log("I was called!!!");
+  console.log("data", request.data);
+  const prompt = request.data.text || "hello";
+
+  const {metadata, stream} = await generateStream(prompt);
+
+  for await (const chunk of stream()) {
+    console.log(chunk);
+    if (metadata.acceptsStreaming) {
+      response.sendChunk(chunk.text());
+    }
+  }
+  return true;
+});

Node/quickstarts/callable-functions-streaming/functions/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "callable-functions-streaming",
+  "description": "Cloud Functions for Firebase",
+  "scripts": {
+    "lint": "eslint .",
+    "lintfix": "eslint . --fix",
+    "serve": "firebase emulators:start --only functions",
+    "shell": "firebase functions:shell",
+    "start": "npm run shell",
+    "deploy": "firebase deploy --only functions",
+    "logs": "firebase functions:log",
+    "compile": "cp ../../../../tsconfig.template.json ./tsconfig-compile.json && tsc --project tsconfig-compile.json"
+  },
+  "engines": {
+    "node": "18"
+  },
+  "main": "index.js",
+  "dependencies": {
+    "firebase-admin": "^13.0.2",
+    "firebase-functions": "^6.2.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.40.0",
+    "eslint-config-google": "^0.14.0",
+    "firebase-functions-test": "^3.4.0"
+  },
+  "private": true
+}

Node/quickstarts/callable-functions-streaming/website/index.html

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>title</title>
+  </head>
+  <body>
+    <button id="btn-call-func">Call function</button>
+    <p id="p-result"></p>
+    <script type="module">
+      import { initializeApp } from "https://www.gstatic.com/firebasejs/11.2.0/firebase-app.js";
+      import {
+        getFunctions,
+        httpsCallable,
+        connectFunctionsEmulator,
+      } from "https://www.gstatic.com/firebasejs/11.2.0/firebase-functions.js";
+
+      // set your firebase config object
+      const firebaseConfig = undefined;
+      if (!firebaseConfig) {
+        throw new Error('You must set your Firebase config');
+      }
+      const app = initializeApp(firebaseConfig);
+      const functions = getFunctions(app);
+      connectFunctionsEmulator(functions, "127.0.0.1", 5001);
+      const streamResponse = httpsCallable(functions, "streamResponse");
+
+      const callableButton = document.getElementById("btn-call-func");
+      const resultElement = document.getElementById("p-result");
+      callableButton.onclick = async () => {
+        // reset result
+        resultElement.innerHTML = "";
+
+        const resp = await streamResponse.stream({
+          text: "What is your favorite Firebase service and why?",
+        });
+
+        // append text each time 
+        for await (const message of resp.stream) {
+          resultElement.innerHTML += message;
+        }
+      };
+    </script>
+  </body>
+</html>