firebase-fx

A wrapper for Google Cloud Functions that simplifies the deployment of serverless applications.

Meant to expose a similar API to the Firebase Functions package for node.js.

Features

• Deployment
  • Output bash script
  • Output Terraform configuration
  • Upload source to Cloud Storage before deployment
  • Profile memory for deployment: --memory flag
• HTTP triggers
  • Unauthenticated
  • Methods, Headers, Host, Query
  • Middleware
• Analytics
• Firebase Authentication triggers
• Firestore triggers
  • Document path wildcards
    • Access vars
  • Custom data types
  • fx tagged fields
    • string
    • number = float64/int
    • boolean = bool
    • map = struct OR map[string]interface{}
      • map = struct OR map[string]interface{}
    • array = []interface{}
    • geopoint = struct
    • timestamp = time.Time
• PubSub triggers
  • Custom data types
• Firebase Realtime Database triggers
  • Path wildcards
    • Access vars
  • Custom data types - JSON tags
• Schedule triggers
• Storage triggers

Usage

setup.go

package functions

import (
	"context"
	"fmt"

	register "github.com/cleanflo/firebase-fx"
)

var Register = register.Shared

func init() {
	Register.PubSub("my-topic").Publish(MyCustomData{}, func(ctx context.Context, msg register.PubSubMessage) error {
		fmt.Println(msg.Topic)
		if data, ok := msg.Data.(*MyCustomData); ok {
			// do something with v
			fmt.Println(data)
		}
		return nil
	})

	Register.Firestore().Collection("users").Document("{uid}").Create(MyUserData{}, func(ctx context.Context, e register.FirestoreEvent) error {
		fmt.Println(e.Vars()["uid"])

		if data, ok := e.Value.Fields.(*MyUserData); ok {
			// do something with v
			fmt.Println(data)
		}

		if data, ok := e.OldValue.Fields.(*MyUserData); ok {
			// do something with v
			fmt.Println(data)
		}
		return nil
	})
}

type MyCustomData struct {
	Name string
}

type MyUserData struct {
	Email string
}

deploy/deploy.go

package main

import (
	"fmt"

	functions "github.com/cleanflo/firebase-fx/functions"
	register "github.com/cleanflo/firebase-fx"
)

func main() {
	fmt.Println(functions.Register.
		WithEntrypoint("Register.EntryPoint").
		WithProjectID("my-project-id").
		WithRuntime("go116").
		Verbosity(register.DebugVerbosity).
		Deploy(),
	)
}

command

$ go run deploy/deploy.go

gcloud functions deploy  --entry-point "Register.EntryPoint" --runtime "go116" --project "my-project-id" --verbosity "debug" \
pubsubpublish-my-topic --trigger-topic "my-topic" &&  \
gcloud functions deploy  --entry-point "Register.EntryPoint" --runtime "go116" --project "my-project-id" --verbosity "debug" \
firestoreDocCreate-users-uid --trigger-event "providers/cloud.firestore/eventTypes/document.create" --trigger-resource "projects/my-project-id/databases/(default)/documents/users/{uid}"