feat: add selective action stubbing support #3040
Conversation
✅ Deploy Preview for pinia-official ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughAdds selective action stubbing to the testing utilities: Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant CT as createTestingPinia
participant JS as shouldStubAction
participant S as Store
Dev->>CT: call createTestingPinia({ stubActions: config })
CT->>CT: iterate store actions
CT->>JS: shouldStubAction(actionName, store, config)
alt config is array
JS->>JS: check actionName in array
else config is function
JS->>JS: call predicate(actionName, store)
else config is boolean
JS->>JS: return boolean
end
JS-->>CT: return boolean
alt true
CT->>S: replace action with stub (mock)
else false
CT->>S: leave action as spyable/real
end
CT-->>Dev: return testing pinia with configured actions
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Pre-merge checks and finishing touches✅ Passed checks (4 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
doubledare704
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
packages/docs/zh/cookbook/testing.md (1)
176-239: 新增“选择性 action 存根”章节内容与实现一致。建议补充对 $reset 的特殊说明。实现中
$reset由stubReset控制，stubActions（含 include/exclude）不会影响$reset。为避免读者误解，建议在本节加一句明确说明。应用此编辑（在提示块后增加一行）：
::: tip 如果同时提供了 `include` 和 `exclude`，`include` 优先。如果两者都没有提供或两个数组都为空，所有 action 都将被存根（等同于 `stubActions: true`）。 ::: +> 注意：内置方法 `$reset` 不受 `stubActions`（包括 include/exclude）影响，请使用 `stubReset` 选项控制其是否存根。packages/docs/cookbook/testing.md (1)
169-232: Selective stubbing docs match behavior. Add a short note about $reset being controlled via stubReset.Code excludes
$resetfromstubActionshandling and wires it viastubReset. A one-liner will prevent confusion.Apply after the tip block:
::: tip If both `include` and `exclude` are provided, `include` takes precedence. If neither is provided or both arrays are empty, all actions will be stubbed (equivalent to `stubActions: true`). ::: +> Note: the built-in `$reset` is not affected by `stubActions` (including `include`/`exclude`). Use the `stubReset` option to control it.packages/testing/src/testing.ts (2)
32-39: Clarify TSDoc to fully specify precedence and defaults for include/exclude.Docs are correct but can be more explicit (matches implementation and user docs).
- * not being executed. When set to an object with `include` or `exclude` arrays, - * only the specified actions will be stubbed or excluded from stubbing. - * Defaults to true. NOTE: when providing `createSpy()`, + * not being executed. + * When set to an object, you can pass `include` and/or `exclude` arrays for per‑action control: + * - if `include` is non‑empty, only listed actions are stubbed + * - else if `exclude` is non‑empty, all actions except those are stubbed + * - if both are omitted or empty, all actions are stubbed (equivalent to `true`) + * Defaults to `true`. NOTE: when providing `createSpy()`,
145-162: Logic is correct; small perf/readability tweak by precomputing sets.Precompute include/exclude Sets once per store to avoid repeated array scans and tighten the branching.
- Object.keys(options.actions).forEach((action) => { - if (action === '$reset') return - - let shouldStub: boolean - if (typeof stubActions === 'boolean') { - shouldStub = stubActions - } else { - // Handle include/exclude logic - const { include, exclude } = stubActions - if (include && include.length > 0) { - shouldStub = include.includes(action) - } else if (exclude && exclude.length > 0) { - shouldStub = !exclude.includes(action) - } else { - // If both include and exclude are empty or undefined, default to true - shouldStub = true - } - } - - store[action] = shouldStub ? createSpy() : createSpy(store[action]) - }) + const includeSet = + typeof stubActions === 'object' && stubActions.include?.length + ? new Set(stubActions.include) + : undefined + const excludeSet = + typeof stubActions === 'object' && stubActions.exclude?.length + ? new Set(stubActions.exclude) + : undefined + + Object.keys(options.actions).forEach((action) => { + if (action === '$reset') return + + const shouldStub = + typeof stubActions === 'boolean' + ? stubActions + : includeSet + ? includeSet.has(action) + : excludeSet + ? !excludeSet.has(action) + : true + + store[action] = shouldStub ? createSpy() : createSpy(store[action]) + })packages/testing/src/testing.spec.ts (1)
412-594: Comprehensive coverage of include/exclude semantics; add one setup‑store case.All primary paths are covered (include, exclude, empty arrays, precedence, booleans, unknown names). To guarantee parity for setup stores too, add one test exercising
stubActionswith a setup store’s actions.Example to append:
it('applies selective stubbing to setup stores', () => { setActivePinia( createTestingPinia({ stubActions: { include: ['increment'] }, createSpy: vi.fn, }) ) const useSetup = defineStore('s', () => { const n = ref(0) function increment() { n.value++ } function decrement() { n.value-- } return { n, increment, decrement } }) const s = useSetup() s.increment() expect(s.n).toBe(0) s.decrement() expect(s.n).toBe(-1) })
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
packages/docs/cookbook/testing.md(1 hunks)packages/docs/zh/cookbook/testing.md(1 hunks)packages/online-playground/package.json(1 hunks)packages/testing/src/testing.spec.ts(2 hunks)packages/testing/src/testing.ts(2 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
packages/testing/src/testing.spec.ts (1)
packages/testing/src/testing.ts (1)
createTestingPinia(95-186)
🔇 Additional comments (2)
packages/testing/src/testing.spec.ts (1)
27-44: Good focused fixture store for multi-action scenarios.Covers a representative mix (mutating counters and value).
packages/docs/cookbook/testing.md (1)
169-232: AI summary incorrect — no duplicate foundSearch shows a single occurrence at packages/docs/cookbook/testing.md:169; no action required.
feat(testing): add selective action stubbing support - Add support for include/exclude options in stubActions parameter - Allow stubbing only specific actions or excluding specific actions from stubbing - Maintain backward compatibility with boolean stubActions values - Add comprehensive tests for all selective stubbing scenarios - Update documentation with examples and usage patterns - Fix workspace naming conflict in online-playground package Closes vuejs#2970
posva
force-pushed
the
feature/issue-2970-selective-action-stubbing
branch
from
0d9ca09 to
6d8630d
Compare
commit: |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
packages/docs/cookbook/testing.md(1 hunks)packages/docs/zh/cookbook/testing.md(1 hunks)packages/testing/src/testing.spec.ts(4 hunks)packages/testing/src/testing.ts(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- packages/docs/zh/cookbook/testing.md
- packages/docs/cookbook/testing.md
🧰 Additional context used
🧬 Code graph analysis (2)
packages/testing/src/testing.ts (2)
packages/testing/src/index.ts (1)
TestingOptions(5-5)packages/pinia/src/types.ts (1)
StoreGeneric(484-489)
packages/testing/src/testing.spec.ts (1)
packages/testing/src/testing.ts (1)
createTestingPinia(103-180)
| stubActions?: | ||
| | boolean | ||
| | string[] | ||
| | ((actionName: string, store: any) => boolean) |
There was a problem hiding this comment.
Include/exclude object config is unsupported, so the new API fails.
Issue #2970 (and this PR’s description) call for stubActions to accept an object like { include, exclude }, but the current change only allows boolean | string[] | predicate. Passing the documented object either hits a TS error or falls through to the return false branch in shouldStubAction, meaning nothing gets stubbed. The flagship feature of this PR is therefore broken. Please extend the type to cover the object shape and update shouldStubAction to honor the include/exclude rules (e.g. include list acts as an allow-list, exclude removes items from the stub set, with tests covering both).
Also applies to: 273-285
🤖 Prompt for AI Agents
In packages/testing/src/testing.ts around lines 43-46 (and similarly update
lines 273-285), the stubActions type and shouldStubAction logic don't support
the documented { include, exclude } object shape; extend the stubActions union
type to also accept an object like { include?: string[]; exclude?: string[] }
and update shouldStubAction to handle that shape: if include is provided treat
it as an allow-list (only names in include may be stubbed), then apply exclude
to remove any names from that set; preserve existing boolean, string[] and
predicate behavior; add/adjust unit tests to cover include-only, exclude-only,
and combined include+exclude scenarios to ensure correct behavior.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## v3 #3040 +/- ##
==========================================
+ Coverage 91.01% 91.63% +0.62%
==========================================
Files 17 17
Lines 1402 1543 +141
Branches 211 227 +16
==========================================
+ Hits 1276 1414 +138
- Misses 125 127 +2
- Partials 1 2 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
github-project-automation
bot
moved this from 🧑💻 In progress
to ✅ Done
in Pinia Roadmap
2 participants
feat(testing): add selective action stubbing support
Closes #2970
Summary by CodeRabbit
New Features
Documentation
Tests