fix: improve wsproxy error when proxyurl is set to a primary #11586
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
|
In this stack:
This stack of pull requests is managed by Graphite. Learn more about stacking. |
7c82247 to
9656c7a
Compare
Emyrk
commented
Jan 11, 2024
Comment on lines
279
to
307
| isCoderErr := fmt.Errorf("proxy url %q is not a coder proxy instance, verify the url is correct", reqURL) | ||
| if resp.Header.Get(codersdk.BuildVersionHeader) != "" { | ||
| isCoderErr = fmt.Errorf("proxy url %q is a coder instance, but unable to decode the response payload. Could this be a primary coderd and not a proxy?", reqURL) | ||
| } | ||
|
|
||
| // If the response is not json, then the user likely input a bad url that returns status code 200. | ||
| // This is very common, since most webpages do return a 200. So let's improve the error message. | ||
| if notJsonErr := codersdk.ExpectJSONMime(resp); notJsonErr != nil { | ||
|
|
||
| err = errors.Join( | ||
| isCoderErr, | ||
| fmt.Errorf("attempted to query health at %q but got back the incorrect content type: %w", reqURL, notJsonErr), | ||
| ) | ||
|
|
||
| status.Report.Errors = []string{ | ||
| err.Error(), | ||
| } | ||
| status.Status = Unhealthy | ||
| break | ||
| } | ||
|
|
||
| // If we cannot read the report, mark the proxy as unhealthy. | ||
| status.Report.Errors = []string{fmt.Sprintf("failed to decode health report: %s", err.Error())} | ||
| status.Report.Errors = []string{ | ||
| errors.Join( | ||
| isCoderErr, | ||
| fmt.Errorf("received a status code 200, but failed to decode health report body: %w", err.Error()), | ||
| ).Error(), | ||
| } | ||
| status.Status = Unhealthy |
There was a problem hiding this comment.
The json decode error is usually absolute garbage. So this should improve it.
It also does a header check to instantly tell the user if they are not even pointed at a coder instance at all (proxy or otherwise)
sreya
approved these changes
Jan 11, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
fixes: #11116
Check header for proxy instance, and check content-type for non json. If it's not a json payload, the json error is almost completely useless.
I think this could be formatted better, but it has the helpful information, which is enough for now imo.