refactor(server): simplify copy logic

[nourbalaha]

Overview

This PR refactors the copy function to simplify its logic and merge related functionalities.

Summary by CodeRabbit

• Refactor
  • Improved the model copying process with enhanced logging and error handling
  • Streamlined the method for creating model copies by consolidating multiple helper functions
  • Refined the schema and metadata copying mechanism for more robust model duplication

[coderabbitai]

Walkthrough

The pull request modifies the Copy method in the Model struct within the server/internal/usecase/interactor/model.go file. The changes restructure the model copying process by introducing a more comprehensive approach to retrieving, creating, and logging model copies. The implementation now explicitly fetches the old model, creates a new model with derived parameters, and handles schema and metadata copying with more detailed logging and error management.

Changes

File	Change Summary
server/internal/usecase/interactor/model.go	- Completely rewrote Copy method implementation - Removed helper methods: copyModel, copySchema, and copyMetaSchema - Enhanced logging and error handling for model copying process - Integrated schema and metadata copying directly into main method

Sequence Diagram

sequenceDiagram
    participant Caller
    participant ModelInteractor
    participant ModelRepository
    participant SchemaRepository
    
    Caller->>ModelInteractor: Copy(ctx, params, operator)
    ModelInteractor->>ModelRepository: FindByID(old model)
    ModelRepository-->>ModelInteractor: Return old model
    ModelInteractor->>ModelInteractor: Create new model
    ModelInteractor->>SchemaRepository: Copy schema
    ModelInteractor->>SchemaRepository: Copy metadata schema
    ModelInteractor-->>Caller: Return new model

Loading

Possibly related PRs

• chore(server): add logging to copier #1351: Adds logging to the Copy method and its helper methods within the Model struct

Suggested reviewers

• yk-eukarya
• rot1024

Poem

🐰 A Rabbit's Ode to Model Copying

With hops and jumps, I copy with grace,
Old models transformed in this coding space,
Logs shine bright, schemas dance anew,
A refactored method, clean and true!
🔍✨

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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. (Beta)
• @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.

[netlify]

✅ Deploy Preview for reearth-cms canceled.

Name	Link
🔨 Latest commit	aa31342
🔍 Latest deploy log	https://app.netlify.com/sites/reearth-cms/deploys/6787cd0202a3f40008ac3bb3

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

server/internal/usecase/interactor/model.go (1)

442-445: Consider handling missing TaskRunner more robustly

In the triggerCopyEvent method, if the TaskRunner is not configured (i.gateways.TaskRunner == nil), the method logs a debug message and returns nil. Consider returning an error or a warning to alert that the copy operation may not proceed as expected, which can help in troubleshooting.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 02d5f54 and aa31342.

📒 Files selected for processing (1)

• server/internal/usecase/interactor/model.go (2 hunks)

🔇 Additional comments (4)

server/internal/usecase/interactor/model.go (4)

336-339: Ensure the uniqueness of the new model's key

When assigning params.Key to the new model, verify that the key is unique within the project to prevent conflicts. Although the Create method checks for duplicate keys, it's important to confirm that potential duplicates are handled gracefully.

---

366-369: Verify that CopyFrom handles IDs correctly

Ensure that calling newSchema.CopyFrom(oldSchema) copies the necessary fields without overwriting the new schema's ID or other unique identifiers. This is crucial to prevent ID conflicts in the database.

---

395-405: Confirm metadata schema copying maintains unique IDs

When copying the metadata schema with newMetaSchema.CopyFrom(oldMetaSchema), verify that the new metadata schema retains its unique ID and does not inadvertently copy over the old schema's ID. Proper handling ensures data integrity.

---

325-414: Refactored Copy method improves clarity and functionality

The updated Copy method enhances code clarity by integrating copying logic directly into the method and removing redundant helper functions. The detailed logging and explicit handling of models, schemas, and metadata contribute to better maintainability and traceability.