Skip to content

test: use fake timers instead of setTimeout mock #32142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 18, 2025

Conversation

OrbisK
Copy link
Collaborator

@OrbisK OrbisK commented May 18, 2025

🔗 Linked issue

📚 Description

This PR replaces the setTimeout mocks with Vitest fake timers. This should be an improvement, as it is now possible to control where you want to skip the timers for testing purposes.

@Copilot Copilot AI review requested due to automatic review settings May 18, 2025 13:55
@OrbisK OrbisK requested a review from danielroe as a code owner May 18, 2025 13:55
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR replaces manual setTimeout mocks in composables tests with Vitest’s fake timer API, enabling precise control over timer callbacks.

  • Swapped out vi.stubGlobal('setTimeout', ...) for vi.useFakeTimers()/vi.useRealTimers().
  • Added vi.advanceTimersToNextTimer() calls to flush pending timers between assertions.
  • Ensured real timers are restored at the end of each test.
Comments suppressed due to low confidence (1)

test/nuxt/composables.test.ts:993

  • There is a typo in the test description: 'stoping' should be 'stopping'.
it('expect loading state to be changed by force starting/stoping', async () => {

})
})

describe('loading state', () => {
it('expect error from loading state to be changed by finish({ error: true })', async () => {
vi.stubGlobal('setTimeout', vi.fn((cb: () => void) => cb()))
vi.useFakeTimers()
Copy link
Preview

Copilot AI May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After enabling fake timers, pending callbacks (e.g., from start() and finish()) won't run automatically; consider adding vi.advanceTimersToNextTimer() after those calls to ensure error.value is updated as expected.

Copilot uses AI. Check for mistakes.

Copy link

coderabbitai bot commented May 18, 2025

Walkthrough

The test file test/nuxt/composables.test.ts was updated to use Vitest's built-in fake timer utilities instead of manually stubbing setTimeout. The changes include replacing vi.stubGlobal('setTimeout', vi.fn(...)) with vi.useFakeTimers() at the start of each relevant test and vi.useRealTimers() at the end. Additionally, vi.advanceTimersToNextTimer() was added after asynchronous operations to advance timers and execute pending callbacks. These modifications affect four test cases related to loading state behaviour, but the test logic and assertions remain the same. No exported or public entity declarations were altered.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cfda706 and 4b172c0.

📒 Files selected for processing (1)
  • test/nuxt/composables.test.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: codeql (javascript-typescript)
  • GitHub Check: build
  • GitHub Check: code
🔇 Additional comments (4)
test/nuxt/composables.test.ts (4)

976-989: Great improvement using Vitest's fake timers instead of manual mocks

This change improves the test by leveraging Vitest's built-in timer mocking capabilities rather than manually stubbing the setTimeout function. By using vi.useFakeTimers() at the beginning and vi.useRealTimers() at the end, with strategic calls to vi.advanceTimersToNextTimer() after operations that might trigger timers, the test becomes more robust and maintainable.


994-1007: Consistent use of timer mocking across tests

The pattern of initializing fake timers, advancing them at appropriate points, and restoring real timers is consistently applied here, which is excellent for maintainability.


1012-1024: Proper timer setup for error state testing

Even though this test doesn't explicitly advance any timers, it's still a good practice to set up the fake timer environment for consistency with the other tests.


1029-1043: Complete test coverage with proper timer handling

This test thoroughly checks the set method with the force option, advancing timers after operations that modify the loading state. The consistent pattern of fake timer initialization and cleanup maintains the integrity of the test suite.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch test/timer-improvments
  • Post Copyable Unit Tests in Comment

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

pkg-pr-new bot commented May 18, 2025

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32142

nuxt

npm i https://pkg.pr.new/nuxt@32142

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32142

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32142

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32142

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32142

commit: 4b172c0

Copy link

codspeed-hq bot commented May 18, 2025

CodSpeed Performance Report

Merging #32142 will not alter performance

Comparing OrbisK:test/timer-improvments (4b172c0) with main (cfda706)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit edff94c into nuxt:main May 18, 2025
83 of 84 checks passed
@github-actions github-actions bot mentioned this pull request May 18, 2025
@github-actions github-actions bot mentioned this pull request May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy