Fix Jest and @orangekit/sdk support #418
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
According to the [jest documentation](https://jestjs.io/docs/getting-started#using-typescript) there are two ways to get TypeScript to work with Jest: - babel - ts-jest We already use ts-jest preset in jest configuration, so we don't need to import babel presets.
We use the JestConfigWithTsJest type to be explicit about the type of the config object we're dealing with.
After we added @orangekit/sdk import Jest started to complain with: ``` Jest encountered an unexpected token Details: /Users/jakub/workspace/acre/acre/node_modules/.pnpm/@orangekit[email protected]/node_modules/@orangekit/sdk/dist/src/index.js:1 ({"Object.<anonymous>":function(module,exports,require,__dirname,__filename,jest){export * from "./lib"; ^^^^^^ SyntaxError: Unexpected token 'export' > 1 | import { OrangeKitSdk } from "@orangekit/sdk" | ^ 2 | import { JsonRpcProvider } from "ethers" 3 | import { AcreContracts } from "./lib/contracts" 4 | import { EthereumNetwork, getEthereumContracts } from "./lib/ethereum" at Runtime.createScriptFromCode (../node_modules/.pnpm/[email protected]/node_modules/jest-runtime/build/index.js:1505:14) at Object.<anonymous> (src/acre.ts:1:1) at Object.<anonymous> (src/index.ts:9:1) at Object.<anonymous> (test/modules/tbtc/Tbtc.test.ts:7:1) ``` The `@orangekit/sdk` module exports `dist/` directory containing JS files in ESM syntax. Jest doesn't support ESM syntax, so we have to convert these JS files to CommonJS syntax with `ts-jest/presets/js-with-ts` preset. We have to define `transformIgnorePatterns` property as `node_modules/` directory is excluded from transformations by default. We also had to add `allowJs: true` in tsconfig.json to support transformation of JS files. Reference: - https://stackoverflow.com/questions/75452411/why-isnt-jest-handling-es-module-dependencies - https://stackoverflow.com/questions/49263429/jest-gives-an-error-syntaxerror-unexpected-token-export?noredirect=1&lq=1
r-czajkowski
merged commit a3b16d1
into
bitcoin-native-experience
19 of 21 checks passed
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.
Depends on: #417
After we added @orangekit/sdk import Jest started to complain with:
The
@orangekit/sdkmodule exportsdist/directory containing JS files in ESM syntax.Jest doesn't support ESM syntax, so we have to convert these JS files to
CommonJS syntax with
ts-jest/presets/js-with-tspreset.We have to define
transformIgnorePatternsproperty asnode_modules/directory is excluded from transformations by default.
We also had to add
allowJs: truein tsconfig.json to supporttransformation of JS files.
Unfortunately, it increased test execution time, so it may be better to mock the
@orangekit/sdkin unit tests instead of transforming the code.Reference: