Add support for providing additional HTTP headers #134
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
julienduchesne
force-pushed
the
master
branch
5 times, most recently
from
da7d369 to
02098da
Compare
inkel
requested changes
Jan 24, 2022
grafana/provider.go
Outdated
| DefaultFunc: schema.EnvDefaultFunc("GRAFANA_AUTH", nil), | ||
| Description: "Credentials for accessing the Grafana API.", | ||
| }, | ||
| "headers": { |
Contributor
There was a problem hiding this comment.
headers is too generic, can you rename it to http_headers? It also maps better to the environment variable name.
grafana/provider.go
Outdated
| headersObj := d.Get("headers").(map[string]interface{}) | ||
| if headersObj != nil && len(headersObj) == 0 { | ||
| // Workaround for a bug when DefaultFunc returns a TypeMap | ||
| headersObjAbs, _ := JsonEnvDefaultFunc("GRAFANA_HTTP_HEADERS", nil)() |
Contributor
There was a problem hiding this comment.
Why are you deciding to ignore the error here? If GRAFANA_HTTP_HEADERS contains invalid JSON no error will be reported to the user but the provider will continue to work, so the end user won't know that their configuration was ignored.
Contributor
Author
There was a problem hiding this comment.
You are right, returning the error in this case.
grafana/provider.go
Outdated
| } | ||
|
|
||
| headersObj := d.Get("headers").(map[string]interface{}) | ||
| if headersObj != nil && len(headersObj) == 0 { |
Contributor
There was a problem hiding this comment.
This can be simplified, as a nil map will always have a len of 0:
Suggested change
| if headersObj != nil && len(headersObj) == 0 { | |
| if len(headersObj) == 0 { |
Contributor
Author
There was a problem hiding this comment.
Reverted, because it results in:
panic: interface conversion: interface {} is nil, not map[string]interface {} [recovered]
panic: interface conversion: interface {} is nil, not map[string]interface {}
grafana/provider.go
Outdated
Comment on lines
82
to
297
| switch v := v.(type) { | ||
| case string: | ||
| headers[k] = v | ||
| } |
Contributor
There was a problem hiding this comment.
For a single case type conversion, it's better to use a type assertion instead:
Suggested change
| switch v := v.(type) { | |
| case string: | |
| headers[k] = v | |
| } | |
| if v, ok := v.(string); ok { | |
| headers[k] = v | |
| } |
gw0
force-pushed
the
gw0/add-http-headers-2
branch
from
326804a to
3f91970
Compare
Contributor
Author
|
@inkel Thank you for your feedback. I rebased on top of master and included your suggested changes. |
gw0
force-pushed
the
gw0/add-http-headers-2
branch
3 times, most recently
from
84d3c60 to
3bbfcae
Compare
gw0
force-pushed
the
gw0/add-http-headers-2
branch
from
3bbfcae to
aa9f394
Compare
Contributor
Author
|
Fixed issues discovered by CI. |
julienduchesne
added a commit
that referenced
this pull request
Mar 1, 2022
Following #134 I had a bit of trouble making sure that the changes were working correctly so I decided to add a unit test for the provider configuration Changes to PR #134: - Add sub-elem string type - Remove http_headers DefaultFunc, it isn't being called - Add provider configure tests to test that configuring headers works both from env and explicitely Other changes: - Add unit test pipeline to CI
Contributor
|
Thank you @gw0 for the changes! |
julienduchesne
added a commit
that referenced
this pull request
Mar 3, 2022
* Add provider configure unit test Following #134 I had a bit of trouble making sure that the changes were working correctly so I decided to add a unit test for the provider configuration Changes to PR #134: - Add sub-elem string type - Remove http_headers DefaultFunc, it isn't being called - Add provider configure tests to test that configuring headers works both from env and explicitely Other changes: - Add unit test pipeline to CI * lint
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Sometimes the Grafana server is behind a proxy or application firewall and it is necessary to provide additional HTTP headers to establish a connection, such as authentication tokens or cookies. In general sense these are represented as key-value pairs of strings. To also add support to provide these using an environment variable
GRAFANA_HTTP_HEADERS, this PR assumes it contains a JSON-encoded map.Usage:
$ GRAFANA_HTTP_HEADERS='{"Cookies":"foo=bar"}' terraform planThis PR is based on #119 and depends on PR grafana/grafana-api-golang-client#16.