Skip to content

chore: fix flaky api key test #1357

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.

Sign up for GitHub

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

Jump to bottom
Merged
elibosley merged 1 commit into from
Apr 14, 2025
Merged

chore: fix flaky api key test #1357

elibosley merged 1 commit into from
Apr 14, 2025

Conversation

@elibosley
Copy link
Member

@elibosley elibosley commented Apr 14, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Tests
    • Improved test validations to flexibly verify dynamic timestamp values in API responses.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 14, 2025 •
edited
Loading

Walkthrough

This pull request updates the test assertions for the ApiKeyService. The tests now use .toMatchObject instead of .toEqual to perform flexible object comparisons. With this change, the createdAt property in API key objects is allowed to be any string while ensuring the rest of the object’s structure matches the expected properties.

Changes

File(s) Change Summary
api/src/.../api-key.service.spec.ts Replaced .toEqual with .toMatchObject in test assertions for both findAll and findById methods to allow for a flexible match on the createdAt field.

Poem

In tests, a tweak so neat,
Flexibility now takes the seat.
Timestamps flow as free as air,
Matching objects with gentle care.
Code and tests now dance in time!
🎉🚀

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 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 2345732 and 4b7feef.

📒 Files selected for processing (1)
  • api/src/unraid-api/auth/api-key.service.spec.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build Web App
  • GitHub Check: Build API
  • GitHub Check: Test API
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
api/src/unraid-api/auth/api-key.service.spec.ts (2)

320-321: Good change to fix flaky test!

Changing from toEqual to toMatchObject with expect.any(String) for the createdAt field is a good approach to fix flaky tests. This allows the test to focus on the structure and content of the API key objects while being flexible about the exact timestamp value.

337-337: Consistent fix applied here too

The same improvement is correctly applied here as well, using toMatchObject with expect.any(String) for the createdAt field. This ensures consistent handling of timestamp fields across tests.

✨ Finishing Touches
  • 📝 Generate Docstrings
🪧 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.
    • 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 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 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 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 14, 2025

This plugin has been deployed to Cloudflare R2 and is available for testing.
Download it at this URL:

https://preview.dl.unraid.net/unraid-api/tag/PR1357/dynamix.unraid.net.plg

@elibosley elibosley merged commit 33ad1fd into main Apr 14, 2025
9 checks passed
@elibosley elibosley deleted the chore/flaky-test branch April 14, 2025 15:45
mdatelle pushed a commit that referenced this pull request Apr 14, 2025
@elibosley
chore: fix flaky api key test (#1357)
cd12184 
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Tests**
- Improved test validations to flexibly verify dynamic timestamp values
in API responses.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@coderabbitai coderabbitai bot mentioned this pull request Apr 15, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Jun 18, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Aug 21, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pujitm pujitm Awaiting requested review from pujitm

@mdatelle mdatelle Awaiting requested review from mdatelle

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@elibosley