functions-samples/user-data-cleanup/README.md

Cleanup user data upon account deletion.

This sample shows how to cleanup the user data when he deletes his account.

Functions Code

See file functions/index.js for the email sending code.

Sending emails is performed using nodemailer a node based Email client with comprehensive EMail server setup. In this sample we're showing how to send email through SMTP using a Gmail account. Be aware that Gmail has an email sending quota. If you are planning on sending a large number of emails you should use a professional email sending platform such as Sendgrid

The dependencies are listed in functions/package.json.

Sample Database Structure

When a user signs-in we write some sample personal data of the following form:

/functions-project-12345
    /users
        $uid : "Some user data"

When the user deletes his account a Function will trigger and automatically delete the corresponding user data in the realtime database.

Trigger rules

The function triggers on user account deletions.

Deploy and test

This sample comes with a Function and web-based UI for testing the function. To configure it:

1. Create a Firebase Project using the Firebase Console.
2. Clone or download this repo and open the user-data-cleanup directory.
3. You must have the Firebase CLI installed. If you don't have it install it with npm install -g firebase-tools and then configure it with firebase login.
4. Configure the CLI locally by using firebase use --add and select your project in the list.
5. Install dependencies locally by running: cd functions; npm install; cd -
6. Deploy your project using firebase deploy
7. Open the app using firebase open hosting:site, this will open a browser.
8. Sign in using Google Sign-In and delete the account using the provided button. You can check at each step of the way if the data has been deleted using the Firebase console.