googlesamples / functions-as-a-service

A demo showing Google Cloud Functions + Google Maps Platform

Functions as a Service

The demo shows calling Google Maps Platform APIs from Google Cloud Functions.

Technologies

• Cloud Functions (Node 10)
  • Function Framework for local development.
• Google Maps Services (Node.js Client)
  • Directions API
• TypeScript
  • Google Maps Types: https://www.npmjs.com/package/@types/google__maps
  • Google Cloud Functions Server (Express): https://www.npmjs.com/package/@types/express

Develop

First install dependencies:

npm i

Then in one tab continually build the project with this command:

npm run build

In another tab, start the web server (and watch if the source code changes):

API_KEY=<KEY> npm run watch

This uses npm-watch with the functions-framework to auto re-build the server after changes.

Test locally

Go to http://localhost:8080 to run your Google Cloud Function locally.

Here are some example URL requests:

http://localhost:8080/directions?mode=driving&origin=37.7841393,-122.404467
http://localhost:8080/origins?origin=6
http://localhost:8080/places?origin=37.7841393,-122.114167

API Key

To create an API key, use the Cloud Console credentials page:

https://console.cloud.google.com/apis/credentials

More detailed instructions can be found in the "Get API Key" guide.

After creating an API key, enable these APIs:

• Directions API
• Places API

Deploy

You must create a .env.yaml with your API Key:

API_KEY=AIsdfyCnTEiLTroDN14NTtpPm1n7jrBR844ID4A

You can deploy this project to Google Cloud Functions by running the following script:

gcloud config set project $MY_PROJECT
sh deploy.sh

functions-as-a-service's Issues

Auth protected paths examples.

Many thanks for this, I'm going to use it as boilerplate for new projects!

Would you also consider adding best practices for auth on functions within a specific path?

Missing output dir for tsconfig and missing env file.

I think you are missing an output dir in the ts config? I can't find the dir gcf and I don't see any tests

Also If I run deploy from master

➜  functions-as-a-service git:(829af1f) sh deploy.sh 
ERROR: (gcloud) Failed to load YAML from [.env.yaml]: Unable to read file [.env.yaml]: [Errno 2] No such file or directory: '.env.yaml'

Kind regards

[question] Access-Control-Allow-Origin position

I was wondering why you set the Access-Control-Allow-Origin header at the end of the function vs the start?

https://github.com/googlesamples/functions-as-a-service/blob/master/index.ts#L27

Granted the options request won't have paths, but it could be more obvious if the headers were set at the top?