fix(test): don't fail build when jest typings can't be resolved #5031
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
patch `getJestPreset` in the jest-stencil connector to return `any`
instead of an inferred type for the function. prior to this fix,
building a stencil project with jest 29 installed could lead to an error
such as:
```
TypeScript: node_modules/@stencil/core/testing/jest/jest-stencil-connector.d.ts:81:31
Could not find a declaration file for module '@jest/types/build/Config'.
'/PROJECT_DIRECTORY/node_modules/@jest/types/build/Config.js' implicitly
has an 'any' type.If the '@jest/types' package actually exposes this module, try adding a new declaration
(.d.ts) file containing `declare module '@jest/types/build/Config';`
```
Explicitly setting this return type to `any` is a temporary measure to
unblock adopters. A TODO for STENCIL-1003 has been added to resolve
this fully.
STENCIL-1002: bug: Stencil 4.7.x & Jest 29.5.7 TypeScript error
fixes: #5030
rwaskiewicz
commented
Nov 7, 2023
| /** | ||
| * Retrieve Stencil's Jest presets for the detected version of Jest | ||
| * | ||
| * @returns an object representing a Jest preset | ||
| */ | ||
| export const getJestPreset = () => { | ||
| export const getJestPreset = (): any => { |
There was a problem hiding this comment.
These typings don't actually don't get consumed in practice, setting this to any temporarily (long term fix pulled into the sprint) will unblock additional adopters of Jest 29
|
| Path | Error Count |
|---|---|
| src/dev-server/index.ts | 37 |
| src/mock-doc/serialize-node.ts | 36 |
| src/dev-server/server-process.ts | 32 |
| src/compiler/build/build-stats.ts | 27 |
| src/compiler/output-targets/dist-lazy/generate-lazy-module.ts | 25 |
| src/compiler/style/test/optimize-css.spec.ts | 23 |
| src/testing/puppeteer/puppeteer-element.ts | 23 |
| src/compiler/prerender/prerender-main.ts | 22 |
| src/runtime/client-hydrate.ts | 19 |
| src/screenshot/connector-base.ts | 19 |
| src/runtime/vdom/vdom-render.ts | 18 |
| src/compiler/config/test/validate-paths.spec.ts | 16 |
| src/dev-server/request-handler.ts | 15 |
| src/compiler/prerender/prerender-optimize.ts | 14 |
| src/compiler/sys/stencil-sys.ts | 14 |
| src/compiler/transpile/transpile-module.ts | 14 |
| src/runtime/vdom/vdom-annotations.ts | 14 |
| src/sys/node/node-sys.ts | 14 |
| src/compiler/build/build-finish.ts | 13 |
| src/compiler/prerender/prerender-queue.ts | 13 |
Our most common errors
| Typescript Error Code | Count |
|---|---|
| TS2345 | 417 |
| TS2322 | 394 |
| TS18048 | 310 |
| TS18047 | 101 |
| TS2722 | 38 |
| TS2532 | 34 |
| TS2531 | 23 |
| TS2454 | 14 |
| TS2352 | 13 |
| TS2769 | 10 |
| TS2790 | 10 |
| TS2538 | 8 |
| TS2344 | 5 |
| TS2416 | 4 |
| TS2493 | 3 |
| TS18046 | 2 |
| TS2684 | 1 |
| TS2488 | 1 |
| TS2430 | 1 |
Unused exports report
There are 15 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!
Unused exports
| File | Line | Identifier |
|---|---|---|
| src/runtime/bootstrap-lazy.ts | 21 | setNonce |
| src/screenshot/screenshot-fs.ts | 18 | readScreenshotData |
| src/testing/testing-utils.ts | 198 | withSilentWarn |
| src/utils/index.ts | 145 | CUSTOM |
| src/utils/index.ts | 232 | resolve |
| src/utils/index.ts | 246 | normalize |
| src/utils/index.ts | 7 | escapeRegExpSpecialCharacters |
| src/compiler/app-core/app-data.ts | 25 | BUILD |
| src/compiler/app-core/app-data.ts | 115 | Env |
| src/compiler/app-core/app-data.ts | 117 | NAMESPACE |
| src/compiler/fs-watch/fs-watch-rebuild.ts | 123 | updateCacheFromRebuild |
| src/compiler/types/validate-primary-package-output-target.ts | 62 | satisfies |
| src/compiler/types/validate-primary-package-output-target.ts | 62 | Record |
| src/testing/puppeteer/puppeteer-declarations.ts | 485 | WaitForEventOptions |
| src/compiler/sys/fetch/write-fetch-success.ts | 7 | writeFetchSuccessSync |
tanner-reits
approved these changes
Nov 8, 2023
alicewriteswrongs
approved these changes
Nov 8, 2023
rwaskiewicz
added a commit
that referenced
this pull request
Nov 9, 2023
this commit is a follow up to #5031 (5df16e6). it narrows the return type of the `JestFacade#getJestPreset` function from `any` to an alias to Jest's `Config.InitialOptions`. prior to #5031, the return type of `getJestPreset` would be inferred by the TypeScript compiler, and a dynamic import to an internal Jest type declaration file would be generated for the typing of the function: ```ts // a snippet of what was generated in `jest-stencil-connector.d.ts export declare const getJestPreset: () => Partial<{ coverageReporters: import("@jest/types/build/Config").CoverageReporters; // other fields omitted }>; ``` however, stencil cannot/should not make assumptions about the location of this file. by placing an alias, the dyanmic import is removed from the output `.d.ts` file (having the same effect as #5031). pr #5031 eliminated this by using `any` as an explicit return type, which would generate: ```ts export declare const getJestPreset: () => any; ``` with this commit, we now generate: ```ts export declare const getJestPreset: () => JestPresetConfig; ``` which no longer inlines dynamic imports for typings.
rwaskiewicz
added a commit
that referenced
this pull request
Nov 9, 2023
this commit is a follow up to #5031 (5df16e6). it narrows the return type of the `JestFacade#getJestPreset` function from `any` to an alias to Jest's `Config.InitialOptions`. prior to #5031, the return type of `getJestPreset` would be inferred by the TypeScript compiler, and a dynamic import to an internal Jest type declaration file would be generated for the typing of the function: ```ts // a snippet of what was generated in `jest-stencil-connector.d.ts export declare const getJestPreset: () => Partial<{ coverageReporters: import("@jest/types/build/Config").CoverageReporters; // other fields omitted }>; ``` however, stencil cannot/should not make assumptions about the location of this file. by placing an alias, the dyanmic import is removed from the output `.d.ts` file (having the same effect as #5031). pr #5031 eliminated this by using `any` as an explicit return type, which would generate: ```ts export declare const getJestPreset: () => any; ``` with this commit, we now generate: ```ts export declare const getJestPreset: () => JestPresetConfig; ``` which no longer inlines dynamic imports for typings. STENCIL-1003 Dynamic IMport Type Resolution Fails for Jest 28, 29
rwaskiewicz
added a commit
that referenced
this pull request
Nov 9, 2023
this commit is a follow up to #5031 (5df16e6). it narrows the return type of the `JestFacade#getJestPreset` function from `any` to an alias to Jest's `Config.InitialOptions`. prior to #5031, the return type of `getJestPreset` would be inferred by the TypeScript compiler, and a dynamic import to an internal Jest type declaration file would be generated for the typing of the function: ```ts // a snippet of what was generated in `jest-stencil-connector.d.ts export declare const getJestPreset: () => Partial<{ coverageReporters: import("@jest/types/build/Config").CoverageReporters; // other fields omitted }>; ``` however, stencil cannot/should not make assumptions about the location of this file. by placing an alias, the dyanmic import is removed from the output `.d.ts` file (having the same effect as #5031). pr #5031 eliminated this by using `any` as an explicit return type, which would generate: ```ts export declare const getJestPreset: () => any; ``` with this commit, we now generate: ```ts export declare const getJestPreset: () => JestPresetConfig; ``` which no longer inlines dynamic imports for typings. STENCIL-1003 Dynamic Import Type Resolution Fails for Jest 28, 29
2 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 13, 2023
this commit is a follow up to #5031 (5df16e6). it narrows the return type of the `JestFacade#getJestPreset` function from `any` to an alias to Jest's `Config.InitialOptions`. prior to #5031, the return type of `getJestPreset` would be inferred by the TypeScript compiler, and a dynamic import to an internal Jest type declaration file would be generated for the typing of the function: ```ts // a snippet of what was generated in `jest-stencil-connector.d.ts export declare const getJestPreset: () => Partial<{ coverageReporters: import("@jest/types/build/Config").CoverageReporters; // other fields omitted }>; ``` however, stencil cannot/should not make assumptions about the location of this file. by placing an alias, the dyanmic import is removed from the output `.d.ts` file (having the same effect as #5031). pr #5031 eliminated this by using `any` as an explicit return type, which would generate: ```ts export declare const getJestPreset: () => any; ``` with this commit, we now generate: ```ts export declare const getJestPreset: () => JestPresetConfig; ``` which no longer inlines dynamic imports for typings. STENCIL-1003 Dynamic Import Type Resolution Fails for Jest 28, 29
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 is the current behavior?
prior to this fix, building a stencil project with jest 29 installed could lead to an error such as:
GitHub Issue Number: #5030
What is the new behavior?
patch
getJestPresetin the jest-stencil connector to returnanyinstead of an inferred type for the function.Explicitly setting this return type to
anyis a temporary measure to unblock adopters. A TODO for STENCIL-1003 has been added to resolve this fully.Does this introduce a breaking change?
Testing
yarnto install dependenciesyarn buildto build the project, observe the erroryarn add @stencil/[email protected]yarn buildto build the project, observe no error occursOther information
STENCIL-1002: bug: Stencil 4.7.x & Jest 29.5.7 TypeScript error
fixes: #5030