Merge remote-tracking branch 'origin/master' into rsgowman/enable_anon_auth

Author: rsgowman

.eslintrc.js

@@ -36,6 +36,15 @@ module.exports = {
 
     // Required checks
     'indent': ['error', 2],
+    'keyword-spacing': ['error'],
+    'max-len': [
+      'error',
+      {
+        'code': 120,
+        'ignoreUrls': true
+      }
+    ],
+    'object-curly-spacing': [2, 'always'],
     '@typescript-eslint/explicit-function-return-type': [
       'error',
       {
@@ -44,5 +53,8 @@ module.exports = {
         'allowHigherOrderFunctions': true
       }
     ],
+    'no-unused-vars': 'off', // Must be disabled to enable the next rule
+    '@typescript-eslint/no-unused-vars': ['error'],
+    'quotes': ['error', 'single', {'avoidEscape': true}]
   }
 };

.github/ISSUE_TEMPLATE/general-bug-report.md

@@ -7,6 +7,8 @@ assignees: ''
 
 ---
 
+**Thank you for submitting your issue. We are operating at reduced capacity from Dec 18 2020 to Jan 4 2021. Please expect delayed responses. For more urgent requests please reach us via our  support channels https://firebase.google.com/support**
+
 ### [READ] Step 1: Are you in the right place?
 
   * For issues related to __the code in this repository__ file a Github issue.

.github/actions/send-tweet/action.yml

@@ -15,8 +15,8 @@
 name: 'Send Tweet Action'
 description: 'Send Tweets from GitHub Actions workflows.'
 inputs:
-  repo:
-    status: Status (Tweet) to be posted
+  status:
+    description: Status (Tweet) to be posted
     required: true
   consumer-key:
     description: Consumer API key.

.github/actions/send-tweet/package-lock.json

@@ -14,7 +14,7 @@
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@actions/core": "^1.2.2",
+    "@actions/core": "^1.2.6",
     "twitter": "^1.7.1"
   },
   "devDependencies": {

.github/actions/send-tweet/package.json

@@ -17,7 +17,7 @@
 set -e
 set -u
 
-echo "//wombat-dressing-room.appspot.com/:_authToken=${NPM_AUTH_TOKEN}" >> ~/.npmrc
+echo "//wombat-dressing-room.appspot.com/:_authToken=${NPM_AUTH_TOKEN}" >> .npmrc
 
 readonly UNPREFIXED_VERSION=`echo ${VERSION} | cut -c 2-`
-npm publish dist/firebase-admin-${UNPREFIXED_VERSION}.tgz --registry https://wombat-dressing-room.appspot.com
+npm publish ./dist/firebase-admin-${UNPREFIXED_VERSION}.tgz --registry https://wombat-dressing-room.appspot.com

.github/scripts/publish_package.sh

@@ -21,55 +21,53 @@
 # applications.
 
 set -e
+set -u
 
 if [ -z "$1" ]; then
     echo "[ERROR] No package name provided."
-    echo "[INFO] Usage: ./verifyReleaseTarball.sh <PACKAGE_NAME>"
+    echo "[INFO] Usage: ./verify_package.sh <PACKAGE_NAME>"
     exit 1
 fi
 
-# Variables
 PKG_NAME="$1"
-ROOT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-MOCHA_CLI="$ROOT/node_modules/.bin/mocha -r ts-node/register"
-DIR="$ROOT/test/integration/typescript"
-WORK_DIR=`mktemp -d`
-
-if [ ! -f "$ROOT/$PKG_NAME" ]; then
-  echo "Package $PKG_NAME does not exist."
+if [ ! -f "${PKG_NAME}" ]; then
+  echo "Package ${PKG_NAME} does not exist."
   exit 1
 fi
 
-# check if tmp dir was created
-if [[ ! "$WORK_DIR" || ! -d "$WORK_DIR" ]]; then
+# create a temporary directory
+WORK_DIR=`mktemp -d`
+if [[ ! "${WORK_DIR}" || ! -d "${WORK_DIR}" ]]; then
   echo "Could not create temp dir"
   exit 1
 fi
 
 # deletes the temp directory
-function cleanup {      
-  rm -rf "$WORK_DIR"
-  echo "Deleted temp working directory $WORK_DIR"
+function cleanup {
+  rm -rf "${WORK_DIR}"
+  echo "Deleted temp working directory ${WORK_DIR}"
 }
 
 # register the cleanup function to be called on the EXIT signal
 trap cleanup EXIT
 
-# Enter work dir
-pushd "$WORK_DIR"
+# Copy package and test sources into working directory
+cp "${PKG_NAME}" "${WORK_DIR}"
+cp -r test/integration/typescript/* "${WORK_DIR}"
+cp test/resources/mock.key.json "${WORK_DIR}"
 
-# Copy test sources into working directory
-cp -r $DIR/* .
-cp "$ROOT/test/resources/mock.key.json" .
+# Enter work dir
+pushd "${WORK_DIR}"
 
 # Install the test package
 npm install
 
 # Install firebase-admin package
-npm install -S "$ROOT/$PKG_NAME"
+npm install -S "${PKG_NAME}"
 
 echo "> tsc -p tsconfig.json"
-$ROOT/node_modules/.bin/tsc -p tsconfig.json
+./node_modules/.bin/tsc -p tsconfig.json
 
+MOCHA_CLI="./node_modules/.bin/mocha -r ts-node/register"
 echo "> $MOCHA_CLI src/*.test.ts"
-$MOCHA_CLI src/*.test.ts
+$MOCHA_CLI src/*.test.ts

verifyReleaseTarball.sh renamed to .github/scripts/verify_package.sh

@@ -1,6 +1,6 @@
 name: Continuous Integration
 
-on: push
+on: pull_request
 
 jobs:
   build:
@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [8.x, 10.x]
+        node-version: [10.x, 12.x, 14.x]
 
     steps:
     - uses: actions/checkout@v1
@@ -23,3 +23,4 @@ jobs:
         npm run build
         npm run build:tests
         npm test
+        npm run api-extractor

.github/workflows/ci.yml

@@ -47,7 +47,7 @@ jobs:
     - name: Set up Node.js
       uses: actions/setup-node@v1
       with:
-        node-version: 8.x
+        node-version: 10.x
 
     - name: Install and build
       run: |
@@ -58,6 +58,9 @@ jobs:
     - name: Run unit tests
       run: npm test
 
+    - name: Verify public API
+      run: npm run api-extractor
+
     - name: Run integration tests
       run: ./.github/scripts/run_integration_tests.sh
       env:
@@ -78,11 +81,10 @@ jobs:
         name: dist
         path: dist
 
-    # TODO: Move this script to .github/scripts.
     - name: Verify tarball
       run: |
         PACKAGE_TARBALL=`ls firebase-admin-*.tgz`
-        ./verifyReleaseTarball.sh $PACKAGE_TARBALL
+        ./.github/scripts/verify_package.sh $PACKAGE_TARBALL
 
   publish_release:
     needs: stage_release
@@ -113,7 +115,7 @@ jobs:
     - name: Set up Node.js
       uses: actions/setup-node@v1
       with:
-        node-version: 8.x
+        node-version: 10.x
 
     - name: Publish preflight check
       id: preflight
@@ -146,7 +148,7 @@ jobs:
       uses: ./.github/actions/send-tweet
       with:
         status: >
-          ${{ steps.preflight.outputs.version }} of @Firebase Admin Node.js SDK is avaialble.
+          ${{ steps.preflight.outputs.version }} of @Firebase Admin Node.js SDK is available.
           https://github.com/firebase/firebase-admin-node/releases/tag/${{ steps.preflight.outputs.version }}
         consumer-key: ${{ secrets.TWITTER_CONSUMER_KEY }}
         consumer-secret: ${{ secrets.TWITTER_CONSUMER_SECRET }}

.github/workflows/release.yml

@@ -5,6 +5,7 @@ npm-debug.log
 
 lib/
 .tmp/
+temp/
 typings/
 coverage/
 node_modules/

.gitignore

@@ -87,7 +87,7 @@ information on using pull requests.
 
 ### Prerequisites
 
-1. Node.js 8.13.0 or higher.
+1. Node.js 10.10.0 or higher.
 2. NPM 5 or higher (NPM 6 recommended).
 3. Google Cloud SDK ([`gcloud`](https://cloud.google.com/sdk/downloads) utility)
 
@@ -155,13 +155,17 @@ Then set up your Firebase/GCP project as follows:
    Firebase Console. Select the "Sign-in method" tab, and enable the
    "Email/Password" sign-in method, including the Email link (passwordless
    sign-in) option.
-3. Enable the IAM API: Go to the
+3. Enable the Firebase ML API: Go to the
+   [Google Developers Console](
+   https://console.developers.google.com/apis/api/firebaseml.googleapis.com/overview)
+   and make sure your project is selected. If the API is not already enabled, click Enable.
+4. Enable the IAM API: Go to the
    [Google Cloud Platform Console](https://console.cloud.google.com) and make
    sure your Firebase/GCP project is selected. Select "APIs & Services >
    Dashboard" from the main menu, and click the "ENABLE APIS AND SERVICES"
    button. Search for and enable the "Identity and Access Management (IAM)
    API".
-4. Grant your service account the 'Firebase Authentication Admin' role. This is
+5. Grant your service account the 'Firebase Authentication Admin' role. This is
    required to ensure that exported user records contain the password hashes of
    the user accounts:
    1. Go to [Google Cloud Platform Console / IAM & admin](https://console.cloud.google.com/iam-admin).

CONTRIBUTING.md

@@ -55,7 +55,7 @@ requests, code review feedback, and also pull requests.
 
 ## Supported Environments
 
-We support Node.js 8.13.0 and higher.
+We support Node.js 10.10.0 and higher.
 
 Please also note that the Admin SDK should only
 be used in server-side/back-end environments controlled by the app developer.