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

[PM-13717] Fix legacy credit rebate for migrated MSPs #9

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lizard-boy
Copy link

@lizard-boy lizard-boy commented Oct 19, 2024

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-13717

📔 Objective

This PR fixes 2 issues:

  1. Legacy credit rebates were originally not working because they were checking the migrating organization's plan type. However, by the time we're applying credit, the organization has already had their plan type changed to one of the Consolidated Billing-supported types in order for the organization to work in the platform. As such, I had to use the organization's migration record to determine their legacy rebate.
  2. The credit for the organization's cancellation proration and legacy rebate were being applied in the same request. I broke those up into two different requests and added a description to the credit application so it's easier for CS to track.

📸 Screenshots

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Greptile Summary

This pull request addresses issues with legacy credit rebates for migrated MSPs in the billing system. Key changes include:

  • Modified ApplyCreditAsync in ProviderMigrator.cs to correctly handle legacy credit rebates
  • Separated cancellation proration and legacy rebate credit applications for clarity
  • Added CustomerBalanceTransactionCreate method to IStripeAdapter interface
  • Implemented CustomerBalanceTransactionCreate in StripeAdapter class using Stripe's API
  • Introduced CustomerBalanceTransactionService in StripeAdapter for improved balance management

These changes enhance the accuracy and transparency of credit applications for migrated MSP organizations, fixing issues with legacy plan detection and credit allocation.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

3 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile


await stripeAdapter.CustomerUpdateAsync(provider.GatewayCustomerId, new CustomerUpdateOptions
if (legacyOrganizationCredit < 0)
Copy link

Choose a reason for hiding this comment

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

logic: This condition might prevent applying positive credits. Consider if this is the intended behavior.


logger.LogInformation("CB: Applied {Credit} credit to provider ({ProviderID})", organizationCancellationCredit, provider.Id);
logger.LogInformation("CB: Applied {Credit} credit to provider ({ProviderID})", organizationCancellationCredit + legacyOrganizationCredit, provider.Id);
Copy link

Choose a reason for hiding this comment

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

style: Update the log message to differentiate between cancellation credit and legacy credit for clarity.

Comment on lines +13 to +14
Task<CustomerBalanceTransaction> CustomerBalanceTransactionCreate(string customerId,
CustomerBalanceTransactionCreateOptions options);
Copy link

Choose a reason for hiding this comment

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

style: Consider adding XML documentation for this new method to improve code clarity and maintainability

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