Fix multiple primary attachments on a single item

[mwayne]

What type of PR is this?

• bug

What this PR does / why we need it:

• Prevents multiple primary attachments on a single item

Which issue(s) this PR fixes:

Fixes #283

Summary by CodeRabbit

• New Features

  • Updated attachment management to ensure only one primary attachment can be designated per item.

• Bug Fixes

  • Improved logic for identifying and updating attachments based on their type and primary status.

• Tests

  • Introduced a new test to validate the primary attachment functionality, ensuring correct behavior when multiple attachments exist.

[coderabbitai]

Walkthrough

The changes involve modifications to the AttachmentRepo struct in the repo_item_attachments.go file, specifically updating the Update method's signature and logic to focus on the attachment itself. Additionally, a new test function has been introduced in the repo_item_attachments_test.go file to ensure that only one attachment can be marked as primary at a time, addressing issues related to multiple primary attachments.

Changes

File Path	Change Summary
backend/internal/data/repo/repo_item_attachments.go	Updated Update method signature from itemID to id and modified logic for primary attachment handling.
backend/internal/data/repo/repo_item_attachments_test.go	Added TestAttachmentRepo_EnsureSinglePrimaryAttachment to verify single primary attachment behavior.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure only one primary photo can be set per item (Issue #283)	✅
Implement unique constraint for primary attachments (Issue #283)	❌	No unique constraint was added in the database.

🎉 In the realm of code where attachments play,
A single primary shines bright as the day.
No more duplicates, just one to adore,
With tests in place, we’re ready for more!
So here’s to the changes, both bold and bright,
In the world of attachments, all feels just right! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3a4c78e and d91251c.

📒 Files selected for processing (2)

• backend/internal/data/repo/repo_item_attachments.go (2 hunks)
• backend/internal/data/repo/repo_item_attachments_test.go (1 hunks)

🧰 Additional context used

🔇 Additional comments (2)

backend/internal/data/repo/repo_item_attachments_test.go (1)

137-157: LGTM! The test effectively ensures single primary attachment.

The new test function TestAttachmentRepo_EnsureSinglePrimaryAttachment correctly verifies that only one attachment can be set as primary at a time. This aligns with the PR objective of fixing the issue of multiple primary attachments on a single item.

Security Recommendation: While using context.Background() is appropriate for this test, ensure that in production code, especially when handling user data or sensitive information, you use a context with proper cancellation and timeout mechanisms to prevent potential security issues related to long-running operations or resource exhaustion.

To verify the security of context usage in the main code, you can run the following script:

backend/internal/data/repo/repo_item_attachments.go (1)

Line range hint 90-126: Consider enforcing a unique constraint on primary attachments per item

While the code unsets the Primary flag on other attachments programmatically, there is a potential for race conditions if multiple updates occur concurrently. To prevent multiple attachments from being marked as primary for the same item, consider adding a unique constraint at the database level on the combination of item_id and primary fields.

Run the following script to check if a unique constraint exists on primary attachments per item:

---

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

[katosdev]

Looks good to me @mwayne - Might be good to add a database constraint per the issue, if possible?

[katosdev]

Paging @tankerkiller125 for the CI tests (Far more knowledgeable than I am! 🙂)

[tankerkiller125]

Paging @tankerkiller125 for the CI tests (Far more knowledgeable than I am! 🙂)

Ignore the frontend tests for now, I haven't yet figured out how to get those fixed. As long as the backend ones are passing and docker is passing it's good enough for now.