feat: terminate stuck paid checkout intent #913
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| """ | ||
| Management command to detect and mark CheckoutIntent records that have been | ||
| stuck in 'paid' state for too long, indicating stalled fulfillment. | ||
| """ | ||
| import logging | ||
| from datetime import timedelta | ||
|
|
||
| from django.core.management.base import BaseCommand | ||
| from django.utils import timezone | ||
|
|
||
| from enterprise_access.apps.customer_billing.constants import CheckoutIntentState | ||
| from enterprise_access.apps.customer_billing.models import CheckoutIntent | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class Command(BaseCommand): | ||
| """ | ||
| Command to detect and transition CheckoutIntent records that have been | ||
| stuck in 'paid' state for a configurable duration. | ||
|
|
||
| When a CheckoutIntent transitions to 'paid' state but fulfillment fails | ||
| without proper error handling, the intent can remain stuck indefinitely. | ||
| This command detects such cases and transitions them to | ||
| 'errored_fulfillment_stalled' to trigger alerts and display error UI. | ||
|
|
||
| Usage: | ||
| ./manage.py mark_stalled_checkout_intents | ||
| ./manage.py mark_stalled_checkout_intents --threshold-seconds=300 | ||
| ./manage.py mark_stalled_checkout_intents --dry-run | ||
| """ | ||
|
|
||
| help = ( | ||
| 'Detect and mark CheckoutIntent records stuck in paid state as ' | ||
| 'errored_fulfillment_stalled' | ||
| ) | ||
|
|
||
| def add_arguments(self, parser): | ||
| """ | ||
| Add command-line arguments. | ||
| """ | ||
| parser.add_argument( | ||
| '--threshold-seconds', | ||
| type=int, | ||
| default=180, | ||
| help=( | ||
| 'Number of seconds a CheckoutIntent must be in paid state ' | ||
| 'before being considered stalled. Default: 180 (3 minutes). ' | ||
| 'This accounts for exponential backoff in Salesforce API calls ' | ||
| 'and the provisioning workflow. Should be long enough to avoid ' | ||
| 'false positives but short enough for timely error display.' | ||
| ), | ||
| ) | ||
| parser.add_argument( | ||
| '--dry-run', | ||
| action='store_true', | ||
| dest='dry_run', | ||
| default=False, | ||
| help='Show what would be updated without actually updating records.', | ||
| ) | ||
|
|
||
| def handle(self, *args, **options): | ||
| """ | ||
| Find and mark stalled CheckoutIntent records. | ||
| """ | ||
| threshold_seconds = options['threshold_seconds'] | ||
| dry_run = options['dry_run'] | ||
|
|
||
| mode_label = '[DRY RUN] ' if dry_run else '' | ||
|
|
||
| self.stdout.write( | ||
| f'{mode_label}Checking for CheckoutIntent records stuck in paid state ' | ||
| f'for more than {threshold_seconds} seconds...' | ||
| ) | ||
| logger.info( | ||
| '%sStarting mark_stalled_checkout_intents command with threshold=%s seconds', | ||
| mode_label, | ||
| threshold_seconds, | ||
| ) | ||
|
|
||
| if dry_run: | ||
|
Contributor
There was a problem hiding this comment. This implementation of a dry run isn't quite appropriate because it replaces too much business logic. A better approach would be to pass a dry run flag into a lower level function and implement dry run within. |
||
| # Query stalled intents without updating | ||
| threshold_time = timezone.now() - timedelta(seconds=threshold_seconds) | ||
| stalled_intents = CheckoutIntent.objects.filter( | ||
| state=CheckoutIntentState.PAID, | ||
| modified__lte=threshold_time, | ||
| ).order_by('modified') | ||
|
|
||
| count = stalled_intents.count() | ||
|
|
||
| if count == 0: | ||
| self.stdout.write( | ||
| self.style.SUCCESS( | ||
| f'{mode_label}No stalled CheckoutIntent records found.' | ||
| ) | ||
| ) | ||
| logger.info('%sNo stalled CheckoutIntent records found', mode_label) | ||
| else: | ||
| self.stdout.write( | ||
| self.style.WARNING( | ||
| f'{mode_label}Found {count} stalled CheckoutIntent record(s):' | ||
| ) | ||
| ) | ||
| for intent in stalled_intents: | ||
| time_stalled = (timezone.now() - intent.modified).total_seconds() | ||
| self.stdout.write( | ||
| f' - ID: {intent.pk}, ' | ||
| f'User: {intent.user.email if intent.user else "N/A"}, ' | ||
| f'Enterprise: {intent.enterprise_name or intent.enterprise_slug}, ' | ||
| f'Time stalled: {int(time_stalled)}s, ' | ||
| f'Last modified: {intent.modified.isoformat()}' | ||
| ) | ||
| logger.info( | ||
| '%sWould mark CheckoutIntent %s as stalled (stalled for %s seconds)', | ||
| mode_label, | ||
| intent.pk, | ||
| int(time_stalled), | ||
| ) | ||
| else: | ||
| # Actually update records | ||
| updated_count, updated_uuids = CheckoutIntent.mark_stalled_fulfillment_intents( | ||
| stalled_threshold_seconds=threshold_seconds | ||
| ) | ||
|
Comment on lines
+121
to
+123
Contributor
There was a problem hiding this comment. This is probably where dry_run needs to be passed. |
||
|
|
||
| if updated_count == 0: | ||
| self.stdout.write( | ||
| self.style.SUCCESS( | ||
| 'No stalled CheckoutIntent records found.' | ||
| ) | ||
| ) | ||
| logger.info('No stalled CheckoutIntent records found') | ||
| else: | ||
| self.stdout.write( | ||
| self.style.SUCCESS( | ||
| f'Successfully marked {updated_count} CheckoutIntent record(s) ' | ||
| f'as errored_fulfillment_stalled' | ||
| ) | ||
| ) | ||
| for intent_id in updated_uuids: | ||
| self.stdout.write(f' - Updated CheckoutIntent: {intent_id}') | ||
| logger.info( | ||
| 'Marked CheckoutIntent %s as errored_fulfillment_stalled', | ||
| intent_id, | ||
| ) | ||
|
|
||
| self.stdout.write( | ||
| self.style.SUCCESS( | ||
| f'{mode_label}Command completed successfully' | ||
| ) | ||
| ) | ||
|
Comment on lines
+146
to
+150
Contributor
There was a problem hiding this comment. IMO, this is the only self.stdout.write() I'd keep, to leverage the success style. |
||
| logger.info('%smark_stalled_checkout_intents command completed', mode_label) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can remove one of these duplicative messages throughout the code. I'm pretty sure
loggeralready goes to stdout, and the stdout messages are not already designed to be machine-readable, so I think we can just remove the stdout.write() lines and keep the logger.info linesFunctionally, you're using stdout.write() as a logger, but it's weaker than logger because it lacks timestamps and other useful metadata.