website-backend icon indicating copy to clipboard operation
website-backend copied to clipboard

Chore: Update API response to replace task status "COMPLETED" with "DONE"

Open vaishalimaheshwari2000 opened this issue 8 months ago • 2 comments

Date: 30-04-2025

Developer Name: Vaishali


Issue Ticket Number

#2404

Description

This pull request updates the task status terminology from "COMPLETED" to "DONE" across the API responses and corresponding test cases. This change aligns with the updated terminology used across the system and improves clarity and consistency between backend logic, frontend usage, and developer understanding.

  • This PR is only for the API response , for DB next PR will be release later

Documentation Updated?

  • [ ] Yes
  • [x] No

Under Feature Flag

  • [ ] Yes
  • [x] No

Database Changes

  • [ ] Yes
  • [x] No

Breaking Changes

  • [ ] Yes
  • [x] No

Development Tested?

  • [ ] Yes
  • [x] No

ScreenShots

Screenshot 1

Screenshot 2025-04-30 003733

Screenshot 2

image

Screenshot 3

Screenshot 2025-04-30 001609

Screenshot 4

Screenshot 2025-04-30 014109

Test Coverage

Screenshot 1

Screenshot 2025-04-30 214019

Screenshot 2

Screenshot 2025-04-30 213939

Additional Notes

vaishalimaheshwari2000 avatar Apr 29 '25 19:04 vaishalimaheshwari2000

[!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

  • Refactor
    • Standardized task status values in API responses, ensuring all "COMPLETED" statuses are now returned as "DONE" across all task-related endpoints. This provides a more consistent experience when viewing task statuses.

Walkthrough

The changes standardize the task status value returned by several endpoints in the controllers/tasks.js file. Specifically, any task with a status of "COMPLETED" is now transformed to "DONE" before being sent in API responses. This transformation is applied within the fetchTasks, getUserTasks, getSelfTasks, and getTask functions. The underlying data and function signatures remain unchanged; only the outgoing response is affected to ensure consistent status naming.

Changes

File(s) Change Summary
controllers/tasks.js Updated response logic in fetchTasks, getUserTasks, getSelfTasks, and getTask to map status "COMPLETED" to "DONE" before returning tasks. No changes to function signatures or data storage.

Poem

In the meadow where tasks are spun, "COMPLETED" transforms—its work is done. Now "DONE" is the word that hops along, In every response, it sings its song. A tidy change, so neat and bright, Task statuses now just feel right! 🐇✨


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

coderabbitai[bot] avatar Apr 29 '25 19:04 coderabbitai[bot]

@vaishalimaheshwari2000 why make a controller level update on a separate pr and proposing to create a separate pr for db level ?

Consider creating a transformer (for backword compatibility) , when returning any task , send it to the transformer firstly that way you don't have to manually change completed to done everywhere

Note: From issue #2104

suggestion was said after wrapper "Once the DB has no more "COMPLETED" entries, remove the wrapper logic from step 1."

if you do write the script then you can still leave the transformer though, can be useful (you can add a note as to why it was added )

JC-Coder avatar May 20 '25 23:05 JC-Coder