chore(fix): fix related articles logic

[losndu]

Summary by CodeRabbit

• New Features

  • Enhanced management of related articles in the admin interface.
  • Introduced temporary storage for related articles during the article creation process.

• Bug Fixes

  • Improved validation to prevent self-references in related articles.
  • Enhanced error handling for circular references and maximum limits on related articles.

• Documentation

  • Updated comments for clarity in the article creation and update processes.

[coderabbitai]

Walkthrough

The pull request introduces significant modifications to the handling of related articles in the admin interface and models. Key changes include updates to the RelatedArticleInline and ArticleAdmin classes to improve the selection and management of related articles. Additionally, the Article and RelatedArticle models receive enhancements for managing temporary related articles and ensuring robust validation against circular references. The serializer for article creation and updates is also refined to streamline the process and improve validation logic.

Changes

File Path	Change Summary
server/apps/research/admin/article_admin.py	- Updated RelatedArticleInline.formfield_for_foreignkey to handle None obj_id and filter articles by status. - Modified ArticleAdmin.get_inlines to always return RelatedArticleInline. - Added ArticleAdmin.save_related method for processing related articles during save.
server/apps/research/models/article.py	- Added Article.set_temp_related_articles method for temporary related articles. - Updated Article.save to create related articles only if new and temporary articles exist. - Enhanced RelatedArticle.clean method for circular reference checks and updated save method for transaction management.
server/apps/research/serializers/article_serializer.py	- Renamed validate_related_articles_ids to validate_related_article_ids and improved validation logic. - Streamlined article creation in create method. - Updated comments in update method for clarity on handling related articles.

Possibly related PRs

• chore(feat): add relatedArticles logic #198: This PR modifies the RelatedArticleInline and ArticleAdmin classes in article_admin.py, which are directly related to the changes made in the main PR regarding the handling of related articles in the admin interface.

Poem

🐇 In the garden of articles, we weave a tale,
With threads of relation, we never fail.
No more self-references, just ready to share,
A hop and a skip, we handle with care.
So let’s save our stories, both near and far,
In the admin's embrace, we shine like a star! ✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6a5f738 and 4ebf126.

📒 Files selected for processing (1)

• server/apps/research/models/article.py (4 hunks)

🔇 Additional comments (6)

server/apps/research/models/article.py (6)

122-129: Proper handling of temporary related articles in the save method

The implementation for handling temporary related articles when saving a new article is correctly implemented. The checks for is_new and the use of transaction.atomic() ensure data integrity.

---

161-170: Transaction ensures atomicity when saving the article and related articles

The use of with transaction.atomic() around super().save() and the creation of RelatedArticle instances ensures that the operation is atomic and will roll back entirely if an error occurs.

---

171-178: New method set_temp_related_articles facilitates pre-save handling

The method set_temp_related_articles neatly allows temporary storage of related articles before the article is saved, ensuring they are properly associated post-save without risking integrity errors.

---

222-229: Enhanced circular reference check in clean method

The clean method now robustly checks for circular references by verifying primary keys and querying for existing inverse relationships, preventing the creation of direct circular references.

---

231-236: Validation for maximum number of related articles is correct

The validation correctly limits the number of related articles to a maximum of 3, preventing over-association and ensuring that each article maintains a manageable set of related articles.

---

239-247: Database lock properly acquired in save method of RelatedArticle

By evaluating the select_for_update() queryset with .exists(), the code now properly acquires a database lock on from_article, ensuring consistency during related article creation and addressing potential race conditions.

---

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 generate docstrings to generate docstrings for this PR. (Experiment)
• @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]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)

server/apps/research/serializers/article_serializer.py (2)

82-93: Use set_temp_related_articles method for consistent handling

In the create method, related articles are being created directly after the article is saved. Since the Article model now supports setting temporary related articles via the set_temp_related_articles method, consider using this method to leverage the model's logic and maintain consistency.

Update the create method to set temporary related articles before saving:

# Create the article instance without saving
article = Article(**validated_data)

# Set temporary related articles
if related_article_ids:
    article.set_temp_related_articles(related_article_ids)

# Save the article, which will handle related articles in the `save` method
article.save()

# Handle authors and categories after saving
if authors:
    article.authors.set(authors)
if categories:
    article.categories.set(categories)

This approach utilizes the Article model's save method to handle related articles, ensuring consistency and encapsulating the logic within the model.

---

Line range hint 114-123: Consider updating self-reference validation during creation

In the validate_related_article_ids method, the self-reference check uses instance.id, which is None during creation. This means self-references might not be caught when creating a new article.

Modify the validation to handle the creation scenario:

# Check for self-reference
if self.instance:
    article_id = self.instance.id
else:
    # If creating, article_id can be derived from validated data or set to None
    article_id = None

if article_id in [article.id for article in value]:
    raise serializers.ValidationError("An article cannot be related to itself.")

Or, since the article doesn't have an ID yet during creation, you can prevent including the article's own ID in related_article_ids.

server/apps/research/admin/article_admin.py (1)

61-69: Remove unnecessary override of save_related method

In ArticleAdmin, the save_related method is overridden but does not add any additional functionality beyond calling super().save_related. The loop over formsets does not perform any operations.

Consider removing the save_related method override to simplify the code unless you plan to add custom processing for related articles.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cec8247 and 6a5f738.

📒 Files selected for processing (3)

• server/apps/research/admin/article_admin.py (2 hunks)
• server/apps/research/models/article.py (4 hunks)
• server/apps/research/serializers/article_serializer.py (2 hunks)