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: hide card number and employee name as options for memo field #1123

Merged
merged 3 commits into from
Dec 13, 2024

Conversation

anishfyle
Copy link
Contributor

@anishfyle anishfyle commented Dec 13, 2024

Description

  • hide card number and employee name as options for memo field

Clickup

  • app.clickup.com/t/86cx0x4rp

Summary by CodeRabbit

  • New Features

    • Enhanced memo options control based on branding configuration, allowing additional options for specific brands.
  • Bug Fixes

    • Improved logic for filtering memo options based on brand ID, ensuring correct options are displayed based on the selected brand.

@anishfyle anishfyle requested a review from ashwin1111 December 13, 2024 06:30
Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Warning

Rate limit exceeded

@anishfyle has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 0 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 2bea95e and ce0c27b.

📒 Files selected for processing (1)
  • src/app/core/models/common/advanced-settings.model.ts (2 hunks)

Walkthrough

The changes introduce an import statement for brandingConfig in the AdvancedSettingsModel class and modify the getMemoOptions method. The updated logic now checks brandingConfig.brandId to determine which options to filter out or include in the memo options. If brandId is 'co', both 'card_number' and 'employee_name' are excluded. If it is 'fyle', all options are allowed if certain conditions are met. Other aspects of the class remain unchanged.

Changes

File Path Change Summary
src/app/core/models/common/advanced-settings.model.ts Added import for brandingConfig and modified getMemoOptions method to include conditions based on brandingConfig.brandId.

Possibly related PRs

Suggested reviewers

  • DhaaraniCIT
  • ashwin1111

Poem

In the meadow where options bloom,
A new check adds light to the room.
With brandingConfig in tow,
The card_number now gets to show!
A hop, a skip, a change so bright,
In the code, we dance with delight! 🐇✨


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. (Experiment)
  • @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 Dec 13, 2024
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6dd0a7c and ef3bca7.

📒 Files selected for processing (1)
  • src/app/core/models/common/advanced-settings.model.ts (2 hunks)
🔇 Additional comments (2)
src/app/core/models/common/advanced-settings.model.ts (2)

8-8: LGTM!

The import of brandingConfig is correctly added and necessary for the new branding-based condition.


91-94: Verify the impact on dependent components

Let's verify the components that might be affected by this change.

✅ Verification successful

Let me check the actual usage of getMemoOptions in these components to understand the impact better.


Let me check how these components handle the memo options in their templates to ensure they properly handle the card_number option.


Based on the analysis of the components and their templates, I can now provide the final response:

No additional changes required in dependent components

The change in getMemoOptions is safely handled by the existing implementation because:

  • All components (Intacct, NetSuite, QBO) simply pass the options to a template-driven dropdown
  • The templates use generic bindings ([options]="defaultMemoOptions") that automatically adapt to the filtered options
  • No component makes assumptions about specific memo options being present
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for components using getMemoOptions
echo "Components using getMemoOptions:"
rg -l "getMemoOptions" --type ts

# Search for tests of getMemoOptions
echo -e "\nTests for getMemoOptions:"
rg -l "getMemoOptions.*spec" --type ts

# Search for UI templates that might display these fields
echo -e "\nUI templates that might use these fields:"
rg -l "employee_name|card_number" --type html

Length of output: 1130


Script:

#!/bin/bash
# Check how getMemoOptions is used in the components
echo "Usage in Intacct Advanced Settings:"
rg "getMemoOptions" -B 2 -A 2 src/app/integrations/intacct/intacct-shared/intacct-advanced-settings/intacct-advanced-settings.component.ts

echo -e "\nUsage in NetSuite Advanced Settings:"
rg "getMemoOptions" -B 2 -A 2 src/app/integrations/netsuite/netsuite-shared/netsuite-advanced-settings/netsuite-advanced-settings.component.ts

echo -e "\nUsage in QBO Advanced Settings:"
rg "getMemoOptions" -B 2 -A 2 src/app/integrations/qbo/qbo-shared/qbo-advanced-settings/qbo-advanced-settings.component.ts

echo -e "\nUsage in QBO Clone Settings:"
rg "getMemoOptions" -B 2 -A 2 src/app/integrations/qbo/qbo-onboarding/qbo-clone-settings/qbo-clone-settings.component.ts

Length of output: 2307


Script:

#!/bin/bash
# Check template handling of memo options
echo "Intacct Advanced Settings Template:"
rg "defaultMemoFields|defaultMemoOptions" -B 2 -A 2 src/app/integrations/intacct/intacct-shared/intacct-advanced-settings/intacct-advanced-settings.component.html

echo -e "\nNetSuite Advanced Settings Template:"
rg "defaultMemoFields|defaultMemoOptions" -B 2 -A 2 src/app/integrations/netsuite/netsuite-shared/netsuite-advanced-settings/netsuite-advanced-settings.component.html

echo -e "\nQBO Advanced Settings Template:"
rg "defaultMemoFields|defaultMemoOptions" -B 2 -A 2 src/app/integrations/qbo/qbo-shared/qbo-advanced-settings/qbo-advanced-settings.component.html

echo -e "\nQBO Clone Settings Template:"
rg "defaultMemoFields|defaultMemoOptions" -B 2 -A 2 src/app/integrations/qbo/qbo-onboarding/qbo-clone-settings/qbo-clone-settings.component.html

Length of output: 2276

src/app/core/models/common/advanced-settings.model.ts Outdated Show resolved Hide resolved
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: 1

🧹 Outside diff range and nitpick comments (1)
src/app/core/models/common/advanced-settings.model.ts (1)

Line range hint 97-112: Maintain consistency in preview values

The formatMemoPreview method still includes preview values for both card_number and employee_name. These should be removed to maintain consistency with the hidden memo field options.

Apply this diff to remove the preview values:

    const previewValues: { [key: string]: string } = {
      employee_email: '[email protected]',
-     employee_name: 'John Doe',
-     card_number: '**** 3456',
      category: 'Meals and Entertainment',
      purpose: 'Client Meeting',
      merchant: 'Pizza Hut',
      report_number: 'C/2021/12/R/1',
      spent_on: today.toLocaleDateString(),
      expense_key: 'E/2024/02/T/11',
      expense_link: `${environment.fyle_app_url}/app/main/#/enterprise/view_expense/`
    };
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6dd0a7c and ef3bca7.

📒 Files selected for processing (1)
  • src/app/core/models/common/advanced-settings.model.ts (2 hunks)
🔇 Additional comments (2)
src/app/core/models/common/advanced-settings.model.ts (2)

8-8: LGTM!

The import of brandingConfig is correctly added and follows the project's import conventions.


91-91: Verify brandingConfig implementation

Let's verify that the brandingConfig is properly initialized and the brandId property is available.

src/app/core/models/common/advanced-settings.model.ts Outdated Show resolved Hide resolved
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

🧹 Outside diff range and nitpick comments (1)
src/app/core/models/common/advanced-settings.model.ts (1)

91-98: Fix style issues and simplify logic

The code has style issues and can be simplified:

  1. Missing space after if
  2. Unnecessary else after return

Apply this diff to fix style and improve readability:

-    if(brandingConfig.brandId === 'co') {
+    if (brandingConfig.brandId === 'co') {
      return defaultOptions.filter(option => option !== 'card_number' && option !== 'employee_name');
-    } else {
-      if (cccExportType && ['netsuite', 'quickbooks online', 'sage intacct'].includes(appName.toLowerCase()) && brandingConfig.brandId === 'fyle') {
-        return defaultOptions;
-      }
-      return defaultOptions.filter(option => option !== 'card_number');
     }
+    
+    if (cccExportType && 
+        ['netsuite', 'quickbooks online', 'sage intacct'].includes(appName.toLowerCase()) && 
+        brandingConfig.brandId === 'fyle') {
+      return defaultOptions;
+    }
+    
+    return defaultOptions.filter(option => option !== 'card_number');
🧰 Tools
🪛 eslint

[error] 91-91: Expected space(s) after "if".

(keyword-spacing)


[error] 93-98: Unnecessary 'else' after 'return'.

(no-else-return)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ef3bca7 and 2bea95e.

📒 Files selected for processing (1)
  • src/app/core/models/common/advanced-settings.model.ts (2 hunks)
🧰 Additional context used
🪛 eslint
src/app/core/models/common/advanced-settings.model.ts

[error] 91-91: Expected space(s) after "if".

(keyword-spacing)


[error] 93-98: Unnecessary 'else' after 'return'.

(no-else-return)

🔇 Additional comments (2)
src/app/core/models/common/advanced-settings.model.ts (2)

8-8: LGTM!

The import statement for brandingConfig is correctly added and necessary for the new branding-based logic.


91-98: ⚠️ Potential issue

Implementation doesn't fully meet PR objectives

According to the PR objectives, both card_number and employee_name should be hidden from the memo field options. However, the current implementation only hides both fields for 'co' brand, while only hiding card_number for other cases.

Apply this diff to align with PR objectives:

     if (brandingConfig.brandId === 'co') {
       return defaultOptions.filter(option => option !== 'card_number' && option !== 'employee_name');
     }
     
     if (cccExportType && 
         ['netsuite', 'quickbooks online', 'sage intacct'].includes(appName.toLowerCase()) && 
         brandingConfig.brandId === 'fyle') {
-      return defaultOptions;
+      return defaultOptions.filter(option => option !== 'card_number' && option !== 'employee_name');
     }
     
-    return defaultOptions.filter(option => option !== 'card_number');
+    return defaultOptions.filter(option => option !== 'card_number' && option !== 'employee_name');

Likely invalid or redundant comment.

🧰 Tools
🪛 eslint

[error] 91-91: Expected space(s) after "if".

(keyword-spacing)


[error] 93-98: Unnecessary 'else' after 'return'.

(no-else-return)

Copy link

Unit Test Coverage % values
Statements 34.05% ( 4207 / 12354 )
Branches 27.68% ( 1215 / 4388 )
Functions 26.69% ( 924 / 3461 )
Lines 34.22% ( 4139 / 12095 )

@anishfyle anishfyle merged commit 204c5f7 into master Dec 13, 2024
4 checks passed
anishfyle added a commit that referenced this pull request Dec 13, 2024
)

* fix: hide card number and employee name as options for memo field

* updated conditions

* fix lint
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