mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-01 13:59:54 +00:00
72389637ed
Summary - Add TelemetryEvents.API_CREDIT_TOPUP_SUCCEEDED and provider method trackApiCreditTopupSucceeded - Introduce topupTrackerStore to persist pending top-ups per user (localStorage) and reconcile against recent audit logs - Hook purchase flow to start tracking before opening Stripe checkout - Reconcile after fetching audit events (UsageLogsTable) and after fetchBalance, then emit telemetry, refresh balance, and clear pending - Minor refactor in customerEventsService to return awaited result Implementation details - Matching strategy: - Event type: credit_added - Time window: createdAt between top-up start time and +24h - Amount: if known, e.params.amount must equal expected cents - Cross-tab/user changes: synchronize via storage event and userId watcher Limitations / Follow-up - Reconciliation fetches only page 1 (limit 10) of events; in high-volume cases, a recent credit_added could fall outside the first page - The window and pagination issue will be "resolved by a followup PR to core and cloud" Files touched - src/stores/topupTrackerStore.ts (new) - src/components/dialog/content/setting/UsageLogsTable.vue - src/composables/auth/useFirebaseAuthActions.ts - src/platform/telemetry/providers/cloud/MixpanelTelemetryProvider.ts - src/platform/telemetry/types.ts - src/services/customerEventsService.ts ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-6500-feat-telemetry-track-API-credit-top-up-success-via-audit-events-29e6d73d365081169941efae70cf71fe) by [Unito](https://www.unito.io) --------- Co-authored-by: Christian Byrne <chrbyrne96@gmail.com> Co-authored-by: Claude <noreply@anthropic.com>
ComfyUI Frontend Testing Guide
This guide provides an overview of testing approaches used in the ComfyUI Frontend codebase. These guides are meant to document any particularities or nuances of writing tests in this codebase, rather than being a comprehensive guide to testing in general. By reading these guides first, you may save yourself some time when encountering issues.
Testing Documentation
Documentation for unit tests is organized into three guides:
- Component Testing - How to test Vue components
- Unit Testing - How to test utility functions, composables, and other non-component code
- Store Testing - How to test Pinia stores specifically
Testing Structure
The ComfyUI Frontend project uses a mixed approach to unit test organization:
- Component Tests: Located directly alongside their components with a
.spec.tsextension - Unit Tests: Located in the
tests-ui/tests/directory - Store Tests: Located in the
tests-ui/tests/store/directory - Browser Tests: These are located in the
browser_tests/directory. There is a dedicated README in thebrowser_tests/directory, so it will not be covered here.
Test Frameworks and Libraries
Our tests use the following frameworks and libraries:
- Vitest - Test runner and assertion library
- @vue/test-utils - Vue component testing utilities
- Pinia - For store testing
Getting Started
To run the tests locally:
# Run unit tests
pnpm test:unit
# Run unit tests in watch mode
pnpm test:unit:dev
Refer to the specific guides for more detailed information on each testing type.