fix(tests): fix i18n tests [skip ci] #2950
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
The tests were failing on #2924 but i thought it was just the CI being flaky… surely changing one word in a comment wouldn’t cause the entire test suite to hang! Boy was I wrong. Turns out that the i18n tests actually greps the filesystem looking for instances of the translate() function, extracts their keys, and then compares those keys to the list inside the translation files. Well, this grep command doesn’t take commented code into account so it sees these blocks of code as equally valid: translate(‘key1’) // translate(‘key2’) /** * translate(‘key3’) */ So the test will look for [key1, key2, key3] and make sure the translations exist. To solve this, I added the key `”hello”` to the EXCEPTIONS list so that this comment will no longer cause the test suite to hang and eventually fail.
frankcalise
approved these changes
May 15, 2025
|
Yeah, until the grep is fixed, tests would fail if both of the following happen:
|
infinitered-circleci
pushed a commit
that referenced
this pull request
May 20, 2025
## [10.4.1](v10.4.0...v10.4.1) (2025-05-20) ### Bug Fixes * **cli:** correct mobx removal when using prompts ([#2949](#2949) by [@frankcalise](https://github.com/frankcalise)) ([73e9809](73e9809)) * **docs:** updated the doc for i18n translate to reflect proper usage of the translation keys ([#2924](#2924)) [skip ci] ([7bb8c5c](7bb8c5c)) * **Header:** change Header's pointerEvents="none" from a prop to a style ([#2933](#2933)) [skip ci] ([a0d305f](a0d305f)) * **tests:** fix i18n tests failing because of a rogue grep and regex not understanding comments ([#2950](#2950)) [skip ci] ([17dd1a4](17dd1a4)), closes [#2924](#2924)
|
🎉 This PR is included in version 10.4.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Description
The tests were failing on #2924 but i thought it was just the CI being flaky… surely changing one word in a comment wouldn’t cause the entire test suite to hang! So i merged it.
Boy was I wrong. Turns out that the i18n tests actually greps the filesystem looking for instances of the
translate()function, extracts their keys, and then compares those keys to the list inside the translation files.This
grepcommand doesn’t take commented code into consideration so it sees these blocks of code as equally valid instances of thetranslate()function:So the test will look for
["key1", "key2", "key3"]and make sure the translations exist instead of just["key1"]like we'd expect.To solve this, I added the key
”hello”to the EXCEPTIONS list with a large comment above it about why... so that this comment will no longer cause the test suite to hang and eventually fail.Checklist