airtable-api-proxy

Firebase Functions with Babel config to target the correct Execution Environment

Based on the work of jthegedus

Use Babel to target the correct execution environment for Cloud Functions for Firebase and use modern languages features (ES6+) to develop.

Here is the accompanying Medium post.

Project Layout Description

I suggest developing your Cloud Functions in the src/functions/ directory and output everything to a dist/functions/ folder. By using a single root package.json we remove the need for maintaining and possibly merging two or more for the Functions themselves and other code, like a frontend app.

Use @babel/core, @babel/cli and @babel/preset-env with some npm scripts to compile to the Cloud Functions server runtime of NodeJS v6.11.5. The output directory, dist/functions/ is created on compilation in the deploy step (yarn deploy).

Firebase predeploy scripts are used in the firebase.json to coordinate which npm scripts get called before deploying to ensure everything is built.

Download & Install

# Clone this dir
git clone git@github.com:enspiral/airtable-api-proxy.git
cd airtable-api-proxy
npm install

Login to the Firebase CLI

If you're using firebase-tools globally, then skip to the Deploy to Firebase step.

npm run firebase:login
npm run firebase use production

Firebase keys (environment variables)

View firebase keys

npm run firebase:keys

Download firebase keys

npm run firebase:keys:download

Local Testing

You need to setup Api keys for firebase (you will need access to the firebase app)

# only needs to be run once
npm run deps
npm run build
npm run serve

Testing the contribute post function

Use: contribute({json: {amount: '100', token: 'tok_1CWLgxDKaELTzswuXU9vYl4v', description: '$100 contribution to Enspiral from dan.lewis@enspiral.com', metadata: {email:'dan.lewis@enspiral.com, name:'Daniel Lewis'}}})

Deploy to Firebase

Update .firebaserc to use your Firebase project id.

npm run deploy

Gotchas

Local function testing error

TypeError: Cannot read property 'api_key' of undefined

This basically occurs because the 'deps' have not been copied across to the built functions folder.

Remedy: run npm run deps, npm run deps:install or for a nuke and build npm run clean:build

Deploy stops working with unclear error

Check the firebase-debug.log and if it has an error:

TypeError: Cannot read property 'wanted' of undefined

Then follow these instructions on stack overflow

FILE:
/usr/local/lib/node_modules/firebase-tools/lib/checkFirebaseSDKVersion.js

add this to account for the updated empty output of {}\n around line 24

    if (data && data.toString() !== "{}\n") {
        output = JSON.parse(data.toString("utf8")); // existing Code!
    }

All my records just disappeared or is not updating anymore!!!

One likely cause of this is that the airtable api key has been changed. This will have to be fetched from the airtable account and uploaded as an firebase environment variable

npm run firebase functions:config:set airtable.api_key="THE API KEY"