Achievement fixes

[Sherin-2711]

Summary by CodeRabbit

• Refactor

  • Improved the logic for updating achievements, including clearer validation and better handling of update fields and image uploads.
  • Enhanced error messages for missing update fields.

• Tests

  • Expanded and reorganized tests for achievement updates to cover more scenarios, including successful updates with various fields and multiple error cases.
  • Improved test isolation and clarity.

[coderabbitai]

Walkthrough

The updateAchievementById controller was refactored to improve update payload handling, validation, and image processing. The corresponding test suite was rewritten and expanded to cover a broader range of success and error scenarios, increasing test granularity and coverage for the controller’s update logic.

Changes

Cohort / File(s)	Change Summary
Controller Refactor src/controllers/achievement.controller.ts	Refactored update logic to exclude memberIds from the main update payload, improved update field validation, clarified error messages, and adjusted image URL assignment.
Test Suite Rewrite & Expansion tests/Achievement.test.ts	Replaced a single broad test with multiple granular cases covering various update scenarios and error conditions, improved mock isolation, and enhanced test clarity and coverage.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Possibly related PRs

• Minor changes #20: Modifies image update and deletion logic in the achievement controller, overlapping with image handling changes in this PR.
• Achievements and Interviews routes #9: Introduces the original updateAchievementById controller, which this PR refactors and expands upon.

Suggested reviewers

• i-am-that-guy

Poem

In the garden of code where achievements bloom,
Refactors and tests sweep away the gloom.
Fields checked with care, images in tow,
Rabbits rejoice as coverage grows!
With every update, we hop with delight—
Bugs beware, we’re ready to fight! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 2c99e6d and 86fd720.

📒 Files selected for processing (2)

• src/controllers/achievement.controller.ts (3 hunks)
• tests/Achievement.test.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

tests/Achievement.test.ts (3)

src/controllers/achievement.controller.ts (1)

• updateAchievementById (74-134)

src/services/achievement.service.ts (1)

• updateAchievementById (70-88)

src/utils/apiError.ts (1)

• ApiError (7-18)

src/controllers/achievement.controller.ts (4)

src/utils/imageUtils.ts (1)

• uploadImage (23-70)

src/app.ts (1)

• supabase (13-16)

src/utils/apiError.ts (1)

• ApiError (7-18)

src/types/achievement.d.ts (1)

• UpdateAchievementInput (6-12)

🔇 Additional comments (15)

src/controllers/achievement.controller.ts (5)

84-91: Good defensive programming for JSON parsing.

The addition of JSON parsing with proper error handling is a solid improvement for handling multipart form data where JSON comes as a string.

---

103-107: LGTM!

The conditional image upload with existing imageUrl passed for potential overwrite is correctly implemented.

---

108-113: Excellent payload separation logic.

The destructuring to exclude memberIds from the main update payload and conditional assignment of imageUrl properly separates concerns and improves code clarity.

---

114-120: Improved validation logic with comprehensive error messaging.

The consolidated validation check ensures at least one field is provided for update, and the detailed error message clearly communicates all available update options to the client.

---

121-124: Correct service call with refined payload.

Using the refined updatePayload instead of raw achievementData properly aligns with the improved payload construction logic.

tests/Achievement.test.ts (10)

295-295: Good test setup improvements.

Adding the beforeEach hook for mock clearing ensures proper test isolation, and the empty members array makes the fixture more realistic.

Also applies to: 303-306

---

307-334: Comprehensive test for full update scenario.

This test properly covers the main success path with file upload, title update, and member addition. The mock setup and assertions are appropriate.

---

336-355: Good focused test for partial updates.

This test effectively verifies title-only updates and uses expect.objectContaining appropriately for flexible payload verification.

---

357-376: LGTM!

This test effectively covers image-only updates and properly verifies the image upload functionality is called.

---

378-395: Proper test for member-only updates.

This test correctly verifies that member updates are handled through the separate addMembersToAchievement service call.

---

397-406: Good validation test for required field.

This test properly verifies that missing updatedById triggers appropriate error handling.

---

408-417: LGTM!

This test appropriately covers input validation for invalid achievement ID format.

---

419-430: Proper test for not found scenario.

This test correctly verifies 404 error handling when the achievement doesn't exist in the database.

---

432-443: Important test for update validation.

This test correctly verifies the new validation logic that prevents updates when no actual fields are provided, avoiding unnecessary database operations.

---

445-454: Good test for JSON parsing error handling.

This test properly verifies the error handling for malformed JSON in the achievementData field, ensuring robustness of the parsing logic.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch achievement-fixes

---

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