feat(rtdb): add go rtdb emulator support #517
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,36 +18,56 @@ package db | |
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "net/url" | ||
| "os" | ||
| "runtime" | ||
| "strings" | ||
|
|
||
| "firebase.google.com/go/v4/internal" | ||
| "golang.org/x/oauth2" | ||
| "google.golang.org/api/option" | ||
| ) | ||
|
|
||
| const userAgentFormat = "Firebase/HTTP/%s/%s/AdminGo" | ||
| const invalidChars = "[].#$" | ||
| const authVarOverride = "auth_variable_override" | ||
| const emulatorDatabaseEnvVar = "FIREBASE_DATABASE_EMULATOR_HOST" | ||
| const emulatorNamespaceParam = "ns" | ||
|
|
||
| var ErrInvalidURL = errors.New("invalid database url") | ||
|
|
||
| var emulatorToken = &oauth2.Token{ | ||
| AccessToken: "owner", | ||
| } | ||
|
|
||
| // Client is the interface for the Firebase Realtime Database service. | ||
| type Client struct { | ||
| hc *internal.HTTPClient | ||
| dbURLConfig *dbURLConfig | ||
| authOverride string | ||
| } | ||
|
|
||
| type dbURLConfig struct { | ||
| // BaseURL can be either: | ||
| // - a production url (https://foo-bar.firebaseio.com/) | ||
| // - an emulator url (http://localhost:9000) | ||
| BaseURL string | ||
|
|
||
| // Namespace is used in for the emulator to specify the databaseName | ||
| // To specify a namespace on your url, pass ns=<database_name> (localhost:9000/?ns=foo-bar) | ||
| Namespace string | ||
| } | ||
|
|
||
| // NewClient creates a new instance of the Firebase Database Client. | ||
| // | ||
| // This function can only be invoked from within the SDK. Client applications should access the | ||
| // Database service through firebase.App. | ||
| func NewClient(ctx context.Context, c *internal.DatabaseConfig) (*Client, error) { | ||
| urlConfig, isEmulator, err := parseURLConfig(c.URL) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| var ao []byte | ||
|
|
@@ -59,6 +79,10 @@ func NewClient(ctx context.Context, c *internal.DatabaseConfig) (*Client, error) | |
| } | ||
|
|
||
| opts := append([]option.ClientOption{}, c.Opts...) | ||
| if isEmulator { | ||
| ts := oauth2.StaticTokenSource(emulatorToken) | ||
| opts = append(opts, option.WithTokenSource(ts)) | ||
| } | ||
| ua := fmt.Sprintf(userAgentFormat, c.Version, runtime.Version()) | ||
| opts = append(opts, option.WithUserAgent(ua)) | ||
| hc, _, err := internal.NewHTTPClient(ctx, opts...) | ||
|
|
@@ -69,7 +93,7 @@ func NewClient(ctx context.Context, c *internal.DatabaseConfig) (*Client, error) | |
| hc.CreateErrFn = handleRTDBError | ||
| return &Client{ | ||
| hc: hc, | ||
| dbURLConfig: urlConfig, | ||
| authOverride: string(ao), | ||
| }, nil | ||
| } | ||
|
|
@@ -96,10 +120,13 @@ func (c *Client) sendAndUnmarshal( | |
| return nil, fmt.Errorf("invalid path with illegal characters: %q", req.URL) | ||
| } | ||
|
|
||
| req.URL = fmt.Sprintf("%s%s.json", c.dbURLConfig.BaseURL, req.URL) | ||
| if c.authOverride != "" { | ||
| req.Opts = append(req.Opts, internal.WithQueryParam(authVarOverride, c.authOverride)) | ||
| } | ||
| if c.dbURLConfig.Namespace != "" { | ||
| req.Opts = append(req.Opts, internal.WithQueryParam(emulatorNamespaceParam, c.dbURLConfig.Namespace)) | ||
| } | ||
|
|
||
| return c.hc.DoAndUnmarshal(ctx, req, v) | ||
| } | ||
|
|
@@ -126,3 +153,65 @@ func handleRTDBError(resp *internal.Response) error { | |
|
|
||
| return err | ||
| } | ||
|
|
||
| // parseURLConfig returns the dbURLConfig for the database | ||
| // dbURL may be either: | ||
| // - a production url (https://foo-bar.firebaseio.com/) | ||
| // - an emulator URL (localhost:9000/?ns=foo-bar) | ||
| // | ||
| // The following rules will apply for determining the output: | ||
| // - If the url has no scheme it will be assumed to be an emulator url and be used. | ||
| // - else If the FIREBASE_DATABASE_EMULATOR_HOST environment variable is set it will be used. | ||
| // - else the url will be assumed to be a production url and be used. | ||
| func parseURLConfig(dbURL string) (*dbURLConfig, bool, error) { | ||
| parsedURL, err := url.ParseRequestURI(dbURL) | ||
| if err == nil && parsedURL.Scheme != "https" { | ||
| cfg, err := parseEmulatorHost(dbURL, parsedURL) | ||
| return cfg, true, err | ||
| } | ||
|
|
||
| environmentEmulatorURL := os.Getenv(emulatorDatabaseEnvVar) | ||
| if environmentEmulatorURL == "" && err != nil { | ||
| return nil, false, fmt.Errorf("%s: %w", dbURL, ErrInvalidURL) | ||
| } | ||
|
|
||
| if environmentEmulatorURL == "" && err == nil { | ||
| return &dbURLConfig{ | ||
| BaseURL: dbURL, | ||
| Namespace: "", | ||
| }, false, nil | ||
| } | ||
|
|
||
| parsedURL, err = url.ParseRequestURI(environmentEmulatorURL) | ||
| if err != nil { | ||
| return nil, false, fmt.Errorf("%s: %w", environmentEmulatorURL, ErrInvalidURL) | ||
| } | ||
| cfg, err := parseEmulatorHost(environmentEmulatorURL, parsedURL) | ||
| return cfg, true, err | ||
| } | ||
|
|
||
| func parseEmulatorHost(rawEmulatorHostURL string, parsedEmulatorHost *url.URL) (*dbURLConfig, error) { | ||
| if strings.Contains(rawEmulatorHostURL, "//") { | ||
|
Comment on lines
+195
to
+196
Contributor
Author
There was a problem hiding this comment. I saw this behavior in the Python sdk: https://github.com/firebase/firebase-admin-python/blob/37ecf18d0ad09d7402143f22443e957a57ec7a2a/firebase_admin/db.py#L784 |
||
| return nil, fmt.Errorf(`invalid %s: "%s". It must follow format "host:port": %w`, emulatorDatabaseEnvVar, rawEmulatorHostURL, ErrInvalidURL) | ||
| } | ||
|
|
||
| baseURL := strings.Replace(rawEmulatorHostURL, fmt.Sprintf("?%s", parsedEmulatorHost.RawQuery), "", -1) | ||
| if parsedEmulatorHost.Scheme != "http" { | ||
| baseURL = fmt.Sprintf("http://%s", baseURL) | ||
| } | ||
|
|
||
| namespace := parsedEmulatorHost.Query().Get(emulatorNamespaceParam) | ||
| if namespace == "" { | ||
| if strings.Contains(rawEmulatorHostURL, ".") { | ||
| namespace = strings.Split(rawEmulatorHostURL, ".")[0] | ||
| } | ||
|
Comment on lines
+207
to
+209
Contributor
Author
There was a problem hiding this comment. I observed similar behaviour in the Node sdk: https://github.com/firebase/firebase-admin-node/blob/master/src/database/database.ts#L325 |
||
| if namespace == "" { | ||
| return nil, fmt.Errorf(`invalid database URL: "%s". Database URL must be a valid URL to a Firebase Realtime Database instance (include ?ns=<db-name> query param)`, parsedEmulatorHost) | ||
| } | ||
| } | ||
|
|
||
| return &dbURLConfig{ | ||
| BaseURL: baseURL, | ||
| Namespace: namespace, | ||
| }, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.