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: Add an "Export Date" option to QBO CCP date options #1148

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

JustARatherRidiculouslyLongUsername
Copy link
Contributor

@JustARatherRidiculouslyLongUsername JustARatherRidiculouslyLongUsername commented Jan 13, 2025

Description

Add the "Export Date" option to QBO Credit Card Purchases. Also fix a small bug where an invalid option can remain in the creditCardExportDate after changing the export type.

Example:

  1. Set CCC export type to Credit Card Purchase
  2. Set date to post date
  3. Set CCC export type to Bill

Post date remains in the form and can be submitted, although it is invalid for bills

Clickup

https://app.clickup.com/t/86cxhjzhf

Summary by CodeRabbit

  • New Features

    • Enhanced credit card expense grouping date options
    • Added ability to select current date as export date type
  • Improvements

    • Improved validation logic for export date selection
    • Added consistency checks for available date options

Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Walkthrough

The pull request introduces enhancements to the QuickBooks Online (QBO) integration's export settings components. Specifically, it adds a new ExportDateType.CURRENT_DATE option for credit card expense grouping, allowing users to select the current date as an export date option. The changes include importing the ExportDateType enum and implementing logic to dynamically update and validate the credit card export date options based on the selected expense object type.

Changes

File Change Summary
src/app/integrations/qbo/qbo-onboarding/qbo-clone-settings/qbo-clone-settings.component.ts - Added import for ExportDateType
- Updated updateCCCExpenseGroupingDateOptions method to include current date option
- Added validation to reset creditCardExportDate if not in allowed options
src/app/integrations/qbo/qbo-shared/qbo-export-settings/qbo-export-settings.component.ts - Added import for ExportDateType
- Conditionally push current date option to cccExpenseGroupingDateOptions

Sequence Diagram

sequenceDiagram
    participant User
    participant QBOComponent
    participant ExportDateOptions

    User->>QBOComponent: Select Credit Card Expense Object
    QBOComponent->>ExportDateOptions: Update Date Options
    alt Credit Card Purchase Selected
        ExportDateOptions->>ExportDateOptions: Add Current Date Option
    end
    QBOComponent->>QBOComponent: Validate Export Date
Loading

Possibly related PRs

  • None identified with strong code-level connection

Suggested labels

size/XS

Suggested reviewers

  • ashwin1111
  • anishfyle
  • DhaaraniCIT

Poem

🐰 In the realm of QuickBooks' dance,
A rabbit hops with export's glance,
Current date now joins the scene,
Making credit card flows serene,
With options bright and logic clean! 📅✨

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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

Copy link

Unit Test Coverage % values
Statements 33.2% ( 4121 / 12411 )
Branches 26.51% ( 1176 / 4436 )
Functions 25.77% ( 894 / 3469 )
Lines 33.39% ( 4055 / 12144 )

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

🧹 Nitpick comments (1)
src/app/integrations/qbo/qbo-onboarding/qbo-clone-settings/qbo-clone-settings.component.ts (1)

327-332: Consider adding error handling for invalid date values.

The conditional logic for adding the CURRENT_DATE option is correct, but consider adding error handling for potential invalid date values.

 if (selectedValue === QBOCorporateCreditCardExpensesObject.CREDIT_CARD_PURCHASE) {
+  try {
     this.cccExpenseGroupingDateOptions.push({
       label: brandingContent.common.currentDate,
       value: ExportDateType.CURRENT_DATE
     });
+  } catch (error) {
+    console.error('Failed to add current date option:', error);
+  }
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 95d7c06 and a83b355.

📒 Files selected for processing (2)
  • src/app/integrations/qbo/qbo-onboarding/qbo-clone-settings/qbo-clone-settings.component.ts (2 hunks)
  • src/app/integrations/qbo/qbo-shared/qbo-export-settings/qbo-export-settings.component.ts (2 hunks)
🔇 Additional comments (3)
src/app/integrations/qbo/qbo-onboarding/qbo-clone-settings/qbo-clone-settings.component.ts (2)

12-12: LGTM! Import statement updated correctly.

Added ExportDateType to the imports for handling the new export date option.


340-343: LGTM! Validation logic is well implemented.

The validation logic correctly handles invalid creditCardExportDate values by resetting them to null.

src/app/integrations/qbo/qbo-shared/qbo-export-settings/qbo-export-settings.component.ts (1)

9-9: LGTM! Import statement updated correctly.

Added ExportDateType to the imports consistently with the clone settings component.

Comment on lines +318 to +323
if (selectedValue === QBOCorporateCreditCardExpensesObject.CREDIT_CARD_PURCHASE) {
this.cccExpenseGroupingDateOptions.push({
label: brandingContent.common.currentDate,
value: ExportDateType.CURRENT_DATE
});
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider refactoring duplicate code into a shared service.

The updateCCCExpenseGroupingDateOptions method implementation is duplicated between QboCloneSettingsComponent and QboExportSettingsComponent. Consider extracting this logic into a shared service.

Create a new service (e.g., QboExportDateService) with the following implementation:

@Injectable({
  providedIn: 'root'
})
export class QboExportDateService {
  updateCCCExpenseGroupingDateOptions(
    selectedValue: QBOCorporateCreditCardExpensesObject,
    options: SelectFormOption[],
    form: FormGroup
  ): SelectFormOption[] {
    let updatedOptions = [...options];
    
    if (selectedValue === QBOCorporateCreditCardExpensesObject.CREDIT_CARD_PURCHASE) {
      try {
        updatedOptions.push({
          label: brandingContent.common.currentDate,
          value: ExportDateType.CURRENT_DATE
        });
      } catch (error) {
        console.error('Failed to add current date option:', error);
      }
    }

    const allowedValues = updatedOptions.map(option => option.value);
    if (!allowedValues.includes(form.get('creditCardExportDate')?.value)) {
      form.get('creditCardExportDate')?.setValue(null);
    }

    return updatedOptions;
  }
}

This refactoring will:

  1. Eliminate code duplication
  2. Centralize the export date logic
  3. Make it easier to maintain and update the logic in one place
  4. Add proper error handling

Also applies to: 330-333

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

Successfully merging this pull request may close these issues.

2 participants