ci: Explicitly add DOM types #949
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
CI for the `integration-test` project is currently failing with: ```console Error: node_modules/@types/jsdom/base.d.ts(24,40): error TS2304: Cannot find name 'DocumentFragment'. Error: node_modules/@types/jsdom/base.d.ts(41,28): error TS2304: Cannot find name 'Node'. Error: node_modules/@types/jsdom/base.d.ts(172,19): error TS2304: Cannot find name 'HTMLScriptElement'. Error: node_modules/@types/jsdom/base.d.ts(172,39): error TS2304: Cannot find name 'HTMLLinkElement'. Error: node_modules/@types/jsdom/base.d.ts(172,57): error TS2304: Cannot find name 'HTMLIFrameElement'. Error: node_modules/@types/jsdom/base.d.ts(172,77): error TS2304: Cannot find name 'HTMLImageElement'. Error: node_modules/@types/jsdom/base.d.ts(181,38): error TS2304: Cannot find name 'Window'. Error: node_modules/@types/jsdom/base.d.ts(185,24): error TS2304: Cannot find name 'Window'. ``` This suggests TypeScript cannot find types definitions for JsDOM. JsDom is a transitive dependency via Jest. In this change we explicitly add the DOM types to tsconfig to solve this. I don't fully understand why this has suddenly started happening. I suspect our lack of a lockfile on the `integration-test` project might have something to do with it. I also don't fully understand why we didn't see CI issues in #931 which bumped the version of TypeScript... See: https://www.typescriptlang.org/tsconfig#high-level-libraries
2 tasks
jacobwinch
approved these changes
Dec 1, 2021
|
Reading jestjs/jest#12098, it looks like others are experiencing similar issues and have made similar fixes. Alternative suggestions on that issue is to downgrade to Jest v26. We don't need JsDOM and it looks like Jest v28 would be better suited for us. Will merge this to unblock |
akash1810
added a commit
that referenced
this pull request
Dec 1, 2021
This is a better solution to #949. See jestjs/jest#12098 (comment).
|
🎉 This PR is included in version 31.3.0 🎉 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.
What does this change?
CI for the
integration-testproject is currently failing with:This suggests TypeScript cannot find types definitions for JsDOM. JsDom is a transitive dependency via Jest.
In this change we explicitly add the DOM types to tsconfig to solve this.
I don't fully understand why this has suddenly started happening. I suspect our lack of a lockfile on the
integration-testproject might have something to do with it.I also don't fully understand why we didn't see CI issues in #931 which bumped the version of TypeScript...
See: https://www.typescriptlang.org/tsconfig#high-level-libraries
How to test
See CI.
Or more specifically, first witness the failing case:
main./script/ciThen witness the passing case:
./script/ciHow can we measure success?
CI should pass.
Have we considered potential risks?
Other than a lack of understanding the root cause...
Checklist
Footnotes
Consider whether this is something that will mean changes to projects that have already been migrated, or to the CDK CLI tool. If changes are required, consider adding a checklist here and/or linking to related PRs. ↩
If you are adding a new construct or pattern, has new documentation been added? If you are amending defaults or changing behaviour, are the existing docs still valid? ↩