firebase-tools 11.21.0 → 11.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-tools",
-  "version": "11.21.0",
+  "version": "11.23.0",
   "description": "Command-Line Interface for Firebase",
   "main": "./lib/index.js",
   "bin": {
@@ -106,7 +106,7 @@
     "stream-chain": "^2.2.4",
     "stream-json": "^1.7.3",
     "strip-ansi": "^6.0.1",
-    "superstatic": "^9.0.2",
+    "superstatic": "^9.0.3",
     "tar": "^6.1.11",
     "tcp-port-used": "^1.0.2",
     "tmp": "^0.2.1",

package/templates/extensions/extension.yaml

@@ -40,7 +40,7 @@ resources:
       location: ${LOCATION}
       # httpsTrigger is used for an HTTP triggered function.
       httpsTrigger: {}
-      runtime: "nodejs12"
+      runtime: "nodejs16"
 
 # In the `params` field, set up your extension's user-configured parameters.
 # Learn more in the docs: https://firebase.google.com/docs/extensions/alpha/ref-extension-yaml#params-field

package/templates/extensions/integration-test.env

@@ -0,0 +1,2 @@
+GREETING=Hello
+LOCATION=us-central1

package/templates/extensions/integration-test.json

@@ -0,0 +1,14 @@
+{
+  "emulators": {
+    "functions": {
+      "port": 5001
+    },
+    "ui": {
+      "enabled": true
+    },
+    "singleProjectMode": true
+  },
+  "extensions": {
+    "greet-the-world": "../.."
+  }
+}

package/templates/extensions/javascript/WELCOME.md

@@ -1,9 +1,18 @@
-This directory now contains the source files for a simple extension called **greet-the-world**. To try out this extension right away, install it in an existing Firebase project by running:
+This directory now contains the source files for a simple extension called **greet-the-world**. You can try it out right away in the Firebase Emulator suite - just naviagte to the integration-test directory and run:
 
-`firebase ext:install . --project=<project-id>`
+`firebase emulators:start --project=<project-id>`
 
-If you want to jump into the code to customize your extension, then modify **index.js** and **extension.yaml** in your favorite editor. When you're ready to try out your fancy new extension, run:
+If you don't have a project to use, you can instead use '--project=demo-test' to run against a fake project.
 
-`firebase ext:install . --project=<project-id>`
+The `integration-test` directory also includes an end to end test (in the file integration-test.spec.js) that verifies that the extension responds back with the expected greeting. You can see it in action by running:
 
-As always, in the docs, you can find detailed instructions for creating and testing your extension (including using the emulator!).
+`npm run test`
+
+If you want to jump into the code to customize your extension, then modify **index.js** and **extension.yaml** in your favorite editor. 
+
+If you want to deploy your extension to test on a real project, go to a Firebase project directory (or create a new one with `firebase init`) and run:
+
+`firebase ext:install ./path/to/extension/directory --project=<project-id>`
+`firebase deploy --only extensions`
+
+You can find more information about building extensions in the publisher docs: https://firebase.google.com/docs/extensions/alpha/overview-build-extensions

package/templates/extensions/javascript/index.js

@@ -1,22 +1,22 @@
 /*
- * This template contains a HTTP function that responds with a greeting when called
- *
- * Always use the FUNCTIONS HANDLER NAMESPACE
- * when writing Cloud Functions for extensions.
- * Learn more about the handler namespace in the docs
+ * This template contains a HTTP function that
+ * responds with a greeting when called
  *
  * Reference PARAMETERS in your functions code with:
  * `process.env.<parameter-name>`
- * Learn more about parameters in the docs
+ * Learn more about building extensions in the docs:
+ * https://firebase.google.com/docs/extensions/alpha/overview
  */
 
-const functions = require('firebase-functions');
+const functions = require("firebase-functions");
 
-exports.greetTheWorld = functions.handler.https.onRequest((req, res) => {
-  // Here we reference a user-provided parameter (its value is provided by the user during installation)
+exports.greetTheWorld = functions.https.onRequest((req, res) => {
+  // Here we reference a user-provided parameter
+  // (its value is provided by the user during installation)
   const consumerProvidedGreeting = process.env.GREETING;
 
-  // And here we reference an auto-populated parameter (its value is provided by Firebase after installation)
+  // And here we reference an auto-populated parameter
+  // (its value is provided by Firebase after installation)
   const instanceId = process.env.EXT_INSTANCE_ID;
 
   const greeting = `${consumerProvidedGreeting} World from ${instanceId}`;

package/templates/extensions/javascript/integration-test.js

@@ -0,0 +1,13 @@
+const axios = require("axios");
+const chai = require("chai");
+
+describe("greet-the-world", () => {
+  it("should respond with the configured greeting", async () => {
+    const expected = "Hello World from greet-the-world";
+
+    const httpFunctionUri = "http://localhost:5001/demo-test/us-central1/ext-greet-the-world-greetTheWorld/";
+    const res = await axios.get(httpFunctionUri);
+
+    return chai.expect(res.data).to.eql(expected);
+  }).timeout(10000);
+});

package/templates/extensions/javascript/package.lint.json

@@ -3,15 +3,23 @@
   "description": "Greet the world",
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^10.2.0",
-    "firebase-functions": "^3.21.0"
+    "firebase-admin": "^11.5.0",
+    "firebase-functions": "^4.2.0"
   },
   "devDependencies": {
     "eslint": "^8.15.1",
-    "eslint-plugin-promise": "^6.0.0"
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-config-google": "^0.14.0",
+    "eslint-plugin-import": "^2.25.4",
+    "axios": "^1.3.2",
+    "chai": "^4.3.7",
+    "mocha": "^10.2.0"
   },
   "scripts": {
-    "lint": "./node_modules/.bin/eslint --max-warnings=0 .."
+    "lint": "./node_modules/.bin/eslint --max-warnings=0 ..",
+    "lint:fix": "./node_modules/.bin/eslint --max-warnings=0 --fix ..",
+    "mocha": "mocha '**/*.spec.js'",
+    "test": "(cd integration-tests && firebase emulators:exec 'npm run mocha' -P demo-test)"
   },
   "private": true
 }

package/templates/extensions/javascript/package.nolint.json

@@ -3,8 +3,17 @@
   "description": "Greet the world",
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^10.2.0",
-    "firebase-functions": "^3.21.0"
+    "firebase-admin": "^11.5.0",
+    "firebase-functions": "^4.2.0"
+  },
+  "devDependencies": {
+    "axios": "^1.3.2",
+    "chai": "^4.3.7",
+    "mocha": "^10.2.0"
+  },
+  "scripts": {
+    "mocha": "mocha '**/*.spec.js'",
+    "test": "(cd integration-tests && firebase emulators:exec 'npm run mocha' -P demo-test)"
   },
   "private": true
 }

package/templates/extensions/typescript/WELCOME.md

@@ -1,9 +1,22 @@
-This directory now contains the source files for a simple extension called **greet-the-world**. To try out this extension right away, install it in an existing Firebase project by running:
+This directory now contains the source files for a simple extension called **greet-the-world**. You can try it out right away in the Firebase Emulator suite: first, compile your code by running:
 
-`npm run build --prefix=functions && firebase ext:install . --project=<project-id>`
+`npm run build --prefix=functions`
 
-If you want to jump into the code to customize your extension, then modify **index.ts** and **extension.yaml** in your favorite editor. When you're ready to try out your fancy new extension, run:
+Then, navigate to the `functions/integration-test` directory and run:
 
-`npm run build --prefix=functions && firebase ext:install . --project=<project-id>`
+`firebase emulators:start --project=<project-id>`
 
-As always, in the docs, you can find detailed instructions for creating and testing your extension (including using the emulator!).
+If you don't have a project to use, you can instead use '--project=demo-test' to run against a fake project.
+
+The `integration-test` directory also includes an end to end test (in the file **integration-test.spec.ts**) that verifies that the extension responds back with the expected greeting. You can see it in action by running:
+
+`npm run test`
+
+If you want to jump into the code to customize your extension, then modify **index.ts** and **extension.yaml** in your favorite editor. 
+
+If you want to deploy your extension to test on a real project, go to a Firebase project directory (or create a new one with `firebase init`) and run:
+
+`firebase ext:install ./path/to/extension/directory --project=<project-id>`
+`firebase deploy --only extensions`
+
+You can find more information about building extensions in the publisher docs: https://firebase.google.com/docs/extensions/alpha/overview-build-extensions

package/templates/extensions/typescript/_mocharc

@@ -0,0 +1,10 @@
+{
+  "require": "ts-node/register",
+  "extensions": ["ts", "tsx"],
+  "spec": [
+    "integration-tests/**/*.spec.*"
+  ],
+  "watch-files": [
+    "src"
+  ]
+}

package/templates/extensions/typescript/index.ts

@@ -1,25 +1,26 @@
 /*
- * This template contains a HTTP function that responds with a greeting when called
- *
- * Always use the FUNCTIONS HANDLER NAMESPACE
- * when writing Cloud Functions for extensions.
- * Learn more about the handler namespace in the docs
+ * This template contains a HTTP function that responds
+ * with a greeting when called
  *
  * Reference PARAMETERS in your functions code with:
  * `process.env.<parameter-name>`
- * Learn more about parameters in the docs
+ * Learn more about building extensions in the docs:
+ * https://firebase.google.com/docs/extensions/alpha/overview
  */
 
-import * as functions from 'firebase-functions';
+import * as functions from "firebase-functions";
 
-exports.greetTheWorld = functions.handler.https.onRequest((req, res) => {
-  // Here we reference a user-provided parameter (its value is provided by the user during installation)
-  const consumerProvidedGreeting = process.env.GREETING;
+exports.greetTheWorld = functions.https.onRequest(
+  (req: functions.Request, res: functions.Response) => {
+    // Here we reference a user-provided parameter
+    // (its value is provided by the user during installation)
+    const consumerProvidedGreeting = process.env.GREETING;
 
-  // And here we reference an auto-populated parameter (its value is provided by Firebase after installation)
-  const instanceId = process.env.EXT_INSTANCE_ID;
+    // And here we reference an auto-populated parameter
+    // (its value is provided by Firebase after installation)
+    const instanceId = process.env.EXT_INSTANCE_ID;
 
-  const greeting = `${consumerProvidedGreeting} World from ${instanceId}`;
+    const greeting = `${consumerProvidedGreeting} World from ${instanceId}`;
 
-  res.send(greeting);
-});
+    res.send(greeting);
+  });

package/templates/extensions/typescript/integration-test.ts

@@ -0,0 +1,13 @@
+import axios from "axios";
+import { expect } from "chai";
+
+describe("greet-the-world", () => {
+  it("should respond with the configured greeting", async () => {
+    const expected = "Hello World from greet-the-world";
+
+    const httpFunctionUri = "http://localhost:5001/demo-test/us-central1/ext-greet-the-world-greetTheWorld/";
+    const res = await axios.get(httpFunctionUri);
+
+    return expect(res.data).to.eql(expected);
+  }).timeout(10000);
+});

package/templates/extensions/typescript/package.lint.json

@@ -2,18 +2,30 @@
   "name": "functions",
   "scripts": {
     "lint": "eslint \"src/**/*\"",
+    "lint:fix": "eslint \"src/**/*\" --fix",
     "build": "tsc",
-    "build:watch": "tsc --watch"
+    "build:watch": "tsc --watch",
+    "mocha": "mocha '**/*.spec.ts'",
+    "test": "(cd integration-tests && firebase emulators:exec 'npm run mocha' -P demo-test)"
   },
   "main": "lib/index.js",
   "dependencies": {
-    "firebase-admin": "^10.2.0",
-    "firebase-functions": "^3.21.0"
+    "firebase-admin": "^11.5.0",
+    "firebase-functions": "^4.2.0"
   },
   "devDependencies": {
+    "@types/chai": "^4.3.4",
+    "@types/mocha": "^10.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.12.0",
+    "@typescript-eslint/parser": "^5.12.0",
     "eslint": "^8.15.1",
     "eslint-plugin-import": "^2.26.0",
-    "typescript": "^4.6.4"
+    "eslint-config-google": "^0.14.0",
+    "typescript": "^4.9.0",
+    "axios": "^1.3.2",
+    "chai": "^4.3.7",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.4.0"
   },
   "private": true
 }

package/templates/extensions/typescript/package.nolint.json

@@ -2,15 +2,23 @@
   "name": "functions",
   "scripts": {
     "build": "tsc",
-    "build:watch": "tsc --watch"
+    "build:watch": "tsc --watch",
+    "mocha": "mocha '**/*.spec.ts'",
+    "test": "(cd integration-tests && firebase emulators:exec 'npm run mocha' -P demo-test)"
   },
   "main": "lib/index.js",
   "dependencies": {
-    "firebase-admin": "^9.8.0",
-    "firebase-functions": "^3.14.1"
+    "firebase-admin": "^11.5.0",
+    "firebase-functions": "^4.2.0"
   },
   "devDependencies": {
-    "typescript": "^3.8.0"
+    "@types/chai": "^4.3.4",
+    "@types/mocha": "^10.0.1",
+    "typescript": "^4.9.0",
+    "axios": "^1.3.2",
+    "chai": "^4.3.7",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.4.0"
   },
   "private": true
 }

package/templates/init/functions/javascript/_eslintrc

@@ -1,14 +1,28 @@
 module.exports = {
-  root: true,
   env: {
     es6: true,
     node: true,
   },
+  parserOptions: {
+    "ecmaVersion": 2018,
+  },
   extends: [
     "eslint:recommended",
     "google",
   ],
   rules: {
-    quotes: ["error", "double"],
+    "no-restricted-globals": ["error", "name", "length"],
+    "prefer-arrow-callback": "error",
+    "quotes": ["error", "double", {"allowTemplateLiterals": true}],
   },
+  overrides: [
+    {
+      files: ["**/*.spec.*"],
+      env: {
+        mocha: true,
+      },
+      rules: {},
+    },
+  ],
+  globals: {},
 };

package/templates/init/functions/javascript/package.lint.json

@@ -14,13 +14,13 @@
   },
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^10.0.2",
-    "firebase-functions": "^3.18.0"
+    "firebase-admin": "^111.5.0",
+    "firebase-functions": "^4.2.0"
   },
   "devDependencies": {
-    "eslint": "^8.9.0",
+    "eslint": "^8.15.0",
     "eslint-config-google": "^0.14.0",
-    "firebase-functions-test": "^0.2.0"
+    "firebase-functions-test": "^3.0.0"
   },
   "private": true
 }

package/templates/init/functions/javascript/package.nolint.json

@@ -13,11 +13,11 @@
   },
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^10.0.2",
-    "firebase-functions": "^3.18.0"
+    "firebase-admin": "^11.5.0",
+    "firebase-functions": "^4.2.0"
   },
   "devDependencies": {
-    "firebase-functions-test": "^0.2.0"
+    "firebase-functions-test": "^3.0.0"
   },
   "private": true
 }

package/templates/init/functions/python/main.py

@@ -0,0 +1,13 @@
+# Welcome to Cloud Functions for Firebase for Python!
+# To get started, simply uncomment the below code or create your own.
+# Deploy with `firebase deploy`
+
+from firebase_functions import https
+from firebase_admin import initialize_app
+
+# initialize_app()
+#
+#
+# @https.on_request()
+# def on_request_example(req: https.Request) -> https.Response:
+#     return https.Response("Hello world!")

package/templates/init/functions/python/requirements.txt

@@ -0,0 +1 @@
+git+https://github.com/firebase/firebase-functions-python.git@main#egg=firebase-functions

package/templates/init/functions/typescript/_eslintrc

@@ -27,5 +27,6 @@ module.exports = {
   rules: {
     "quotes": ["error", "double"],
     "import/no-unresolved": 0,
+    "indent": ["error", 2]
   },
 };

package/templates/init/functions/typescript/package.lint.json

@@ -15,8 +15,8 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "firebase-admin": "^10.0.2",
-    "firebase-functions": "^3.18.0"
+    "firebase-admin": "^11.5.0",
+    "firebase-functions": "^4.2.0"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.12.0",
@@ -24,8 +24,8 @@
     "eslint": "^8.9.0",
     "eslint-config-google": "^0.14.0",
     "eslint-plugin-import": "^2.25.4",
-    "firebase-functions-test": "^0.2.0",
-    "typescript": "^4.5.4"
+    "firebase-functions-test": "^3.0.0",
+    "typescript": "^4.9.0"
   },
   "private": true
 }

package/templates/init/functions/typescript/package.nolint.json

@@ -14,11 +14,12 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "firebase-admin": "^10.2.0",
-    "firebase-functions": "^3.21.0"
+    "firebase-admin": "^11.5.0",
+    "firebase-functions": "^4.2.0"
   },
   "devDependencies": {
-    "typescript": "^4.6.4"
+    "typescript": "^4.9.0",
+    "firebase-functions-test": "^3.0.0"
   },
   "private": true
 }