langgenius/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-07-21 12:05:30 -04:00
Code Issues 775 Packages Projects Releases 10 Wiki Activity

[PR #28747] chore: enhance the test script of current billing service #32166

New Issue
Closed
opened 2026-02-21 20:50:52 -05:00 by yindo · 0 comments
yindo commented 2026-02-21 20:50:52 -05:00
Owner
Copy Link
Copy Source

Original Pull Request: https://github.com/langgenius/dify/pull/28747

State: closed
Merged: Yes

Comprehensive Unit Tests for BillingService

Important

  1. Make sure you have read our contribution guidelines
  2. Ensure there is an associated issue and you have been assigned to it
  3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

This PR implements a comprehensive unit test suite for the BillingService module, covering all critical billing operations including usage calculation, subscription tier management, rate limit enforcement, and credit management.

Fixes

Closes https://github.com/langgenius/dify/issues/28746

What's Changed

  • Added 70 unit tests for api/tests/unit_tests/services/test_billing_service.py
  • Comprehensive coverage of all BillingService methods and edge cases
  • Well-documented test classes with clear docstrings and inline comments
  • All tests follow the Arrange-Act-Assert pattern for clarity

Test Coverage Areas

1. HTTP Request Handling (27 tests)

  • ✅ Successful GET/PUT/POST/DELETE requests
  • ✅ Error handling for various HTTP status codes (400, 404, 500, etc.)
  • ✅ Retry logic on network failures with exponential backoff
  • ✅ Request header and parameter validation
  • ✅ JSON parsing and malformed response handling

2. Subscription Tier Checks (6 tests)

  • ✅ Billing information retrieval
  • ✅ Knowledge rate limits with default and custom values
  • ✅ All subscription tiers (SANDBOX, PROFESSIONAL, TEAM)
  • ✅ Payment link generation for subscriptions and model providers
  • ✅ Invoice retrieval with various parameters

3. Usage Calculation & Credit Management (9 tests)

  • ✅ Feature plan usage information retrieval
  • ✅ Credit addition (positive delta)
  • ✅ Credit consumption (negative delta)
  • ✅ Zero delta edge case
  • ✅ Large negative delta boundary testing
  • ✅ Usage refunds with history ID tracking
  • ✅ Specific feature usage queries

4. Rate Limit Enforcement (9 tests)

  • ✅ Compliance download rate limiting (4 requests per 60 seconds)
  • ✅ Education verification rate limiting (10 requests per 60 seconds)
  • ✅ Education activation rate limiting (10 requests per 60 seconds)
  • ✅ Rate limit increment after successful operations
  • ✅ Proper exception raising when limits are exceeded
  • ✅ Multiple requests within rate limits

5. Account Management (9 tests)

  • ✅ Account deletion
  • ✅ Email freeze status checking
  • ✅ Account deletion feedback submission
  • ✅ Tenant owner/admin permission validation
  • ✅ All role types (OWNER, ADMIN, NORMAL, EDITOR, DATASET_OPERATOR)
  • ✅ Error handling for missing tenant joins

6. Edge Cases & Integration Scenarios (10 tests)

  • ✅ Empty responses from billing API
  • ✅ Cache management and invalidation
  • ✅ Partner integration and tenant bindings
  • ✅ Complete subscription upgrade workflow
  • ✅ Usage tracking and refund workflow
  • ✅ Education verification and activation flow

Documentation Improvements

  • Module-level docstring explaining the entire test suite purpose and structure
  • Class-level docstrings for each test class describing what they cover
  • Inline comments explaining complex test scenarios and edge cases
  • Clear test method names following the pattern test_<method>_<scenario>

Code Quality

  • ✅ All 70 tests passing
  • ✅ Passes ruff check with no linting errors
  • ✅ Follows TDD best practices (Arrange-Act-Assert pattern)
  • ✅ Uses proper mocking to avoid external dependencies
  • ✅ Strong type hints and explicit assertions

Screenshots

Not applicable - this is a backend testing change with no UI impact.

Test Results

$ uv run --project api pytest api/tests/unit_tests/services/test_billing_service.py -v

=========================================== 70 passed, 1 warning in 68.77s ============================================

$ uv run --project api ruff check api/tests/unit_tests/services/test_billing_service.py

All checks passed!

Checklist

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

Contribution by Gittensor, learn more at https://gittensor.io/

**Original Pull Request:** https://github.com/langgenius/dify/pull/28747 **State:** closed **Merged:** Yes --- # Comprehensive Unit Tests for BillingService > [!IMPORTANT] > > 1. Make sure you have read our [contribution guidelines](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md) > 1. Ensure there is an associated issue and you have been assigned to it > 1. Use the correct syntax to link this PR: `Fixes #<issue number>`. ## Summary This PR implements a comprehensive unit test suite for the `BillingService` module, covering all critical billing operations including usage calculation, subscription tier management, rate limit enforcement, and credit management. ### Fixes Closes https://github.com/langgenius/dify/issues/28746 ### What's Changed - **Added 70 unit tests** for `api/tests/unit_tests/services/test_billing_service.py` - Comprehensive coverage of all BillingService methods and edge cases - Well-documented test classes with clear docstrings and inline comments - All tests follow the Arrange-Act-Assert pattern for clarity ### Test Coverage Areas #### 1. HTTP Request Handling (27 tests) - ✅ Successful GET/PUT/POST/DELETE requests - ✅ Error handling for various HTTP status codes (400, 404, 500, etc.) - ✅ Retry logic on network failures with exponential backoff - ✅ Request header and parameter validation - ✅ JSON parsing and malformed response handling #### 2. Subscription Tier Checks (6 tests) - ✅ Billing information retrieval - ✅ Knowledge rate limits with default and custom values - ✅ All subscription tiers (SANDBOX, PROFESSIONAL, TEAM) - ✅ Payment link generation for subscriptions and model providers - ✅ Invoice retrieval with various parameters #### 3. Usage Calculation & Credit Management (9 tests) - ✅ Feature plan usage information retrieval - ✅ Credit addition (positive delta) - ✅ Credit consumption (negative delta) - ✅ Zero delta edge case - ✅ Large negative delta boundary testing - ✅ Usage refunds with history ID tracking - ✅ Specific feature usage queries #### 4. Rate Limit Enforcement (9 tests) - ✅ Compliance download rate limiting (4 requests per 60 seconds) - ✅ Education verification rate limiting (10 requests per 60 seconds) - ✅ Education activation rate limiting (10 requests per 60 seconds) - ✅ Rate limit increment after successful operations - ✅ Proper exception raising when limits are exceeded - ✅ Multiple requests within rate limits #### 5. Account Management (9 tests) - ✅ Account deletion - ✅ Email freeze status checking - ✅ Account deletion feedback submission - ✅ Tenant owner/admin permission validation - ✅ All role types (OWNER, ADMIN, NORMAL, EDITOR, DATASET_OPERATOR) - ✅ Error handling for missing tenant joins #### 6. Edge Cases & Integration Scenarios (10 tests) - ✅ Empty responses from billing API - ✅ Cache management and invalidation - ✅ Partner integration and tenant bindings - ✅ Complete subscription upgrade workflow - ✅ Usage tracking and refund workflow - ✅ Education verification and activation flow ### Documentation Improvements - **Module-level docstring** explaining the entire test suite purpose and structure - **Class-level docstrings** for each test class describing what they cover - **Inline comments** explaining complex test scenarios and edge cases - **Clear test method names** following the pattern `test_<method>_<scenario>` ### Code Quality - ✅ All 70 tests passing - ✅ Passes `ruff check` with no linting errors - ✅ Follows TDD best practices (Arrange-Act-Assert pattern) - ✅ Uses proper mocking to avoid external dependencies - ✅ Strong type hints and explicit assertions ## Screenshots Not applicable - this is a backend testing change with no UI impact. ## Test Results ```bash $ uv run --project api pytest api/tests/unit_tests/services/test_billing_service.py -v =========================================== 70 passed, 1 warning in 68.77s ============================================ ``` ```bash $ uv run --project api ruff check api/tests/unit_tests/services/test_billing_service.py All checks passed! ``` ## Checklist - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!) - [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change. - [x] I've updated the documentation accordingly. - [x] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods Contribution by Gittensor, learn more at https://gittensor.io/
yindo added the pull-request label 2026-02-21 20:50:52 -05:00
yindo closed this issue 2026-02-21 20:50:52 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Knowledge Pipeline
Proposal
WIP
cloud
dependencies
feat:webapp
good first issue
outdated
performance
pull-request
Mirrored from GitHub Pull Request
 python:uv
refactor
size:L
stale
status: accepting prs
status: blocked
status: in discussion
stt & tts
vulnerablity
web
wont-fix
🌊 feat:workflow
🌚 invalid
🐞 bug
👻 feat:rag
💪 enhancement
📚 documentation
🔨 feat:tools
🙋‍♂️ question
🙏 help wanted
🤔 cant-reproduce
🤖 feat:agent
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#32166
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?