chore: set gorm user-agent header #397
Merged
+42
−1
Conversation
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
Set the user-agent header to go-gorm-spanner if it is Spanner gorm that is creating the connection.
sakthivelmanii
approved these changes
Mar 18, 2025
driver.go
Outdated
| // Check if it is Spanner gorm that is creating the connection. | ||
| // If so, we should set a different user-agent header than the | ||
| // default go-sql-spanner header. | ||
| callers := make([]uintptr, 20) |
There was a problem hiding this comment.
nit: what's the idea behind choosing 20 frames in the stack?
There was a problem hiding this comment.
nit: can we separate the logic identifying if the request is coming from gorm or not into a new function?
Collaborator
Author
There was a problem hiding this comment.
- Go requires us to set a (max) number of stack items. 20 is relatively randomly chosen, but should be large enough to account for the internal functions that are called in the Go
sqlpackage between the time that the call 'leaves' gorm and enters the Spanner driver. Setting it at the exact level that would be needed today could be dangerous, as both thegormandsqlpackages could add more internal function calls that become part of the stack that we see here in the future. - I've moved the logic for checking whether the connection comes from gorm into a separate method.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Set the user-agent header to go-gorm-spanner if it is Spanner gorm that is creating the connection.