Merge pull request #1009 from firebase/colerogers.v2-scheduled

Scheduled v2 Triggers

Author: colerogers

2nd-gen/delete-unused-accounts-cron/README.md

@@ -0,0 +1,24 @@
+# Periodically delete unused accounts
+
+This sample demonstrates how to delete the accounts of users who have not signed-in in the last month.
+
+
+## Functions Code
+
+See the file [functions/index.js](functions/index.js) for the code.
+
+**Note:** This function uses Cloud Scheduler, which can have associated costs. Your project must be on the Blaze payment plan as these features require billing information. See the [Cloud Scheduler pricing page](https://cloud.google.com/scheduler/pricing) for more information.
+
+The dependencies are listed in [functions/package.json](functions/package.json).
+
+## Deploy and test
+
+To set up the sample:
+
+ - Create a Firebase Project using the [Firebase Developer Console](https://console.firebase.google.com)
+ - Download this sample e.g. `git clone https://github.com/firebase/functions-samples`
+ - Enter the sample directory `cd functions-samples/2nd-gen/delete-unused-accounts-cron`
+ - Setup the sample with your project `firebase use --add` and follow the instructions.
+ - Install node dependencies of your Functions `cd functions; npm install; cd -`
+ - Deploy your project using `firebase deploy`.
+ - The Cloud Scheduler job should then run once a day and delete any inactive users. You can manually run the task by [navigating to Cloud Scheduler in the Google Cloud Platform Console](https://console.cloud.google.com/cloudscheduler).

2nd-gen/delete-unused-accounts-cron/firebase.json

@@ -0,0 +1 @@
+{}

2nd-gen/delete-unused-accounts-cron/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/delete-unused-accounts-cron/functions/index.js

@@ -0,0 +1,93 @@
+/**
+ * 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 set up triggers.
+const { onSchedule } = require('firebase-functions/v2/scheduler');
+const { logger } = require('firebase-functions');
+
+// The Firebase Admin SDK to delete inactive users.
+const admin = require('firebase-admin');
+admin.initializeApp();
+
+// The es6-promise-pool to limit the concurrency of promises.
+const PromisePool = require('es6-promise-pool').default;
+// Maximum concurrent account deletions.
+const MAX_CONCURRENT = 3;
+// [END import]
+
+// [START accountcleanup]
+// Run once a day at midnight, to clean up the users
+// Manually run the task here https://console.cloud.google.com/cloudscheduler
+exports.accountcleanup = onSchedule('every day 00:00', async (event) => {
+  // Fetch all user details.
+  const inactiveUsers = await getInactiveUsers();
+  // Use a pool so that we delete maximum `MAX_CONCURRENT` users in parallel.
+  const promisePool = new PromisePool(() => deleteInactiveUser(inactiveUsers), MAX_CONCURRENT);
+  await promisePool.start();
+  logger.log('User cleanup finished');
+});
+// [END accountcleanup]
+
+// [START deleteInactiveUser]
+// Deletes one inactive user from the list.
+function deleteInactiveUser(inactiveUsers) {
+  if (inactiveUsers.length > 0) {
+    const userToDelete = inactiveUsers.pop();
+    
+    // Delete the inactive user.
+    return admin.auth().deleteUser(userToDelete.uid).then(() => {
+      return logger.log(
+        'Deleted user account',
+        userToDelete.uid,
+        'because of inactivity'
+      );
+    }).catch((error) => {
+      return logger.error(
+        'Deletion of inactive user account',
+        userToDelete.uid,
+        'failed:',
+        error
+      );
+    });
+  } else {
+    return null;
+  }
+}
+// [END deleteInactiveUser]
+
+// [START getInactiveUsers]
+// Returns the list of all inactive users.
+async function getInactiveUsers(users = [], nextPageToken) {
+  const result = await admin.auth().listUsers(1000, nextPageToken);
+  // Find users that have not signed in in the last 30 days.
+  const inactiveUsers = result.users.filter(
+      user => Date.parse(user.metadata.lastRefreshTime || user.metadata.lastSignInTime) < (Date.now() - 30 * 24 * 60 * 60 * 1000));
+  
+  // Concat with list of previously found inactive users if there was more than 1000 users.
+  users = users.concat(inactiveUsers);
+  
+  // If there are more users to fetch we fetch them.
+  if (result.pageToken) {
+    return getInactiveUsers(users, result.pageToken);
+  }
+  
+  return users;
+}
+// [END getInactiveUsers]
+// [END all]

2nd-gen/delete-unused-accounts-cron/functions/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "delete-unused-accounts-cron-functions",
+  "description": "Periodically delete unused Firebase accounts",
+  "dependencies": {
+    "es6-promise-pool": "^2.5.0",
+    "firebase-admin": "^10.2.0",
+    "firebase-functions": "^3.23.0"
+  },
+  "devDependencies": {
+    "eslint": "^6.8.0",
+    "eslint-plugin-promise": "^4.2.1"
+  },
+  "scripts": {
+    "lint": "./node_modules/.bin/eslint --max-warnings=0 .",
+    "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": "16"
+  },
+  "private": true
+}