feat: Add test cases for PATCH /requests/:id API for acknowledging OOO requests

[surajmaity1]

Date: 22 Mar, 2025

Developer Name: Suraj Maity ( @surajmaity1 )

---

Issue Ticket Number

• Open https://github.com/Real-Dev-Squad/website-backend/issues/2242

Description

This PR adds test cases for the PATCH /requests/:id API for acknowledging OOO requests to ensure its correctness and reliability. The tests cover the following scenarios:

• Valid input for acknowledging OOO request.
• Authentication and authorization checks.
• Error handling for edge cases and unexpected failures.

Documentation Updated?

• [ ] Yes
• [x] No

Under Feature Flag

• [x] Yes
• [ ] No

Database Changes

• [ ] Yes
• [x] No

Breaking Changes

• [ ] Yes
• [x] No

Development Tested?

• [x] Yes
• [ ] No

Test Coverage

Screenshot 1

Additional Notes

• Feature PR https://github.com/Real-Dev-Squad/website-backend/pull/2384

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Summary by CodeRabbit

• New Features

  • Introduced enhanced out-of-office request acknowledgment, allowing clearer feedback when processing approval or rejection actions.

• Bug Fixes

  • Improved error handling to ensure users receive appropriate messages for unauthorized access, invalid request types, duplicate processing, or unexpected issues.

Walkthrough

The changes enhance the functionality and test coverage for out-of-office (OOO) requests. New constants for creating and acknowledging OOO requests were added to a fixture file. Integration tests now cover the PATCH /requests/:id endpoint for various error conditions and success scenarios during request acknowledgment. Additionally, unit tests have been expanded to verify the behavior of the OOO request validator and service functions under valid and invalid conditions.

Changes

File(s)	Change Summary
test/fixtures/.../oooRequest.ts	Added two new exported constants: createOooRequests3 (for creating an OOO request with preset properties) and acknowledgeOooRequest (to represent approval with a comment for emergency situations).
test/integration/requests.test.ts	Introduced a new test suite for the PATCH /requests/:id endpoint, defining variables to manage request states and covering scenarios such as unauthorized access, feature not implemented, non-existent requests, and error cases.
test/unit/{middlewares/oooRequests.test.ts, services/oooRequest.test.ts}	Added unit test suites: one for acknowledgeOOORequestsValidator to check request validity, and another for the OOO Request Service (including validateOOOAcknowledgeRequest and acknowledgeOOORequest) for handling both successful and exceptional cases.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Validator
    participant Service

    Client->>API: PATCH /requests/{id} (acknowledge OOO request)
    API->>Validator: Run acknowledgeOOORequestsValidator
    alt Validation Success
        API->>Service: Process OOO request acknowledgment
        Service-->>API: Return success response
        API-->>Client: 200 OK (acknowledged)
    else Validation Failure
        API-->>Client: Error response (400/401/404/501)
    end

Poem

I'm a bunny hopping through the code,
With new tests shining on the road.
OOO requests now run so clear,
Each patch and validator brings cheer.
Hoppy carrots and joy abound,
In this patch of code, magic is found!

---

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

• 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>, 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.

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 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.

[prakashchoudhary07]

@surajmaity1 Error in build it self, please have a look

[prakashchoudhary07]

@surajmaity1 Build is faling, please check

[surajmaity1]

@surajmaity1 Build is faling, please check

Hi @prakashchoudhary07 , it's fixed. Thank you.

[surajmaity1]

@surajmaity1 Error in build it self, please have a look

Hi @prakashchoudhary07 , it's fixed now. Thank you.