Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support bulk backup backing images #836

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

houhoucoop
Copy link
Contributor

@houhoucoop houhoucoop commented Dec 23, 2024

What this PR does / why we need it

  • Allow to bulk backup backing images to different backup target

Issue

[UI][FEATURE] Multiple backup stores support #8647

Test Result

  • Go to the Backing Image page
  • Select multiple backing images and click the bulk action Backup
  • When the modal pop up, select a target and click Backup
    Screenshot 2024-12-23 at 4 25 37 PM (2)
  • The backups should be created successfully.

Additional documentation or context

Test with LONGHORN_MANAGER_IP=http://134.209.101.112:30001/ npm run dev

Summary by CodeRabbit

  • New Features

    • Introduced a backup modal with enhanced user interaction for bulk actions.
    • Added support for selecting backup targets in the backup process.
  • Bug Fixes

    • Improved state management and organization of action handling within the bulk actions component.
  • Style

    • Updated styles for bulk action buttons and the backup modal for better responsiveness and visual clarity.
  • Documentation

    • Enhanced PropTypes validation to ensure required props are passed to components.

Signed-off-by: Yi-Ya Chen <[email protected]>
@houhoucoop houhoucoop self-assigned this Dec 23, 2024
Copy link

coderabbitai bot commented Dec 23, 2024

Walkthrough

This pull request introduces modifications to the backing image management system, focusing on enhancing the bulk backup functionality. The changes span multiple files, including the model, routes, and styling components. The primary updates involve refactoring the bulkBackup effect to include more contextual information, transforming the BackingImageBulkActions component into a more structured functional component, and adding corresponding styling for the new backup modal and action buttons.

Changes

File Change Summary
src/models/backingImage.js Updated bulkBackup effect to pass both URL and bi object to execAction
src/routes/backingImage/BackingImageBulkActions.js Converted to functional component with React hooks, added backup modal handling, enhanced prop types
src/routes/backingImage/BackingImageBulkActions.less Added new CSS classes for bulk action buttons and backup modal styling
src/routes/backingImage/index.js Introduced backupTargets variable to consolidate backup target retrieval

Sequence Diagram

sequenceDiagram
    participant User
    participant BulkActions
    participant BackupModal
    participant BackupService

    User->>BulkActions: Select backing images
    User->>BulkActions: Trigger Backup
    BulkActions->>BackupModal: Open Backup Modal
    User->>BackupModal: Select Backup Target
    User->>BackupModal: Confirm Backup
    BackupModal->>BackupService: Execute Backup
    BackupService-->>BulkActions: Backup Completed
Loading

Possibly related PRs

Suggested Labels

require backport v1.8

Suggested Reviewers

  • derekbit
  • a110605
  • mantissahz

Poem

🐰 Backup Bunny's Ballad 🔒

With hooks and modals, sleek and bright,
Backing images take their flight
Targets selected, actions clear
A rabbit's touch brings data near!
Hop, hop, backup with delight! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (4)
src/models/backingImage.js (1)

215-215: Add error handling and consider concurrency.

While passing both the URL and the backing image object to execAction helps provide context, note the following potential improvements:
• Handle potential errors or failures returned from the call to execAction, e.g., by assessing resp.status or using try/catch for robust error handling.
• If the payload array can be large, running each backup sequentially may be slow. Introducing concurrency (e.g., using Promise.all or dispatching multiple sagas) could improve performance and user experience.

src/routes/backingImage/BackingImageBulkActions.js (2)

145-179: Form validation could be enhanced.
Currently, the user can proceed without choosing a valid target if the default is missing. Consider marking the 'Backup Target' field as required for a smoother UX.


193-193: Legacy Form.create() usage
Form.create() indicates usage of an older Ant Design pattern. Confirm this is intentional and supported, or consider the newer hooks-based form if upgrading.

src/routes/backingImage/index.js (1)

128-128: Single retrieval of backup targets is clean.
Storing backupTargets in a variable improves readability and avoids repeated calls to getBackupTargets.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ddfa9dd and 053f413.

📒 Files selected for processing (4)
  • src/models/backingImage.js (1 hunks)
  • src/routes/backingImage/BackingImageBulkActions.js (1 hunks)
  • src/routes/backingImage/BackingImageBulkActions.less (1 hunks)
  • src/routes/backingImage/index.js (4 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/routes/backingImage/BackingImageBulkActions.less
🔇 Additional comments (8)
src/routes/backingImage/BackingImageBulkActions.js (6)

1-3: Imports look consistent and necessary.
These imports are all used, and there are no obvious redundancies.


7-15: Good use of default values for props.
Destructuring the props with default values (backupTargets = [], form = {}) helps avoid runtime errors if these props are undefined.


33-54: Deletion confirmation is well-structured.
The code clearly displays a list of selected items before confirming deletion, improving user awareness. No changes suggested.


83-85: Exposing backup modal via state is straightforward.
Toggling the backup modal using a boolean state is simple and effective.


114-117: Disable condition for 'Download' action is appropriate.
It excludes rows that are not ready or use the v2 data engine, avoiding partial/inconsistent downloads.


183-190: PropTypes are thorough.
Marking each prop as required clarifies usage and prevents runtime issues.

src/routes/backingImage/index.js (2)

183-183: Passing backupTargets to modals and bulk actions.
This maintains consistency across components and reduces duplication.

Also applies to: 331-331


349-349: Minor structural update.
No issues identified at line 349; the change appears to be a closing brace or an updated line break.

@a110605
Copy link
Contributor

a110605 commented Dec 23, 2024

All UI changes are good. But I can't backup any backing image in cifs backup target.

Screenshot 2024-12-23 at 4 54 36 PM

POST /v1/backingimages/parrot?action=backupBackingImageCreate return 200 ok.
GET /v1/backupbackingimages has below error in data. cc @ChanYiLin

rpc error: code = Unknown desc = failed to create backup parrot: cannot mount CIFS share longhorn-test-cifs-svc.default/backupstore, options [soft]: mount failed: exit status 32\nMounting command: mount\nMounting arguments: -t cifs -o soft,<masked>,<masked> //longhorn-test-cifs-svc.default/backupstore /var/lib/longhorn-backupstore-mounts/longhorn-test-cifs-svc_default/backupstore\nOutput: mount: /var/lib/longhorn-backupstore-mounts/longhorn-test-cifs-svc_default/backupstore: bad option; for several filesystems (e.g. nfs, cifs) you might need a /sbin/mount.<type> helper program.\n       dmesg(1) may have more information after failed mount system call.\n

Copy link
Contributor

@a110605 a110605 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@a110605 a110605 merged commit 21c4758 into longhorn:master Dec 23, 2024
8 checks passed
@houhoucoop
Copy link
Contributor Author

@mergify backport v1.8.x

Copy link

mergify bot commented Dec 23, 2024

backport v1.8.x

✅ Backports have been created

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants