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

singletone action upload in appendmode fix #1609

Conversation

hasinaxp
Copy link
Contributor

@hasinaxp hasinaxp commented Nov 29, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced action management to prevent duplicate actions when adding new ones, ensuring only unique actions are retained.
    • Introduced support for live agent actions in the action serializer.
  • Bug Fixes

    • Improved error handling during action configuration to raise exceptions for existing forms with the same name.
  • Tests

    • Added new tests to verify the handling of live agent actions and prevent duplication during deserialization.

Copy link

coderabbitai bot commented Nov 29, 2024

Walkthrough

The changes involve modifications to the ActionSerializer class in the kairon/shared/data/action_serializer.py file, specifically to the deserialize method. A new conditional block was added to prevent the addition of duplicate actions when the overwrite parameter is set to False and the action type is single_instance. Additionally, the error handling was improved to raise an AppException if a form with the same name already exists, enhancing the robustness of the action configuration process.

Changes

File Path Change Summary
kairon/shared/data/action_serializer.py Modified the deserialize method to prevent duplicate actions when overwrite is False and the action is single_instance. Improved error handling to raise an AppException for existing forms with the same name.
tests/unit_test/data_processor/action_serializer_test.py Added a new test method test_action_serializer_deserialize_single_instance_append() to verify the behavior of the deserialize method with live agent actions, checking for duplicates. Imported LiveAgentActionConfig.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ActionSerializer
    participant Database

    User->>ActionSerializer: Call deserialize(bot, user, actions, overwrite=False)
    ActionSerializer->>Database: Check for existing action
    alt Action exists
        ActionSerializer-->>User: Raise AppException (duplicate action)
    else Action does not exist
        ActionSerializer->>Database: Add new action
        ActionSerializer-->>User: Confirm action added
    end
Loading

🐇 "In the land where actions play,
Unique ones will find their way.
With care we check, no duplicates here,
A robust dance, let’s all cheer!
For every form, a name so bright,
In our garden, all feels right!" 🌼


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

🧹 Outside diff range and nitpick comments (1)
kairon/shared/data/action_serializer.py (1)

341-344: LGTM! Consider adding documentation.

The logic correctly prevents duplicate single instance actions in append mode. This fixes the singleton action upload issue.

Consider adding a comment to explain the single instance behavior:

                     if action_info.get('single_instance'):
                         if overwrite:
                             filtered_actions[action_type] = actions[action_type]
                         else:
+                            # Skip adding new actions if a single instance action already exists
                             existing_action = action_info.get("db_model").objects(bot=bot).first()
                             if not existing_action:
                                 filtered_actions[action_type] = actions[action_type]
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 48554f8 and d2c663d.

📒 Files selected for processing (1)
  • kairon/shared/data/action_serializer.py (1 hunks)

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

🧹 Outside diff range and nitpick comments (2)
tests/unit_test/data_processor/action_serializer_test.py (2)

610-610: Remove debug print statement

The print(action_names) statement appears to be a debugging artifact and should be removed.

-    print(action_names)

612-613: Optimize variable usage

The names variable is redundant as action_names already contains the same data. Consider using action_names directly.

-    names = [action.name for action in actions_added]
-    assert "live_agent_action" in names
+    assert "live_agent_action" in action_names
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d2c663d and 0864e9f.

📒 Files selected for processing (1)
  • tests/unit_test/data_processor/action_serializer_test.py (2 hunks)
🔇 Additional comments (2)
tests/unit_test/data_processor/action_serializer_test.py (2)

6-6: LGTM!

The import of LiveAgentActionConfig is correctly added to support the new test cases.


591-623: LGTM! Well-structured test cases

The test function effectively verifies the single instance behavior of live agent actions:

  1. Successfully adds a new live agent action when it doesn't exist
  2. Correctly handles duplicate attempts by maintaining only one instance

@hiteshghuge hiteshghuge merged commit c3def34 into digiteinfotech:master Dec 4, 2024
8 checks passed
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.

2 participants