storybookjs/storybook

[Bug]: Interactions panel fails when stepping through "waitForElementToBeRemoved" as the element's been removed

Open

#21,520 建立於 2023年3月9日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)TypeScript (89,909 star) (10,058 fork)batch import
addon: interactionsbughelp wantedsev:S3

描述

Describe the bug

This is tricky.

Suppose there's an element in a page, which gets removed in 500ms (e.g. loading spinner). When writing a play function that asserts for that element to be removed, like so:

play: async ({ canvasElement, step }) => {
    const canvas = within(canvasElement);
    await waitForElementToBeRemoved(await canvas.findByText('loading...'))
    await userEvent.click(getByRole('button')) // button is only visible after spinner is gone!
},

If you click to start on the step debugger, by the time you think of clicking on the next step, the spinner is already gone. This means that stepping through the steps will fail.

I'm not sure what's a solution to this scenario, or even if there is a good solution!

To Reproduce

No response

System

No response

Additional context

No response

貢獻者指南

技術棧
typescriptreactjest
領域
frontendtesting
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
4
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Understanding of Storybook's interactions panelFamiliarity with async testing utilities like waitForElementToBeRemoved
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
25
研究方向
Investigate the interactions addon's step debugger to understand how it handles async operations like waitForElementToBeRemoved. The bug occurs because the step advances before the async assertion completes. Look into the source code in the `addons/interactions` directory, specifically the step runner and play function execution flow. Consider adding a mechanism to wait for all pending promises from test utilities before proceeding to the next step.