chore: update the document. #964
Conversation
size-limit report 📦
|
|
|
||
| Running tests is a good way to get a sense of what the features will do. We try to have full unit test coverage for all new features, although sometimes mocking network conditions can be difficult, and e2e tests may be preferable. | ||
|
|
||
| Before running tests, you need to compile the packages. |
There was a problem hiding this comment.
Randomly came across this PR. It feels somewhat uncommon to require building before running the tests — at least I'm not aware of any other JS libraries at the foundation that need such a step. Shouldn't the issue be fixed instead?
Just my two cents of course, feel free to ignore.
There was a problem hiding this comment.
Agree. I'm just working on adding a feature to agent-js, but I cannot run the tests successfully by following the steps. So I think it's better to have it fixed first.
I can discuss with Kaia to see how to address your concerns afterward.
There was a problem hiding this comment.
I spent a half hour comparing the ic-js and agent-js Jest configs yesterday and haven't found the culprit yet. I'll create a ticket for figuring out why jest isn't working without building the packages
There was a problem hiding this comment.
I tried to run the test in ic-js, and I have to do npm run build as well. Otherwise, I got the similar error as below
~/repos/ic-js$ npm test
> @dfinity/[email protected] test
> jest
FAIL packages/nns/src/utils/neurons.utils.spec.ts
● Test suite failed to run
packages/nns/src/utils/neurons.utils.spec.ts:2:39 - error TS2307: Cannot find module '@dfinity/utils' or its corresponding type declarations.
2 import { uint8ArrayToHexString } from "@dfinity/utils";
~~~~~~~~~~~~~~~~
PASS packages/utils/src/utils/date.utils.spec.ts (6.511 s)
FAIL packages/nns/src/canisters/governance/request.converters.spec.ts
● Test suite failed to run
I have to do
npm install
npm run build
npm test
to run the tests successfully.
Could you guys confirm it as well? Not sure if I did something wrong.
There was a problem hiding this comment.
Ahhhhhhh, yes, I can confirm. Now I get it. It's actually a phrasing observation.
Instead of the sentence provided in this PR:
Before running tests, you need to compile the packages.
Maybe we should write the following:
Before running tests **for the very first time**, you need to compile the packages.
3 participants
Description
Update the document about how to run the tests.
Fixes # (issue)
How Has This Been Tested?
Only document change.
Checklist: