fix: accept legacy redirect HTTP environment variables #10748
Merged
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
|
Current dependencies on/for this PR: This stack of pull requests is managed by Graphite. |
johnstcn
reviewed
Nov 17, 2023
cli/server.go
Outdated
| // corresponding flag!) "CODER_TLS_REDIRECT_HTTP", and it appeared in a configuration | ||
| // example, so we keep accepting it to not break backward compat. | ||
| func redirectHTTPToHTTPSDeprecation(ctx context.Context, logger slog.Logger, inv *clibase.Invocation, cfg *codersdk.DeploymentValues) { | ||
| if inv.Environ.Get("CODER_TLS_REDIRECT_HTTP") == "true" || |
There was a problem hiding this comment.
Should probably use strconv.ParseBool as well instead of comparing the raw values.
johnstcn
reviewed
Nov 17, 2023
cli/server.go
Outdated
| if inv.Environ.Get("CODER_TLS_REDIRECT_HTTP") == "true" || | ||
| inv.Environ.Get("CODER_TLS_REDIRECT_HTTP_TO_HTTPS") == "true" || | ||
| inv.ParsedFlags().Changed("tls-redirect-http-to-https") { | ||
| logger.Warn(ctx, "--tls-redirect-http-to-https is deprecated, please use --redirect-to-access-url instead") |
There was a problem hiding this comment.
This may sound silly, but adding some
johnstcn
approved these changes
Nov 17, 2023
30f40f1 to
1e1f734
Compare
Merge activity
|
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.
Oh man, what a mess. It looks like
CODER_TLS_REDIRECT_HTTPappears in our config docs. Maybe that was the initial name for the environment variable?At some point, both the flag and the environment variable were
--tls-redirect-http-to-httpsandCODER_TLS_REDIRECT_HTTP_TO_HTTPS.CODER_TLS_REDIRECT_HTTPdid nothing.However, then we introduced
CODER_REDIRECT_TO_ACCESS_URL, we put in some deprecation code that was maybe fat-fingered such that we accept the environment variableCODER_TLS_REDIRECT_HTTPbut the flag--tls-redirect-http-to-https. Our docs still refer toCODER_TLS_REDIRECT_HTTPat https://coder.com/docs/v2/latest/admin/configure#addressSo, I think what we gotta do is still accept
CODER_TLS_REDIRECT_HTTPsince it was working and in an example doc, but also fix the deprecation code to acceptCODER_TLS_REDIRECT_HTTP_TO_HTTPSenvironment variable.