How Should I Manage Firestore Clients in Google App Engine for Optimal Performance?

Per-Request Firestore Client in Google App Engine

The question revolves around the appropriate approach to managing Firestore clients within Google App Engine (GAE). The concern stems from GAE's requirement for client libraries to use a context.Context scoped to an HTTP request.

The Issue

Traditionally, Firestore clients have been created in the following manner:

type server struct {
    db *firestore.Client
}

func main() {
    s := &server{db: NewFirestoreClient()}

    // Setup Router
    http.HandleFunc("/people", s.peopleHandler())

    // Starts the server to receive requests
    appengine.Main()
}

However, this approach conflicts with GAE's requirement for context.Context to inherit from the request scope.

The Solution

The solution in GAE's new Go 1.11 runtime is to reuse the firestore.Client instance for multiple invocations. This wasn't possible in the old Go runtime, hence the need for creating a new client per request.

Implementation

In the Go 1.11 runtime, you can initialize the client in main() or init().

package main

var client *firestore.Client

func init() {
  var err error
  client, err = firestore.NewClient(context.Background())
  // handle errors as needed
}

func handleRequest(w http.ResponseWriter, r *http.Request) {
  doc := client.Collection("cities").Doc("Mountain View")
  doc.Set(r.Context(), someData)
  // rest of the handler logic
}

By utilizing the request context within handler functions, you can eliminate the need to pass the ctx variable from main to handlers, simplify dependency injection, and improve code clarity.

Resources

• [GAE Go 1.11 Differences](https://cloud.google.com/appengine/docs/standard/go111/go-differences)
• [Sample GAE App using Go 1.11 and Firestore](https://github.com/hiranya911/firecloud/blob/master/crypto-fire-alert/cryptocron/web/main.go)

The above is the detailed content of How Should I Manage Firestore Clients in Google App Engine for Optimal Performance?. For more information, please follow other related articles on the PHP Chinese website!