fix: wrap Intl.<>() calls in try/catch #297
Merged
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
francinelucca
commented
Dec 5, 2024
src/relative-time-element.ts
Outdated
Comment on lines
123
to
143
| let dateTimeFormat | ||
| try { | ||
| dateTimeFormat = new Intl.DateTimeFormat(this.#lang, { | ||
| day: 'numeric', | ||
| month: 'short', | ||
| year: 'numeric', | ||
| hour: 'numeric', | ||
| minute: '2-digit', | ||
| timeZoneName: 'short', | ||
| }) | ||
| } catch (_e) { | ||
| dateTimeFormat = new Intl.DateTimeFormat('default', { | ||
| day: 'numeric', | ||
| month: 'short', | ||
| year: 'numeric', | ||
| hour: 'numeric', | ||
| minute: '2-digit', | ||
| timeZoneName: 'short', | ||
| }) | ||
| } | ||
| return dateTimeFormat.format(date) |
There was a problem hiding this comment.
@keithamus I did some research on using an array in the constructor instead but it'd fail anyways if one of the locales was invalid, so I settled on this.
Also I'm not quite sure how to test this but happy to update on Primer and test once this is in
keithamus
reviewed
Dec 6, 2024
There was a problem hiding this comment.
Instead of try/catching each of the Intl calls we could add a try/catch into #lang:
get #lang() {
const lang = this.closest('[lang]')?.getAttribute('lang') ||
this.ownerDocument.documentElement.getAttribute('lang')
try {
return new Intl.Locale(lang).toString()
} catch {
return 'default'
}
}This way #lang would always return a reliable language code and we minimise the surface area of changes.
|
@keithamus done in 0a42e68, much better now, thanks! |
keithamus
approved these changes
Dec 7, 2024
TylerJDev
approved these changes
Dec 9, 2024
Co-authored-by: Keith Cirkel <[email protected]>
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.
Closes https://github.com/github/primer/issues/4409
Fixes error thrown when an invalid locale is passed to the
Intlfunctions by wrapping it in Try/Catch. When the call fails (locale is invalid), the default locale will be used