open.source/manifold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
908c8c03e6
manifold/functions
History
mantikoros 908c8c03e6
Create user cloud function (#31) 
* createUser cloud function; change User object

* initial commit

* listenForLogin: avoid race condition

* createUser: allow capital letters in username

* remove debugging

* leaderboard: empty url for undefined avatar image
2022-01-18 01:18:38 -06:00
..
src Create user cloud function (#31) 2022-01-18 01:18:38 -06:00
.gitignore initial commit 2021-12-10 12:10:30 -06:00
package.json DX: Cloud Functions tooling 2022-01-16 01:59:05 -05:00
README.md DX: Cloud Functions tooling 2022-01-16 01:59:05 -05:00
tsconfig.json refactor data structures, calculations to common directory 2022-01-10 15:07:57 -06:00
yarn.lock Stripe (#22) 2022-01-07 16:56:14 -06:00

README.md

NOTE: Adapted from One Word's /functions doc. Fix any errors you see!

Firestore Cloud Functions

This is code that doesn't make sense on the frontend client, e.g.

  • Long-running or slow operation (database)
  • Tasks that need to be run every so often (syncing email list to Mailjet)
  • Anything we should't trust to clients (secrets, auth)

If you want to make and test changes, you'll have to do a bit of setup...

Installing

Adapted from https://firebase.google.com/docs/functions/get-started

  1. $ cd functions to switch to this folder
  2. $ yarn global add firebase-tools to install the Firebase CLI globally
  3. $ yarn to install JS dependencies
  4. $ firebase functions:config:get > .runtimeconfig.json to cache secrets for local dev (TODO: maybe not for Manifold)
  5. $ firebase use dev to choose the dev project

Developing locally

  1. $ firebase login if you aren't logged into Firebase via commandline yet.
  2. $ yarn dev to spin up the emulators The Emulator UI is at http://localhost:4000; the functions are hosted on :5001. Note: You have to kill and restart emulators when you change code; no hot reload =(
  3. Connect to emulators by enabling functions.useEmulator('localhost', 5001)

Debugging

  • Find local logs directly in the shell that ran $ yarn dev
  • Find deployed logs here

Deploying

  1. $ firebase use prod to switch to prod
  2. $ yarn deploy to push your changes live! (Future TODO: auto-deploy functions on Git push)

Secrets management

Secrets are strings that shouldn't be checked into Git (eg API keys, passwords). We store these using environment config on Firebase Functions. Some useful workflows:

  • Set a secret: $ firebase functions:config:set stripe.test_secret="THE-API-KEY"
  • Preview all secrets: $ firebase functions:config:get
  • Cache for local dev:$ firebase functions:config:get > .runtimeconfig.json