Use https by default in prependHTTP util #47467
Closed
Conversation
This file contains 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
|
Size Change: +3 B (0%) Total Size: 1.31 MB
ℹ️ View Unchanged
|
|
Just to say I prefer the other approach where we allow the consumer to modify the protocol as required leaving the existing API in tact. |
tyxla
reviewed
Jan 27, 2023
| @@ -24,7 +24,7 @@ export function prependHTTP( url ) { | |||
|
|
|||
| url = url.trim(); | |||
| if ( ! USABLE_HREF_REGEXP.test( url ) && ! isEmail( url ) ) { | |||
| return 'http://' + url; | |||
| return 'https://' + url; | |||
There was a problem hiding this comment.
This is a potentially breaking change that needs to be documented as one in the package's CHANGELOG.
| @@ -24,7 +24,7 @@ export function prependHTTP( url ) { | |||
|
|
|||
| url = url.trim(); | |||
| if ( ! USABLE_HREF_REGEXP.test( url ) && ! isEmail( url ) ) { | |||
| return 'http://' + url; | |||
| return 'https://' + url; | |||
There was a problem hiding this comment.
Actually, I'd generally be against that change, because I'd expect a function called prependHTTP to prepend http, not https. I'd suggest one of these alternative approaches instead:
- Create a new universal function
prependProtocolthat will look at the current protocol (window.location.protocolif in a browser environment), and consider it when deciding whether to applyhttporhttps. That way we'll keep usinghttpfor local installations that are not on HTTPS, but we'll still properly supporthttpswhen applicable. - Create a function
prependHTTPSthat always prependshttpsand in another PR, use that function instead ofprependHTTPto make it transparent as to what we're doing. That will also help us test the impact of that change in all areas whereprependHTTPis being used.
In any case, we might want to deprecate prependHTTP as it will no longer be used and preferred, since sites are recommended to be on https.
What do you think?
There was a problem hiding this comment.
Yeh so I went with adding an option to the existing function in #47312.
But we could just as easily create a new function and deprecate this one.
There was a problem hiding this comment.
I agree with you and I think that adding an extra param is of the smallest impact here, since it's not a breaking change. That's why I'm happy to add it here. The downside is the potential confusion that the prependHTTP function can prepend https but I guess if we document it well, it can be fine.
| @@ -24,7 +24,7 @@ export function prependHTTP( url ) { | |||
|
|
|||
| url = url.trim(); | |||
| if ( ! USABLE_HREF_REGEXP.test( url ) && ! isEmail( url ) ) { | |||
| return 'http://' + url; | |||
| return 'https://' + url; | |||
There was a problem hiding this comment.
We will also need to update some snapshots that previously used http and will now be using https.
|
I think the breaking change of defaulting to |
|
Closing in favour of suggestion to add HTTPS util. |
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.
What?
Alternative to #47312.
Why?
Because @draganescu suggested it in #47312 (review) so I'm raising it for consideration.
How?
Update the util to always use
httpsinstead ofhttp.Testing Instructions
Same as #47312.
Testing Instructions for Keyboard
Screenshots or screencast