feat: add payment statistics API endpoint #366
Draft
Conversation
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
- Add PaymentStatisticsView to provide sales metrics including total sales, order count, average order value, and daily breakdown - Add get_payment_statistics function for aggregating payment data - Add API documentation for the payment statistics endpoint - Add comprehensive tests for payment statistics - Fix duplicate test class definitions in test_views.py that were causing coverage failures (TestCoursesFeedbackView and TestLibrariesView) - Add mock models for Cart, CartItem, and CatalogueItem for testing
mkurkar
force-pushed
the
mkurkar/payment-staticts
branch
from
cb5fe57 to
2b9f1b5
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds a new payment statistics API endpoint to provide sales metrics for courses, including total sales, order count, average order value, and daily breakdowns. It also includes test infrastructure improvements and fixes for duplicate test class definitions.
- Adds PaymentStatisticsView with comprehensive date filtering and tenant-based access control
- Implements get_payment_statistics function with permission-based course filtering
- Upgrades mock zeitlabs_payments models from simple classes to proper Django models for better testing
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| futurex_openedx_extensions/dashboard/views.py | Adds PaymentStatisticsView with date/course/tenant filtering and permission checks |
| futurex_openedx_extensions/dashboard/statistics/payments.py | Implements core payment statistics aggregation logic with daily breakdowns |
| futurex_openedx_extensions/dashboard/urls.py | Registers new payment statistics endpoint |
| futurex_openedx_extensions/dashboard/docs_src.py | Adds API documentation for payment statistics endpoint |
| tests/test_dashboard/test_views.py | Removes duplicate test classes and adds comprehensive PaymentStatisticsView tests |
| tests/test_dashboard/test_statistics/test_payments.py | Adds unit tests for payment statistics function |
| tests/test_dashboard/test_serializers.py | Adds additional serializer validation tests |
| test_utils/edx_platform_mocks_shared/zeitlabs_payments/models.py | Converts mock models to proper Django models with relationships |
| tests/conftest.py | Adds gc_collect fixture to mitigate potential memory issues |
| tox.ini | Excludes zeitlabs-payments directory and sets PYTHONHASHSEED for reproducibility |
| docs/concepts/payment_statistics.rst | Adds comprehensive documentation of payment statistics mathematical logic |
| docs/concepts/index.rst | Updates documentation index to include payment statistics concept |
| futurex_openedx_extensions/helpers/admin.py | Adds commented-out permission methods (should be cleaned up) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+260
to
+270
| # def has_add_permission(self, request: Any) -> bool: # pylint: disable=unused-argument | ||
| # """Disable add permission for CacheInvalidator.""" | ||
| # return False | ||
|
|
||
| # def has_change_permission(self, request: Any, obj: Any = None) -> bool: # pylint: disable=unused-argument | ||
| # """Disable change permission for CacheInvalidator.""" | ||
| # return False | ||
|
|
||
| # def has_delete_permission(self, request: Any, obj: Any = None) -> bool: # pylint: disable=unused-argument | ||
| # """Disable delete permission for CacheInvalidator.""" | ||
| # return False |
There was a problem hiding this comment.
Commented-out code should be removed. If these permission methods need to be disabled, they should either be removed entirely or uncommented with proper justification. Keeping commented-out code reduces code maintainability and clarity.
| ' following are the available tags along with the fields they include:\n' | ||
| '| tag | mapped fields |\n' | ||
| '|-----|---------------|\n' | ||
|
|
There was a problem hiding this comment.
The empty line 247 appears to be unintentional and breaks the continuity of the docstring table. This should either be removed or the table should be completed if it's incomplete.
|
|
||
| re_path(r'^api/fx/payments/v1/orders/$', views.PaymentOrdersView.as_view(), name='payments-orders'), | ||
| re_path(r'^api/fx/statistics/v1/payments/$', views.PaymentStatisticsView.as_view(), name='payment-statistics'), | ||
|
|
There was a problem hiding this comment.
Extra blank line should be removed to maintain consistency with the rest of the URL patterns in the file.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description:
Add a brief description of the changes made in this PR.
Related Issue: