fix(template): refactor and split code for test helper #317
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Current dependencies on/for this PR:
This stack of pull requests is managed by Graphite. |
| } | ||
|
|
||
| describe('FieldPluginExammple', () => { | ||
| describe('FieldPluginExample', () => { | ||
| afterEach(() => { | ||
| vi.unstubAllGlobals() |
There was a problem hiding this comment.
After working closely on the test helper, I realized that we will need to provide additional documentation, maybe a comment that explains that vi.unstubAllGlobals() is needed if they use our helper setup() function. This at first glance might be rather unintuitive.
There was a problem hiding this comment.
Good point! Maybe we could do
test('something', async () => {
const { cleanUp } = setupFieldPlugin();
// do stuff
cleanUp();
});And cleanUp is actually just vi.unstubAllGlobals() internally. What do you think?
…oved console.logs
BibiSebi
changed the title
There was a problem hiding this comment.
Yeah I see vi.mock can be tricky to abstract because of hoisting. I guess if we still took the approach #2, we could've done something like..
// something.spec.tsx
import { mockedLibrary } from '@storyblok/field-plugin/test'
vi.mock('@storyblok/field-plugin', mockedLibrary());meaning it's the user who needs to mock the library while we provide the mock implementation. However, the approach #1 (the current PR) seems cleaner for users than that 🙂
| } | ||
|
|
||
| describe('FieldPluginExammple', () => { | ||
| describe('FieldPluginExample', () => { | ||
| afterEach(() => { | ||
| vi.unstubAllGlobals() |
There was a problem hiding this comment.
Good point! Maybe we could do
test('something', async () => {
const { cleanUp } = setupFieldPlugin();
// do stuff
cleanUp();
});And cleanUp is actually just vi.unstubAllGlobals() internally. What do you think?
What?
In this PR, I have refactored and separated the test helper PoC code into a separate file. I used the first approach #307 as it was easier to split.
Once the PR #313 is merged, I will continue with the following next steps:
packages/helpers/testtestinside field-plugin exports in package.jsonWhy?
EXT-2078
How to test? (optional)
yarn installyarn test:template react