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: qbd direct connection phase fix #1155

Merged
merged 1 commit into from
Jan 20, 2025

Conversation

DhaaraniCIT
Copy link
Contributor

@DhaaraniCIT DhaaraniCIT commented Jan 20, 2025

Description

fix: qbd direct connection phase fix

Clickup

https://app.clickup.com/

Summary by CodeRabbit

  • Bug Fixes
    • Improved loading state management during QuickBooks Direct onboarding process
    • Enhanced error handling for connection status scenarios

Copy link
Contributor

coderabbitai bot commented Jan 20, 2025

Walkthrough

The pull request focuses on enhancing the QbdDirectOnboardingConnectorComponent in the QuickBooks Direct integration onboarding process. The changes improve loading state management by adding more precise conditional handling for different connection statuses. A minor modification was also made to create a shallow copy of a workspace response object, preventing potential unintended mutations during the onboarding workflow.

Changes

File Change Summary
src/app/integrations/qbd-direct/qbd-direct-onboarding/.../qbd-direct-onboarding-connector.component.ts - Updated handleStatus method to set isConnectionLoading to false for specific onboarding states
- Modified proceedToExportSetting to use Object.assign() for creating a shallow copy of workspace response

Possibly related PRs

Suggested labels

qa_deploy, size/XS

Suggested reviewers

  • ashwin1111
  • Hrishabh17

Poem

🐰 In the realm of QuickBooks' dance,
Loading states now take their stance
A shallow copy, with care so neat
Onboarding's path becomes more fleet
Rabbit's code, with wisdom bright
Guides connections to the light! 🌟

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.

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

Unit Test Coverage % values
Statements 33.01% ( 4126 / 12499 )
Branches 26.42% ( 1179 / 4462 )
Functions 25.59% ( 893 / 3489 )
Lines 33.19% ( 4060 / 12230 )

@@ -174,17 +174,19 @@ export class QbdDirectOnboardingConnectorComponent implements OnInit {
this.connectionStatus = QBDConnectionStatus.INCORRECT_COMPANY_PATH;
this.warningDialogText = 'Incorrect company file path detected. Please check and try again.';
this.isDialogVisible = true;
this.isConnectionLoading = false;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this change is done, because the step 2.2 is not waiting or show loading until it hit the terminal condition as we have the isConnectionLoading false in the else case.

can see the video attached below for reference

Screen.Recording.2025-01-20.at.11.49.42.AM.mov

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 (3)
src/app/integrations/qbd-direct/qbd-direct-onboarding/qbd-direct-onboarding-connector/qbd-direct-onboarding-connector.component.ts (3)

177-177: Consider refactoring repeated loading state management.

The loading state management is duplicated across different status handling branches. Consider moving this.isConnectionLoading = false to the end of the method to reduce code duplication.

 handleStatus(status: QbdDirectWorkspace): void {
   const onboardingState = status.onboarding_state;

   if (onboardingState === QbdDirectOnboardingState.INCORRECT_COMPANY_PATH) {
     this.connectionStatus = QBDConnectionStatus.INCORRECT_COMPANY_PATH;
     this.warningDialogText = 'Incorrect company file path detected. Please check and try again.';
     this.isDialogVisible = true;
-    this.isConnectionLoading = false;
   } else if (onboardingState === QbdDirectOnboardingState.INCORRECT_PASSWORD) {
     this.connectionStatus = QBDConnectionStatus.IN_CORRECT_PASSWORD;
     this.warningDialogText = 'Incorrect password detected. Please check and try again.';
     this.isDialogVisible = true;
-    this.isConnectionLoading = false;
   } else if (onboardingState === QbdDirectOnboardingState.DESTINATION_SYNC_IN_PROGRESS || onboardingState === QbdDirectOnboardingState.DESTINATION_SYNC_COMPLETE) {
     this.connectionStatus = QBDConnectionStatus.SUCCESS;
     this.isConnectionCTAEnabled = true;
-    this.isConnectionLoading = false;
   }
+  this.isConnectionLoading = false;
 }

Also applies to: 183-183, 188-188


262-262: Good use of Object.assign to prevent mutations.

Creating a shallow copy prevents unintended mutations of the original workspace response. Consider using a more descriptive variable name like workspaceResponseCopy instead of oldWorkspaceResponse to better reflect its purpose.

-const oldWorkspaceResponse = Object.assign({}, workspaceResponse);
+const workspaceResponseCopy = Object.assign({}, workspaceResponse);

Line range hint 74-91: Consider implementing a retry limit for connection attempts.

While the error handling is comprehensive, there's no limit on how many times a user can retry the connection. Consider implementing a maximum retry count to prevent infinite attempts and provide appropriate feedback when the limit is reached.

Example implementation:

private readonly MAX_RETRY_ATTEMPTS = 3;
private retryCount = 0;

onConnectionDone(event: CheckBoxUpdate) {
  if (this.retryCount >= this.MAX_RETRY_ATTEMPTS) {
    this.toastService.displayToastMessage(
      ToastSeverity.ERROR,
      'Maximum retry attempts reached. Please contact support.'
    );
    return;
  }

  this.isConnectionLoading = true;
  if (event.value) {
    this.retryCount++;
    // ... rest of the existing code
  }
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5bf389c and fe10e20.

📒 Files selected for processing (1)
  • src/app/integrations/qbd-direct/qbd-direct-onboarding/qbd-direct-onboarding-connector/qbd-direct-onboarding-connector.component.ts (2 hunks)

@DhaaraniCIT DhaaraniCIT merged commit cd89ca7 into master Jan 20, 2025
5 checks passed
DhaaraniCIT added a commit that referenced this pull request Jan 20, 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