fix: getShouldClockUpdate test

[alex-Arc]

It seams that using system time in github actions tests is unstable
and values from Date.now() should never be less than zero

[coderabbitai]

Walkthrough

The recent changes enhance the test suite for the getShouldClockUpdate function in the rundownService.utils.test.ts file. By incorporating beforeEach and afterEach hooks with controlled timer manipulation, the tests now utilize dynamic timestamps for more realistic scenarios. This adjustment improves test reliability and ensures that the function's behavior is accurately validated under varying time conditions.

Changes

File Path	Change Summary
apps/server/src/services/runtime-service/__tests__/rundownService.utils.test.ts	Modified test cases for getShouldClockUpdate to enhance timer control and realistic timestamp usage.

Sequence Diagram(s)

sequenceDiagram
    participant Test Suite
    participant Timer
    participant getShouldClockUpdate

    Test Suite->>Timer: Setup fake timers
    Timer-->>Test Suite: Timers controlled
    Test Suite->>getShouldClockUpdate: Call with previousUpdate and now
    getShouldClockUpdate-->>Test Suite: Return clock update decision
    Test Suite->>Timer: Cleanup timers

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a103f8b and ee265b2.

Files selected for processing (1)

• apps/server/src/services/runtime-service/tests/rundownService.utils.test.ts (2 hunks)

Additional comments not posted (6)

apps/server/src/services/runtime-service/__tests__/rundownService.utils.test.ts (6)

4-7: LGTM! The beforeEach hook is correctly setting up the test environment.

The fake timers and system time initialization ensure consistent test conditions.

---

9-11: LGTM! The afterEach hook is correctly restoring the test environment.

Restoring the real timers ensures proper cleanup after each test.

---

15-16: LGTM! The test case correctly simulates sliding forwards.

Setting previousUpdate to the current time and now to 2000 milliseconds in the future ensures accurate evaluation of the getShouldClockUpdate function.

---

22-23: LGTM! The test case correctly simulates sliding backwards.

Setting previousUpdate to 2000 milliseconds in the future and now to the current time ensures accurate evaluation of the getShouldClockUpdate function.

---

36-37: LGTM! The test case correctly simulates the clock being a second ahead.

Setting previousUpdate to MILLIS_PER_MINUTE - 100 and now to MILLIS_PER_MINUTE ensures accurate evaluation of the getShouldClockUpdate function.

---

36-37: LGTM! The test case correctly simulates the clock not being a second ahead.

Setting previousUpdate to the current time and now to 32 milliseconds in the future ensures accurate evaluation of the getShouldClockUpdate function.