TracecatHQ / tracecat

The open source Tines / Splunk SOAR alternative for security engineers.
https://tracecat.com
GNU Affero General Public License v3.0
2.42k stars 173 forks source link

fix(ui): Properly handle registry action loading state in action panel #510

Closed daryllimyt closed 2 weeks ago

daryllimyt commented 2 weeks ago

Self explanatory

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes made to the ActionPanel component in the frontend/src/components/workbench/panel/action-panel.tsx file include the addition of a new property, registryActionsIsLoading, from the useWorkbenchRegistryActions hook. This update modifies the loading state check to display a loading spinner if either actionIsLoading or registryActionsIsLoading is true. The error handling in the handleSave function remains unchanged, but the control flow is adjusted to incorporate the new loading state while retaining existing error messages.

Changes

File Path Change Summary
frontend/src/components/workbench/panel/action-panel.tsx Added registryActionsIsLoading to the destructured return of useWorkbenchRegistryActions. Updated loading state check to include the new property. Control flow adjusted in handleSave, but error handling remains unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ActionPanel
    participant WorkbenchRegistryActions

    User->>ActionPanel: Trigger action
    ActionPanel->>WorkbenchRegistryActions: Call useWorkbenchRegistryActions()
    WorkbenchRegistryActions-->>ActionPanel: Return { getRegistryAction, registryActionsIsLoading }
    alt Loading state
        ActionPanel->>User: Show loading spinner
    else Not loading
        ActionPanel->>User: Show action result
    end

🐰 "In the panel, where actions play,
A new loading state comes to stay.
With spins and waits, we now can see,
If actions are quick or take a spree.
Errors still whisper, but now we know,
When loading's afoot, we won't feel low!" 🌟


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 9c6c86a76cb27a3db768157db530ec45638ac73e and ec6631993f4b1adb2596785fd7f5f9d5e1fb87e0.
📒 Files selected for processing (1) * `frontend/src/components/workbench/panel/action-panel.tsx` (2 hunks)
🔇 Additional comments (2)
frontend/src/components/workbench/panel/action-panel.tsx (2) `142-143`: **LGTM: Clean hook usage.** The addition of `registryActionsIsLoading` from the `useWorkbenchRegistryActions` hook is well-implemented and follows React conventions. --- `258-258`: **LGTM: Proper loading state handling.** The combined loading check `actionIsLoading || registryActionsIsLoading` ensures the UI shows a loading indicator until all data is ready, preventing potential display of incomplete information.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.