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

Add error handling for media update when file is missing or invalid #35

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rahmatsubandi
Copy link

@rahmatsubandi rahmatsubandi commented Feb 28, 2025

In this fix I added error handling when I do drag n drop on the column but the image is empty/not uploaded which causes an error:
array_keys(): Argument #1 ($array) must be of type array, null given

The improvements I made were to add conditions such as:

if (is_array($item) && isset($item['file']) && is_array($item['file']) && !empty($item['file'])) {
    $media = Media::where('uuid', array_keys($item['file'])[0])->first();
    if($media){
        $media->update([
            'order_column'=> $counter
            ]);
        }
    }

so around line 192 in the MediaManagerInput.php file the complete code now is:

$this->reorderAction(static function (Action $action): void {
    $action->action(function (array $arguments, Repeater $component): void {
        $items = [
            ...array_flip($arguments['items']),
            ...$component->getState(),
        ];
        $counter=0;
        foreach ($items as $item){
            if (is_array($item) && isset($item['file']) && is_array($item['file']) && !empty($item['file'])) {
                $media = Media::where('uuid', array_keys($item['file'])[0])->first();
                if($media){
                    $media->update([
                        'order_column'=> $counter
                    ]);
                }
            }
            $counter++;
        }

        $component->state($items);

        $component->callAfterStateUpdated();
    });
});

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **Bug Fixes**
	- Enhanced media input handling by adding additional validation to ensure file data is properly structured, reducing potential errors during processing.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Copy link

coderabbitai bot commented Feb 28, 2025

Walkthrough

This change updates the MediaManagerInput class by enhancing the setUp method with a conditional check. Before retrieving a Media instance using the UUID, the method now verifies that the $item is an array that contains a non-empty 'file' key. If the condition is met, the method continues to update the order_column; otherwise, it avoids processing, thereby reducing potential errors from unexpected array structures.

Changes

File Change Summary
src/Form/MediaManagerInput.php Modified the setUp method to add a conditional check ensuring $item is an array with a non-empty 'file' key before retrieving a Media instance.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant MMI as MediaManagerInput
    participant Media as Media Entity

    C->>MMI: Call setUp($item)
    alt $item valid (array with non-empty 'file')
        MMI->>Media: Retrieve Media instance using UUID
        Media-->>MMI: Return Media instance
        MMI->>Media: Update order_column
    else $item invalid
        MMI-->>C: Skip Media retrieval and order update
    end
Loading

Possibly related PRs

Poem

I'm a bunny, hopping through code so fine,
Checking arrays and keys in a perfect line.
With each careful hop, validations shine through,
Making order in media, fresh as morning dew.
In the realm of logic, my little leaps break through!

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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: 0

🧹 Nitpick comments (1)
src/Form/MediaManagerInput.php (1)

199-205: Good addition of validation checks to prevent errors with invalid media items.

The conditional checks added here effectively prevent the array_keys(): Argument #1 ($array) must be of type array, null given error mentioned in the PR objectives. The code now properly validates that:

  1. $item is an array
  2. $item has a 'file' key
  3. The 'file' value is an array
  4. The 'file' array is not empty

Additionally, the nested check for $media existence before updating is a good defensive programming practice.

Consider adding logging when the validation fails to aid in debugging future issues. For example:

 if (is_array($item) && isset($item['file']) && is_array($item['file']) && !empty($item['file'])) {
     $media = Media::where('uuid', array_keys($item['file'])[0])->first();
     if($media){
         $media->update([
             'order_column'=> $counter
         ]);
     }
+} else {
+    \Illuminate\Support\Facades\Log::debug('MediaManagerInput: Skipping invalid media item', [
+        'item' => $item
+    ]);
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a22420f and f0be924.

📒 Files selected for processing (1)
  • src/Form/MediaManagerInput.php (1 hunks)

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

Successfully merging this pull request may close these issues.

1 participant