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

fix: get the key safely #592

Merged
merged 1 commit into from
Jan 22, 2025
Merged

fix: get the key safely #592

merged 1 commit into from
Jan 22, 2025

Conversation

Hrishabh17
Copy link
Contributor

@Hrishabh17 Hrishabh17 commented Jan 22, 2025

Description

fix detination attribute get detail dict value safely

Clickup

https://app.clickup.com/

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling when retrieving employee details
    • Enhanced robustness of employee object retrieval method
  • New Features

    • Added functionality to retrieve charge card account ID
    • Implemented flexible mapping for corporate card transactions

Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request introduces modifications to the Sage Intacct models, focusing on enhancing employee and charge card account retrieval. The changes include updating the get_intacct_employee_object method to use a more robust value retrieval approach and adding a new get_ccc_account_id function. The new function provides a flexible mechanism for determining charge card account IDs by checking corporate card mappings, employee mappings, and falling back to a default account ID.

Changes

File Change Summary
apps/sage_intacct/models.py - Updated get_intacct_employee_object to use .get() for safer dictionary access
- Added new get_ccc_account_id function for charge card account ID retrieval

Sequence Diagram

sequenceDiagram
    participant Expense
    participant GeneralMapping
    participant Function as get_ccc_account_id()
    
    Expense->>Function: Provide expense details
    GeneralMapping->>Function: Provide general mappings
    
    alt Corporate Card Mapping Exists
        Function-->>Expense: Return Corporate Card Account ID
    else Employee Mapping Available
        Function-->>Expense: Return Employee Card Account ID
    else No Mapping Found
        Function-->>Expense: Return Default Charge Card ID
    end
Loading

Poem

🐰 In the realm of Intacct's dance,
A rabbit hops with code's advance,
Mapping cards with gentle grace,
Preventing errors without a trace,
Charge accounts now find their place! 🎉

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

@github-actions github-actions bot added the size/XS Extra Small PR label Jan 22, 2025
Copy link
Contributor

@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 (2)
apps/sage_intacct/models.py (2)

526-529: Good change, but let's make it even safer!

While using .get() is safer than direct dictionary access, there's still room for improvement:

  1. Line 527 still uses direct dictionary access employee.detail[object_type] which could raise KeyError
  2. The function implicitly returns None when conditions aren't met

Consider this safer implementation:

-        if employee and employee.detail.get(object_type):
-            default_employee_object = employee.detail[object_type]
-            return default_employee_object
+        if employee and employee.detail.get(object_type):
+            return employee.detail.get(object_type)
+        return None

Line range hint 530-545: Well-structured function with clear fallback logic!

The implementation is good, but could benefit from better documentation and type safety.

Consider these improvements:

-def get_ccc_account_id(general_mappings: GeneralMapping, expense: Expense, description: str):
+def get_ccc_account_id(general_mappings: GeneralMapping, expense: Expense, description: Dict[str, Any]) -> str:
+    """Get the charge card account ID based on various mapping rules.
+
+    Args:
+        general_mappings: General mappings configuration
+        expense: The expense object
+        description: Dictionary containing expense group description
+
+    Returns:
+        str: The charge card account ID from either corporate card mapping,
+             employee mapping, or default charge card ID
+    """
+    if not general_mappings:
+        raise ValueError("General mappings cannot be None")
+
     card_mapping = Mapping.objects.filter(
         source_type='CORPORATE_CARD',
         destination_type='CHARGE_CARD_NUMBER',
         source__source_id=expense.corporate_card_id,
         workspace_id=general_mappings.workspace
     ).first()
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e968fc0 and b2ef1b9.

📒 Files selected for processing (1)
  • apps/sage_intacct/models.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: pytest

Copy link

Tests Skipped Failures Errors Time
286 0 💤 0 ❌ 0 🔥 43.786s ⏱️

@Hrishabh17 Hrishabh17 merged commit 5e5db95 into master Jan 22, 2025
4 checks passed
Hrishabh17 added a commit that referenced this pull request Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XS Extra Small PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants