From 658ac155893a69822eb581e0c83d51e0480a6e86 Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Fri, 20 Mar 2026 13:29:22 +0800 Subject: [PATCH 01/34] use new quota system --- api/enums/quota_type.py | 227 ++++++++++++++---------- api/services/app_generate_service.py | 3 +- api/services/async_workflow_service.py | 26 +-- api/services/billing_service.py | 54 +++++- api/services/trigger/webhook_service.py | 19 +- api/tasks/trigger_processing_tasks.py | 5 +- api/tasks/workflow_schedule_tasks.py | 3 +- 7 files changed, 224 insertions(+), 113 deletions(-) diff --git a/api/enums/quota_type.py b/api/enums/quota_type.py index 9f511b88ef..305f5b9808 100644 --- a/api/enums/quota_type.py +++ b/api/enums/quota_type.py @@ -1,5 +1,6 @@ import logging -from dataclasses import dataclass +import uuid +from dataclasses import dataclass, field from enum import StrEnum, auto logger = logging.getLogger(__name__) @@ -8,49 +9,85 @@ logger = logging.getLogger(__name__) @dataclass class QuotaCharge: """ - Result of a quota consumption operation. + Result of a quota reservation (Reserve phase). - Attributes: - success: Whether the quota charge succeeded - charge_id: UUID for refund, or None if failed/disabled + Lifecycle: + charge = QuotaType.TRIGGER.consume(tenant_id) # Reserve + try: + do_work() + charge.commit() # Confirm consumption + except: + charge.refund() # Release frozen quota + + If neither commit() nor refund() is called, the billing system's + cleanup CronJob will auto-release the reservation within ~75 seconds. """ success: bool - charge_id: str | None + charge_id: str | None # reservation_id _quota_type: "QuotaType" + _tenant_id: str | None = None + _feature_key: str | None = None + _amount: int = 0 + _committed: bool = field(default=False, repr=False) + + def commit(self, actual_amount: int | None = None) -> None: + """ + Confirm the consumption with actual amount. + + Args: + actual_amount: Actual amount consumed. Defaults to the reserved amount. + If less than reserved, the difference is refunded automatically. + """ + if self._committed or not self.charge_id: + return + + try: + from services.billing_service import BillingService + + amount = actual_amount if actual_amount is not None else self._amount + BillingService.quota_commit( + tenant_id=self._tenant_id, + feature_key=self._feature_key, + reservation_id=self.charge_id, + actual_amount=amount, + ) + self._committed = True + logger.debug( + "Committed %s quota for tenant %s, reservation_id: %s, amount: %d", + self._quota_type.value, self._tenant_id, self.charge_id, amount, + ) + except Exception: + logger.exception("Failed to commit quota, reservation_id: %s", self.charge_id) def refund(self) -> None: """ - Refund this quota charge. + Release the reserved quota (cancel the charge). + + Safe to call even if: + - charge failed or was disabled (charge_id is None) + - already committed (Release after Commit is a no-op) + - already refunded (idempotent) - Safe to call even if charge failed or was disabled. This method guarantees no exceptions will be raised. """ - if self.charge_id: - self._quota_type.refund(self.charge_id) - logger.info("Refunded quota for %s with charge_id: %s", self._quota_type.value, self.charge_id) + if not self.charge_id or not self._tenant_id or not self._feature_key: + return + + self._quota_type.release(self.charge_id, self._tenant_id, self._feature_key) class QuotaType(StrEnum): """ Supported quota types for tenant feature usage. - - Add additional types here whenever new billable features become available. """ - # Trigger execution quota TRIGGER = auto() - - # Workflow execution quota WORKFLOW = auto() - UNLIMITED = auto() @property def billing_key(self) -> str: - """ - Get the billing key for the feature. - """ match self: case QuotaType.TRIGGER: return "trigger_event" @@ -61,14 +98,45 @@ class QuotaType(StrEnum): def consume(self, tenant_id: str, amount: int = 1) -> QuotaCharge: """ - Consume quota for the feature. + Consume quota using Reserve + immediate Commit. + + This is the simple one-shot mode: Reserve freezes quota, then Commit + confirms it right away. The returned QuotaCharge supports .refund() + which calls Release (idempotent even after Commit). + + For advanced two-phase usage (e.g. streaming), use reserve() directly + and call charge.commit() / charge.refund() manually. Args: tenant_id: The tenant identifier amount: Amount to consume (default: 1) Returns: - QuotaCharge with success status and charge_id for refund + QuotaCharge with reservation_id for potential refund + + Raises: + QuotaExceededError: When quota is insufficient + """ + charge = self.reserve(tenant_id, amount) + if charge.success and charge.charge_id: + charge.commit() + return charge + + def reserve(self, tenant_id: str, amount: int = 1) -> QuotaCharge: + """ + Reserve quota before task execution (Reserve phase only). + + The caller MUST call charge.commit() after the task succeeds, + or charge.refund() if the task fails. + + If neither is called, the reservation auto-expires in ~75 seconds. + + Args: + tenant_id: The tenant identifier + amount: Amount to reserve (default: 1) + + Returns: + QuotaCharge — call .commit() on success, .refund() on failure Raises: QuotaExceededError: When quota is insufficient @@ -81,51 +149,52 @@ class QuotaType(StrEnum): logger.debug("Billing disabled, allowing request for %s", tenant_id) return QuotaCharge(success=True, charge_id=None, _quota_type=self) - logger.info("Consuming %d %s quota for tenant %s", amount, self.value, tenant_id) + logger.info("Reserving %d %s quota for tenant %s", amount, self.value, tenant_id) if amount <= 0: - raise ValueError("Amount to consume must be greater than 0") + raise ValueError("Amount to reserve must be greater than 0") + + request_id = str(uuid.uuid4()) + feature_key = self.billing_key try: - response = BillingService.update_tenant_feature_plan_usage(tenant_id, self.billing_key, delta=amount) + reserve_resp = BillingService.quota_reserve( + tenant_id=tenant_id, + feature_key=feature_key, + request_id=request_id, + amount=amount, + ) - if response.get("result") != "success": + reservation_id = reserve_resp.get("reservation_id") + if not reservation_id: logger.warning( - "Failed to consume quota for %s, feature %s details: %s", - tenant_id, - self.value, - response.get("detail"), + "Reserve returned no reservation_id for %s, feature %s, response: %s", + tenant_id, self.value, reserve_resp, ) raise QuotaExceededError(feature=self.value, tenant_id=tenant_id, required=amount) - charge_id = response.get("history_id") logger.debug( - "Successfully consumed %d %s quota for tenant %s, charge_id: %s", - amount, - self.value, - tenant_id, - charge_id, + "Reserved %d %s quota for tenant %s, reservation_id: %s", + amount, self.value, tenant_id, reservation_id, + ) + return QuotaCharge( + success=True, + charge_id=reservation_id, + _quota_type=self, + _tenant_id=tenant_id, + _feature_key=feature_key, + _amount=amount, ) - return QuotaCharge(success=True, charge_id=charge_id, _quota_type=self) except QuotaExceededError: raise + except ValueError: + raise except Exception: - # fail-safe: allow request on billing errors - logger.exception("Failed to consume quota for %s, feature %s", tenant_id, self.value) + logger.exception("Failed to reserve quota for %s, feature %s", tenant_id, self.value) return unlimited() def check(self, tenant_id: str, amount: int = 1) -> bool: - """ - Check if tenant has sufficient quota without consuming. - - Args: - tenant_id: The tenant identifier - amount: Amount to check (default: 1) - - Returns: - True if quota is sufficient, False otherwise - """ from configs import dify_config if not dify_config.BILLING_ENABLED: @@ -139,18 +208,11 @@ class QuotaType(StrEnum): return remaining >= amount if remaining != -1 else True except Exception: logger.exception("Failed to check quota for %s, feature %s", tenant_id, self.value) - # fail-safe: allow request on billing errors return True - def refund(self, charge_id: str) -> None: + def release(self, reservation_id: str, tenant_id: str, feature_key: str) -> None: """ - Refund quota using charge_id from consume(). - - This method guarantees no exceptions will be raised. - All errors are logged but silently handled. - - Args: - charge_id: The UUID returned from consume() + Release a reservation. Guarantees no exceptions. """ try: from configs import dify_config @@ -159,51 +221,36 @@ class QuotaType(StrEnum): if not dify_config.BILLING_ENABLED: return - if not charge_id: - logger.warning("Cannot refund: charge_id is empty") + if not reservation_id: return - logger.info("Refunding %s quota with charge_id: %s", self.value, charge_id) - - response = BillingService.refund_tenant_feature_plan_usage(charge_id) - if response.get("result") == "success": - logger.debug("Successfully refunded %s quota, charge_id: %s", self.value, charge_id) - else: - logger.warning("Refund failed for charge_id: %s", charge_id) - + logger.info("Releasing %s quota, reservation_id: %s", self.value, reservation_id) + BillingService.quota_release( + tenant_id=tenant_id, + feature_key=feature_key, + reservation_id=reservation_id, + ) except Exception: - # Catch ALL exceptions - refund must never fail - logger.exception("Failed to refund quota for charge_id: %s", charge_id) - # Don't raise - refund is best-effort and must be silent + logger.exception("Failed to release quota, reservation_id: %s", reservation_id) def get_remaining(self, tenant_id: str) -> int: - """ - Get remaining quota for the tenant. - - Args: - tenant_id: The tenant identifier - - Returns: - Remaining quota amount - """ from services.billing_service import BillingService try: - usage_info = BillingService.get_tenant_feature_plan_usage(tenant_id, self.billing_key) - # Assuming the API returns a dict with 'remaining' or 'limit' and 'used' + usage_info = BillingService.get_tenant_feature_plan_usage_info(tenant_id) if isinstance(usage_info, dict): - return usage_info.get("remaining", 0) - # If it returns a simple number, treat it as remaining - return int(usage_info) if usage_info else 0 + feature_info = usage_info.get(self.billing_key, {}) + if isinstance(feature_info, dict): + limit = feature_info.get("limit", 0) + usage = feature_info.get("usage", 0) + if limit == -1: + return -1 + return max(0, limit - usage) + return 0 except Exception: logger.exception("Failed to get remaining quota for %s, feature %s", tenant_id, self.value) return -1 def unlimited() -> QuotaCharge: - """ - Return a quota charge for unlimited quota. - - This is useful for features that are not subject to quota limits, such as the UNLIMITED quota type. - """ return QuotaCharge(success=True, charge_id=None, _quota_type=QuotaType.UNLIMITED) diff --git a/api/services/app_generate_service.py b/api/services/app_generate_service.py index 40013f2b66..ce68a1dcba 100644 --- a/api/services/app_generate_service.py +++ b/api/services/app_generate_service.py @@ -106,7 +106,7 @@ class AppGenerateService: quota_charge = unlimited() if dify_config.BILLING_ENABLED: try: - quota_charge = QuotaType.WORKFLOW.consume(app_model.tenant_id) + quota_charge = QuotaType.WORKFLOW.reserve(app_model.tenant_id) except QuotaExceededError: raise InvokeRateLimitError(f"Workflow execution quota limit reached for tenant {app_model.tenant_id}") @@ -116,6 +116,7 @@ class AppGenerateService: request_id = RateLimit.gen_request_key() try: request_id = rate_limit.enter(request_id) + quota_charge.commit() if app_model.mode == AppMode.COMPLETION: return rate_limit.generate( CompletionAppGenerator.convert_to_event_stream( diff --git a/api/services/async_workflow_service.py b/api/services/async_workflow_service.py index 0133634e5a..5f7201de11 100644 --- a/api/services/async_workflow_service.py +++ b/api/services/async_workflow_service.py @@ -13,7 +13,7 @@ from celery.result import AsyncResult from sqlalchemy import select from sqlalchemy.orm import Session -from enums.quota_type import QuotaType +from enums.quota_type import QuotaType, unlimited from extensions.ext_database import db from models.account import Account from models.enums import CreatorUserRole, WorkflowTriggerStatus @@ -131,9 +131,10 @@ class AsyncWorkflowService: trigger_log = trigger_log_repo.create(trigger_log) session.commit() - # 7. Check and consume quota + # 7. Reserve quota (commit after successful dispatch) + quota_charge = unlimited() try: - QuotaType.WORKFLOW.consume(trigger_data.tenant_id) + quota_charge = QuotaType.WORKFLOW.reserve(trigger_data.tenant_id) except QuotaExceededError as e: # Update trigger log status trigger_log.status = WorkflowTriggerStatus.RATE_LIMITED @@ -153,13 +154,18 @@ class AsyncWorkflowService: # 9. Dispatch to appropriate queue task_data_dict = task_data.model_dump(mode="json") - task: AsyncResult[Any] | None = None - if queue_name == QueuePriority.PROFESSIONAL: - task = execute_workflow_professional.delay(task_data_dict) - elif queue_name == QueuePriority.TEAM: - task = execute_workflow_team.delay(task_data_dict) - else: # SANDBOX - task = execute_workflow_sandbox.delay(task_data_dict) + try: + task: AsyncResult[Any] | None = None + if queue_name == QueuePriority.PROFESSIONAL: + task = execute_workflow_professional.delay(task_data_dict) + elif queue_name == QueuePriority.TEAM: + task = execute_workflow_team.delay(task_data_dict) + else: # SANDBOX + task = execute_workflow_sandbox.delay(task_data_dict) + quota_charge.commit() + except Exception: + quota_charge.refund() + raise # 10. Update trigger log with task info trigger_log.status = WorkflowTriggerStatus.QUEUED diff --git a/api/services/billing_service.py b/api/services/billing_service.py index 5ab47c799a..4648d675c8 100644 --- a/api/services/billing_service.py +++ b/api/services/billing_service.py @@ -47,10 +47,60 @@ class BillingService: @classmethod def get_tenant_feature_plan_usage_info(cls, tenant_id: str): params = {"tenant_id": tenant_id} - - usage_info = cls._send_request("GET", "/tenant-feature-usage/info", params=params) + usage_info = cls._send_request("GET", "/quota/info", params=params) return usage_info + @classmethod + def quota_reserve( + cls, tenant_id: str, feature_key: str, request_id: str, amount: int = 1, meta: dict | None = None + ) -> dict: + """Reserve quota before task execution. + + Returns: + {"reservation_id": "uuid", "available": int, "reserved": int} + """ + payload = { + "tenant_id": tenant_id, + "feature_key": feature_key, + "request_id": request_id, + "amount": amount, + } + if meta: + payload["meta"] = meta + return cls._send_request("POST", "/quota/reserve", json=payload) + + @classmethod + def quota_commit( + cls, tenant_id: str, feature_key: str, reservation_id: str, actual_amount: int, meta: dict | None = None + ) -> dict: + """Commit a reservation with actual consumption. + + Returns: + {"available": int, "reserved": int, "refunded": int} + """ + payload = { + "tenant_id": tenant_id, + "feature_key": feature_key, + "reservation_id": reservation_id, + "actual_amount": actual_amount, + } + if meta: + payload["meta"] = meta + return cls._send_request("POST", "/quota/commit", json=payload) + + @classmethod + def quota_release(cls, tenant_id: str, feature_key: str, reservation_id: str) -> dict: + """Release a reservation (cancel, return frozen quota). + + Returns: + {"available": int, "reserved": int, "released": int} + """ + return cls._send_request("POST", "/quota/release", json={ + "tenant_id": tenant_id, + "feature_key": feature_key, + "reservation_id": reservation_id, + }) + @classmethod def get_knowledge_rate_limit(cls, tenant_id: str): params = {"tenant_id": tenant_id} diff --git a/api/services/trigger/webhook_service.py b/api/services/trigger/webhook_service.py index 3c1a4cc747..3bc64423b3 100644 --- a/api/services/trigger/webhook_service.py +++ b/api/services/trigger/webhook_service.py @@ -779,9 +779,9 @@ class WebhookService: user_id=None, ) - # consume quota before triggering workflow execution + # reserve quota before triggering workflow execution try: - QuotaType.TRIGGER.consume(webhook_trigger.tenant_id) + quota_charge = QuotaType.TRIGGER.reserve(webhook_trigger.tenant_id) except QuotaExceededError: AppTriggerService.mark_tenant_triggers_rate_limited(webhook_trigger.tenant_id) logger.info( @@ -792,11 +792,16 @@ class WebhookService: raise # Trigger workflow execution asynchronously - AsyncWorkflowService.trigger_workflow_async( - session, - end_user, - trigger_data, - ) + try: + AsyncWorkflowService.trigger_workflow_async( + session, + end_user, + trigger_data, + ) + quota_charge.commit() + except Exception: + quota_charge.refund() + raise except Exception: logger.exception("Failed to trigger workflow for webhook %s", webhook_trigger.webhook_id) diff --git a/api/tasks/trigger_processing_tasks.py b/api/tasks/trigger_processing_tasks.py index 75ae1f6316..3a9a663759 100644 --- a/api/tasks/trigger_processing_tasks.py +++ b/api/tasks/trigger_processing_tasks.py @@ -298,10 +298,10 @@ def dispatch_triggered_workflow( icon_dark_filename=trigger_entity.identity.icon_dark or "", ) - # consume quota before invoking trigger + # reserve quota before invoking trigger quota_charge = unlimited() try: - quota_charge = QuotaType.TRIGGER.consume(subscription.tenant_id) + quota_charge = QuotaType.TRIGGER.reserve(subscription.tenant_id) except QuotaExceededError: AppTriggerService.mark_tenant_triggers_rate_limited(subscription.tenant_id) logger.info( @@ -387,6 +387,7 @@ def dispatch_triggered_workflow( raise ValueError(f"End user not found for app {plugin_trigger.app_id}") AsyncWorkflowService.trigger_workflow_async(session=session, user=end_user, trigger_data=trigger_data) + quota_charge.commit() dispatched_count += 1 logger.info( "Triggered workflow for app %s with trigger event %s", diff --git a/api/tasks/workflow_schedule_tasks.py b/api/tasks/workflow_schedule_tasks.py index 8c64d3ab27..9aa90c3793 100644 --- a/api/tasks/workflow_schedule_tasks.py +++ b/api/tasks/workflow_schedule_tasks.py @@ -43,7 +43,7 @@ def run_schedule_trigger(schedule_id: str) -> None: quota_charge = unlimited() try: - quota_charge = QuotaType.TRIGGER.consume(schedule.tenant_id) + quota_charge = QuotaType.TRIGGER.reserve(schedule.tenant_id) except QuotaExceededError: AppTriggerService.mark_tenant_triggers_rate_limited(schedule.tenant_id) logger.info("Tenant %s rate limited, skipping schedule trigger %s", schedule.tenant_id, schedule_id) @@ -61,6 +61,7 @@ def run_schedule_trigger(schedule_id: str) -> None: tenant_id=schedule.tenant_id, ), ) + quota_charge.commit() logger.info("Schedule %s triggered workflow: %s", schedule_id, response.workflow_trigger_log_id) except Exception as e: quota_charge.refund() From 3888969af3aae0ee9cdcc8dadf450456004fbd26 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Fri, 20 Mar 2026 05:45:30 +0000 Subject: [PATCH 02/34] [autofix.ci] apply automated fixes --- api/enums/quota_type.py | 14 +++++++++++--- api/services/billing_service.py | 14 +++++++++----- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/api/enums/quota_type.py b/api/enums/quota_type.py index 305f5b9808..4caf9ec98b 100644 --- a/api/enums/quota_type.py +++ b/api/enums/quota_type.py @@ -55,7 +55,10 @@ class QuotaCharge: self._committed = True logger.debug( "Committed %s quota for tenant %s, reservation_id: %s, amount: %d", - self._quota_type.value, self._tenant_id, self.charge_id, amount, + self._quota_type.value, + self._tenant_id, + self.charge_id, + amount, ) except Exception: logger.exception("Failed to commit quota, reservation_id: %s", self.charge_id) @@ -169,13 +172,18 @@ class QuotaType(StrEnum): if not reservation_id: logger.warning( "Reserve returned no reservation_id for %s, feature %s, response: %s", - tenant_id, self.value, reserve_resp, + tenant_id, + self.value, + reserve_resp, ) raise QuotaExceededError(feature=self.value, tenant_id=tenant_id, required=amount) logger.debug( "Reserved %d %s quota for tenant %s, reservation_id: %s", - amount, self.value, tenant_id, reservation_id, + amount, + self.value, + tenant_id, + reservation_id, ) return QuotaCharge( success=True, diff --git a/api/services/billing_service.py b/api/services/billing_service.py index 4648d675c8..2bddd3ab11 100644 --- a/api/services/billing_service.py +++ b/api/services/billing_service.py @@ -95,11 +95,15 @@ class BillingService: Returns: {"available": int, "reserved": int, "released": int} """ - return cls._send_request("POST", "/quota/release", json={ - "tenant_id": tenant_id, - "feature_key": feature_key, - "reservation_id": reservation_id, - }) + return cls._send_request( + "POST", + "/quota/release", + json={ + "tenant_id": tenant_id, + "feature_key": feature_key, + "reservation_id": reservation_id, + }, + ) @classmethod def get_knowledge_rate_limit(cls, tenant_id: str): From 80b4633e8f226511215ad8d1ab72f9bf96effa55 Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Fri, 20 Mar 2026 14:58:31 +0800 Subject: [PATCH 03/34] fix style check and test --- api/enums/quota_type.py | 2 +- api/services/billing_service.py | 4 ++-- .../services/test_app_generate_service.py | 18 +++++++++++++----- .../services/test_app_generate_service.py | 11 ++++++----- .../services/test_async_workflow_service.py | 8 ++++++-- .../services/test_billing_service.py | 2 +- 6 files changed, 29 insertions(+), 16 deletions(-) diff --git a/api/enums/quota_type.py b/api/enums/quota_type.py index 4caf9ec98b..a2a7f689a5 100644 --- a/api/enums/quota_type.py +++ b/api/enums/quota_type.py @@ -39,7 +39,7 @@ class QuotaCharge: actual_amount: Actual amount consumed. Defaults to the reserved amount. If less than reserved, the difference is refunded automatically. """ - if self._committed or not self.charge_id: + if self._committed or not self.charge_id or not self._tenant_id or not self._feature_key: return try: diff --git a/api/services/billing_service.py b/api/services/billing_service.py index 2bddd3ab11..6fe61a1a52 100644 --- a/api/services/billing_service.py +++ b/api/services/billing_service.py @@ -59,7 +59,7 @@ class BillingService: Returns: {"reservation_id": "uuid", "available": int, "reserved": int} """ - payload = { + payload: dict = { "tenant_id": tenant_id, "feature_key": feature_key, "request_id": request_id, @@ -78,7 +78,7 @@ class BillingService: Returns: {"available": int, "reserved": int, "refunded": int} """ - payload = { + payload: dict = { "tenant_id": tenant_id, "feature_key": feature_key, "reservation_id": reservation_id, diff --git a/api/tests/test_containers_integration_tests/services/test_app_generate_service.py b/api/tests/test_containers_integration_tests/services/test_app_generate_service.py index 5b1a4790f5..eea9673710 100644 --- a/api/tests/test_containers_integration_tests/services/test_app_generate_service.py +++ b/api/tests/test_containers_integration_tests/services/test_app_generate_service.py @@ -39,9 +39,15 @@ class TestAppGenerateService: patch("configs.dify_config", autospec=True) as mock_global_dify_config, ): # Setup default mock returns for billing service - mock_billing_service.update_tenant_feature_plan_usage.return_value = { - "result": "success", - "history_id": "test_history_id", + mock_billing_service.quota_reserve.return_value = { + "reservation_id": "test-reservation-id", + "available": 100, + "reserved": 1, + } + mock_billing_service.quota_commit.return_value = { + "available": 99, + "reserved": 0, + "refunded": 0, } # Setup default mock returns for workflow service @@ -478,8 +484,10 @@ class TestAppGenerateService: # Verify the result assert result == ["test_response"] - # Verify billing service was called to consume quota - mock_external_service_dependencies["billing_service"].update_tenant_feature_plan_usage.assert_called_once() + # Verify billing two-phase quota (reserve + commit) + billing = mock_external_service_dependencies["billing_service"] + billing.quota_reserve.assert_called_once() + billing.quota_commit.assert_called_once() def test_generate_with_invalid_app_mode( self, db_session_with_containers: Session, mock_external_service_dependencies diff --git a/api/tests/unit_tests/services/test_app_generate_service.py b/api/tests/unit_tests/services/test_app_generate_service.py index c2b430c551..68ee6ae9d6 100644 --- a/api/tests/unit_tests/services/test_app_generate_service.py +++ b/api/tests/unit_tests/services/test_app_generate_service.py @@ -447,8 +447,8 @@ class TestGenerateBilling: def test_billing_enabled_consumes_quota(self, mocker, monkeypatch): monkeypatch.setattr(ags_module.dify_config, "BILLING_ENABLED", True) quota_charge = MagicMock() - consume_mock = mocker.patch( - "services.app_generate_service.QuotaType.WORKFLOW.consume", + reserve_mock = mocker.patch( + "services.app_generate_service.QuotaType.WORKFLOW.reserve", return_value=quota_charge, ) mocker.patch( @@ -467,7 +467,8 @@ class TestGenerateBilling: invoke_from=InvokeFrom.SERVICE_API, streaming=False, ) - consume_mock.assert_called_once_with("tenant-id") + reserve_mock.assert_called_once_with("tenant-id") + quota_charge.commit.assert_called_once() def test_billing_quota_exceeded_raises_rate_limit_error(self, mocker, monkeypatch): from services.errors.app import QuotaExceededError @@ -475,7 +476,7 @@ class TestGenerateBilling: monkeypatch.setattr(ags_module.dify_config, "BILLING_ENABLED", True) mocker.patch( - "services.app_generate_service.QuotaType.WORKFLOW.consume", + "services.app_generate_service.QuotaType.WORKFLOW.reserve", side_effect=QuotaExceededError(feature="workflow", tenant_id="t", required=1), ) @@ -492,7 +493,7 @@ class TestGenerateBilling: monkeypatch.setattr(ags_module.dify_config, "BILLING_ENABLED", True) quota_charge = MagicMock() mocker.patch( - "services.app_generate_service.QuotaType.WORKFLOW.consume", + "services.app_generate_service.QuotaType.WORKFLOW.reserve", return_value=quota_charge, ) mocker.patch( diff --git a/api/tests/unit_tests/services/test_async_workflow_service.py b/api/tests/unit_tests/services/test_async_workflow_service.py index 639e091041..ab83c8020f 100644 --- a/api/tests/unit_tests/services/test_async_workflow_service.py +++ b/api/tests/unit_tests/services/test_async_workflow_service.py @@ -146,6 +146,9 @@ class TestAsyncWorkflowService: mocks["team_task"].delay.return_value = task_result mocks["sandbox_task"].delay.return_value = task_result + quota_charge_mock = MagicMock() + mocks["quota_workflow"].reserve.return_value = quota_charge_mock + class DummyAccount: def __init__(self, user_id: str): self.id = user_id @@ -163,7 +166,8 @@ class TestAsyncWorkflowService: assert result.status == "queued" assert result.queue == queue_name - mocks["quota_workflow"].consume.assert_called_once_with("tenant-123") + mocks["quota_workflow"].reserve.assert_called_once_with("tenant-123") + quota_charge_mock.commit.assert_called_once() assert session.commit.call_count == 2 created_log = mocks["repo"].create.call_args[0][0] @@ -250,7 +254,7 @@ class TestAsyncWorkflowService: mocks = async_workflow_trigger_mocks mocks["dispatcher"].get_queue_name.return_value = QueuePriority.TEAM mocks["get_workflow"].return_value = workflow - mocks["quota_workflow"].consume.side_effect = QuotaExceededError( + mocks["quota_workflow"].reserve.side_effect = QuotaExceededError( feature="workflow", tenant_id="tenant-123", required=1, diff --git a/api/tests/unit_tests/services/test_billing_service.py b/api/tests/unit_tests/services/test_billing_service.py index eecb3c7672..135c2e9962 100644 --- a/api/tests/unit_tests/services/test_billing_service.py +++ b/api/tests/unit_tests/services/test_billing_service.py @@ -426,7 +426,7 @@ class TestBillingServiceUsageCalculation: # Assert assert result == expected_response - mock_send_request.assert_called_once_with("GET", "/tenant-feature-usage/info", params={"tenant_id": tenant_id}) + mock_send_request.assert_called_once_with("GET", "/quota/info", params={"tenant_id": tenant_id}) def test_update_tenant_feature_plan_usage_positive_delta(self, mock_send_request): """Test updating tenant feature usage with positive delta (adding credits).""" From f1bcd6d71532f7390a419b5814dbac9e92854748 Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Mon, 30 Mar 2026 16:41:56 +0800 Subject: [PATCH 04/34] add test case for quota and billing service --- api/tests/unit_tests/enums/__init__.py | 0 api/tests/unit_tests/enums/test_quota_type.py | 358 ++++++++++++++++++ .../services/test_billing_service.py | 81 ++++ 3 files changed, 439 insertions(+) create mode 100644 api/tests/unit_tests/enums/__init__.py create mode 100644 api/tests/unit_tests/enums/test_quota_type.py diff --git a/api/tests/unit_tests/enums/__init__.py b/api/tests/unit_tests/enums/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/api/tests/unit_tests/enums/test_quota_type.py b/api/tests/unit_tests/enums/test_quota_type.py new file mode 100644 index 0000000000..8a3bb349ac --- /dev/null +++ b/api/tests/unit_tests/enums/test_quota_type.py @@ -0,0 +1,358 @@ +"""Unit tests for QuotaType and QuotaCharge.""" + +from unittest.mock import patch + +import pytest + +from enums.quota_type import QuotaCharge, QuotaType, unlimited + + +class TestQuotaType: + def test_billing_key_trigger(self): + assert QuotaType.TRIGGER.billing_key == "trigger_event" + + def test_billing_key_workflow(self): + assert QuotaType.WORKFLOW.billing_key == "api_rate_limit" + + def test_billing_key_unlimited_raises(self): + with pytest.raises(ValueError, match="Invalid quota type"): + _ = QuotaType.UNLIMITED.billing_key + + def test_reserve_billing_disabled(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService"), + ): + mock_cfg.BILLING_ENABLED = False + charge = QuotaType.TRIGGER.reserve("t1") + assert charge.success is True + assert charge.charge_id is None + + def test_reserve_zero_amount_raises(self): + with patch("configs.dify_config") as mock_cfg: + mock_cfg.BILLING_ENABLED = True + with pytest.raises(ValueError, match="greater than 0"): + QuotaType.TRIGGER.reserve("t1", amount=0) + + def test_reserve_success(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService") as mock_bs, + ): + mock_cfg.BILLING_ENABLED = True + mock_bs.quota_reserve.return_value = {"reservation_id": "rid-1", "available": 99} + + charge = QuotaType.TRIGGER.reserve("t1", amount=1) + + assert charge.success is True + assert charge.charge_id == "rid-1" + assert charge._tenant_id == "t1" + assert charge._feature_key == "trigger_event" + assert charge._amount == 1 + mock_bs.quota_reserve.assert_called_once() + + def test_reserve_no_reservation_id_raises(self): + from services.errors.app import QuotaExceededError + + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService") as mock_bs, + ): + mock_cfg.BILLING_ENABLED = True + mock_bs.quota_reserve.return_value = {} + + with pytest.raises(QuotaExceededError): + QuotaType.TRIGGER.reserve("t1") + + def test_reserve_quota_exceeded_propagates(self): + from services.errors.app import QuotaExceededError + + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService") as mock_bs, + ): + mock_cfg.BILLING_ENABLED = True + mock_bs.quota_reserve.side_effect = QuotaExceededError( + feature="trigger", tenant_id="t1", required=1 + ) + + with pytest.raises(QuotaExceededError): + QuotaType.TRIGGER.reserve("t1") + + def test_reserve_api_exception_returns_unlimited(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService") as mock_bs, + ): + mock_cfg.BILLING_ENABLED = True + mock_bs.quota_reserve.side_effect = RuntimeError("network") + + charge = QuotaType.TRIGGER.reserve("t1") + assert charge.success is True + assert charge.charge_id is None + + def test_consume_calls_reserve_and_commit(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService") as mock_bs, + ): + mock_cfg.BILLING_ENABLED = True + mock_bs.quota_reserve.return_value = {"reservation_id": "rid-c"} + mock_bs.quota_commit.return_value = {} + + charge = QuotaType.TRIGGER.consume("t1") + assert charge.success is True + mock_bs.quota_commit.assert_called_once() + + def test_check_billing_disabled(self): + with patch("configs.dify_config") as mock_cfg: + mock_cfg.BILLING_ENABLED = False + assert QuotaType.TRIGGER.check("t1") is True + + def test_check_zero_amount_raises(self): + with patch("configs.dify_config") as mock_cfg: + mock_cfg.BILLING_ENABLED = True + with pytest.raises(ValueError, match="greater than 0"): + QuotaType.TRIGGER.check("t1", amount=0) + + def test_check_sufficient_quota(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch.object(QuotaType.TRIGGER, "get_remaining", return_value=100), + ): + mock_cfg.BILLING_ENABLED = True + assert QuotaType.TRIGGER.check("t1", amount=50) is True + + def test_check_insufficient_quota(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch.object(QuotaType.TRIGGER, "get_remaining", return_value=5), + ): + mock_cfg.BILLING_ENABLED = True + assert QuotaType.TRIGGER.check("t1", amount=10) is False + + def test_check_unlimited_quota(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch.object(QuotaType.TRIGGER, "get_remaining", return_value=-1), + ): + mock_cfg.BILLING_ENABLED = True + assert QuotaType.TRIGGER.check("t1", amount=999) is True + + def test_check_exception_returns_true(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch.object(QuotaType.TRIGGER, "get_remaining", side_effect=RuntimeError), + ): + mock_cfg.BILLING_ENABLED = True + assert QuotaType.TRIGGER.check("t1") is True + + def test_release_billing_disabled(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService") as mock_bs, + ): + mock_cfg.BILLING_ENABLED = False + QuotaType.TRIGGER.release("rid-1", "t1", "trigger_event") + mock_bs.quota_release.assert_not_called() + + def test_release_empty_reservation(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService") as mock_bs, + ): + mock_cfg.BILLING_ENABLED = True + QuotaType.TRIGGER.release("", "t1", "trigger_event") + mock_bs.quota_release.assert_not_called() + + def test_release_success(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService") as mock_bs, + ): + mock_cfg.BILLING_ENABLED = True + mock_bs.quota_release.return_value = {} + QuotaType.TRIGGER.release("rid-1", "t1", "trigger_event") + mock_bs.quota_release.assert_called_once_with( + tenant_id="t1", feature_key="trigger_event", reservation_id="rid-1" + ) + + def test_release_exception_swallowed(self): + with ( + patch("configs.dify_config") as mock_cfg, + patch("services.billing_service.BillingService") as mock_bs, + ): + mock_cfg.BILLING_ENABLED = True + mock_bs.quota_release.side_effect = RuntimeError("fail") + QuotaType.TRIGGER.release("rid-1", "t1", "trigger_event") + + def test_get_remaining_normal(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.get_tenant_feature_plan_usage_info.return_value = { + "trigger_event": {"limit": 100, "usage": 30} + } + assert QuotaType.TRIGGER.get_remaining("t1") == 70 + + def test_get_remaining_unlimited(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.get_tenant_feature_plan_usage_info.return_value = { + "trigger_event": {"limit": -1, "usage": 0} + } + assert QuotaType.TRIGGER.get_remaining("t1") == -1 + + def test_get_remaining_over_limit_returns_zero(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.get_tenant_feature_plan_usage_info.return_value = { + "trigger_event": {"limit": 10, "usage": 15} + } + assert QuotaType.TRIGGER.get_remaining("t1") == 0 + + def test_get_remaining_exception_returns_neg1(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.get_tenant_feature_plan_usage_info.side_effect = RuntimeError + assert QuotaType.TRIGGER.get_remaining("t1") == -1 + + def test_get_remaining_empty_response(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.get_tenant_feature_plan_usage_info.return_value = {} + assert QuotaType.TRIGGER.get_remaining("t1") == 0 + + def test_get_remaining_non_dict_response(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.get_tenant_feature_plan_usage_info.return_value = "invalid" + assert QuotaType.TRIGGER.get_remaining("t1") == 0 + + def test_get_remaining_feature_not_in_response(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.get_tenant_feature_plan_usage_info.return_value = { + "other_feature": {"limit": 100, "usage": 0} + } + remaining = QuotaType.TRIGGER.get_remaining("t1") + assert remaining == 0 + + def test_get_remaining_non_dict_feature_info(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.get_tenant_feature_plan_usage_info.return_value = { + "trigger_event": "not_a_dict" + } + assert QuotaType.TRIGGER.get_remaining("t1") == 0 + + +class TestQuotaCharge: + def test_commit_success(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.quota_commit.return_value = {} + charge = QuotaCharge( + success=True, + charge_id="rid-1", + _quota_type=QuotaType.TRIGGER, + _tenant_id="t1", + _feature_key="trigger_event", + _amount=1, + ) + charge.commit() + mock_bs.quota_commit.assert_called_once_with( + tenant_id="t1", + feature_key="trigger_event", + reservation_id="rid-1", + actual_amount=1, + ) + assert charge._committed is True + + def test_commit_with_actual_amount(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.quota_commit.return_value = {} + charge = QuotaCharge( + success=True, + charge_id="rid-1", + _quota_type=QuotaType.TRIGGER, + _tenant_id="t1", + _feature_key="trigger_event", + _amount=10, + ) + charge.commit(actual_amount=5) + call_kwargs = mock_bs.quota_commit.call_args[1] + assert call_kwargs["actual_amount"] == 5 + + def test_commit_idempotent(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.quota_commit.return_value = {} + charge = QuotaCharge( + success=True, + charge_id="rid-1", + _quota_type=QuotaType.TRIGGER, + _tenant_id="t1", + _feature_key="trigger_event", + _amount=1, + ) + charge.commit() + charge.commit() + assert mock_bs.quota_commit.call_count == 1 + + def test_commit_no_charge_id_noop(self): + with patch("services.billing_service.BillingService") as mock_bs: + charge = QuotaCharge(success=True, charge_id=None, _quota_type=QuotaType.TRIGGER) + charge.commit() + mock_bs.quota_commit.assert_not_called() + + def test_commit_no_tenant_id_noop(self): + with patch("services.billing_service.BillingService") as mock_bs: + charge = QuotaCharge( + success=True, + charge_id="rid-1", + _quota_type=QuotaType.TRIGGER, + _tenant_id=None, + _feature_key="trigger_event", + ) + charge.commit() + mock_bs.quota_commit.assert_not_called() + + def test_commit_exception_swallowed(self): + with patch("services.billing_service.BillingService") as mock_bs: + mock_bs.quota_commit.side_effect = RuntimeError("fail") + charge = QuotaCharge( + success=True, + charge_id="rid-1", + _quota_type=QuotaType.TRIGGER, + _tenant_id="t1", + _feature_key="trigger_event", + _amount=1, + ) + charge.commit() + + def test_refund_success(self): + with patch.object(QuotaType.TRIGGER, "release") as mock_rel: + charge = QuotaCharge( + success=True, + charge_id="rid-1", + _quota_type=QuotaType.TRIGGER, + _tenant_id="t1", + _feature_key="trigger_event", + ) + charge.refund() + mock_rel.assert_called_once_with("rid-1", "t1", "trigger_event") + + def test_refund_no_charge_id_noop(self): + with patch.object(QuotaType.TRIGGER, "release") as mock_rel: + charge = QuotaCharge(success=True, charge_id=None, _quota_type=QuotaType.TRIGGER) + charge.refund() + mock_rel.assert_not_called() + + def test_refund_no_tenant_id_noop(self): + with patch.object(QuotaType.TRIGGER, "release") as mock_rel: + charge = QuotaCharge( + success=True, + charge_id="rid-1", + _quota_type=QuotaType.TRIGGER, + _tenant_id=None, + ) + charge.refund() + mock_rel.assert_not_called() + + +class TestUnlimited: + def test_unlimited_returns_success_with_no_charge_id(self): + charge = unlimited() + assert charge.success is True + assert charge.charge_id is None + assert charge._quota_type == QuotaType.UNLIMITED diff --git a/api/tests/unit_tests/services/test_billing_service.py b/api/tests/unit_tests/services/test_billing_service.py index 252b898c70..d7d496031b 100644 --- a/api/tests/unit_tests/services/test_billing_service.py +++ b/api/tests/unit_tests/services/test_billing_service.py @@ -505,6 +505,87 @@ class TestBillingServiceUsageCalculation: ) +class TestBillingServiceQuotaOperations: + """Unit tests for quota reserve/commit/release operations.""" + + @pytest.fixture + def mock_send_request(self): + with patch.object(BillingService, "_send_request") as mock: + yield mock + + def test_quota_reserve_success(self, mock_send_request): + expected = {"reservation_id": "rid-1", "available": 99, "reserved": 1} + mock_send_request.return_value = expected + + result = BillingService.quota_reserve( + tenant_id="t1", feature_key="trigger_event", request_id="req-1", amount=1 + ) + + assert result == expected + mock_send_request.assert_called_once_with( + "POST", + "/quota/reserve", + json={"tenant_id": "t1", "feature_key": "trigger_event", "request_id": "req-1", "amount": 1}, + ) + + def test_quota_reserve_with_meta(self, mock_send_request): + mock_send_request.return_value = {"reservation_id": "rid-2"} + meta = {"source": "webhook"} + + BillingService.quota_reserve( + tenant_id="t1", feature_key="trigger_event", request_id="req-2", amount=1, meta=meta + ) + + call_json = mock_send_request.call_args[1]["json"] + assert call_json["meta"] == {"source": "webhook"} + + def test_quota_commit_success(self, mock_send_request): + expected = {"available": 98, "reserved": 0, "refunded": 0} + mock_send_request.return_value = expected + + result = BillingService.quota_commit( + tenant_id="t1", feature_key="trigger_event", reservation_id="rid-1", actual_amount=1 + ) + + assert result == expected + mock_send_request.assert_called_once_with( + "POST", + "/quota/commit", + json={ + "tenant_id": "t1", + "feature_key": "trigger_event", + "reservation_id": "rid-1", + "actual_amount": 1, + }, + ) + + def test_quota_commit_with_meta(self, mock_send_request): + mock_send_request.return_value = {} + meta = {"reason": "partial"} + + BillingService.quota_commit( + tenant_id="t1", feature_key="trigger_event", reservation_id="rid-1", actual_amount=1, meta=meta + ) + + call_json = mock_send_request.call_args[1]["json"] + assert call_json["meta"] == {"reason": "partial"} + + def test_quota_release_success(self, mock_send_request): + expected = {"available": 100, "reserved": 0, "released": 1} + mock_send_request.return_value = expected + + result = BillingService.quota_release( + tenant_id="t1", feature_key="trigger_event", reservation_id="rid-1" + ) + + assert result == expected + mock_send_request.assert_called_once_with( + "POST", + "/quota/release", + json={"tenant_id": "t1", "feature_key": "trigger_event", "reservation_id": "rid-1"}, + ) + + class TestBillingServiceRateLimitEnforcement: """Unit tests for rate limit enforcement mechanisms. From b95cdabe26bddfdd739b20138b1a47720971e7dc Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Mon, 30 Mar 2026 08:45:37 +0000 Subject: [PATCH 05/34] [autofix.ci] apply automated fixes --- api/tests/unit_tests/enums/test_quota_type.py | 24 +++++-------------- .../services/test_billing_service.py | 8 ++----- 2 files changed, 8 insertions(+), 24 deletions(-) diff --git a/api/tests/unit_tests/enums/test_quota_type.py b/api/tests/unit_tests/enums/test_quota_type.py index 8a3bb349ac..ac34064f8a 100644 --- a/api/tests/unit_tests/enums/test_quota_type.py +++ b/api/tests/unit_tests/enums/test_quota_type.py @@ -72,9 +72,7 @@ class TestQuotaType: patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = True - mock_bs.quota_reserve.side_effect = QuotaExceededError( - feature="trigger", tenant_id="t1", required=1 - ) + mock_bs.quota_reserve.side_effect = QuotaExceededError(feature="trigger", tenant_id="t1", required=1) with pytest.raises(QuotaExceededError): QuotaType.TRIGGER.reserve("t1") @@ -188,23 +186,17 @@ class TestQuotaType: def test_get_remaining_normal(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = { - "trigger_event": {"limit": 100, "usage": 30} - } + mock_bs.get_tenant_feature_plan_usage_info.return_value = {"trigger_event": {"limit": 100, "usage": 30}} assert QuotaType.TRIGGER.get_remaining("t1") == 70 def test_get_remaining_unlimited(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = { - "trigger_event": {"limit": -1, "usage": 0} - } + mock_bs.get_tenant_feature_plan_usage_info.return_value = {"trigger_event": {"limit": -1, "usage": 0}} assert QuotaType.TRIGGER.get_remaining("t1") == -1 def test_get_remaining_over_limit_returns_zero(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = { - "trigger_event": {"limit": 10, "usage": 15} - } + mock_bs.get_tenant_feature_plan_usage_info.return_value = {"trigger_event": {"limit": 10, "usage": 15}} assert QuotaType.TRIGGER.get_remaining("t1") == 0 def test_get_remaining_exception_returns_neg1(self): @@ -224,17 +216,13 @@ class TestQuotaType: def test_get_remaining_feature_not_in_response(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = { - "other_feature": {"limit": 100, "usage": 0} - } + mock_bs.get_tenant_feature_plan_usage_info.return_value = {"other_feature": {"limit": 100, "usage": 0}} remaining = QuotaType.TRIGGER.get_remaining("t1") assert remaining == 0 def test_get_remaining_non_dict_feature_info(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = { - "trigger_event": "not_a_dict" - } + mock_bs.get_tenant_feature_plan_usage_info.return_value = {"trigger_event": "not_a_dict"} assert QuotaType.TRIGGER.get_remaining("t1") == 0 diff --git a/api/tests/unit_tests/services/test_billing_service.py b/api/tests/unit_tests/services/test_billing_service.py index d7d496031b..3ae2e006e3 100644 --- a/api/tests/unit_tests/services/test_billing_service.py +++ b/api/tests/unit_tests/services/test_billing_service.py @@ -517,9 +517,7 @@ class TestBillingServiceQuotaOperations: expected = {"reservation_id": "rid-1", "available": 99, "reserved": 1} mock_send_request.return_value = expected - result = BillingService.quota_reserve( - tenant_id="t1", feature_key="trigger_event", request_id="req-1", amount=1 - ) + result = BillingService.quota_reserve(tenant_id="t1", feature_key="trigger_event", request_id="req-1", amount=1) assert result == expected mock_send_request.assert_called_once_with( @@ -574,9 +572,7 @@ class TestBillingServiceQuotaOperations: expected = {"available": 100, "reserved": 0, "released": 1} mock_send_request.return_value = expected - result = BillingService.quota_release( - tenant_id="t1", feature_key="trigger_event", reservation_id="rid-1" - ) + result = BillingService.quota_release(tenant_id="t1", feature_key="trigger_event", reservation_id="rid-1") assert result == expected mock_send_request.assert_called_once_with( From 4e50d55339cb105f57d36a345aded1fef98ebe46 Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Tue, 31 Mar 2026 09:49:09 +0800 Subject: [PATCH 06/34] fix comment --- api/enums/quota_type.py | 86 +----------------- api/services/app_generate_service.py | 3 +- api/services/async_workflow_service.py | 3 +- api/services/billing_service.py | 77 ++++++++++------ api/services/quota_service.py | 90 +++++++++++++++++++ api/tasks/trigger_processing_tasks.py | 3 +- api/tasks/workflow_schedule_tasks.py | 3 +- api/tests/unit_tests/enums/test_quota_type.py | 19 ++-- .../services/test_billing_service.py | 55 +++++++++++- 9 files changed, 212 insertions(+), 127 deletions(-) create mode 100644 api/services/quota_service.py diff --git a/api/enums/quota_type.py b/api/enums/quota_type.py index a2a7f689a5..95146d17d9 100644 --- a/api/enums/quota_type.py +++ b/api/enums/quota_type.py @@ -1,85 +1,10 @@ import logging import uuid -from dataclasses import dataclass, field from enum import StrEnum, auto logger = logging.getLogger(__name__) -@dataclass -class QuotaCharge: - """ - Result of a quota reservation (Reserve phase). - - Lifecycle: - charge = QuotaType.TRIGGER.consume(tenant_id) # Reserve - try: - do_work() - charge.commit() # Confirm consumption - except: - charge.refund() # Release frozen quota - - If neither commit() nor refund() is called, the billing system's - cleanup CronJob will auto-release the reservation within ~75 seconds. - """ - - success: bool - charge_id: str | None # reservation_id - _quota_type: "QuotaType" - _tenant_id: str | None = None - _feature_key: str | None = None - _amount: int = 0 - _committed: bool = field(default=False, repr=False) - - def commit(self, actual_amount: int | None = None) -> None: - """ - Confirm the consumption with actual amount. - - Args: - actual_amount: Actual amount consumed. Defaults to the reserved amount. - If less than reserved, the difference is refunded automatically. - """ - if self._committed or not self.charge_id or not self._tenant_id or not self._feature_key: - return - - try: - from services.billing_service import BillingService - - amount = actual_amount if actual_amount is not None else self._amount - BillingService.quota_commit( - tenant_id=self._tenant_id, - feature_key=self._feature_key, - reservation_id=self.charge_id, - actual_amount=amount, - ) - self._committed = True - logger.debug( - "Committed %s quota for tenant %s, reservation_id: %s, amount: %d", - self._quota_type.value, - self._tenant_id, - self.charge_id, - amount, - ) - except Exception: - logger.exception("Failed to commit quota, reservation_id: %s", self.charge_id) - - def refund(self) -> None: - """ - Release the reserved quota (cancel the charge). - - Safe to call even if: - - charge failed or was disabled (charge_id is None) - - already committed (Release after Commit is a no-op) - - already refunded (idempotent) - - This method guarantees no exceptions will be raised. - """ - if not self.charge_id or not self._tenant_id or not self._feature_key: - return - - self._quota_type.release(self.charge_id, self._tenant_id, self._feature_key) - - class QuotaType(StrEnum): """ Supported quota types for tenant feature usage. @@ -99,7 +24,7 @@ class QuotaType(StrEnum): case _: raise ValueError(f"Invalid quota type: {self}") - def consume(self, tenant_id: str, amount: int = 1) -> QuotaCharge: + def consume(self, tenant_id: str, amount: int = 1): """ Consume quota using Reserve + immediate Commit. @@ -125,7 +50,7 @@ class QuotaType(StrEnum): charge.commit() return charge - def reserve(self, tenant_id: str, amount: int = 1) -> QuotaCharge: + def reserve(self, tenant_id: str, amount: int = 1): """ Reserve quota before task execution (Reserve phase only). @@ -147,6 +72,7 @@ class QuotaType(StrEnum): from configs import dify_config from services.billing_service import BillingService from services.errors.app import QuotaExceededError + from services.quota_service import QuotaCharge, unlimited if not dify_config.BILLING_ENABLED: logger.debug("Billing disabled, allowing request for %s", tenant_id) @@ -245,7 +171,7 @@ class QuotaType(StrEnum): from services.billing_service import BillingService try: - usage_info = BillingService.get_tenant_feature_plan_usage_info(tenant_id) + usage_info = BillingService.get_quota_info(tenant_id) if isinstance(usage_info, dict): feature_info = usage_info.get(self.billing_key, {}) if isinstance(feature_info, dict): @@ -258,7 +184,3 @@ class QuotaType(StrEnum): except Exception: logger.exception("Failed to get remaining quota for %s, feature %s", tenant_id, self.value) return -1 - - -def unlimited() -> QuotaCharge: - return QuotaCharge(success=True, charge_id=None, _quota_type=QuotaType.UNLIMITED) diff --git a/api/services/app_generate_service.py b/api/services/app_generate_service.py index ce68a1dcba..246252fda0 100644 --- a/api/services/app_generate_service.py +++ b/api/services/app_generate_service.py @@ -18,7 +18,8 @@ from core.app.features.rate_limiting import RateLimit from core.app.features.rate_limiting.rate_limit import rate_limit_context from core.app.layers.pause_state_persist_layer import PauseStateLayerConfig from core.db import session_factory -from enums.quota_type import QuotaType, unlimited +from enums.quota_type import QuotaType +from services.quota_service import unlimited from extensions.otel import AppGenerateHandler, trace_span from models.model import Account, App, AppMode, EndUser from models.workflow import Workflow, WorkflowRun diff --git a/api/services/async_workflow_service.py b/api/services/async_workflow_service.py index 5f7201de11..d9a468795c 100644 --- a/api/services/async_workflow_service.py +++ b/api/services/async_workflow_service.py @@ -13,7 +13,8 @@ from celery.result import AsyncResult from sqlalchemy import select from sqlalchemy.orm import Session -from enums.quota_type import QuotaType, unlimited +from enums.quota_type import QuotaType +from services.quota_service import unlimited from extensions.ext_database import db from models.account import Account from models.enums import CreatorUserRole, WorkflowTriggerStatus diff --git a/api/services/billing_service.py b/api/services/billing_service.py index 755407d849..717b818d52 100644 --- a/api/services/billing_service.py +++ b/api/services/billing_service.py @@ -26,6 +26,29 @@ class SubscriptionPlan(TypedDict): expiration_date: int +class QuotaReserveResult(TypedDict): + reservation_id: str + available: int + reserved: int + + +class QuotaCommitResult(TypedDict): + available: int + reserved: int + refunded: int + + +class QuotaReleaseResult(TypedDict): + available: int + reserved: int + released: int + + +_quota_reserve_adapter = TypeAdapter(QuotaReserveResult) +_quota_commit_adapter = TypeAdapter(QuotaCommitResult) +_quota_release_adapter = TypeAdapter(QuotaReleaseResult) + + class BillingService: base_url = os.environ.get("BILLING_API_URL", "BILLING_API_URL") secret_key = os.environ.get("BILLING_API_SECRET_KEY", "BILLING_API_SECRET_KEY") @@ -46,19 +69,21 @@ class BillingService: @classmethod def get_tenant_feature_plan_usage_info(cls, tenant_id: str): + """Deprecated: Use get_quota_info instead.""" params = {"tenant_id": tenant_id} - usage_info = cls._send_request("GET", "/quota/info", params=params) + usage_info = cls._send_request("GET", "/tenant-feature-usage/info", params=params) return usage_info + @classmethod + def get_quota_info(cls, tenant_id: str): + params = {"tenant_id": tenant_id} + return cls._send_request("GET", "/quota/info", params=params) + @classmethod def quota_reserve( cls, tenant_id: str, feature_key: str, request_id: str, amount: int = 1, meta: dict | None = None - ) -> dict: - """Reserve quota before task execution. - - Returns: - {"reservation_id": "uuid", "available": int, "reserved": int} - """ + ) -> QuotaReserveResult: + """Reserve quota before task execution.""" payload: dict = { "tenant_id": tenant_id, "feature_key": feature_key, @@ -67,17 +92,13 @@ class BillingService: } if meta: payload["meta"] = meta - return cls._send_request("POST", "/quota/reserve", json=payload) + return _quota_reserve_adapter.validate_python(cls._send_request("POST", "/quota/reserve", json=payload)) @classmethod def quota_commit( cls, tenant_id: str, feature_key: str, reservation_id: str, actual_amount: int, meta: dict | None = None - ) -> dict: - """Commit a reservation with actual consumption. - - Returns: - {"available": int, "reserved": int, "refunded": int} - """ + ) -> QuotaCommitResult: + """Commit a reservation with actual consumption.""" payload: dict = { "tenant_id": tenant_id, "feature_key": feature_key, @@ -86,23 +107,21 @@ class BillingService: } if meta: payload["meta"] = meta - return cls._send_request("POST", "/quota/commit", json=payload) + return _quota_commit_adapter.validate_python(cls._send_request("POST", "/quota/commit", json=payload)) @classmethod - def quota_release(cls, tenant_id: str, feature_key: str, reservation_id: str) -> dict: - """Release a reservation (cancel, return frozen quota). - - Returns: - {"available": int, "reserved": int, "released": int} - """ - return cls._send_request( - "POST", - "/quota/release", - json={ - "tenant_id": tenant_id, - "feature_key": feature_key, - "reservation_id": reservation_id, - }, + def quota_release(cls, tenant_id: str, feature_key: str, reservation_id: str) -> QuotaReleaseResult: + """Release a reservation (cancel, return frozen quota).""" + return _quota_release_adapter.validate_python( + cls._send_request( + "POST", + "/quota/release", + json={ + "tenant_id": tenant_id, + "feature_key": feature_key, + "reservation_id": reservation_id, + }, + ) ) @classmethod diff --git a/api/services/quota_service.py b/api/services/quota_service.py new file mode 100644 index 0000000000..77cfdda3a3 --- /dev/null +++ b/api/services/quota_service.py @@ -0,0 +1,90 @@ +from __future__ import annotations + +import logging +from dataclasses import dataclass, field +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from enums.quota_type import QuotaType + +logger = logging.getLogger(__name__) + + +@dataclass +class QuotaCharge: + """ + Result of a quota reservation (Reserve phase). + + Lifecycle: + charge = QuotaType.TRIGGER.consume(tenant_id) # Reserve + try: + do_work() + charge.commit() # Confirm consumption + except: + charge.refund() # Release frozen quota + + If neither commit() nor refund() is called, the billing system's + cleanup CronJob will auto-release the reservation within ~75 seconds. + """ + + success: bool + charge_id: str | None # reservation_id + _quota_type: QuotaType + _tenant_id: str | None = None + _feature_key: str | None = None + _amount: int = 0 + _committed: bool = field(default=False, repr=False) + + def commit(self, actual_amount: int | None = None) -> None: + """ + Confirm the consumption with actual amount. + + Args: + actual_amount: Actual amount consumed. Defaults to the reserved amount. + If less than reserved, the difference is refunded automatically. + """ + if self._committed or not self.charge_id or not self._tenant_id or not self._feature_key: + return + + try: + from services.billing_service import BillingService + + amount = actual_amount if actual_amount is not None else self._amount + BillingService.quota_commit( + tenant_id=self._tenant_id, + feature_key=self._feature_key, + reservation_id=self.charge_id, + actual_amount=amount, + ) + self._committed = True + logger.debug( + "Committed %s quota for tenant %s, reservation_id: %s, amount: %d", + self._quota_type, + self._tenant_id, + self.charge_id, + amount, + ) + except Exception: + logger.exception("Failed to commit quota, reservation_id: %s", self.charge_id) + + def refund(self) -> None: + """ + Release the reserved quota (cancel the charge). + + Safe to call even if: + - charge failed or was disabled (charge_id is None) + - already committed (Release after Commit is a no-op) + - already refunded (idempotent) + + This method guarantees no exceptions will be raised. + """ + if not self.charge_id or not self._tenant_id or not self._feature_key: + return + + self._quota_type.release(self.charge_id, self._tenant_id, self._feature_key) + + +def unlimited() -> QuotaCharge: + from enums.quota_type import QuotaType + + return QuotaCharge(success=True, charge_id=None, _quota_type=QuotaType.UNLIMITED) diff --git a/api/tasks/trigger_processing_tasks.py b/api/tasks/trigger_processing_tasks.py index aca2b93fc9..a3f72da6f5 100644 --- a/api/tasks/trigger_processing_tasks.py +++ b/api/tasks/trigger_processing_tasks.py @@ -28,7 +28,8 @@ from core.trigger.entities.entities import TriggerProviderEntity from core.trigger.provider import PluginTriggerProviderController from core.trigger.trigger_manager import TriggerManager from core.workflow.nodes.trigger_plugin.entities import TriggerEventNodeData -from enums.quota_type import QuotaType, unlimited +from enums.quota_type import QuotaType +from services.quota_service import unlimited from models.enums import ( AppTriggerType, CreatorUserRole, diff --git a/api/tasks/workflow_schedule_tasks.py b/api/tasks/workflow_schedule_tasks.py index 9aa90c3793..2816bd04ab 100644 --- a/api/tasks/workflow_schedule_tasks.py +++ b/api/tasks/workflow_schedule_tasks.py @@ -8,7 +8,8 @@ from core.workflow.nodes.trigger_schedule.exc import ( ScheduleNotFoundError, TenantOwnerNotFoundError, ) -from enums.quota_type import QuotaType, unlimited +from enums.quota_type import QuotaType +from services.quota_service import unlimited from models.trigger import WorkflowSchedulePlan from services.async_workflow_service import AsyncWorkflowService from services.errors.app import QuotaExceededError diff --git a/api/tests/unit_tests/enums/test_quota_type.py b/api/tests/unit_tests/enums/test_quota_type.py index ac34064f8a..85b5b8bb3e 100644 --- a/api/tests/unit_tests/enums/test_quota_type.py +++ b/api/tests/unit_tests/enums/test_quota_type.py @@ -4,7 +4,8 @@ from unittest.mock import patch import pytest -from enums.quota_type import QuotaCharge, QuotaType, unlimited +from enums.quota_type import QuotaType +from services.quota_service import QuotaCharge, unlimited class TestQuotaType: @@ -186,43 +187,43 @@ class TestQuotaType: def test_get_remaining_normal(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = {"trigger_event": {"limit": 100, "usage": 30}} + mock_bs.get_quota_info.return_value = {"trigger_event": {"limit": 100, "usage": 30}} assert QuotaType.TRIGGER.get_remaining("t1") == 70 def test_get_remaining_unlimited(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = {"trigger_event": {"limit": -1, "usage": 0}} + mock_bs.get_quota_info.return_value = {"trigger_event": {"limit": -1, "usage": 0}} assert QuotaType.TRIGGER.get_remaining("t1") == -1 def test_get_remaining_over_limit_returns_zero(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = {"trigger_event": {"limit": 10, "usage": 15}} + mock_bs.get_quota_info.return_value = {"trigger_event": {"limit": 10, "usage": 15}} assert QuotaType.TRIGGER.get_remaining("t1") == 0 def test_get_remaining_exception_returns_neg1(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.side_effect = RuntimeError + mock_bs.get_quota_info.side_effect = RuntimeError assert QuotaType.TRIGGER.get_remaining("t1") == -1 def test_get_remaining_empty_response(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = {} + mock_bs.get_quota_info.return_value = {} assert QuotaType.TRIGGER.get_remaining("t1") == 0 def test_get_remaining_non_dict_response(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = "invalid" + mock_bs.get_quota_info.return_value = "invalid" assert QuotaType.TRIGGER.get_remaining("t1") == 0 def test_get_remaining_feature_not_in_response(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = {"other_feature": {"limit": 100, "usage": 0}} + mock_bs.get_quota_info.return_value = {"other_feature": {"limit": 100, "usage": 0}} remaining = QuotaType.TRIGGER.get_remaining("t1") assert remaining == 0 def test_get_remaining_non_dict_feature_info(self): with patch("services.billing_service.BillingService") as mock_bs: - mock_bs.get_tenant_feature_plan_usage_info.return_value = {"trigger_event": "not_a_dict"} + mock_bs.get_quota_info.return_value = {"trigger_event": "not_a_dict"} assert QuotaType.TRIGGER.get_remaining("t1") == 0 diff --git a/api/tests/unit_tests/services/test_billing_service.py b/api/tests/unit_tests/services/test_billing_service.py index 3ae2e006e3..ed78397dc3 100644 --- a/api/tests/unit_tests/services/test_billing_service.py +++ b/api/tests/unit_tests/services/test_billing_service.py @@ -415,7 +415,7 @@ class TestBillingServiceUsageCalculation: yield mock def test_get_tenant_feature_plan_usage_info(self, mock_send_request): - """Test retrieval of tenant feature plan usage information.""" + """Test retrieval of tenant feature plan usage information (legacy endpoint).""" # Arrange tenant_id = "tenant-123" expected_response = {"features": {"trigger": {"used": 50, "limit": 100}, "workflow": {"used": 20, "limit": 50}}} @@ -424,6 +424,20 @@ class TestBillingServiceUsageCalculation: # Act result = BillingService.get_tenant_feature_plan_usage_info(tenant_id) + # Assert + assert result == expected_response + mock_send_request.assert_called_once_with("GET", "/tenant-feature-usage/info", params={"tenant_id": tenant_id}) + + def test_get_quota_info(self, mock_send_request): + """Test retrieval of quota info from new endpoint.""" + # Arrange + tenant_id = "tenant-123" + expected_response = {"trigger_event": {"limit": 100, "usage": 30}, "api_rate_limit": {"limit": -1, "usage": 0}} + mock_send_request.return_value = expected_response + + # Act + result = BillingService.get_quota_info(tenant_id) + # Assert assert result == expected_response mock_send_request.assert_called_once_with("GET", "/quota/info", params={"tenant_id": tenant_id}) @@ -526,8 +540,19 @@ class TestBillingServiceQuotaOperations: json={"tenant_id": "t1", "feature_key": "trigger_event", "request_id": "req-1", "amount": 1}, ) + def test_quota_reserve_coerces_string_to_int(self, mock_send_request): + """Test that TypeAdapter coerces string values to int.""" + mock_send_request.return_value = {"reservation_id": "rid-str", "available": "99", "reserved": "1"} + + result = BillingService.quota_reserve(tenant_id="t1", feature_key="trigger_event", request_id="req-s", amount=1) + + assert result["available"] == 99 + assert isinstance(result["available"], int) + assert result["reserved"] == 1 + assert isinstance(result["reserved"], int) + def test_quota_reserve_with_meta(self, mock_send_request): - mock_send_request.return_value = {"reservation_id": "rid-2"} + mock_send_request.return_value = {"reservation_id": "rid-2", "available": 98, "reserved": 1} meta = {"source": "webhook"} BillingService.quota_reserve( @@ -557,8 +582,21 @@ class TestBillingServiceQuotaOperations: }, ) + def test_quota_commit_coerces_string_to_int(self, mock_send_request): + """Test that TypeAdapter coerces string values to int.""" + mock_send_request.return_value = {"available": "97", "reserved": "0", "refunded": "1"} + + result = BillingService.quota_commit( + tenant_id="t1", feature_key="trigger_event", reservation_id="rid-s", actual_amount=1 + ) + + assert result["available"] == 97 + assert isinstance(result["available"], int) + assert result["refunded"] == 1 + assert isinstance(result["refunded"], int) + def test_quota_commit_with_meta(self, mock_send_request): - mock_send_request.return_value = {} + mock_send_request.return_value = {"available": 97, "reserved": 0, "refunded": 0} meta = {"reason": "partial"} BillingService.quota_commit( @@ -581,6 +619,17 @@ class TestBillingServiceQuotaOperations: json={"tenant_id": "t1", "feature_key": "trigger_event", "reservation_id": "rid-1"}, ) + def test_quota_release_coerces_string_to_int(self, mock_send_request): + """Test that TypeAdapter coerces string values to int.""" + mock_send_request.return_value = {"available": "100", "reserved": "0", "released": "1"} + + result = BillingService.quota_release(tenant_id="t1", feature_key="trigger_event", reservation_id="rid-s") + + assert result["available"] == 100 + assert isinstance(result["available"], int) + assert result["released"] == 1 + assert isinstance(result["released"], int) + class TestBillingServiceRateLimitEnforcement: """Unit tests for rate limit enforcement mechanisms. From 6e745f9e9b85d9f9ec2ee7f20751da597047ad53 Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Tue, 31 Mar 2026 09:49:24 +0800 Subject: [PATCH 07/34] fix linter --- api/services/app_generate_service.py | 2 +- api/services/async_workflow_service.py | 2 +- api/tasks/trigger_processing_tasks.py | 2 +- api/tasks/workflow_schedule_tasks.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/services/app_generate_service.py b/api/services/app_generate_service.py index 246252fda0..ee24424cd5 100644 --- a/api/services/app_generate_service.py +++ b/api/services/app_generate_service.py @@ -19,12 +19,12 @@ from core.app.features.rate_limiting.rate_limit import rate_limit_context from core.app.layers.pause_state_persist_layer import PauseStateLayerConfig from core.db import session_factory from enums.quota_type import QuotaType -from services.quota_service import unlimited from extensions.otel import AppGenerateHandler, trace_span from models.model import Account, App, AppMode, EndUser from models.workflow import Workflow, WorkflowRun from services.errors.app import QuotaExceededError, WorkflowIdFormatError, WorkflowNotFoundError from services.errors.llm import InvokeRateLimitError +from services.quota_service import unlimited from services.workflow_service import WorkflowService from tasks.app_generate.workflow_execute_task import AppExecutionParams, workflow_based_app_execution_task diff --git a/api/services/async_workflow_service.py b/api/services/async_workflow_service.py index d9a468795c..e78e03cce5 100644 --- a/api/services/async_workflow_service.py +++ b/api/services/async_workflow_service.py @@ -14,7 +14,6 @@ from sqlalchemy import select from sqlalchemy.orm import Session from enums.quota_type import QuotaType -from services.quota_service import unlimited from extensions.ext_database import db from models.account import Account from models.enums import CreatorUserRole, WorkflowTriggerStatus @@ -23,6 +22,7 @@ from models.trigger import WorkflowTriggerLog, WorkflowTriggerLogDict from models.workflow import Workflow from repositories.sqlalchemy_workflow_trigger_log_repository import SQLAlchemyWorkflowTriggerLogRepository from services.errors.app import QuotaExceededError, WorkflowNotFoundError, WorkflowQuotaLimitError +from services.quota_service import unlimited from services.workflow.entities import AsyncTriggerResponse, TriggerData, WorkflowTaskData from services.workflow.queue_dispatcher import QueueDispatcherManager, QueuePriority from services.workflow_service import WorkflowService diff --git a/api/tasks/trigger_processing_tasks.py b/api/tasks/trigger_processing_tasks.py index a3f72da6f5..1b1e809baf 100644 --- a/api/tasks/trigger_processing_tasks.py +++ b/api/tasks/trigger_processing_tasks.py @@ -29,7 +29,6 @@ from core.trigger.provider import PluginTriggerProviderController from core.trigger.trigger_manager import TriggerManager from core.workflow.nodes.trigger_plugin.entities import TriggerEventNodeData from enums.quota_type import QuotaType -from services.quota_service import unlimited from models.enums import ( AppTriggerType, CreatorUserRole, @@ -43,6 +42,7 @@ from models.workflow import Workflow, WorkflowAppLog, WorkflowAppLogCreatedFrom, from services.async_workflow_service import AsyncWorkflowService from services.end_user_service import EndUserService from services.errors.app import QuotaExceededError +from services.quota_service import unlimited from services.trigger.app_trigger_service import AppTriggerService from services.trigger.trigger_provider_service import TriggerProviderService from services.trigger.trigger_request_service import TriggerHttpRequestCachingService diff --git a/api/tasks/workflow_schedule_tasks.py b/api/tasks/workflow_schedule_tasks.py index 2816bd04ab..774e1103df 100644 --- a/api/tasks/workflow_schedule_tasks.py +++ b/api/tasks/workflow_schedule_tasks.py @@ -9,10 +9,10 @@ from core.workflow.nodes.trigger_schedule.exc import ( TenantOwnerNotFoundError, ) from enums.quota_type import QuotaType -from services.quota_service import unlimited from models.trigger import WorkflowSchedulePlan from services.async_workflow_service import AsyncWorkflowService from services.errors.app import QuotaExceededError +from services.quota_service import unlimited from services.trigger.app_trigger_service import AppTriggerService from services.trigger.schedule_service import ScheduleService from services.workflow.entities import ScheduleTriggerData From 422bf3506e4ff71a1b1a394fc1d5162e52dec02e Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Tue, 31 Mar 2026 14:59:45 +0800 Subject: [PATCH 08/34] rebuild quota service --- api/enums/quota_type.py | 165 ------------------ api/services/app_generate_service.py | 4 +- api/services/async_workflow_service.py | 4 +- api/services/quota_service.py | 147 +++++++++++++++- api/services/trigger/webhook_service.py | 3 +- api/tasks/trigger_processing_tasks.py | 4 +- api/tasks/workflow_schedule_tasks.py | 4 +- .../trigger/test_trigger_e2e.py | 4 +- api/tests/unit_tests/enums/test_quota_type.py | 106 +++++------ .../services/test_app_generate_service.py | 6 +- .../services/test_async_workflow_service.py | 16 +- 11 files changed, 222 insertions(+), 241 deletions(-) diff --git a/api/enums/quota_type.py b/api/enums/quota_type.py index 95146d17d9..a10ac21f69 100644 --- a/api/enums/quota_type.py +++ b/api/enums/quota_type.py @@ -1,9 +1,5 @@ -import logging -import uuid from enum import StrEnum, auto -logger = logging.getLogger(__name__) - class QuotaType(StrEnum): """ @@ -23,164 +19,3 @@ class QuotaType(StrEnum): return "api_rate_limit" case _: raise ValueError(f"Invalid quota type: {self}") - - def consume(self, tenant_id: str, amount: int = 1): - """ - Consume quota using Reserve + immediate Commit. - - This is the simple one-shot mode: Reserve freezes quota, then Commit - confirms it right away. The returned QuotaCharge supports .refund() - which calls Release (idempotent even after Commit). - - For advanced two-phase usage (e.g. streaming), use reserve() directly - and call charge.commit() / charge.refund() manually. - - Args: - tenant_id: The tenant identifier - amount: Amount to consume (default: 1) - - Returns: - QuotaCharge with reservation_id for potential refund - - Raises: - QuotaExceededError: When quota is insufficient - """ - charge = self.reserve(tenant_id, amount) - if charge.success and charge.charge_id: - charge.commit() - return charge - - def reserve(self, tenant_id: str, amount: int = 1): - """ - Reserve quota before task execution (Reserve phase only). - - The caller MUST call charge.commit() after the task succeeds, - or charge.refund() if the task fails. - - If neither is called, the reservation auto-expires in ~75 seconds. - - Args: - tenant_id: The tenant identifier - amount: Amount to reserve (default: 1) - - Returns: - QuotaCharge — call .commit() on success, .refund() on failure - - Raises: - QuotaExceededError: When quota is insufficient - """ - from configs import dify_config - from services.billing_service import BillingService - from services.errors.app import QuotaExceededError - from services.quota_service import QuotaCharge, unlimited - - if not dify_config.BILLING_ENABLED: - logger.debug("Billing disabled, allowing request for %s", tenant_id) - return QuotaCharge(success=True, charge_id=None, _quota_type=self) - - logger.info("Reserving %d %s quota for tenant %s", amount, self.value, tenant_id) - - if amount <= 0: - raise ValueError("Amount to reserve must be greater than 0") - - request_id = str(uuid.uuid4()) - feature_key = self.billing_key - - try: - reserve_resp = BillingService.quota_reserve( - tenant_id=tenant_id, - feature_key=feature_key, - request_id=request_id, - amount=amount, - ) - - reservation_id = reserve_resp.get("reservation_id") - if not reservation_id: - logger.warning( - "Reserve returned no reservation_id for %s, feature %s, response: %s", - tenant_id, - self.value, - reserve_resp, - ) - raise QuotaExceededError(feature=self.value, tenant_id=tenant_id, required=amount) - - logger.debug( - "Reserved %d %s quota for tenant %s, reservation_id: %s", - amount, - self.value, - tenant_id, - reservation_id, - ) - return QuotaCharge( - success=True, - charge_id=reservation_id, - _quota_type=self, - _tenant_id=tenant_id, - _feature_key=feature_key, - _amount=amount, - ) - - except QuotaExceededError: - raise - except ValueError: - raise - except Exception: - logger.exception("Failed to reserve quota for %s, feature %s", tenant_id, self.value) - return unlimited() - - def check(self, tenant_id: str, amount: int = 1) -> bool: - from configs import dify_config - - if not dify_config.BILLING_ENABLED: - return True - - if amount <= 0: - raise ValueError("Amount to check must be greater than 0") - - try: - remaining = self.get_remaining(tenant_id) - return remaining >= amount if remaining != -1 else True - except Exception: - logger.exception("Failed to check quota for %s, feature %s", tenant_id, self.value) - return True - - def release(self, reservation_id: str, tenant_id: str, feature_key: str) -> None: - """ - Release a reservation. Guarantees no exceptions. - """ - try: - from configs import dify_config - from services.billing_service import BillingService - - if not dify_config.BILLING_ENABLED: - return - - if not reservation_id: - return - - logger.info("Releasing %s quota, reservation_id: %s", self.value, reservation_id) - BillingService.quota_release( - tenant_id=tenant_id, - feature_key=feature_key, - reservation_id=reservation_id, - ) - except Exception: - logger.exception("Failed to release quota, reservation_id: %s", reservation_id) - - def get_remaining(self, tenant_id: str) -> int: - from services.billing_service import BillingService - - try: - usage_info = BillingService.get_quota_info(tenant_id) - if isinstance(usage_info, dict): - feature_info = usage_info.get(self.billing_key, {}) - if isinstance(feature_info, dict): - limit = feature_info.get("limit", 0) - usage = feature_info.get("usage", 0) - if limit == -1: - return -1 - return max(0, limit - usage) - return 0 - except Exception: - logger.exception("Failed to get remaining quota for %s, feature %s", tenant_id, self.value) - return -1 diff --git a/api/services/app_generate_service.py b/api/services/app_generate_service.py index ee24424cd5..5bff841c10 100644 --- a/api/services/app_generate_service.py +++ b/api/services/app_generate_service.py @@ -24,7 +24,7 @@ from models.model import Account, App, AppMode, EndUser from models.workflow import Workflow, WorkflowRun from services.errors.app import QuotaExceededError, WorkflowIdFormatError, WorkflowNotFoundError from services.errors.llm import InvokeRateLimitError -from services.quota_service import unlimited +from services.quota_service import QuotaService, unlimited from services.workflow_service import WorkflowService from tasks.app_generate.workflow_execute_task import AppExecutionParams, workflow_based_app_execution_task @@ -107,7 +107,7 @@ class AppGenerateService: quota_charge = unlimited() if dify_config.BILLING_ENABLED: try: - quota_charge = QuotaType.WORKFLOW.reserve(app_model.tenant_id) + quota_charge = QuotaService.reserve(QuotaType.WORKFLOW, app_model.tenant_id) except QuotaExceededError: raise InvokeRateLimitError(f"Workflow execution quota limit reached for tenant {app_model.tenant_id}") diff --git a/api/services/async_workflow_service.py b/api/services/async_workflow_service.py index e78e03cce5..327756753c 100644 --- a/api/services/async_workflow_service.py +++ b/api/services/async_workflow_service.py @@ -22,7 +22,7 @@ from models.trigger import WorkflowTriggerLog, WorkflowTriggerLogDict from models.workflow import Workflow from repositories.sqlalchemy_workflow_trigger_log_repository import SQLAlchemyWorkflowTriggerLogRepository from services.errors.app import QuotaExceededError, WorkflowNotFoundError, WorkflowQuotaLimitError -from services.quota_service import unlimited +from services.quota_service import QuotaService, unlimited from services.workflow.entities import AsyncTriggerResponse, TriggerData, WorkflowTaskData from services.workflow.queue_dispatcher import QueueDispatcherManager, QueuePriority from services.workflow_service import WorkflowService @@ -135,7 +135,7 @@ class AsyncWorkflowService: # 7. Reserve quota (commit after successful dispatch) quota_charge = unlimited() try: - quota_charge = QuotaType.WORKFLOW.reserve(trigger_data.tenant_id) + quota_charge = QuotaService.reserve(QuotaType.WORKFLOW, trigger_data.tenant_id) except QuotaExceededError as e: # Update trigger log status trigger_log.status = WorkflowTriggerStatus.RATE_LIMITED diff --git a/api/services/quota_service.py b/api/services/quota_service.py index 77cfdda3a3..4c784315c7 100644 --- a/api/services/quota_service.py +++ b/api/services/quota_service.py @@ -1,9 +1,12 @@ from __future__ import annotations import logging +import uuid from dataclasses import dataclass, field from typing import TYPE_CHECKING +from configs import dify_config + if TYPE_CHECKING: from enums.quota_type import QuotaType @@ -16,7 +19,7 @@ class QuotaCharge: Result of a quota reservation (Reserve phase). Lifecycle: - charge = QuotaType.TRIGGER.consume(tenant_id) # Reserve + charge = QuotaService.consume(QuotaType.TRIGGER, tenant_id) try: do_work() charge.commit() # Confirm consumption @@ -81,10 +84,150 @@ class QuotaCharge: if not self.charge_id or not self._tenant_id or not self._feature_key: return - self._quota_type.release(self.charge_id, self._tenant_id, self._feature_key) + QuotaService.release(self._quota_type, self.charge_id, self._tenant_id, self._feature_key) def unlimited() -> QuotaCharge: from enums.quota_type import QuotaType return QuotaCharge(success=True, charge_id=None, _quota_type=QuotaType.UNLIMITED) + + +class QuotaService: + """Orchestrates quota reserve / commit / release lifecycle via BillingService.""" + + @staticmethod + def consume(quota_type: QuotaType, tenant_id: str, amount: int = 1) -> QuotaCharge: + """ + Reserve + immediate Commit (one-shot mode). + + The returned QuotaCharge supports .refund() which calls Release. + For two-phase usage (e.g. streaming), use reserve() directly. + """ + charge = QuotaService.reserve(quota_type, tenant_id, amount) + if charge.success and charge.charge_id: + charge.commit() + return charge + + @staticmethod + def reserve(quota_type: QuotaType, tenant_id: str, amount: int = 1) -> QuotaCharge: + """ + Reserve quota before task execution (Reserve phase only). + + The caller MUST call charge.commit() after the task succeeds, + or charge.refund() if the task fails. + + Raises: + QuotaExceededError: When quota is insufficient + """ + from services.billing_service import BillingService + from services.errors.app import QuotaExceededError + + if not dify_config.BILLING_ENABLED: + logger.debug("Billing disabled, allowing request for %s", tenant_id) + return QuotaCharge(success=True, charge_id=None, _quota_type=quota_type) + + logger.info("Reserving %d %s quota for tenant %s", amount, quota_type.value, tenant_id) + + if amount <= 0: + raise ValueError("Amount to reserve must be greater than 0") + + request_id = str(uuid.uuid4()) + feature_key = quota_type.billing_key + + try: + reserve_resp = BillingService.quota_reserve( + tenant_id=tenant_id, + feature_key=feature_key, + request_id=request_id, + amount=amount, + ) + + reservation_id = reserve_resp.get("reservation_id") + if not reservation_id: + logger.warning( + "Reserve returned no reservation_id for %s, feature %s, response: %s", + tenant_id, + quota_type.value, + reserve_resp, + ) + raise QuotaExceededError(feature=quota_type.value, tenant_id=tenant_id, required=amount) + + logger.debug( + "Reserved %d %s quota for tenant %s, reservation_id: %s", + amount, + quota_type.value, + tenant_id, + reservation_id, + ) + return QuotaCharge( + success=True, + charge_id=reservation_id, + _quota_type=quota_type, + _tenant_id=tenant_id, + _feature_key=feature_key, + _amount=amount, + ) + + except QuotaExceededError: + raise + except ValueError: + raise + except Exception: + logger.exception("Failed to reserve quota for %s, feature %s", tenant_id, quota_type.value) + return unlimited() + + @staticmethod + def check(quota_type: QuotaType, tenant_id: str, amount: int = 1) -> bool: + if not dify_config.BILLING_ENABLED: + return True + + if amount <= 0: + raise ValueError("Amount to check must be greater than 0") + + try: + remaining = QuotaService.get_remaining(quota_type, tenant_id) + return remaining >= amount if remaining != -1 else True + except Exception: + logger.exception("Failed to check quota for %s, feature %s", tenant_id, quota_type.value) + return True + + @staticmethod + def release(quota_type: QuotaType, reservation_id: str, tenant_id: str, feature_key: str) -> None: + """Release a reservation. Guarantees no exceptions.""" + try: + from services.billing_service import BillingService + + if not dify_config.BILLING_ENABLED: + return + + if not reservation_id: + return + + logger.info("Releasing %s quota, reservation_id: %s", quota_type.value, reservation_id) + BillingService.quota_release( + tenant_id=tenant_id, + feature_key=feature_key, + reservation_id=reservation_id, + ) + except Exception: + logger.exception("Failed to release quota, reservation_id: %s", reservation_id) + + @staticmethod + def get_remaining(quota_type: QuotaType, tenant_id: str) -> int: + from services.billing_service import BillingService + + try: + usage_info = BillingService.get_quota_info(tenant_id) + if isinstance(usage_info, dict): + feature_info = usage_info.get(quota_type.billing_key, {}) + if isinstance(feature_info, dict): + limit = feature_info.get("limit", 0) + usage = feature_info.get("usage", 0) + if limit == -1: + return -1 + return max(0, limit - usage) + return 0 + except Exception: + logger.exception("Failed to get remaining quota for %s, feature %s", tenant_id, quota_type.value) + return -1 diff --git a/api/services/trigger/webhook_service.py b/api/services/trigger/webhook_service.py index 2254ce8e7d..b71ae6fe41 100644 --- a/api/services/trigger/webhook_service.py +++ b/api/services/trigger/webhook_service.py @@ -28,6 +28,7 @@ from core.workflow.nodes.trigger_webhook.entities import ( WebhookParameter, ) from enums.quota_type import QuotaType +from services.quota_service import QuotaService from extensions.ext_database import db from extensions.ext_redis import redis_client from factories import file_factory @@ -784,7 +785,7 @@ class WebhookService: # reserve quota before triggering workflow execution try: - quota_charge = QuotaType.TRIGGER.reserve(webhook_trigger.tenant_id) + quota_charge = QuotaService.reserve(QuotaType.TRIGGER, webhook_trigger.tenant_id) except QuotaExceededError: AppTriggerService.mark_tenant_triggers_rate_limited(webhook_trigger.tenant_id) logger.info( diff --git a/api/tasks/trigger_processing_tasks.py b/api/tasks/trigger_processing_tasks.py index 1b1e809baf..b9f382eccf 100644 --- a/api/tasks/trigger_processing_tasks.py +++ b/api/tasks/trigger_processing_tasks.py @@ -42,7 +42,7 @@ from models.workflow import Workflow, WorkflowAppLog, WorkflowAppLogCreatedFrom, from services.async_workflow_service import AsyncWorkflowService from services.end_user_service import EndUserService from services.errors.app import QuotaExceededError -from services.quota_service import unlimited +from services.quota_service import QuotaService, unlimited from services.trigger.app_trigger_service import AppTriggerService from services.trigger.trigger_provider_service import TriggerProviderService from services.trigger.trigger_request_service import TriggerHttpRequestCachingService @@ -302,7 +302,7 @@ def dispatch_triggered_workflow( # reserve quota before invoking trigger quota_charge = unlimited() try: - quota_charge = QuotaType.TRIGGER.reserve(subscription.tenant_id) + quota_charge = QuotaService.reserve(QuotaType.TRIGGER, subscription.tenant_id) except QuotaExceededError: AppTriggerService.mark_tenant_triggers_rate_limited(subscription.tenant_id) logger.info( diff --git a/api/tasks/workflow_schedule_tasks.py b/api/tasks/workflow_schedule_tasks.py index 774e1103df..dfb2fb3391 100644 --- a/api/tasks/workflow_schedule_tasks.py +++ b/api/tasks/workflow_schedule_tasks.py @@ -12,7 +12,7 @@ from enums.quota_type import QuotaType from models.trigger import WorkflowSchedulePlan from services.async_workflow_service import AsyncWorkflowService from services.errors.app import QuotaExceededError -from services.quota_service import unlimited +from services.quota_service import QuotaService, unlimited from services.trigger.app_trigger_service import AppTriggerService from services.trigger.schedule_service import ScheduleService from services.workflow.entities import ScheduleTriggerData @@ -44,7 +44,7 @@ def run_schedule_trigger(schedule_id: str) -> None: quota_charge = unlimited() try: - quota_charge = QuotaType.TRIGGER.reserve(schedule.tenant_id) + quota_charge = QuotaService.reserve(QuotaType.TRIGGER, schedule.tenant_id) except QuotaExceededError: AppTriggerService.mark_tenant_triggers_rate_limited(schedule.tenant_id) logger.info("Tenant %s rate limited, skipping schedule trigger %s", schedule.tenant_id, schedule_id) diff --git a/api/tests/test_containers_integration_tests/trigger/test_trigger_e2e.py b/api/tests/test_containers_integration_tests/trigger/test_trigger_e2e.py index 7539bae685..3514447240 100644 --- a/api/tests/test_containers_integration_tests/trigger/test_trigger_e2e.py +++ b/api/tests/test_containers_integration_tests/trigger/test_trigger_e2e.py @@ -602,9 +602,9 @@ def test_schedule_trigger_creates_trigger_log( ) # Mock quota to avoid rate limiting - from enums import quota_type + from services import quota_service - monkeypatch.setattr(quota_type.QuotaType.TRIGGER, "consume", lambda _tenant_id: quota_type.unlimited()) + monkeypatch.setattr(quota_service.QuotaService, "reserve", lambda *_args, **_kwargs: quota_service.unlimited()) # Execute schedule trigger workflow_schedule_tasks.run_schedule_trigger(plan.id) diff --git a/api/tests/unit_tests/enums/test_quota_type.py b/api/tests/unit_tests/enums/test_quota_type.py index 85b5b8bb3e..f256ff3b4e 100644 --- a/api/tests/unit_tests/enums/test_quota_type.py +++ b/api/tests/unit_tests/enums/test_quota_type.py @@ -1,11 +1,11 @@ -"""Unit tests for QuotaType and QuotaCharge.""" +"""Unit tests for QuotaType, QuotaService, and QuotaCharge.""" from unittest.mock import patch import pytest from enums.quota_type import QuotaType -from services.quota_service import QuotaCharge, unlimited +from services.quota_service import QuotaCharge, QuotaService, unlimited class TestQuotaType: @@ -19,31 +19,33 @@ class TestQuotaType: with pytest.raises(ValueError, match="Invalid quota type"): _ = QuotaType.UNLIMITED.billing_key + +class TestQuotaService: def test_reserve_billing_disabled(self): with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService"), ): mock_cfg.BILLING_ENABLED = False - charge = QuotaType.TRIGGER.reserve("t1") + charge = QuotaService.reserve(QuotaType.TRIGGER, "t1") assert charge.success is True assert charge.charge_id is None def test_reserve_zero_amount_raises(self): - with patch("configs.dify_config") as mock_cfg: + with patch("services.quota_service.dify_config") as mock_cfg: mock_cfg.BILLING_ENABLED = True with pytest.raises(ValueError, match="greater than 0"): - QuotaType.TRIGGER.reserve("t1", amount=0) + QuotaService.reserve(QuotaType.TRIGGER, "t1", amount=0) def test_reserve_success(self): with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = True mock_bs.quota_reserve.return_value = {"reservation_id": "rid-1", "available": 99} - charge = QuotaType.TRIGGER.reserve("t1", amount=1) + charge = QuotaService.reserve(QuotaType.TRIGGER, "t1", amount=1) assert charge.success is True assert charge.charge_id == "rid-1" @@ -56,175 +58,175 @@ class TestQuotaType: from services.errors.app import QuotaExceededError with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = True mock_bs.quota_reserve.return_value = {} with pytest.raises(QuotaExceededError): - QuotaType.TRIGGER.reserve("t1") + QuotaService.reserve(QuotaType.TRIGGER, "t1") def test_reserve_quota_exceeded_propagates(self): from services.errors.app import QuotaExceededError with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = True mock_bs.quota_reserve.side_effect = QuotaExceededError(feature="trigger", tenant_id="t1", required=1) with pytest.raises(QuotaExceededError): - QuotaType.TRIGGER.reserve("t1") + QuotaService.reserve(QuotaType.TRIGGER, "t1") def test_reserve_api_exception_returns_unlimited(self): with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = True mock_bs.quota_reserve.side_effect = RuntimeError("network") - charge = QuotaType.TRIGGER.reserve("t1") + charge = QuotaService.reserve(QuotaType.TRIGGER, "t1") assert charge.success is True assert charge.charge_id is None def test_consume_calls_reserve_and_commit(self): with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = True mock_bs.quota_reserve.return_value = {"reservation_id": "rid-c"} mock_bs.quota_commit.return_value = {} - charge = QuotaType.TRIGGER.consume("t1") + charge = QuotaService.consume(QuotaType.TRIGGER, "t1") assert charge.success is True mock_bs.quota_commit.assert_called_once() def test_check_billing_disabled(self): - with patch("configs.dify_config") as mock_cfg: + with patch("services.quota_service.dify_config") as mock_cfg: mock_cfg.BILLING_ENABLED = False - assert QuotaType.TRIGGER.check("t1") is True + assert QuotaService.check(QuotaType.TRIGGER, "t1") is True def test_check_zero_amount_raises(self): - with patch("configs.dify_config") as mock_cfg: + with patch("services.quota_service.dify_config") as mock_cfg: mock_cfg.BILLING_ENABLED = True with pytest.raises(ValueError, match="greater than 0"): - QuotaType.TRIGGER.check("t1", amount=0) + QuotaService.check(QuotaType.TRIGGER, "t1", amount=0) def test_check_sufficient_quota(self): with ( - patch("configs.dify_config") as mock_cfg, - patch.object(QuotaType.TRIGGER, "get_remaining", return_value=100), + patch("services.quota_service.dify_config") as mock_cfg, + patch.object(QuotaService, "get_remaining", return_value=100), ): mock_cfg.BILLING_ENABLED = True - assert QuotaType.TRIGGER.check("t1", amount=50) is True + assert QuotaService.check(QuotaType.TRIGGER, "t1", amount=50) is True def test_check_insufficient_quota(self): with ( - patch("configs.dify_config") as mock_cfg, - patch.object(QuotaType.TRIGGER, "get_remaining", return_value=5), + patch("services.quota_service.dify_config") as mock_cfg, + patch.object(QuotaService, "get_remaining", return_value=5), ): mock_cfg.BILLING_ENABLED = True - assert QuotaType.TRIGGER.check("t1", amount=10) is False + assert QuotaService.check(QuotaType.TRIGGER, "t1", amount=10) is False def test_check_unlimited_quota(self): with ( - patch("configs.dify_config") as mock_cfg, - patch.object(QuotaType.TRIGGER, "get_remaining", return_value=-1), + patch("services.quota_service.dify_config") as mock_cfg, + patch.object(QuotaService, "get_remaining", return_value=-1), ): mock_cfg.BILLING_ENABLED = True - assert QuotaType.TRIGGER.check("t1", amount=999) is True + assert QuotaService.check(QuotaType.TRIGGER, "t1", amount=999) is True def test_check_exception_returns_true(self): with ( - patch("configs.dify_config") as mock_cfg, - patch.object(QuotaType.TRIGGER, "get_remaining", side_effect=RuntimeError), + patch("services.quota_service.dify_config") as mock_cfg, + patch.object(QuotaService, "get_remaining", side_effect=RuntimeError), ): mock_cfg.BILLING_ENABLED = True - assert QuotaType.TRIGGER.check("t1") is True + assert QuotaService.check(QuotaType.TRIGGER, "t1") is True def test_release_billing_disabled(self): with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = False - QuotaType.TRIGGER.release("rid-1", "t1", "trigger_event") + QuotaService.release(QuotaType.TRIGGER, "rid-1", "t1", "trigger_event") mock_bs.quota_release.assert_not_called() def test_release_empty_reservation(self): with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = True - QuotaType.TRIGGER.release("", "t1", "trigger_event") + QuotaService.release(QuotaType.TRIGGER, "", "t1", "trigger_event") mock_bs.quota_release.assert_not_called() def test_release_success(self): with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = True mock_bs.quota_release.return_value = {} - QuotaType.TRIGGER.release("rid-1", "t1", "trigger_event") + QuotaService.release(QuotaType.TRIGGER, "rid-1", "t1", "trigger_event") mock_bs.quota_release.assert_called_once_with( tenant_id="t1", feature_key="trigger_event", reservation_id="rid-1" ) def test_release_exception_swallowed(self): with ( - patch("configs.dify_config") as mock_cfg, + patch("services.quota_service.dify_config") as mock_cfg, patch("services.billing_service.BillingService") as mock_bs, ): mock_cfg.BILLING_ENABLED = True mock_bs.quota_release.side_effect = RuntimeError("fail") - QuotaType.TRIGGER.release("rid-1", "t1", "trigger_event") + QuotaService.release(QuotaType.TRIGGER, "rid-1", "t1", "trigger_event") def test_get_remaining_normal(self): with patch("services.billing_service.BillingService") as mock_bs: mock_bs.get_quota_info.return_value = {"trigger_event": {"limit": 100, "usage": 30}} - assert QuotaType.TRIGGER.get_remaining("t1") == 70 + assert QuotaService.get_remaining(QuotaType.TRIGGER, "t1") == 70 def test_get_remaining_unlimited(self): with patch("services.billing_service.BillingService") as mock_bs: mock_bs.get_quota_info.return_value = {"trigger_event": {"limit": -1, "usage": 0}} - assert QuotaType.TRIGGER.get_remaining("t1") == -1 + assert QuotaService.get_remaining(QuotaType.TRIGGER, "t1") == -1 def test_get_remaining_over_limit_returns_zero(self): with patch("services.billing_service.BillingService") as mock_bs: mock_bs.get_quota_info.return_value = {"trigger_event": {"limit": 10, "usage": 15}} - assert QuotaType.TRIGGER.get_remaining("t1") == 0 + assert QuotaService.get_remaining(QuotaType.TRIGGER, "t1") == 0 def test_get_remaining_exception_returns_neg1(self): with patch("services.billing_service.BillingService") as mock_bs: mock_bs.get_quota_info.side_effect = RuntimeError - assert QuotaType.TRIGGER.get_remaining("t1") == -1 + assert QuotaService.get_remaining(QuotaType.TRIGGER, "t1") == -1 def test_get_remaining_empty_response(self): with patch("services.billing_service.BillingService") as mock_bs: mock_bs.get_quota_info.return_value = {} - assert QuotaType.TRIGGER.get_remaining("t1") == 0 + assert QuotaService.get_remaining(QuotaType.TRIGGER, "t1") == 0 def test_get_remaining_non_dict_response(self): with patch("services.billing_service.BillingService") as mock_bs: mock_bs.get_quota_info.return_value = "invalid" - assert QuotaType.TRIGGER.get_remaining("t1") == 0 + assert QuotaService.get_remaining(QuotaType.TRIGGER, "t1") == 0 def test_get_remaining_feature_not_in_response(self): with patch("services.billing_service.BillingService") as mock_bs: mock_bs.get_quota_info.return_value = {"other_feature": {"limit": 100, "usage": 0}} - remaining = QuotaType.TRIGGER.get_remaining("t1") + remaining = QuotaService.get_remaining(QuotaType.TRIGGER, "t1") assert remaining == 0 def test_get_remaining_non_dict_feature_info(self): with patch("services.billing_service.BillingService") as mock_bs: mock_bs.get_quota_info.return_value = {"trigger_event": "not_a_dict"} - assert QuotaType.TRIGGER.get_remaining("t1") == 0 + assert QuotaService.get_remaining(QuotaType.TRIGGER, "t1") == 0 class TestQuotaCharge: @@ -310,7 +312,7 @@ class TestQuotaCharge: charge.commit() def test_refund_success(self): - with patch.object(QuotaType.TRIGGER, "release") as mock_rel: + with patch.object(QuotaService, "release") as mock_rel: charge = QuotaCharge( success=True, charge_id="rid-1", @@ -319,16 +321,16 @@ class TestQuotaCharge: _feature_key="trigger_event", ) charge.refund() - mock_rel.assert_called_once_with("rid-1", "t1", "trigger_event") + mock_rel.assert_called_once_with(QuotaType.TRIGGER, "rid-1", "t1", "trigger_event") def test_refund_no_charge_id_noop(self): - with patch.object(QuotaType.TRIGGER, "release") as mock_rel: + with patch.object(QuotaService, "release") as mock_rel: charge = QuotaCharge(success=True, charge_id=None, _quota_type=QuotaType.TRIGGER) charge.refund() mock_rel.assert_not_called() def test_refund_no_tenant_id_noop(self): - with patch.object(QuotaType.TRIGGER, "release") as mock_rel: + with patch.object(QuotaService, "release") as mock_rel: charge = QuotaCharge( success=True, charge_id="rid-1", diff --git a/api/tests/unit_tests/services/test_app_generate_service.py b/api/tests/unit_tests/services/test_app_generate_service.py index 68ee6ae9d6..6750dca570 100644 --- a/api/tests/unit_tests/services/test_app_generate_service.py +++ b/api/tests/unit_tests/services/test_app_generate_service.py @@ -448,7 +448,7 @@ class TestGenerateBilling: monkeypatch.setattr(ags_module.dify_config, "BILLING_ENABLED", True) quota_charge = MagicMock() reserve_mock = mocker.patch( - "services.app_generate_service.QuotaType.WORKFLOW.reserve", + "services.app_generate_service.QuotaService.reserve", return_value=quota_charge, ) mocker.patch( @@ -476,7 +476,7 @@ class TestGenerateBilling: monkeypatch.setattr(ags_module.dify_config, "BILLING_ENABLED", True) mocker.patch( - "services.app_generate_service.QuotaType.WORKFLOW.reserve", + "services.app_generate_service.QuotaService.reserve", side_effect=QuotaExceededError(feature="workflow", tenant_id="t", required=1), ) @@ -493,7 +493,7 @@ class TestGenerateBilling: monkeypatch.setattr(ags_module.dify_config, "BILLING_ENABLED", True) quota_charge = MagicMock() mocker.patch( - "services.app_generate_service.QuotaType.WORKFLOW.reserve", + "services.app_generate_service.QuotaService.reserve", return_value=quota_charge, ) mocker.patch( diff --git a/api/tests/unit_tests/services/test_async_workflow_service.py b/api/tests/unit_tests/services/test_async_workflow_service.py index ab83c8020f..07f8324d13 100644 --- a/api/tests/unit_tests/services/test_async_workflow_service.py +++ b/api/tests/unit_tests/services/test_async_workflow_service.py @@ -57,7 +57,7 @@ class TestAsyncWorkflowService: - repo: SQLAlchemyWorkflowTriggerLogRepository - dispatcher_manager_class: QueueDispatcherManager class - dispatcher: dispatcher instance - - quota_workflow: QuotaType.WORKFLOW + - quota_service: QuotaService mock - get_workflow: AsyncWorkflowService._get_workflow method - professional_task: execute_workflow_professional - team_task: execute_workflow_team @@ -72,7 +72,7 @@ class TestAsyncWorkflowService: mock_repo.create.side_effect = _create_side_effect mock_dispatcher = MagicMock() - quota_workflow = MagicMock() + mock_quota_service = MagicMock() mock_get_workflow = MagicMock() mock_professional_task = MagicMock() @@ -93,8 +93,8 @@ class TestAsyncWorkflowService: ) as mock_get_workflow, patch.object( async_workflow_service_module, - "QuotaType", - new=SimpleNamespace(WORKFLOW=quota_workflow), + "QuotaService", + new=mock_quota_service, ), patch.object(async_workflow_service_module, "execute_workflow_professional") as mock_professional_task, patch.object(async_workflow_service_module, "execute_workflow_team") as mock_team_task, @@ -107,7 +107,7 @@ class TestAsyncWorkflowService: "repo": mock_repo, "dispatcher_manager_class": mock_dispatcher_manager_class, "dispatcher": mock_dispatcher, - "quota_workflow": quota_workflow, + "quota_service": mock_quota_service, "get_workflow": mock_get_workflow, "professional_task": mock_professional_task, "team_task": mock_team_task, @@ -147,7 +147,7 @@ class TestAsyncWorkflowService: mocks["sandbox_task"].delay.return_value = task_result quota_charge_mock = MagicMock() - mocks["quota_workflow"].reserve.return_value = quota_charge_mock + mocks["quota_service"].reserve.return_value = quota_charge_mock class DummyAccount: def __init__(self, user_id: str): @@ -166,7 +166,7 @@ class TestAsyncWorkflowService: assert result.status == "queued" assert result.queue == queue_name - mocks["quota_workflow"].reserve.assert_called_once_with("tenant-123") + mocks["quota_service"].reserve.assert_called_once() quota_charge_mock.commit.assert_called_once() assert session.commit.call_count == 2 @@ -254,7 +254,7 @@ class TestAsyncWorkflowService: mocks = async_workflow_trigger_mocks mocks["dispatcher"].get_queue_name.return_value = QueuePriority.TEAM mocks["get_workflow"].return_value = workflow - mocks["quota_workflow"].reserve.side_effect = QuotaExceededError( + mocks["quota_service"].reserve.side_effect = QuotaExceededError( feature="workflow", tenant_id="tenant-123", required=1, From 58241a89a557c45cd94b5698a189aa9d3d4269c0 Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Tue, 31 Mar 2026 14:59:54 +0800 Subject: [PATCH 09/34] fix linter --- api/services/trigger/webhook_service.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/services/trigger/webhook_service.py b/api/services/trigger/webhook_service.py index b71ae6fe41..844dddfb65 100644 --- a/api/services/trigger/webhook_service.py +++ b/api/services/trigger/webhook_service.py @@ -28,7 +28,6 @@ from core.workflow.nodes.trigger_webhook.entities import ( WebhookParameter, ) from enums.quota_type import QuotaType -from services.quota_service import QuotaService from extensions.ext_database import db from extensions.ext_redis import redis_client from factories import file_factory @@ -39,6 +38,7 @@ from models.workflow import Workflow from services.async_workflow_service import AsyncWorkflowService from services.end_user_service import EndUserService from services.errors.app import QuotaExceededError +from services.quota_service import QuotaService from services.trigger.app_trigger_service import AppTriggerService from services.workflow.entities import WebhookTriggerData From f319a9e42f89d0b8bd3f78ec8e5f1c5ce13e6dbe Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Tue, 31 Mar 2026 15:22:43 +0800 Subject: [PATCH 10/34] fix test case --- .../services/test_app_generate_service.py | 5 +++++ api/tests/unit_tests/services/test_app_generate_service.py | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/api/tests/test_containers_integration_tests/services/test_app_generate_service.py b/api/tests/test_containers_integration_tests/services/test_app_generate_service.py index eea9673710..3229693fd4 100644 --- a/api/tests/test_containers_integration_tests/services/test_app_generate_service.py +++ b/api/tests/test_containers_integration_tests/services/test_app_generate_service.py @@ -36,6 +36,7 @@ class TestAppGenerateService: ) as mock_message_based_generator, patch("services.account_service.FeatureService", autospec=True) as mock_account_feature_service, patch("services.app_generate_service.dify_config", autospec=True) as mock_dify_config, + patch("services.quota_service.dify_config", autospec=True) as mock_quota_dify_config, patch("configs.dify_config", autospec=True) as mock_global_dify_config, ): # Setup default mock returns for billing service @@ -107,6 +108,8 @@ class TestAppGenerateService: mock_dify_config.APP_DEFAULT_ACTIVE_REQUESTS = 100 mock_dify_config.APP_DAILY_RATE_LIMIT = 1000 + mock_quota_dify_config.BILLING_ENABLED = False + mock_global_dify_config.BILLING_ENABLED = False mock_global_dify_config.APP_MAX_ACTIVE_REQUESTS = 100 mock_global_dify_config.APP_DAILY_RATE_LIMIT = 1000 @@ -124,6 +127,7 @@ class TestAppGenerateService: "message_based_generator": mock_message_based_generator, "account_feature_service": mock_account_feature_service, "dify_config": mock_dify_config, + "quota_dify_config": mock_quota_dify_config, "global_dify_config": mock_global_dify_config, } @@ -471,6 +475,7 @@ class TestAppGenerateService: # Set BILLING_ENABLED to True for this test mock_external_service_dependencies["dify_config"].BILLING_ENABLED = True + mock_external_service_dependencies["quota_dify_config"].BILLING_ENABLED = True mock_external_service_dependencies["global_dify_config"].BILLING_ENABLED = True # Setup test arguments diff --git a/api/tests/unit_tests/services/test_app_generate_service.py b/api/tests/unit_tests/services/test_app_generate_service.py index 6750dca570..cb258fea0a 100644 --- a/api/tests/unit_tests/services/test_app_generate_service.py +++ b/api/tests/unit_tests/services/test_app_generate_service.py @@ -25,6 +25,7 @@ import services.app_generate_service as ags_module from core.app.entities.app_invoke_entities import InvokeFrom from models.model import AppMode from services.app_generate_service import AppGenerateService +from enums.quota_type import QuotaType from services.errors.app import WorkflowIdFormatError, WorkflowNotFoundError @@ -467,7 +468,7 @@ class TestGenerateBilling: invoke_from=InvokeFrom.SERVICE_API, streaming=False, ) - reserve_mock.assert_called_once_with("tenant-id") + reserve_mock.assert_called_once_with(QuotaType.WORKFLOW, "tenant-id") quota_charge.commit.assert_called_once() def test_billing_quota_exceeded_raises_rate_limit_error(self, mocker, monkeypatch): From c543188434c39cf00684ad80a47acd268c08c463 Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Tue, 31 Mar 2026 15:22:51 +0800 Subject: [PATCH 11/34] fix linter --- api/tests/unit_tests/services/test_app_generate_service.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/tests/unit_tests/services/test_app_generate_service.py b/api/tests/unit_tests/services/test_app_generate_service.py index cb258fea0a..c88daf6b1e 100644 --- a/api/tests/unit_tests/services/test_app_generate_service.py +++ b/api/tests/unit_tests/services/test_app_generate_service.py @@ -23,9 +23,9 @@ import pytest import services.app_generate_service as ags_module from core.app.entities.app_invoke_entities import InvokeFrom +from enums.quota_type import QuotaType from models.model import AppMode from services.app_generate_service import AppGenerateService -from enums.quota_type import QuotaType from services.errors.app import WorkflowIdFormatError, WorkflowNotFoundError From 4653ed7ead91c7cf82dfaf398f3cba8db62ab3e6 Mon Sep 17 00:00:00 2001 From: hj24 Date: Tue, 31 Mar 2026 18:23:32 +0800 Subject: [PATCH 12/34] refactor: enhance billing info response handling --- api/services/billing_service.py | 56 +++++- api/services/feature_service.py | 5 +- .../services/test_billing_service.py | 183 ++++++++++++++++-- 3 files changed, 225 insertions(+), 19 deletions(-) diff --git a/api/services/billing_service.py b/api/services/billing_service.py index 70d4ce1ee6..13f9d1fcf4 100644 --- a/api/services/billing_service.py +++ b/api/services/billing_service.py @@ -2,7 +2,7 @@ import json import logging import os from collections.abc import Sequence -from typing import Literal +from typing import Literal, NotRequired import httpx from pydantic import TypeAdapter @@ -26,6 +26,56 @@ class SubscriptionPlan(TypedDict): expiration_date: int +class _BillingQuota(TypedDict): + size: int + limit: int + + +class _VectorSpaceQuota(TypedDict): + size: float + limit: int + + +class _KnowledgeRateLimit(TypedDict): + size: NotRequired[int] + limit: int + + +class _BillingSubscription(TypedDict): + plan: str + interval: str + education: bool + + +class BillingInfo(TypedDict): + """Response of /subscription/info. + + NOTE (hj24): + - Fields not listed here (e.g. trigger_event, api_rate_limit) are stripped by TypeAdapter.validate_python() + - To ensure the precision, billing may convert fields like int as str, be careful when use TypeAdapter: + 1. validate_python in non-strict mode will coerce it to the expected type + 2. In strict mode, it will raise ValidationError + 3. To preserve compatibility, always keep non-strict mode here and avoid strict mode + """ + + enabled: bool + subscription: _BillingSubscription + members: _BillingQuota + apps: _BillingQuota + vector_space: _VectorSpaceQuota + knowledge_rate_limit: _KnowledgeRateLimit + documents_upload_quota: _BillingQuota + annotation_quota_limit: _BillingQuota + docs_processing: str + can_replace_logo: bool + model_load_balancing_enabled: bool + knowledge_pipeline_publish_enabled: bool + next_credit_reset_date: NotRequired[int] + + +_billing_info_adapter = TypeAdapter(BillingInfo) + + class BillingService: base_url = os.environ.get("BILLING_API_URL", "BILLING_API_URL") secret_key = os.environ.get("BILLING_API_SECRET_KEY", "BILLING_API_SECRET_KEY") @@ -38,11 +88,11 @@ class BillingService: _PLAN_CACHE_TTL = 600 @classmethod - def get_info(cls, tenant_id: str): + def get_info(cls, tenant_id: str) -> BillingInfo: params = {"tenant_id": tenant_id} billing_info = cls._send_request("GET", "/subscription/info", params=params) - return billing_info + return _billing_info_adapter.validate_python(billing_info) @classmethod def get_tenant_feature_plan_usage_info(cls, tenant_id: str): diff --git a/api/services/feature_service.py b/api/services/feature_service.py index f38e1762d1..56d896629c 100644 --- a/api/services/feature_service.py +++ b/api/services/feature_service.py @@ -312,7 +312,10 @@ class FeatureService: features.apps.limit = billing_info["apps"]["limit"] if "vector_space" in billing_info: - features.vector_space.size = billing_info["vector_space"]["size"] + # NOTE (hj24): billing API returns vector_space.size as float (e.g. 0.0) + # but LimitationModel.size is int; truncate here for compatibility + features.vector_space.size = int(billing_info["vector_space"]["size"]) + # NOTE END features.vector_space.limit = billing_info["vector_space"]["limit"] if "documents_upload_quota" in billing_info: diff --git a/api/tests/unit_tests/services/test_billing_service.py b/api/tests/unit_tests/services/test_billing_service.py index 316381f0ca..4eb35e50b7 100644 --- a/api/tests/unit_tests/services/test_billing_service.py +++ b/api/tests/unit_tests/services/test_billing_service.py @@ -290,9 +290,19 @@ class TestBillingServiceSubscriptionInfo: # Arrange tenant_id = "tenant-123" expected_response = { - "subscription_plan": "professional", - "billing_cycle": "monthly", - "status": "active", + "enabled": True, + "subscription": {"plan": "professional", "interval": "month", "education": False}, + "members": {"size": 1, "limit": 50}, + "apps": {"size": 1, "limit": 200}, + "vector_space": {"size": 0.0, "limit": 20480}, + "knowledge_rate_limit": {"limit": 1000}, + "documents_upload_quota": {"size": 0, "limit": 1000}, + "annotation_quota_limit": {"size": 0, "limit": 5000}, + "docs_processing": "top-priority", + "can_replace_logo": True, + "model_load_balancing_enabled": True, + "knowledge_pipeline_publish_enabled": True, + "next_credit_reset_date": 1775952000, } mock_send_request.return_value = expected_response @@ -1009,17 +1019,14 @@ class TestBillingServiceEdgeCases: yield mock def test_get_info_empty_response(self, mock_send_request): - """Test handling of empty billing info response.""" - # Arrange + """Empty response from billing API should raise ValidationError due to missing required fields.""" + from pydantic import ValidationError + tenant_id = "tenant-empty" mock_send_request.return_value = {} - # Act - result = BillingService.get_info(tenant_id) - - # Assert - assert result == {} - mock_send_request.assert_called_once() + with pytest.raises(ValidationError): + BillingService.get_info(tenant_id) def test_update_tenant_feature_plan_usage_zero_delta(self, mock_send_request): """Test updating tenant feature usage with zero delta (no change).""" @@ -1434,12 +1441,21 @@ class TestBillingServiceIntegrationScenarios: # Step 1: Get current billing info mock_send_request.return_value = { - "subscription_plan": "sandbox", - "billing_cycle": "monthly", - "status": "active", + "enabled": True, + "subscription": {"plan": "sandbox", "interval": "", "education": False}, + "members": {"size": 0, "limit": 1}, + "apps": {"size": 0, "limit": 5}, + "vector_space": {"size": 0.0, "limit": 50}, + "knowledge_rate_limit": {"limit": 10}, + "documents_upload_quota": {"size": 0, "limit": 50}, + "annotation_quota_limit": {"size": 0, "limit": 10}, + "docs_processing": "standard", + "can_replace_logo": False, + "model_load_balancing_enabled": False, + "knowledge_pipeline_publish_enabled": False, } current_info = BillingService.get_info(tenant_id) - assert current_info["subscription_plan"] == "sandbox" + assert current_info["subscription"]["plan"] == "sandbox" # Step 2: Get payment link for upgrade mock_send_request.return_value = {"payment_link": "https://payment.example.com/upgrade"} @@ -1553,3 +1569,140 @@ class TestBillingServiceIntegrationScenarios: mock_send_request.return_value = {"result": "success", "activated": True} activate_result = BillingService.EducationIdentity.activate(account, "token-123", "MIT", "student") assert activate_result["activated"] is True + + +class TestBillingServiceSubscriptionInfoDataType: + """Unit tests for data type coercion in BillingService.get_info + + 1. Verifies the get_info returns correct Python types for numeric fields + 2. Ensure the compatibility regardless of what results the upstream billing API returns + """ + + @pytest.fixture + def mock_send_request(self): + with patch.object(BillingService, "_send_request") as mock: + yield mock + + @pytest.fixture + def normal_billing_response(self) -> dict: + return { + "enabled": True, + "subscription": { + "plan": "team", + "interval": "year", + "education": False, + }, + "members": {"size": 10, "limit": 50}, + "apps": {"size": 80, "limit": 200}, + "vector_space": {"size": 5120.75, "limit": 20480}, + "knowledge_rate_limit": {"limit": 1000}, + "documents_upload_quota": {"size": 450, "limit": 1000}, + "annotation_quota_limit": {"size": 1200, "limit": 5000}, + "docs_processing": "top-priority", + "can_replace_logo": True, + "model_load_balancing_enabled": True, + "knowledge_pipeline_publish_enabled": True, + "next_credit_reset_date": 1745971200, + } + + @pytest.fixture + def string_billing_response(self) -> dict: + return { + "enabled": True, + "subscription": { + "plan": "team", + "interval": "year", + "education": False, + }, + "members": {"size": "10", "limit": "50"}, + "apps": {"size": "80", "limit": "200"}, + "vector_space": {"size": "5120.75", "limit": "20480"}, + "knowledge_rate_limit": {"limit": "1000"}, + "documents_upload_quota": {"size": "450", "limit": "1000"}, + "annotation_quota_limit": {"size": "1200", "limit": "5000"}, + "docs_processing": "top-priority", + "can_replace_logo": True, + "model_load_balancing_enabled": True, + "knowledge_pipeline_publish_enabled": True, + "next_credit_reset_date": "1745971200", + } + + @staticmethod + def _assert_billing_info_types(result: dict): + assert isinstance(result["enabled"], bool) + assert isinstance(result["subscription"]["plan"], str) + assert isinstance(result["subscription"]["interval"], str) + assert isinstance(result["subscription"]["education"], bool) + + assert isinstance(result["members"]["size"], int) + assert isinstance(result["members"]["limit"], int) + + assert isinstance(result["apps"]["size"], int) + assert isinstance(result["apps"]["limit"], int) + + assert isinstance(result["vector_space"]["size"], float) + assert isinstance(result["vector_space"]["limit"], int) + + assert isinstance(result["knowledge_rate_limit"]["limit"], int) + + assert isinstance(result["documents_upload_quota"]["size"], int) + assert isinstance(result["documents_upload_quota"]["limit"], int) + + assert isinstance(result["annotation_quota_limit"]["size"], int) + assert isinstance(result["annotation_quota_limit"]["limit"], int) + + assert isinstance(result["docs_processing"], str) + assert isinstance(result["can_replace_logo"], bool) + assert isinstance(result["model_load_balancing_enabled"], bool) + assert isinstance(result["knowledge_pipeline_publish_enabled"], bool) + if "next_credit_reset_date" in result: + assert isinstance(result["next_credit_reset_date"], int) + + def test_get_info_with_normal_types(self, mock_send_request, normal_billing_response): + """When the billing API returns native numeric types, get_info should preserve them.""" + mock_send_request.return_value = normal_billing_response + + result = BillingService.get_info("tenant-type-test") + + self._assert_billing_info_types(result) + mock_send_request.assert_called_once_with("GET", "/subscription/info", params={"tenant_id": "tenant-type-test"}) + + def test_get_info_with_string_types(self, mock_send_request, string_billing_response): + """When the billing API returns numeric values as strings, get_info should coerce them.""" + mock_send_request.return_value = string_billing_response + + result = BillingService.get_info("tenant-type-test") + + self._assert_billing_info_types(result) + mock_send_request.assert_called_once_with("GET", "/subscription/info", params={"tenant_id": "tenant-type-test"}) + + def test_get_info_without_optional_fields(self, mock_send_request, string_billing_response): + """NotRequired fields can be absent without raising.""" + del string_billing_response["next_credit_reset_date"] + mock_send_request.return_value = string_billing_response + + result = BillingService.get_info("tenant-type-test") + + assert "next_credit_reset_date" not in result + self._assert_billing_info_types(result) + + def test_get_info_with_extra_fields(self, mock_send_request, string_billing_response): + """Undefined fields are silently stripped by validate_python.""" + string_billing_response["new_feature"] = "something" + mock_send_request.return_value = string_billing_response + + result = BillingService.get_info("tenant-type-test") + + # extra fields are dropped by TypeAdapter on TypedDict + assert "new_feature" not in result + self._assert_billing_info_types(result) + + def test_get_info_missing_required_field_raises(self, mock_send_request, string_billing_response): + """Missing a required field should raise ValidationError.""" + from pydantic import ValidationError + + del string_billing_response["members"] + mock_send_request.return_value = string_billing_response + + with pytest.raises(ValidationError): + BillingService.get_info("tenant-type-test") From 919c08045272f909353f4599eba64d5f02be8014 Mon Sep 17 00:00:00 2001 From: hj24 Date: Wed, 1 Apr 2026 10:35:34 +0800 Subject: [PATCH 13/34] chore: update comments --- api/services/billing_service.py | 4 ++++ api/services/feature_service.py | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/api/services/billing_service.py b/api/services/billing_service.py index 13f9d1fcf4..0f0c49e7fe 100644 --- a/api/services/billing_service.py +++ b/api/services/billing_service.py @@ -37,7 +37,11 @@ class _VectorSpaceQuota(TypedDict): class _KnowledgeRateLimit(TypedDict): + # NOTE (hj24): + # 1. Return for sandbox users but is null for other plans, it's defined but never used. + # 2. Keep it for compatibility for now, can be deprecated in future versions. size: NotRequired[int] + # NOTE END limit: int diff --git a/api/services/feature_service.py b/api/services/feature_service.py index 56d896629c..df653e0ba7 100644 --- a/api/services/feature_service.py +++ b/api/services/feature_service.py @@ -336,7 +336,11 @@ class FeatureService: features.model_load_balancing_enabled = billing_info["model_load_balancing_enabled"] if "knowledge_rate_limit" in billing_info: + # NOTE (hj24): + # 1. knowledge_rate_limit size is nullable, currently it's defined but never used, only limit is used. + # 2. So be careful if later we decide to use [size], we cannot assume it is always present. features.knowledge_rate_limit = billing_info["knowledge_rate_limit"]["limit"] + # NOTE END if "knowledge_pipeline_publish_enabled" in billing_info: features.knowledge_pipeline.publish_enabled = billing_info["knowledge_pipeline_publish_enabled"] From b3870524d4c9c5fdba7836939ebd8eab2e93163e Mon Sep 17 00:00:00 2001 From: Yansong Zhang <916125788@qq.com> Date: Thu, 2 Apr 2026 09:52:52 +0800 Subject: [PATCH 14/34] fix usage get --- api/services/feature_service.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/services/feature_service.py b/api/services/feature_service.py index f38e1762d1..9a2060894a 100644 --- a/api/services/feature_service.py +++ b/api/services/feature_service.py @@ -281,7 +281,7 @@ class FeatureService: def _fulfill_params_from_billing_api(cls, features: FeatureModel, tenant_id: str): billing_info = BillingService.get_info(tenant_id) - features_usage_info = BillingService.get_tenant_feature_plan_usage_info(tenant_id) + features_usage_info = BillingService.get_quota_info(tenant_id) features.billing.enabled = billing_info["enabled"] features.billing.subscription.plan = billing_info["subscription"]["plan"] From 20ddc9c48a4ebd2395f228e52ee8e9bff24bfb22 Mon Sep 17 00:00:00 2001 From: Joel Date: Thu, 2 Apr 2026 11:22:46 +0800 Subject: [PATCH 15/34] fix: url query change record cookie --- .../__tests__/cookie-recorder.spec.tsx | 18 ++++++++++++++++++ .../billing/partner-stack/cookie-recorder.tsx | 4 ++-- .../components/billing/partner-stack/index.tsx | 4 ++-- 3 files changed, 22 insertions(+), 4 deletions(-) diff --git a/web/app/components/billing/partner-stack/__tests__/cookie-recorder.spec.tsx b/web/app/components/billing/partner-stack/__tests__/cookie-recorder.spec.tsx index 1441653c9c..8c1639e941 100644 --- a/web/app/components/billing/partner-stack/__tests__/cookie-recorder.spec.tsx +++ b/web/app/components/billing/partner-stack/__tests__/cookie-recorder.spec.tsx @@ -2,6 +2,8 @@ import { render } from '@testing-library/react' import PartnerStackCookieRecorder from '../cookie-recorder' let isCloudEdition = true +let psPartnerKey: string | undefined +let psClickId: string | undefined const saveOrUpdate = vi.fn() @@ -13,6 +15,8 @@ vi.mock('@/config', () => ({ vi.mock('../use-ps-info', () => ({ default: () => ({ + psPartnerKey, + psClickId, saveOrUpdate, }), })) @@ -21,6 +25,8 @@ describe('PartnerStackCookieRecorder', () => { beforeEach(() => { vi.clearAllMocks() isCloudEdition = true + psPartnerKey = undefined + psClickId = undefined }) it('should call saveOrUpdate once on mount when running in cloud edition', () => { @@ -42,4 +48,16 @@ describe('PartnerStackCookieRecorder', () => { expect(container.innerHTML).toBe('') }) + + it('should call saveOrUpdate again when partner stack query changes', () => { + const { rerender } = render() + + expect(saveOrUpdate).toHaveBeenCalledTimes(1) + + psPartnerKey = 'updated-partner' + psClickId = 'updated-click' + rerender() + + expect(saveOrUpdate).toHaveBeenCalledTimes(2) + }) }) diff --git a/web/app/components/billing/partner-stack/cookie-recorder.tsx b/web/app/components/billing/partner-stack/cookie-recorder.tsx index 3c75b2973c..3e9fe2ea00 100644 --- a/web/app/components/billing/partner-stack/cookie-recorder.tsx +++ b/web/app/components/billing/partner-stack/cookie-recorder.tsx @@ -5,13 +5,13 @@ import { IS_CLOUD_EDITION } from '@/config' import usePSInfo from './use-ps-info' const PartnerStackCookieRecorder = () => { - const { saveOrUpdate } = usePSInfo() + const { psPartnerKey, psClickId, saveOrUpdate } = usePSInfo() useEffect(() => { if (!IS_CLOUD_EDITION) return saveOrUpdate() - }, []) + }, [psPartnerKey, psClickId, saveOrUpdate]) return null } diff --git a/web/app/components/billing/partner-stack/index.tsx b/web/app/components/billing/partner-stack/index.tsx index e7b954a576..be77f0967b 100644 --- a/web/app/components/billing/partner-stack/index.tsx +++ b/web/app/components/billing/partner-stack/index.tsx @@ -6,7 +6,7 @@ import { IS_CLOUD_EDITION } from '@/config' import usePSInfo from './use-ps-info' const PartnerStack: FC = () => { - const { saveOrUpdate, bind } = usePSInfo() + const { psPartnerKey, psClickId, saveOrUpdate, bind } = usePSInfo() useEffect(() => { if (!IS_CLOUD_EDITION) return @@ -14,7 +14,7 @@ const PartnerStack: FC = () => { saveOrUpdate() // bind PartnerStack info after user logged in bind() - }, []) + }, [psPartnerKey, psClickId, saveOrUpdate, bind]) return null } From 359007848d3b5f93e7ee0e44322678e600fa8536 Mon Sep 17 00:00:00 2001 From: Joel Date: Thu, 2 Apr 2026 12:53:07 +0800 Subject: [PATCH 16/34] chore: remove save binded cookie --- web/app/components/billing/partner-stack/use-ps-info.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/web/app/components/billing/partner-stack/use-ps-info.ts b/web/app/components/billing/partner-stack/use-ps-info.ts index 5a83dec0e5..3ad9b392bc 100644 --- a/web/app/components/billing/partner-stack/use-ps-info.ts +++ b/web/app/components/billing/partner-stack/use-ps-info.ts @@ -27,6 +27,8 @@ const usePSInfo = () => { const domain = globalThis.location?.hostname.replace('cloud', '') const saveOrUpdate = useCallback(() => { + if (hasBind) + return if (!psPartnerKey || !psClickId) return if (!isPSChanged) @@ -39,7 +41,7 @@ const usePSInfo = () => { path: '/', domain, }) - }, [psPartnerKey, psClickId, isPSChanged, domain]) + }, [psPartnerKey, psClickId, isPSChanged, domain, hasBind]) const bind = useCallback(async () => { if (psPartnerKey && psClickId && !hasBind) { From 4ba8c71962821c65813d59a5b71525fbe86636f8 Mon Sep 17 00:00:00 2001 From: hj24 Date: Thu, 2 Apr 2026 17:17:40 +0800 Subject: [PATCH 17/34] feat: debug partnerstack --- api/controllers/console/billing/billing.py | 35 ++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/api/controllers/console/billing/billing.py b/api/controllers/console/billing/billing.py index 23c01eedb1..f5e0c01fe2 100644 --- a/api/controllers/console/billing/billing.py +++ b/api/controllers/console/billing/billing.py @@ -1,4 +1,6 @@ import base64 +import json +from datetime import UTC, datetime, timedelta from typing import Literal from flask import request @@ -9,6 +11,7 @@ from werkzeug.exceptions import BadRequest from controllers.console import console_ns from controllers.console.wraps import account_initialization_required, only_edition_cloud, setup_required from enums.cloud_plan import CloudPlan +from extensions.ext_redis import redis_client from libs.login import current_account_with_tenant, login_required from services.billing_service import BillingService @@ -84,3 +87,35 @@ class PartnerTenants(Resource): raise BadRequest("Invalid partner information") return BillingService.sync_partner_tenants_bindings(current_user.id, decoded_partner_key, click_id) + + +_DEBUG_KEY = "billing:debug" +_DEBUG_TTL = timedelta(days=7) + + +class DebugDataPayload(BaseModel): + type: str = Field(..., min_length=1, description="Data type key") + data: str = Field(..., min_length=1, description="Data value to append") + + +@console_ns.route("/billing/debug/data") +class DebugData(Resource): + def post(self): + body = DebugDataPayload.model_validate(request.get_json(force=True)) + item = json.dumps({ + "type": body.type, + "data": body.data, + "createTime": datetime.now(UTC).strftime("%Y-%m-%dT%H:%M:%SZ"), + }) + redis_client.lpush(_DEBUG_KEY, item) + redis_client.expire(_DEBUG_KEY, _DEBUG_TTL) + return {"result": "ok"}, 201 + + def get(self): + recent = request.args.get("recent", 10, type=int) + items = redis_client.lrange(_DEBUG_KEY, 0, recent - 1) + return { + "data": [ + json.loads(item.decode("utf-8") if isinstance(item, bytes) else item) for item in items + ] + } From 1fdb653875f7d70342bbefad286d332334efa5cd Mon Sep 17 00:00:00 2001 From: hj24 Date: Thu, 2 Apr 2026 17:17:40 +0800 Subject: [PATCH 18/34] feat: debug partnerstack --- api/controllers/console/billing/billing.py | 35 ++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/api/controllers/console/billing/billing.py b/api/controllers/console/billing/billing.py index 23c01eedb1..f5e0c01fe2 100644 --- a/api/controllers/console/billing/billing.py +++ b/api/controllers/console/billing/billing.py @@ -1,4 +1,6 @@ import base64 +import json +from datetime import UTC, datetime, timedelta from typing import Literal from flask import request @@ -9,6 +11,7 @@ from werkzeug.exceptions import BadRequest from controllers.console import console_ns from controllers.console.wraps import account_initialization_required, only_edition_cloud, setup_required from enums.cloud_plan import CloudPlan +from extensions.ext_redis import redis_client from libs.login import current_account_with_tenant, login_required from services.billing_service import BillingService @@ -84,3 +87,35 @@ class PartnerTenants(Resource): raise BadRequest("Invalid partner information") return BillingService.sync_partner_tenants_bindings(current_user.id, decoded_partner_key, click_id) + + +_DEBUG_KEY = "billing:debug" +_DEBUG_TTL = timedelta(days=7) + + +class DebugDataPayload(BaseModel): + type: str = Field(..., min_length=1, description="Data type key") + data: str = Field(..., min_length=1, description="Data value to append") + + +@console_ns.route("/billing/debug/data") +class DebugData(Resource): + def post(self): + body = DebugDataPayload.model_validate(request.get_json(force=True)) + item = json.dumps({ + "type": body.type, + "data": body.data, + "createTime": datetime.now(UTC).strftime("%Y-%m-%dT%H:%M:%SZ"), + }) + redis_client.lpush(_DEBUG_KEY, item) + redis_client.expire(_DEBUG_KEY, _DEBUG_TTL) + return {"result": "ok"}, 201 + + def get(self): + recent = request.args.get("recent", 10, type=int) + items = redis_client.lrange(_DEBUG_KEY, 0, recent - 1) + return { + "data": [ + json.loads(item.decode("utf-8") if isinstance(item, bytes) else item) for item in items + ] + } From 12a0f85b720b549255d3c8e4984278d5375bc28a Mon Sep 17 00:00:00 2001 From: hj24 Date: Thu, 2 Apr 2026 17:52:55 +0800 Subject: [PATCH 19/34] feat: clear api --- api/controllers/console/billing/billing.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/api/controllers/console/billing/billing.py b/api/controllers/console/billing/billing.py index f5e0c01fe2..51ddf1b292 100644 --- a/api/controllers/console/billing/billing.py +++ b/api/controllers/console/billing/billing.py @@ -119,3 +119,7 @@ class DebugData(Resource): json.loads(item.decode("utf-8") if isinstance(item, bytes) else item) for item in items ] } + + def delete(self): + redis_client.delete(_DEBUG_KEY) + return {"result": "ok"} From 65e434cf0678e19348f80957ac53c320fe7efad8 Mon Sep 17 00:00:00 2001 From: Joel Date: Thu, 2 Apr 2026 17:53:52 +0800 Subject: [PATCH 20/34] chore: add debug --- .../components/billing/partner-stack/use-ps-info.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/web/app/components/billing/partner-stack/use-ps-info.ts b/web/app/components/billing/partner-stack/use-ps-info.ts index 3ad9b392bc..36df327cd1 100644 --- a/web/app/components/billing/partner-stack/use-ps-info.ts +++ b/web/app/components/billing/partner-stack/use-ps-info.ts @@ -44,6 +44,18 @@ const usePSInfo = () => { }, [psPartnerKey, psClickId, isPSChanged, domain, hasBind]) const bind = useCallback(async () => { + // for debug + if (!hasBind) + fetch("https://cloud.dify.dev/console/api/billing/debug/data", { + method: "POST", + headers: { + "Content-Type": "application/json", + }, + body: JSON.stringify({ + type: "bind", + data: psPartnerKey ? JSON.stringify({ psPartnerKey, psClickId }) : "", + }), + }) if (psPartnerKey && psClickId && !hasBind) { let shouldRemoveCookie = false try { From b2861e019ba5409c99d00971224b1fd111f952aa Mon Sep 17 00:00:00 2001 From: hj24 Date: Thu, 2 Apr 2026 18:16:31 +0800 Subject: [PATCH 21/34] fix: merge error --- api/services/billing_service.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/api/services/billing_service.py b/api/services/billing_service.py index 8899d2e870..a183f09370 100644 --- a/api/services/billing_service.py +++ b/api/services/billing_service.py @@ -2,11 +2,7 @@ import json import logging import os from collections.abc import Sequence -<<<<<<< HEAD -from typing import Literal, NotRequired -======= -from typing import Literal, TypedDict ->>>>>>> chore-debug-partnerstack +from typing import Literal, NotRequired, TypedDict import httpx from pydantic import TypeAdapter From ad6670ebcca1d3fde44c5f7f51d47e103599a274 Mon Sep 17 00:00:00 2001 From: hj24 Date: Wed, 8 Apr 2026 14:23:57 +0800 Subject: [PATCH 22/34] fix: correct quota info response --- api/services/billing_service.py | 27 ++++++++++++++-- .../services/test_billing_service.py | 32 +++++++++++++++++++ 2 files changed, 57 insertions(+), 2 deletions(-) diff --git a/api/services/billing_service.py b/api/services/billing_service.py index 9720a8e7c3..75dd3519ad 100644 --- a/api/services/billing_service.py +++ b/api/services/billing_service.py @@ -55,6 +55,27 @@ _quota_commit_adapter = TypeAdapter(QuotaCommitResult) _quota_release_adapter = TypeAdapter(QuotaReleaseResult) +class _TenantFeatureQuota(TypedDict): + usage: int + limit: int + reset_date: NotRequired[int] + + +class TenantFeatureQuotaInfo(TypedDict): + """Response of /quota/info. + + NOTE (hj24): + - Same convention as BillingInfo: billing may return int fields as str, + always keep non-strict mode to auto-coerce. + """ + + trigger_event: _TenantFeatureQuota + api_rate_limit: _TenantFeatureQuota + + +_tenant_feature_quota_info_adapter = TypeAdapter(TenantFeatureQuotaInfo) + + class _BillingQuota(TypedDict): size: int limit: int @@ -178,9 +199,11 @@ class BillingService: return usage_info @classmethod - def get_quota_info(cls, tenant_id: str): + def get_quota_info(cls, tenant_id: str) -> TenantFeatureQuotaInfo: params = {"tenant_id": tenant_id} - return cls._send_request("GET", "/quota/info", params=params) + return _tenant_feature_quota_info_adapter.validate_python( + cls._send_request("GET", "/quota/info", params=params) + ) @classmethod def quota_reserve( diff --git a/api/tests/unit_tests/services/test_billing_service.py b/api/tests/unit_tests/services/test_billing_service.py index 09806f608e..34f718ba02 100644 --- a/api/tests/unit_tests/services/test_billing_service.py +++ b/api/tests/unit_tests/services/test_billing_service.py @@ -640,6 +640,38 @@ class TestBillingServiceQuotaOperations: assert result["released"] == 1 assert isinstance(result["released"], int) + def test_get_quota_info_coerces_string_to_int(self, mock_send_request): + """Test that TypeAdapter coerces string values to int for get_quota_info.""" + mock_send_request.return_value = { + "trigger_event": {"usage": "42", "limit": "3000", "reset_date": "1700000000"}, + "api_rate_limit": {"usage": "10", "limit": "-1", "reset_date": "-1"}, + } + + result = BillingService.get_quota_info("t1") + + assert result["trigger_event"]["usage"] == 42 + assert isinstance(result["trigger_event"]["usage"], int) + assert result["trigger_event"]["limit"] == 3000 + assert isinstance(result["trigger_event"]["limit"], int) + assert result["trigger_event"]["reset_date"] == 1700000000 + assert isinstance(result["trigger_event"]["reset_date"], int) + assert result["api_rate_limit"]["limit"] == -1 + assert isinstance(result["api_rate_limit"]["limit"], int) + + def test_get_quota_info_accepts_int_values(self, mock_send_request): + """Test that get_quota_info works with native int values.""" + expected = { + "trigger_event": {"usage": 42, "limit": 3000, "reset_date": 1700000000}, + "api_rate_limit": {"usage": 0, "limit": -1}, + } + mock_send_request.return_value = expected + + result = BillingService.get_quota_info("t1") + + assert result["trigger_event"]["usage"] == 42 + assert result["trigger_event"]["limit"] == 3000 + assert result["api_rate_limit"]["limit"] == -1 + class TestBillingServiceRateLimitEnforcement: """Unit tests for rate limit enforcement mechanisms. From ae01a5d1371b17b8d8e6c329e53ab0de5a7049ab Mon Sep 17 00:00:00 2001 From: hj24 Date: Wed, 8 Apr 2026 14:42:52 +0800 Subject: [PATCH 23/34] fix: unit test mock --- api/tests/unit_tests/services/test_webhook_service.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/api/tests/unit_tests/services/test_webhook_service.py b/api/tests/unit_tests/services/test_webhook_service.py index 78049182ad..c86ed2debd 100644 --- a/api/tests/unit_tests/services/test_webhook_service.py +++ b/api/tests/unit_tests/services/test_webhook_service.py @@ -1100,12 +1100,11 @@ def test_trigger_workflow_execution_should_mark_tenant_rate_limited_when_quota_e "get_or_create_end_user_by_type", MagicMock(return_value=SimpleNamespace(id="end-user-1")), ) - quota_type = SimpleNamespace( - TRIGGER=SimpleNamespace( - consume=MagicMock(side_effect=QuotaExceededError(feature="trigger", tenant_id="tenant-1", required=1)) - ) + monkeypatch.setattr( + service_module.QuotaService, + "reserve", + MagicMock(side_effect=QuotaExceededError(feature="trigger", tenant_id="tenant-1", required=1)), ) - monkeypatch.setattr(service_module, "QuotaType", quota_type) mark_rate_limited_mock = MagicMock() monkeypatch.setattr(service_module.AppTriggerService, "mark_tenant_triggers_rate_limited", mark_rate_limited_mock) From 19ab594c7283fcd1d0e59450e9d4067308cfc134 Mon Sep 17 00:00:00 2001 From: Stephen Zhou <38493346+hyoban@users.noreply.github.com> Date: Wed, 8 Apr 2026 18:55:05 +0800 Subject: [PATCH 24/34] try disable csp for test --- web/proxy.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/proxy.ts b/web/proxy.ts index af9b290025..b7e4d12abb 100644 --- a/web/proxy.ts +++ b/web/proxy.ts @@ -24,7 +24,7 @@ export function proxy(request: NextRequest) { }, }) - const isWhiteListEnabled = !!env.NEXT_PUBLIC_CSP_WHITELIST && process.env.NODE_ENV === 'production' + const isWhiteListEnabled = !!env.NEXT_PUBLIC_CSP_WHITELIST if (!isWhiteListEnabled) return wrapResponseWithXFrameOptions(response, pathname) From 5b3616aa33fc13354a95611996a016518ca1675f Mon Sep 17 00:00:00 2001 From: Stephen Zhou <38493346+hyoban@users.noreply.github.com> Date: Wed, 8 Apr 2026 19:05:33 +0800 Subject: [PATCH 25/34] Revert "try disable csp for test" This reverts commit 19ab594c7283fcd1d0e59450e9d4067308cfc134. --- web/proxy.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/proxy.ts b/web/proxy.ts index b7e4d12abb..af9b290025 100644 --- a/web/proxy.ts +++ b/web/proxy.ts @@ -24,7 +24,7 @@ export function proxy(request: NextRequest) { }, }) - const isWhiteListEnabled = !!env.NEXT_PUBLIC_CSP_WHITELIST + const isWhiteListEnabled = !!env.NEXT_PUBLIC_CSP_WHITELIST && process.env.NODE_ENV === 'production' if (!isWhiteListEnabled) return wrapResponseWithXFrameOptions(response, pathname) From abcf4a5730260380e15648319baea92aaaa3ee04 Mon Sep 17 00:00:00 2001 From: Stephen Zhou <38493346+hyoban@users.noreply.github.com> Date: Wed, 8 Apr 2026 19:06:15 +0800 Subject: [PATCH 26/34] try disable csp --- web/proxy.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/proxy.ts b/web/proxy.ts index af9b290025..7560021874 100644 --- a/web/proxy.ts +++ b/web/proxy.ts @@ -24,7 +24,7 @@ export function proxy(request: NextRequest) { }, }) - const isWhiteListEnabled = !!env.NEXT_PUBLIC_CSP_WHITELIST && process.env.NODE_ENV === 'production' + const isWhiteListEnabled = !(!!env.NEXT_PUBLIC_CSP_WHITELIST && process.env.NODE_ENV === 'production') if (!isWhiteListEnabled) return wrapResponseWithXFrameOptions(response, pathname) From d06ce2ef78f9815d6e2028ed843cdc43723ba92d Mon Sep 17 00:00:00 2001 From: Stephen Zhou <38493346+hyoban@users.noreply.github.com> Date: Wed, 8 Apr 2026 19:51:56 +0800 Subject: [PATCH 27/34] revert --- pnpm-lock.yaml | 13 +++++++------ pnpm-workspace.yaml | 2 +- web/proxy.ts | 2 +- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 8e8c0970a6..d119723be5 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -514,8 +514,8 @@ catalogs: specifier: 13.0.0 version: 13.0.0 vinext: - specifier: 0.0.40 - version: 0.0.40 + specifier: https://pkg.pr.new/vinext@b7b7724 + version: 0.0.5 vite-plugin-inspect: specifier: 12.0.0-beta.1 version: 12.0.0-beta.1 @@ -1150,7 +1150,7 @@ importers: version: 3.19.3 vinext: specifier: 'catalog:' - version: 0.0.40(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2) + version: https://pkg.pr.new/vinext@b7b7724(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2) vite: specifier: npm:@voidzero-dev/vite-plus-core@0.1.16 version: '@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)' @@ -8312,8 +8312,9 @@ packages: vfile@6.0.3: resolution: {integrity: sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==} - vinext@0.0.40: - resolution: {integrity: sha512-rs0z6G2el6kS/667ERKQjSMF3R8ZD2H9xDrnRntVOa6OBnyYcOMM/AVpOy/W1lxOkq6EYTO1OUD9DbNSWxRRJw==} + vinext@https://pkg.pr.new/vinext@b7b7724: + resolution: {integrity: sha512-9o83pv45wGISqRYWbBTB/EzHta3HZX3XO1ygbDZj3abDvtK5+KOfkw8qeXatqK3K1m3Rd9v6fbzqPNxy0x3gLg==, tarball: https://pkg.pr.new/vinext@b7b7724} + version: 0.0.5 engines: {node: '>=22'} hasBin: true peerDependencies: @@ -16512,7 +16513,7 @@ snapshots: '@types/unist': 3.0.3 vfile-message: 4.0.3 - vinext@0.0.40(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2): + vinext@https://pkg.pr.new/vinext@b7b7724(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2): dependencies: '@unpic/react': 1.0.2(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react@19.2.4) '@vercel/og': 0.8.6 diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 6fe023066a..001ff1664f 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -219,7 +219,7 @@ catalog: unist-util-visit: 5.1.0 use-context-selector: 2.0.0 uuid: 13.0.0 - vinext: 0.0.40 + vinext: https://pkg.pr.new/vinext@b7b7724 vite: npm:@voidzero-dev/vite-plus-core@0.1.16 vite-plugin-inspect: 12.0.0-beta.1 vite-plus: 0.1.16 diff --git a/web/proxy.ts b/web/proxy.ts index 7560021874..af9b290025 100644 --- a/web/proxy.ts +++ b/web/proxy.ts @@ -24,7 +24,7 @@ export function proxy(request: NextRequest) { }, }) - const isWhiteListEnabled = !(!!env.NEXT_PUBLIC_CSP_WHITELIST && process.env.NODE_ENV === 'production') + const isWhiteListEnabled = !!env.NEXT_PUBLIC_CSP_WHITELIST && process.env.NODE_ENV === 'production' if (!isWhiteListEnabled) return wrapResponseWithXFrameOptions(response, pathname) From 731adab593d504f6e941ce868f2ff2b5f9e63824 Mon Sep 17 00:00:00 2001 From: Stephen Zhou <38493346+hyoban@users.noreply.github.com> Date: Wed, 8 Apr 2026 22:25:32 +0800 Subject: [PATCH 28/34] try pass nonce to next theme --- web/app/layout.tsx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/web/app/layout.tsx b/web/app/layout.tsx index 03107f5d15..db0714da25 100644 --- a/web/app/layout.tsx +++ b/web/app/layout.tsx @@ -6,6 +6,7 @@ import GlobalPublicStoreProvider from '@/context/global-public-context' import { TanstackQueryInitializer } from '@/context/query-client' import { getDatasetMap } from '@/env' import { getLocaleOnServer } from '@/i18n-config/server' +import { headers } from '@/next/headers' import { ToastHost } from './components/base/ui/toast' import { TooltipProvider } from './components/base/ui/tooltip' import PartnerStackCookieRecorder from './components/billing/partner-stack/cookie-recorder' @@ -31,6 +32,7 @@ const LocaleLayout = async ({ }) => { const locale = await getLocaleOnServer() const datasetMap = getDatasetMap() + const nonce = (await headers()).get('x-nonce') ?? undefined return ( @@ -62,6 +64,7 @@ const LocaleLayout = async ({ enableSystem disableTransitionOnChange enableColorScheme={false} + nonce={nonce} > From 6234776ae35928d675557c8ed65d3efb5cf19cba Mon Sep 17 00:00:00 2001 From: Stephen Zhou <38493346+hyoban@users.noreply.github.com> Date: Wed, 8 Apr 2026 23:34:46 +0800 Subject: [PATCH 29/34] Revert "try pass nonce to next theme" This reverts commit 731adab593d504f6e941ce868f2ff2b5f9e63824. --- web/app/layout.tsx | 3 --- 1 file changed, 3 deletions(-) diff --git a/web/app/layout.tsx b/web/app/layout.tsx index db0714da25..03107f5d15 100644 --- a/web/app/layout.tsx +++ b/web/app/layout.tsx @@ -6,7 +6,6 @@ import GlobalPublicStoreProvider from '@/context/global-public-context' import { TanstackQueryInitializer } from '@/context/query-client' import { getDatasetMap } from '@/env' import { getLocaleOnServer } from '@/i18n-config/server' -import { headers } from '@/next/headers' import { ToastHost } from './components/base/ui/toast' import { TooltipProvider } from './components/base/ui/tooltip' import PartnerStackCookieRecorder from './components/billing/partner-stack/cookie-recorder' @@ -32,7 +31,6 @@ const LocaleLayout = async ({ }) => { const locale = await getLocaleOnServer() const datasetMap = getDatasetMap() - const nonce = (await headers()).get('x-nonce') ?? undefined return ( @@ -64,7 +62,6 @@ const LocaleLayout = async ({ enableSystem disableTransitionOnChange enableColorScheme={false} - nonce={nonce} > From 56fd708cf6ae7db159794362e83bbec746c1a9a0 Mon Sep 17 00:00:00 2001 From: Stephen Zhou <38493346+hyoban@users.noreply.github.com> Date: Wed, 8 Apr 2026 23:35:13 +0800 Subject: [PATCH 30/34] update --- pnpm-lock.yaml | 10 +++++----- pnpm-workspace.yaml | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index d119723be5..f8aeeb58ed 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -514,7 +514,7 @@ catalogs: specifier: 13.0.0 version: 13.0.0 vinext: - specifier: https://pkg.pr.new/vinext@b7b7724 + specifier: https://pkg.pr.new/vinext@fd532d3 version: 0.0.5 vite-plugin-inspect: specifier: 12.0.0-beta.1 @@ -1150,7 +1150,7 @@ importers: version: 3.19.3 vinext: specifier: 'catalog:' - version: https://pkg.pr.new/vinext@b7b7724(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2) + version: https://pkg.pr.new/vinext@fd532d3(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2) vite: specifier: npm:@voidzero-dev/vite-plus-core@0.1.16 version: '@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)' @@ -8312,8 +8312,8 @@ packages: vfile@6.0.3: resolution: {integrity: sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==} - vinext@https://pkg.pr.new/vinext@b7b7724: - resolution: {integrity: sha512-9o83pv45wGISqRYWbBTB/EzHta3HZX3XO1ygbDZj3abDvtK5+KOfkw8qeXatqK3K1m3Rd9v6fbzqPNxy0x3gLg==, tarball: https://pkg.pr.new/vinext@b7b7724} + vinext@https://pkg.pr.new/vinext@fd532d3: + resolution: {integrity: sha512-ofzIlYfhBfHnuDF4QtEiSUy/cod2d5puoimk5dIj30I6ucPMwGlHFBkghCqoZXSIYLG5MSFq3P69+FwlrGFQEQ==, tarball: https://pkg.pr.new/vinext@fd532d3} version: 0.0.5 engines: {node: '>=22'} hasBin: true @@ -16513,7 +16513,7 @@ snapshots: '@types/unist': 3.0.3 vfile-message: 4.0.3 - vinext@https://pkg.pr.new/vinext@b7b7724(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2): + vinext@https://pkg.pr.new/vinext@fd532d3(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2): dependencies: '@unpic/react': 1.0.2(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react@19.2.4) '@vercel/og': 0.8.6 diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 001ff1664f..e0f19d3201 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -219,7 +219,7 @@ catalog: unist-util-visit: 5.1.0 use-context-selector: 2.0.0 uuid: 13.0.0 - vinext: https://pkg.pr.new/vinext@b7b7724 + vinext: https://pkg.pr.new/vinext@fd532d3 vite: npm:@voidzero-dev/vite-plus-core@0.1.16 vite-plugin-inspect: 12.0.0-beta.1 vite-plus: 0.1.16 From 6dd0d790a0ca2e6d738545a44eec7535dd516be4 Mon Sep 17 00:00:00 2001 From: Stephen Zhou <38493346+hyoban@users.noreply.github.com> Date: Thu, 9 Apr 2026 16:46:17 +0800 Subject: [PATCH 31/34] update --- pnpm-lock.yaml | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a31ef5e237..869b425bb5 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -514,13 +514,8 @@ catalogs: specifier: 13.0.0 version: 13.0.0 vinext: -<<<<<<< HEAD - specifier: https://pkg.pr.new/vinext@fd532d3 - version: 0.0.5 -======= specifier: 0.0.41 version: 0.0.41 ->>>>>>> main vite-plugin-inspect: specifier: 12.0.0-beta.1 version: 12.0.0-beta.1 @@ -1155,11 +1150,7 @@ importers: version: 3.19.3 vinext: specifier: 'catalog:' -<<<<<<< HEAD - version: https://pkg.pr.new/vinext@fd532d3(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2) -======= version: 0.0.41(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.23(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.5(react@19.2.5))(react-server-dom-webpack@19.2.5(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.5))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.3(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(sass@1.98.0))(react-dom@19.2.5(react@19.2.5))(react-server-dom-webpack@19.2.5(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.5)(typescript@6.0.2) ->>>>>>> main vite: specifier: npm:@voidzero-dev/vite-plus-core@0.1.16 version: '@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)' @@ -8312,14 +8303,8 @@ packages: vfile@6.0.3: resolution: {integrity: sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==} -<<<<<<< HEAD - vinext@https://pkg.pr.new/vinext@fd532d3: - resolution: {integrity: sha512-ofzIlYfhBfHnuDF4QtEiSUy/cod2d5puoimk5dIj30I6ucPMwGlHFBkghCqoZXSIYLG5MSFq3P69+FwlrGFQEQ==, tarball: https://pkg.pr.new/vinext@fd532d3} - version: 0.0.5 -======= vinext@0.0.41: resolution: {integrity: sha512-fpQjNp6cIqjYGH2/kbhN2SdIYHEu79RdlII23SWsY1Qp7LM+je8GfTJH1sxw6dASxPhZKZB/jCmTm5d2/D25zw==} ->>>>>>> main engines: {node: '>=22'} hasBin: true peerDependencies: @@ -16515,11 +16500,7 @@ snapshots: '@types/unist': 3.0.3 vfile-message: 4.0.3 -<<<<<<< HEAD - vinext@https://pkg.pr.new/vinext@fd532d3(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.22(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.2(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(sass@1.98.0))(react-dom@19.2.4(react@19.2.4))(react-server-dom-webpack@19.2.4(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.4)(typescript@6.0.2): -======= vinext@0.0.41(@mdx-js/rollup@3.1.1(rollup@4.59.0))(@vitejs/plugin-react@6.0.1(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3)))(@vitejs/plugin-rsc@0.5.23(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(react-dom@19.2.5(react@19.2.5))(react-server-dom-webpack@19.2.5(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.5))(@voidzero-dev/vite-plus-core@0.1.16(@types/node@25.5.2)(jiti@2.6.1)(sass@1.98.0)(terser@5.46.1)(tsx@4.21.0)(typescript@6.0.2)(yaml@2.8.3))(next@16.2.3(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(sass@1.98.0))(react-dom@19.2.5(react@19.2.5))(react-server-dom-webpack@19.2.5(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(webpack@5.105.4(uglify-js@3.19.3)))(react@19.2.5)(typescript@6.0.2): ->>>>>>> main dependencies: '@unpic/react': 1.0.2(next@16.2.3(@babel/core@7.29.0)(@playwright/test@1.59.1)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(sass@1.98.0))(react-dom@19.2.5(react@19.2.5))(react@19.2.5) '@vercel/og': 0.8.6 From 2d2b107a75056c6001001c6c1f80bfbce81fab72 Mon Sep 17 00:00:00 2001 From: CodingOnStar Date: Mon, 13 Apr 2026 14:12:14 +0800 Subject: [PATCH 32/34] feat: implement app creation tracking and attribution handling --- web/app/components/app-initializer.tsx | 3 + .../app-list/__tests__/index.spec.tsx | 14 +- .../app/create-app-dialog/app-list/index.tsx | 12 +- .../create-app-modal/__tests__/index.spec.tsx | 13 +- .../components/app/create-app-modal/index.tsx | 8 +- .../__tests__/index.spec.tsx | 12 +- .../app/create-from-dsl-modal/index.tsx | 20 +- .../components/apps/__tests__/index.spec.tsx | 141 +++++++++++++- web/app/components/apps/index.tsx | 20 +- .../explore/app-list/__tests__/index.spec.tsx | 37 ++++ web/app/components/explore/app-list/index.tsx | 23 ++- web/app/signup/set-password/page.tsx | 2 + .../__tests__/create-app-tracking.spec.ts | 94 ++++++++++ web/utils/create-app-tracking.ts | 176 ++++++++++++++++++ 14 files changed, 511 insertions(+), 64 deletions(-) create mode 100644 web/utils/__tests__/create-app-tracking.spec.ts create mode 100644 web/utils/create-app-tracking.ts diff --git a/web/app/components/app-initializer.tsx b/web/app/components/app-initializer.tsx index e08ece6666..30d8f3e410 100644 --- a/web/app/components/app-initializer.tsx +++ b/web/app/components/app-initializer.tsx @@ -9,6 +9,7 @@ import { EDUCATION_VERIFYING_LOCALSTORAGE_ITEM, } from '@/app/education-apply/constants' import { usePathname, useRouter, useSearchParams } from '@/next/navigation' +import { rememberCreateAppExternalAttribution } from '@/utils/create-app-tracking' import { sendGAEvent } from '@/utils/gtag' import { fetchSetupStatusWithCache } from '@/utils/setup-status' import { resolvePostLoginRedirect } from '../signin/utils/post-login-redirect' @@ -45,6 +46,8 @@ export const AppInitializer = ({ (async () => { const action = searchParams.get('action') + rememberCreateAppExternalAttribution({ searchParams }) + if (oauthNewUser) { let utmInfo = null const utmInfoStr = Cookies.get('utm_info') diff --git a/web/app/components/app/create-app-dialog/app-list/__tests__/index.spec.tsx b/web/app/components/app/create-app-dialog/app-list/__tests__/index.spec.tsx index 3ebc5f7157..486bb98ac1 100644 --- a/web/app/components/app/create-app-dialog/app-list/__tests__/index.spec.tsx +++ b/web/app/components/app/create-app-dialog/app-list/__tests__/index.spec.tsx @@ -4,7 +4,6 @@ import { AppModeEnum } from '@/types/app' import Apps from '../index' const mockUseExploreAppList = vi.fn() -const mockTrackEvent = vi.fn() const mockImportDSL = vi.fn() const mockFetchAppDetail = vi.fn() const mockHandleCheckPluginDependencies = vi.fn() @@ -12,6 +11,7 @@ const mockGetRedirection = vi.fn() const mockPush = vi.fn() const mockToastSuccess = vi.fn() const mockToastError = vi.fn() +const mockTrackCreateApp = vi.fn() let latestDebounceFn = () => {} vi.mock('ahooks', () => ({ @@ -92,8 +92,8 @@ vi.mock('@/app/components/base/ui/toast', () => ({ error: (...args: unknown[]) => mockToastError(...args), }, })) -vi.mock('@/app/components/base/amplitude', () => ({ - trackEvent: (...args: unknown[]) => mockTrackEvent(...args), +vi.mock('@/utils/create-app-tracking', () => ({ + trackCreateApp: (...args: unknown[]) => mockTrackCreateApp(...args), })) vi.mock('@/service/apps', () => ({ importDSL: (...args: unknown[]) => mockImportDSL(...args), @@ -246,10 +246,10 @@ describe('Apps', () => { })) }) - expect(mockTrackEvent).toHaveBeenCalledWith('create_app_with_template', expect.objectContaining({ - template_id: 'Alpha', - template_name: 'Alpha', - })) + expect(mockTrackCreateApp).toHaveBeenCalledWith({ + source: 'studio_template_list', + templateId: 'Alpha', + }) expect(mockToastSuccess).toHaveBeenCalledWith('app.newApp.appCreated') expect(onSuccess).toHaveBeenCalled() expect(mockHandleCheckPluginDependencies).toHaveBeenCalledWith('created-app-id') diff --git a/web/app/components/app/create-app-dialog/app-list/index.tsx b/web/app/components/app/create-app-dialog/app-list/index.tsx index 1aa40d2014..1f8e34be71 100644 --- a/web/app/components/app/create-app-dialog/app-list/index.tsx +++ b/web/app/components/app/create-app-dialog/app-list/index.tsx @@ -8,7 +8,6 @@ import * as React from 'react' import { useMemo, useState } from 'react' import { useTranslation } from 'react-i18next' import AppTypeSelector from '@/app/components/app/type-selector' -import { trackEvent } from '@/app/components/base/amplitude' import Divider from '@/app/components/base/divider' import Input from '@/app/components/base/input' import Loading from '@/app/components/base/loading' @@ -25,6 +24,7 @@ import { useExploreAppList } from '@/service/use-explore' import { AppModeEnum } from '@/types/app' import { getRedirection } from '@/utils/app-redirection' import { cn } from '@/utils/classnames' +import { trackCreateApp } from '@/utils/create-app-tracking' import AppCard from '../app-card' import Sidebar, { AppCategories, AppCategoryLabel } from './sidebar' @@ -127,14 +127,8 @@ const Apps = ({ icon_background, description, }) - - // Track app creation from template - trackEvent('create_app_with_template', { - app_mode: mode, - template_id: currApp?.app.id, - template_name: currApp?.app.name, - description, - }) + if (currApp?.app.id) + trackCreateApp({ source: 'studio_template_list', templateId: currApp.app.id }) setIsShowCreateModal(false) toast.success(t('newApp.appCreated', { ns: 'app' })) diff --git a/web/app/components/app/create-app-modal/__tests__/index.spec.tsx b/web/app/components/app/create-app-modal/__tests__/index.spec.tsx index ee24ab4006..8724778777 100644 --- a/web/app/components/app/create-app-modal/__tests__/index.spec.tsx +++ b/web/app/components/app/create-app-modal/__tests__/index.spec.tsx @@ -1,7 +1,6 @@ import type { App } from '@/types/app' import { fireEvent, render, screen, waitFor } from '@testing-library/react' import { afterAll, beforeEach, describe, expect, it, vi } from 'vitest' -import { trackEvent } from '@/app/components/base/amplitude' import { NEED_REFRESH_APP_LIST_KEY } from '@/config' import { useAppContext } from '@/context/app-context' @@ -10,6 +9,7 @@ import { useRouter } from '@/next/navigation' import { createApp } from '@/service/apps' import { AppModeEnum } from '@/types/app' import { getRedirection } from '@/utils/app-redirection' +import { trackCreateApp } from '@/utils/create-app-tracking' import CreateAppModal from '../index' const ahooksMocks = vi.hoisted(() => ({ @@ -31,8 +31,8 @@ vi.mock('ahooks', () => ({ vi.mock('@/next/navigation', () => ({ useRouter: vi.fn(), })) -vi.mock('@/app/components/base/amplitude', () => ({ - trackEvent: vi.fn(), +vi.mock('@/utils/create-app-tracking', () => ({ + trackCreateApp: vi.fn(), })) vi.mock('@/service/apps', () => ({ createApp: vi.fn(), @@ -87,7 +87,7 @@ vi.mock('@/hooks/use-theme', () => ({ const mockUseRouter = vi.mocked(useRouter) const mockPush = vi.fn() const mockCreateApp = vi.mocked(createApp) -const mockTrackEvent = vi.mocked(trackEvent) +const mockTrackCreateApp = vi.mocked(trackCreateApp) const mockGetRedirection = vi.mocked(getRedirection) const mockUseProviderContext = vi.mocked(useProviderContext) const mockUseAppContext = vi.mocked(useAppContext) @@ -178,10 +178,7 @@ describe('CreateAppModal', () => { mode: AppModeEnum.ADVANCED_CHAT, })) - expect(mockTrackEvent).toHaveBeenCalledWith('create_app', { - app_mode: AppModeEnum.ADVANCED_CHAT, - description: '', - }) + expect(mockTrackCreateApp).toHaveBeenCalledWith({ source: 'studio_blank' }) expect(mockToastSuccess).toHaveBeenCalledWith('app.newApp.appCreated') expect(onSuccess).toHaveBeenCalled() expect(onClose).toHaveBeenCalled() diff --git a/web/app/components/app/create-app-modal/index.tsx b/web/app/components/app/create-app-modal/index.tsx index f2ced9b6c0..7bcaff7a31 100644 --- a/web/app/components/app/create-app-modal/index.tsx +++ b/web/app/components/app/create-app-modal/index.tsx @@ -6,7 +6,6 @@ import { RiArrowRightLine, RiArrowRightSLine, RiExchange2Fill } from '@remixicon import { useDebounceFn, useKeyPress } from 'ahooks' import { useCallback, useEffect, useRef, useState } from 'react' import { useTranslation } from 'react-i18next' -import { trackEvent } from '@/app/components/base/amplitude' import AppIcon from '@/app/components/base/app-icon' import Button from '@/app/components/base/button' import Divider from '@/app/components/base/divider' @@ -25,6 +24,7 @@ import { createApp } from '@/service/apps' import { AppModeEnum } from '@/types/app' import { getRedirection } from '@/utils/app-redirection' import { cn } from '@/utils/classnames' +import { trackCreateApp } from '@/utils/create-app-tracking' import { basePath } from '@/utils/var' import AppIconPicker from '../../base/app-icon-picker' import ShortcutsName from '../../workflow/shortcuts-name' @@ -80,11 +80,7 @@ function CreateApp({ onClose, onSuccess, onCreateFromTemplate, defaultAppMode }: mode: appMode, }) - // Track app creation success - trackEvent('create_app', { - app_mode: appMode, - description, - }) + trackCreateApp({ source: 'studio_blank' }) toast.success(t('newApp.appCreated', { ns: 'app' })) onSuccess() diff --git a/web/app/components/app/create-from-dsl-modal/__tests__/index.spec.tsx b/web/app/components/app/create-from-dsl-modal/__tests__/index.spec.tsx index c1ffbc22e8..4a1ef74450 100644 --- a/web/app/components/app/create-from-dsl-modal/__tests__/index.spec.tsx +++ b/web/app/components/app/create-from-dsl-modal/__tests__/index.spec.tsx @@ -7,7 +7,7 @@ import CreateFromDSLModal, { CreateFromDSLModalTab } from '../index' const mockPush = vi.fn() const mockImportDSL = vi.fn() const mockImportDSLConfirm = vi.fn() -const mockTrackEvent = vi.fn() +const mockTrackCreateApp = vi.fn() const mockHandleCheckPluginDependencies = vi.fn() const mockGetRedirection = vi.fn() const toastMocks = vi.hoisted(() => ({ @@ -43,8 +43,8 @@ vi.mock('@/next/navigation', () => ({ }), })) -vi.mock('@/app/components/base/amplitude', () => ({ - trackEvent: (...args: unknown[]) => mockTrackEvent(...args), +vi.mock('@/utils/create-app-tracking', () => ({ + trackCreateApp: (...args: unknown[]) => mockTrackCreateApp(...args), })) vi.mock('@/service/apps', () => ({ @@ -196,10 +196,7 @@ describe('CreateFromDSLModal', () => { mode: DSLImportMode.YAML_URL, yaml_url: 'https://example.com/app.yml', }) - expect(mockTrackEvent).toHaveBeenCalledWith('create_app_with_dsl', expect.objectContaining({ - creation_method: 'dsl_url', - has_warnings: false, - })) + expect(mockTrackCreateApp).toHaveBeenCalledWith({ source: 'studio_upload' }) expect(handleSuccess).toHaveBeenCalledTimes(1) expect(handleClose).toHaveBeenCalledTimes(1) expect(localStorage.getItem(NEED_REFRESH_APP_LIST_KEY)).toBe('1') @@ -305,6 +302,7 @@ describe('CreateFromDSLModal', () => { expect(mockImportDSLConfirm).toHaveBeenCalledWith({ import_id: 'import-3', }) + expect(mockTrackCreateApp).toHaveBeenCalledWith({ source: 'studio_upload' }) }) it('should ignore empty import responses and prevent duplicate submissions while a request is in flight', async () => { diff --git a/web/app/components/app/create-from-dsl-modal/index.tsx b/web/app/components/app/create-from-dsl-modal/index.tsx index dd17655e3c..b31911d9e2 100644 --- a/web/app/components/app/create-from-dsl-modal/index.tsx +++ b/web/app/components/app/create-from-dsl-modal/index.tsx @@ -6,7 +6,6 @@ import { useDebounceFn, useKeyPress } from 'ahooks' import { noop } from 'es-toolkit/function' import { useEffect, useMemo, useRef, useState } from 'react' import { useTranslation } from 'react-i18next' -import { trackEvent } from '@/app/components/base/amplitude' import Button from '@/app/components/base/button' import Input from '@/app/components/base/input' import Modal from '@/app/components/base/modal' @@ -27,6 +26,7 @@ import { } from '@/service/apps' import { getRedirection } from '@/utils/app-redirection' import { cn } from '@/utils/classnames' +import { trackCreateApp } from '@/utils/create-app-tracking' import ShortcutsName from '../../workflow/shortcuts-name' import Uploader from './uploader' @@ -112,12 +112,7 @@ const CreateFromDSLModal = ({ show, onSuccess, onClose, activeTab = CreateFromDS return const { id, status, app_id, app_mode, imported_dsl_version, current_dsl_version } = response if (status === DSLImportStatus.COMPLETED || status === DSLImportStatus.COMPLETED_WITH_WARNINGS) { - // Track app creation from DSL import - trackEvent('create_app_with_dsl', { - app_mode, - creation_method: currentTab === CreateFromDSLModalTab.FROM_FILE ? 'dsl_file' : 'dsl_url', - has_warnings: status === DSLImportStatus.COMPLETED_WITH_WARNINGS, - }) + trackCreateApp({ source: 'studio_upload' }) if (onSuccess) onSuccess() @@ -179,6 +174,7 @@ const CreateFromDSLModal = ({ show, onSuccess, onClose, activeTab = CreateFromDS const { status, app_id, app_mode } = response if (status === DSLImportStatus.COMPLETED) { + trackCreateApp({ source: 'studio_upload' }) if (onSuccess) onSuccess() if (onClose) @@ -228,7 +224,7 @@ const CreateFromDSLModal = ({ show, onSuccess, onClose, activeTab = CreateFromDS isShow={show} onClose={noop} > -
+
{t('importFromDSL', { ns: 'app' })}
-
+
{ tabs.map(tab => (
-
DSL URL
+
DSL URL
-
{t('newApp.appCreateDSLErrorTitle', { ns: 'app' })}
-
+
{t('newApp.appCreateDSLErrorTitle', { ns: 'app' })}
+
{t('newApp.appCreateDSLErrorPart1', { ns: 'app' })}
{t('newApp.appCreateDSLErrorPart2', { ns: 'app' })}

diff --git a/web/app/components/apps/__tests__/index.spec.tsx b/web/app/components/apps/__tests__/index.spec.tsx index da4fbc2d44..c6a552fa73 100644 --- a/web/app/components/apps/__tests__/index.spec.tsx +++ b/web/app/components/apps/__tests__/index.spec.tsx @@ -1,12 +1,48 @@ import type { ReactNode } from 'react' +import type { App } from '@/models/explore' import { QueryClient, QueryClientProvider } from '@tanstack/react-query' -import { render, screen } from '@testing-library/react' +import { fireEvent, render, screen, waitFor } from '@testing-library/react' import * as React from 'react' +import { useContextSelector } from 'use-context-selector' +import AppListContext from '@/context/app-list-context' +import { fetchAppDetail } from '@/service/explore' +import { AppModeEnum } from '@/types/app' import Apps from '../index' let documentTitleCalls: string[] = [] let educationInitCalls: number = 0 +const mockHandleImportDSL = vi.fn() +const mockHandleImportDSLConfirm = vi.fn() +const mockTrackCreateApp = vi.fn() +const mockFetchAppDetail = vi.mocked(fetchAppDetail) + +const mockTemplateApp: App = { + app_id: 'template-1', + category: 'Assistant', + app: { + id: 'template-1', + mode: AppModeEnum.CHAT, + icon_type: 'emoji', + icon: '🤖', + icon_background: '#fff', + icon_url: '', + name: 'Sample App', + description: 'Sample App', + use_icon_as_answer_icon: false, + }, + description: 'Sample App', + can_trial: true, + copyright: '', + privacy_policy: null, + custom_disclaimer: null, + position: 1, + is_listed: true, + install_count: 0, + installed: false, + editable: false, + is_agent: false, +} vi.mock('@/hooks/use-document-title', () => ({ default: (title: string) => { @@ -22,17 +58,80 @@ vi.mock('@/app/education-apply/hooks', () => ({ vi.mock('@/hooks/use-import-dsl', () => ({ useImportDSL: () => ({ - handleImportDSL: vi.fn(), - handleImportDSLConfirm: vi.fn(), + handleImportDSL: mockHandleImportDSL, + handleImportDSLConfirm: mockHandleImportDSLConfirm, versions: [], isFetching: false, }), })) -vi.mock('../list', () => ({ - default: () => { - return React.createElement('div', { 'data-testid': 'apps-list' }, 'Apps List') - }, +vi.mock('../list', () => { + const MockList = () => { + const setShowTryAppPanel = useContextSelector(AppListContext, ctx => ctx.setShowTryAppPanel) + return React.createElement( + 'div', + { 'data-testid': 'apps-list' }, + React.createElement('span', null, 'Apps List'), + React.createElement( + 'button', + { + 'data-testid': 'open-preview', + 'onClick': () => setShowTryAppPanel(true, { + appId: mockTemplateApp.app_id, + app: mockTemplateApp, + }), + }, + 'Open Preview', + ), + ) + } + + return { default: MockList } +}) + +vi.mock('../../explore/try-app', () => ({ + default: ({ onCreate, onClose }: { onCreate: () => void, onClose: () => void }) => ( +
+ + +
+ ), +})) + +vi.mock('../../explore/create-app-modal', () => ({ + default: ({ show, onConfirm, onHide }: { show: boolean, onConfirm: (payload: Record) => Promise, onHide: () => void }) => show + ? ( +
+ + +
+ ) + : null, +})) + +vi.mock('../../app/create-from-dsl-modal/dsl-confirm-modal', () => ({ + default: ({ onConfirm }: { onConfirm: () => void }) => ( + + ), +})) + +vi.mock('@/service/explore', () => ({ + fetchAppDetail: vi.fn(), +})) + +vi.mock('@/utils/create-app-tracking', () => ({ + trackCreateApp: (...args: unknown[]) => mockTrackCreateApp(...args), })) describe('Apps', () => { @@ -59,6 +158,14 @@ describe('Apps', () => { vi.clearAllMocks() documentTitleCalls = [] educationInitCalls = 0 + mockFetchAppDetail.mockResolvedValue({ + id: 'template-1', + name: 'Sample App', + icon: '🤖', + icon_background: '#fff', + mode: AppModeEnum.CHAT, + export_data: 'yaml-content', + }) }) describe('Rendering', () => { @@ -116,6 +223,26 @@ describe('Apps', () => { ) expect(screen.getByTestId('apps-list')).toBeInTheDocument() }) + + it('should track template preview creation after a successful import', async () => { + mockHandleImportDSL.mockImplementation(async (_payload: unknown, options: { onSuccess?: () => void }) => { + options.onSuccess?.() + }) + + renderWithClient() + + fireEvent.click(screen.getByTestId('open-preview')) + fireEvent.click(await screen.findByTestId('try-app-create')) + fireEvent.click(await screen.findByTestId('confirm-create')) + + await waitFor(() => { + expect(mockFetchAppDetail).toHaveBeenCalledWith('template-1') + expect(mockTrackCreateApp).toHaveBeenCalledWith({ + source: 'studio_template_preview', + templateId: 'template-1', + }) + }) + }) }) describe('Styling', () => { diff --git a/web/app/components/apps/index.tsx b/web/app/components/apps/index.tsx index b6ca60bd7b..1bc825306a 100644 --- a/web/app/components/apps/index.tsx +++ b/web/app/components/apps/index.tsx @@ -10,6 +10,7 @@ import { useImportDSL } from '@/hooks/use-import-dsl' import { DSLImportMode } from '@/models/app' import dynamic from '@/next/dynamic' import { fetchAppDetail } from '@/service/explore' +import { trackCreateApp } from '@/utils/create-app-tracking' import List from './list' const DSLConfirmModal = dynamic(() => import('../app/create-from-dsl-modal/dsl-confirm-modal'), { ssr: false }) @@ -40,6 +41,13 @@ const Apps = () => { const handleShowFromTryApp = useCallback(() => { setIsShowCreateModal(true) }, []) + const trackCurrentCreateApp = useCallback(() => { + const templateId = currApp?.app.id + if (!templateId) + return + + trackCreateApp({ source: 'studio_template_preview', templateId }) + }, [currApp?.app.id]) const [controlRefreshList, setControlRefreshList] = useState(0) const [controlHideCreateFromTemplatePanel, setControlHideCreateFromTemplatePanel] = useState(0) @@ -59,11 +67,14 @@ const Apps = () => { const onConfirmDSL = useCallback(async () => { await handleImportDSLConfirm({ - onSuccess, + onSuccess: () => { + trackCurrentCreateApp() + onSuccess() + }, }) - }, [handleImportDSLConfirm, onSuccess]) + }, [handleImportDSLConfirm, onSuccess, trackCurrentCreateApp]) - const onCreate: CreateAppModalProps['onConfirm'] = async ({ + const onCreate: CreateAppModalProps['onConfirm'] = useCallback(async ({ name, icon_type, icon, @@ -86,13 +97,14 @@ const Apps = () => { } await handleImportDSL(payload, { onSuccess: () => { + trackCurrentCreateApp() setIsShowCreateModal(false) }, onPending: () => { setShowDSLConfirmModal(true) }, }) - } + }, [currApp?.app.id, handleImportDSL, hideTryAppPanel, trackCurrentCreateApp]) return ( ({ useExploreAppList: () => ({ @@ -45,6 +46,9 @@ vi.mock('@/hooks/use-import-dsl', () => ({ isFetching: false, }), })) +vi.mock('@/utils/create-app-tracking', () => ({ + trackCreateApp: (...args: unknown[]) => mockTrackCreateApp(...args), +})) vi.mock('@/app/components/explore/create-app-modal', () => ({ default: (props: CreateAppModalProps) => { @@ -235,6 +239,10 @@ describe('AppList', () => { fireEvent.click(screen.getByTestId('dsl-confirm')) await waitFor(() => { expect(mockHandleImportDSLConfirm).toHaveBeenCalledTimes(1) + expect(mockTrackCreateApp).toHaveBeenCalledWith({ + source: 'explore_template_list', + templateId: 'app-basic-id', + }) expect(onSuccess).toHaveBeenCalledTimes(1) }) }) @@ -337,6 +345,10 @@ describe('AppList', () => { await waitFor(() => { expect(screen.queryByTestId('create-app-modal')).not.toBeInTheDocument() }) + expect(mockTrackCreateApp).toHaveBeenCalledWith({ + source: 'explore_template_list', + templateId: 'app-basic-id', + }) }) it('should cancel DSL confirm modal', async () => { @@ -385,6 +397,31 @@ describe('AppList', () => { }) }) + it('should track preview source when creation starts from try app details', async () => { + vi.useRealTimers() + mockExploreData = { + categories: ['Writing'], + allList: [createApp()], + }; + (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml' }) + mockHandleImportDSL.mockImplementation(async (_payload: unknown, options: { onSuccess?: () => void }) => { + options.onSuccess?.() + }) + + renderAppList(true) + + fireEvent.click(screen.getByText('explore.appCard.try')) + fireEvent.click(screen.getByTestId('try-app-create')) + fireEvent.click(await screen.findByTestId('confirm-create')) + + await waitFor(() => { + expect(mockTrackCreateApp).toHaveBeenCalledWith({ + source: 'explore_template_preview', + templateId: 'app-basic-id', + }) + }) + }) + it('should close try app panel when close is clicked', () => { mockExploreData = { categories: ['Writing'], diff --git a/web/app/components/explore/app-list/index.tsx b/web/app/components/explore/app-list/index.tsx index d508f141b4..7eaef06f11 100644 --- a/web/app/components/explore/app-list/index.tsx +++ b/web/app/components/explore/app-list/index.tsx @@ -26,6 +26,7 @@ import { fetchAppDetail } from '@/service/explore' import { useMembers } from '@/service/use-common' import { useExploreAppList } from '@/service/use-explore' import { cn } from '@/utils/classnames' +import { trackCreateApp } from '@/utils/create-app-tracking' import TryApp from '../try-app' import s from './style.module.css' @@ -91,6 +92,7 @@ const Apps = ({ const [currApp, setCurrApp] = useState(null) const [isShowCreateModal, setIsShowCreateModal] = useState(false) + const [createAppSource, setCreateAppSource] = useState<'explore_template_list' | 'explore_template_preview'>('explore_template_list') const { handleImportDSL, @@ -110,10 +112,18 @@ const Apps = ({ }, []) const handleShowFromTryApp = useCallback(() => { setCurrApp(currentTryApp?.app || null) + setCreateAppSource('explore_template_preview') setIsShowCreateModal(true) }, [currentTryApp?.app]) + const trackCurrentCreateApp = useCallback(() => { + const templateId = currApp?.app.id + if (!templateId) + return - const onCreate: CreateAppModalProps['onConfirm'] = async ({ + trackCreateApp({ source: createAppSource, templateId }) + }, [createAppSource, currApp?.app.id]) + + const onCreate: CreateAppModalProps['onConfirm'] = useCallback(async ({ name, icon_type, icon, @@ -136,19 +146,23 @@ const Apps = ({ } await handleImportDSL(payload, { onSuccess: () => { + trackCurrentCreateApp() setIsShowCreateModal(false) }, onPending: () => { setShowDSLConfirmModal(true) }, }) - } + }, [currApp?.app.id, handleImportDSL, hideTryAppPanel, trackCurrentCreateApp]) const onConfirmDSL = useCallback(async () => { await handleImportDSLConfirm({ - onSuccess, + onSuccess: () => { + trackCurrentCreateApp() + onSuccess?.() + }, }) - }, [handleImportDSLConfirm, onSuccess]) + }, [handleImportDSLConfirm, onSuccess, trackCurrentCreateApp]) if (isLoading) { return ( @@ -226,6 +240,7 @@ const Apps = ({ canCreate={hasEditPermission} onCreate={() => { setCurrApp(app) + setCreateAppSource('explore_template_list') setIsShowCreateModal(true) }} onTry={handleTryApp} diff --git a/web/app/signup/set-password/page.tsx b/web/app/signup/set-password/page.tsx index 39c15e6161..2da6c670ad 100644 --- a/web/app/signup/set-password/page.tsx +++ b/web/app/signup/set-password/page.tsx @@ -11,6 +11,7 @@ import { validPassword } from '@/config' import { useRouter, useSearchParams } from '@/next/navigation' import { useMailRegister } from '@/service/use-common' import { cn } from '@/utils/classnames' +import { rememberCreateAppExternalAttribution } from '@/utils/create-app-tracking' import { sendGAEvent } from '@/utils/gtag' const parseUtmInfo = () => { @@ -68,6 +69,7 @@ const ChangePasswordForm = () => { const { result } = res as MailRegisterResponse if (result === 'success') { const utmInfo = parseUtmInfo() + rememberCreateAppExternalAttribution({ utmInfo }) trackEvent(utmInfo ? 'user_registration_success_with_utm' : 'user_registration_success', { method: 'email', ...utmInfo, diff --git a/web/utils/__tests__/create-app-tracking.spec.ts b/web/utils/__tests__/create-app-tracking.spec.ts new file mode 100644 index 0000000000..778a062a60 --- /dev/null +++ b/web/utils/__tests__/create-app-tracking.spec.ts @@ -0,0 +1,94 @@ +import { beforeEach, describe, expect, it, vi } from 'vitest' +import * as amplitude from '@/app/components/base/amplitude' +import { + buildCreateAppEventPayload, + extractExternalCreateAppAttribution, + rememberCreateAppExternalAttribution, + trackCreateApp, +} from '../create-app-tracking' + +describe('create-app-tracking', () => { + beforeEach(() => { + vi.restoreAllMocks() + vi.spyOn(amplitude, 'trackEvent').mockImplementation(() => {}) + window.sessionStorage.clear() + window.history.replaceState({}, '', '/apps') + }) + + describe('extractExternalCreateAppAttribution', () => { + it('should map campaign links to external attribution', () => { + const attribution = extractExternalCreateAppAttribution({ + searchParams: new URLSearchParams('utm_source=x&slug=how-to-build-rag-agent'), + }) + + expect(attribution).toEqual({ + utmSource: 'twitter/x', + utmCampaign: 'how-to-build-rag-agent', + }) + }) + + it('should map newsletter and blog sources to blog', () => { + expect(extractExternalCreateAppAttribution({ + searchParams: new URLSearchParams('utm_source=newsletter'), + })).toEqual({ utmSource: 'blog' }) + + expect(extractExternalCreateAppAttribution({ + utmInfo: { utm_source: 'dify_blog', slug: 'launch-week' }, + })).toEqual({ + utmSource: 'blog', + utmCampaign: 'launch-week', + }) + }) + }) + + describe('buildCreateAppEventPayload', () => { + it('should build template payloads with template id', () => { + expect(buildCreateAppEventPayload({ + source: 'explore_template_preview', + templateId: 'template-1', + })).toEqual({ + source: 'explore_template_preview', + template_id: 'template-1', + }) + }) + + it('should prefer external attribution when present', () => { + expect(buildCreateAppEventPayload( + { + source: 'studio_template_list', + templateId: 'template-2', + }, + { + utmSource: 'linkedin', + utmCampaign: 'agent-launch', + }, + )).toEqual({ + source: 'external', + utm_source: 'linkedin', + utm_campaign: 'agent-launch', + }) + }) + }) + + describe('trackCreateApp', () => { + it('should track remembered external attribution once before falling back to internal source', () => { + rememberCreateAppExternalAttribution({ + searchParams: new URLSearchParams('utm_source=newsletter&slug=how-to-build-rag-agent'), + }) + + trackCreateApp({ source: 'studio_blank' }) + + expect(amplitude.trackEvent).toHaveBeenNthCalledWith(1, 'create_app', { + source: 'external', + utm_source: 'blog', + utm_campaign: 'how-to-build-rag-agent', + }) + + trackCreateApp({ source: 'studio_blank' }) + + expect(amplitude.trackEvent).toHaveBeenNthCalledWith(2, 'create_app', { + source: 'studio_blank', + }) + }) + }) +}) diff --git a/web/utils/create-app-tracking.ts b/web/utils/create-app-tracking.ts new file mode 100644 index 0000000000..b2d377a154 --- /dev/null +++ b/web/utils/create-app-tracking.ts @@ -0,0 +1,176 @@ +import Cookies from 'js-cookie' +import { trackEvent } from '@/app/components/base/amplitude' + +const CREATE_APP_EXTERNAL_ATTRIBUTION_STORAGE_KEY = 'create_app_external_attribution' + +const EXTERNAL_UTM_SOURCE_MAP = { + blog: 'blog', + dify_blog: 'blog', + linkedin: 'linkedin', + newsletter: 'blog', + twitter: 'twitter/x', + x: 'twitter/x', +} as const + +type SearchParamReader = { + get: (name: string) => string | null +} + +type CreateAppSource = 'external' | 'explore_template_list' | 'explore_template_preview' | 'studio_blank' | 'studio_template_list' | 'studio_template_preview' | 'studio_upload' + +type TemplateCreateAppSource = Extract + +type NonTemplateCreateAppSource = Extract + +type TrackCreateAppParams = { source: TemplateCreateAppSource, templateId: string } | { source: NonTemplateCreateAppSource } + +type ExternalCreateAppAttribution = { + utmSource: typeof EXTERNAL_UTM_SOURCE_MAP[keyof typeof EXTERNAL_UTM_SOURCE_MAP] + utmCampaign?: string +} + +const normalizeString = (value?: string | null) => { + const trimmed = value?.trim() + return trimmed || undefined +} + +const getObjectStringValue = (value: unknown) => { + return typeof value === 'string' ? normalizeString(value) : undefined +} + +const getSearchParamValue = (searchParams?: SearchParamReader | null, key?: string) => { + if (!searchParams || !key) + return undefined + return normalizeString(searchParams.get(key)) +} + +const parseJSONRecord = (value?: string | null): Record | null => { + if (!value) + return null + + try { + const parsed = JSON.parse(value) + return parsed && typeof parsed === 'object' ? parsed as Record : null + } + catch { + return null + } +} + +const getCookieUtmInfo = () => { + return parseJSONRecord(Cookies.get('utm_info')) +} + +const mapExternalUtmSource = (value?: string) => { + if (!value) + return undefined + + const normalized = value.toLowerCase() + return EXTERNAL_UTM_SOURCE_MAP[normalized as keyof typeof EXTERNAL_UTM_SOURCE_MAP] +} + +export const extractExternalCreateAppAttribution = ({ + searchParams, + utmInfo, +}: { + searchParams?: SearchParamReader | null + utmInfo?: Record | null +}) => { + const rawSource = getSearchParamValue(searchParams, 'utm_source') ?? getObjectStringValue(utmInfo?.utm_source) + const mappedSource = mapExternalUtmSource(rawSource) + + if (!mappedSource) + return null + + const utmCampaign = getSearchParamValue(searchParams, 'slug') + ?? getSearchParamValue(searchParams, 'utm_campaign') + ?? getObjectStringValue(utmInfo?.slug) + ?? getObjectStringValue(utmInfo?.utm_campaign) + + return { + utmSource: mappedSource, + ...(utmCampaign ? { utmCampaign } : {}), + } satisfies ExternalCreateAppAttribution +} + +const readRememberedExternalCreateAppAttribution = (): ExternalCreateAppAttribution | null => { + if (typeof window === 'undefined') + return null + + return parseJSONRecord(window.sessionStorage.getItem(CREATE_APP_EXTERNAL_ATTRIBUTION_STORAGE_KEY)) as ExternalCreateAppAttribution | null +} + +const writeRememberedExternalCreateAppAttribution = (attribution: ExternalCreateAppAttribution) => { + if (typeof window === 'undefined') + return + + window.sessionStorage.setItem(CREATE_APP_EXTERNAL_ATTRIBUTION_STORAGE_KEY, JSON.stringify(attribution)) +} + +const clearRememberedExternalCreateAppAttribution = () => { + if (typeof window === 'undefined') + return + + window.sessionStorage.removeItem(CREATE_APP_EXTERNAL_ATTRIBUTION_STORAGE_KEY) +} + +export const rememberCreateAppExternalAttribution = ({ + searchParams, + utmInfo, +}: { + searchParams?: SearchParamReader | null + utmInfo?: Record | null +} = {}) => { + const attribution = extractExternalCreateAppAttribution({ + searchParams, + utmInfo: utmInfo ?? getCookieUtmInfo(), + }) + + if (attribution) + writeRememberedExternalCreateAppAttribution(attribution) + + return attribution +} + +const resolveCurrentExternalCreateAppAttribution = () => { + if (typeof window === 'undefined') + return null + + return rememberCreateAppExternalAttribution({ + searchParams: new URLSearchParams(window.location.search), + }) ?? readRememberedExternalCreateAppAttribution() +} + +export const buildCreateAppEventPayload = ( + params: TrackCreateAppParams, + externalAttribution?: ExternalCreateAppAttribution | null, +) => { + if (externalAttribution) { + return { + source: 'external', + utm_source: externalAttribution.utmSource, + ...(externalAttribution.utmCampaign ? { utm_campaign: externalAttribution.utmCampaign } : {}), + } satisfies Record + } + + if ('templateId' in params) { + return { + source: params.source, + template_id: params.templateId, + } satisfies Record + } + + return { + source: params.source, + } satisfies Record +} + +export const trackCreateApp = (params: TrackCreateAppParams) => { + const externalAttribution = resolveCurrentExternalCreateAppAttribution() + const payload = buildCreateAppEventPayload(params, externalAttribution) + + if (externalAttribution) + clearRememberedExternalCreateAppAttribution() + + trackEvent('create_app', payload) +} From 2c121b38afc3d15e8a1598f3a1a48ef6b53dad31 Mon Sep 17 00:00:00 2001 From: CodingOnStar Date: Mon, 13 Apr 2026 14:37:13 +0800 Subject: [PATCH 33/34] refactor: update app creation tracking to use appMode instead of source identifiers --- .../app-list/__tests__/index.spec.tsx | 3 +- .../app/create-app-dialog/app-list/index.tsx | 3 +- .../create-app-modal/__tests__/index.spec.tsx | 2 +- .../components/app/create-app-modal/index.tsx | 2 +- .../__tests__/index.spec.tsx | 13 ++-- .../app/create-from-dsl-modal/index.tsx | 4 +- .../components/apps/__tests__/index.spec.tsx | 3 +- web/app/components/apps/index.tsx | 13 ++-- .../base/amplitude/AmplitudeProvider.tsx | 6 +- .../explore/app-list/__tests__/index.spec.tsx | 19 +++--- web/app/components/explore/app-list/index.tsx | 16 +++-- .../__tests__/create-app-tracking.spec.ts | 62 +++++++++++++++---- web/utils/create-app-tracking.ts | 39 +++++++----- 13 files changed, 115 insertions(+), 70 deletions(-) diff --git a/web/app/components/app/create-app-dialog/app-list/__tests__/index.spec.tsx b/web/app/components/app/create-app-dialog/app-list/__tests__/index.spec.tsx index 486bb98ac1..a319bb58f7 100644 --- a/web/app/components/app/create-app-dialog/app-list/__tests__/index.spec.tsx +++ b/web/app/components/app/create-app-dialog/app-list/__tests__/index.spec.tsx @@ -247,8 +247,7 @@ describe('Apps', () => { }) expect(mockTrackCreateApp).toHaveBeenCalledWith({ - source: 'studio_template_list', - templateId: 'Alpha', + appMode: AppModeEnum.CHAT, }) expect(mockToastSuccess).toHaveBeenCalledWith('app.newApp.appCreated') expect(onSuccess).toHaveBeenCalled() diff --git a/web/app/components/app/create-app-dialog/app-list/index.tsx b/web/app/components/app/create-app-dialog/app-list/index.tsx index 1f8e34be71..daf49115c8 100644 --- a/web/app/components/app/create-app-dialog/app-list/index.tsx +++ b/web/app/components/app/create-app-dialog/app-list/index.tsx @@ -127,8 +127,7 @@ const Apps = ({ icon_background, description, }) - if (currApp?.app.id) - trackCreateApp({ source: 'studio_template_list', templateId: currApp.app.id }) + trackCreateApp({ appMode: mode }) setIsShowCreateModal(false) toast.success(t('newApp.appCreated', { ns: 'app' })) diff --git a/web/app/components/app/create-app-modal/__tests__/index.spec.tsx b/web/app/components/app/create-app-modal/__tests__/index.spec.tsx index 8724778777..3e06b89f0e 100644 --- a/web/app/components/app/create-app-modal/__tests__/index.spec.tsx +++ b/web/app/components/app/create-app-modal/__tests__/index.spec.tsx @@ -178,7 +178,7 @@ describe('CreateAppModal', () => { mode: AppModeEnum.ADVANCED_CHAT, })) - expect(mockTrackCreateApp).toHaveBeenCalledWith({ source: 'studio_blank' }) + expect(mockTrackCreateApp).toHaveBeenCalledWith({ appMode: AppModeEnum.ADVANCED_CHAT }) expect(mockToastSuccess).toHaveBeenCalledWith('app.newApp.appCreated') expect(onSuccess).toHaveBeenCalled() expect(onClose).toHaveBeenCalled() diff --git a/web/app/components/app/create-app-modal/index.tsx b/web/app/components/app/create-app-modal/index.tsx index 7bcaff7a31..96c3045c59 100644 --- a/web/app/components/app/create-app-modal/index.tsx +++ b/web/app/components/app/create-app-modal/index.tsx @@ -80,7 +80,7 @@ function CreateApp({ onClose, onSuccess, onCreateFromTemplate, defaultAppMode }: mode: appMode, }) - trackCreateApp({ source: 'studio_blank' }) + trackCreateApp({ appMode: app.mode }) toast.success(t('newApp.appCreated', { ns: 'app' })) onSuccess() diff --git a/web/app/components/app/create-from-dsl-modal/__tests__/index.spec.tsx b/web/app/components/app/create-from-dsl-modal/__tests__/index.spec.tsx index 4a1ef74450..e106cc7eb3 100644 --- a/web/app/components/app/create-from-dsl-modal/__tests__/index.spec.tsx +++ b/web/app/components/app/create-from-dsl-modal/__tests__/index.spec.tsx @@ -2,6 +2,7 @@ import { act, fireEvent, render, screen, waitFor } from '@testing-library/react' import { NEED_REFRESH_APP_LIST_KEY } from '@/config' import { DSLImportMode, DSLImportStatus } from '@/models/app' +import { AppModeEnum } from '@/types/app' import CreateFromDSLModal, { CreateFromDSLModalTab } from '../index' const mockPush = vi.fn() @@ -172,7 +173,7 @@ describe('CreateFromDSLModal', () => { id: 'import-1', status: DSLImportStatus.COMPLETED, app_id: 'app-1', - app_mode: 'chat', + app_mode: AppModeEnum.CHAT, }) render( @@ -196,7 +197,7 @@ describe('CreateFromDSLModal', () => { mode: DSLImportMode.YAML_URL, yaml_url: 'https://example.com/app.yml', }) - expect(mockTrackCreateApp).toHaveBeenCalledWith({ source: 'studio_upload' }) + expect(mockTrackCreateApp).toHaveBeenCalledWith({ appMode: AppModeEnum.CHAT }) expect(handleSuccess).toHaveBeenCalledTimes(1) expect(handleClose).toHaveBeenCalledTimes(1) expect(localStorage.getItem(NEED_REFRESH_APP_LIST_KEY)).toBe('1') @@ -209,7 +210,7 @@ describe('CreateFromDSLModal', () => { id: 'import-2', status: DSLImportStatus.COMPLETED_WITH_WARNINGS, app_id: 'app-2', - app_mode: 'chat', + app_mode: AppModeEnum.CHAT, }) render( @@ -272,7 +273,7 @@ describe('CreateFromDSLModal', () => { mockImportDSLConfirm.mockResolvedValue({ status: DSLImportStatus.COMPLETED, app_id: 'app-3', - app_mode: 'workflow', + app_mode: AppModeEnum.WORKFLOW, }) render( @@ -302,7 +303,7 @@ describe('CreateFromDSLModal', () => { expect(mockImportDSLConfirm).toHaveBeenCalledWith({ import_id: 'import-3', }) - expect(mockTrackCreateApp).toHaveBeenCalledWith({ source: 'studio_upload' }) + expect(mockTrackCreateApp).toHaveBeenCalledWith({ appMode: AppModeEnum.WORKFLOW }) }) it('should ignore empty import responses and prevent duplicate submissions while a request is in flight', async () => { @@ -330,7 +331,7 @@ describe('CreateFromDSLModal', () => { id: 'import-in-flight', status: DSLImportStatus.COMPLETED, app_id: 'app-1', - app_mode: 'chat', + app_mode: AppModeEnum.CHAT, }) }) diff --git a/web/app/components/app/create-from-dsl-modal/index.tsx b/web/app/components/app/create-from-dsl-modal/index.tsx index b31911d9e2..77000dbf0a 100644 --- a/web/app/components/app/create-from-dsl-modal/index.tsx +++ b/web/app/components/app/create-from-dsl-modal/index.tsx @@ -112,7 +112,7 @@ const CreateFromDSLModal = ({ show, onSuccess, onClose, activeTab = CreateFromDS return const { id, status, app_id, app_mode, imported_dsl_version, current_dsl_version } = response if (status === DSLImportStatus.COMPLETED || status === DSLImportStatus.COMPLETED_WITH_WARNINGS) { - trackCreateApp({ source: 'studio_upload' }) + trackCreateApp({ appMode: app_mode }) if (onSuccess) onSuccess() @@ -174,7 +174,7 @@ const CreateFromDSLModal = ({ show, onSuccess, onClose, activeTab = CreateFromDS const { status, app_id, app_mode } = response if (status === DSLImportStatus.COMPLETED) { - trackCreateApp({ source: 'studio_upload' }) + trackCreateApp({ appMode: app_mode }) if (onSuccess) onSuccess() if (onClose) diff --git a/web/app/components/apps/__tests__/index.spec.tsx b/web/app/components/apps/__tests__/index.spec.tsx index c6a552fa73..aae862c865 100644 --- a/web/app/components/apps/__tests__/index.spec.tsx +++ b/web/app/components/apps/__tests__/index.spec.tsx @@ -238,8 +238,7 @@ describe('Apps', () => { await waitFor(() => { expect(mockFetchAppDetail).toHaveBeenCalledWith('template-1') expect(mockTrackCreateApp).toHaveBeenCalledWith({ - source: 'studio_template_preview', - templateId: 'template-1', + appMode: AppModeEnum.CHAT, }) }) }) diff --git a/web/app/components/apps/index.tsx b/web/app/components/apps/index.tsx index 1bc825306a..9bf07e81e6 100644 --- a/web/app/components/apps/index.tsx +++ b/web/app/components/apps/index.tsx @@ -1,7 +1,7 @@ 'use client' import type { CreateAppModalProps } from '../explore/create-app-modal' import type { TryAppSelection } from '@/types/try-app' -import { useCallback, useState } from 'react' +import { useCallback, useRef, useState } from 'react' import { useTranslation } from 'react-i18next' import { useEducationInit } from '@/app/education-apply/hooks' import AppListContext from '@/context/app-list-context' @@ -24,6 +24,7 @@ const Apps = () => { useEducationInit() const [currentTryAppParams, setCurrentTryAppParams] = useState(undefined) + const currentCreateAppModeRef = useRef(null) const currApp = currentTryAppParams?.app const [isShowTryAppPanel, setIsShowTryAppPanel] = useState(false) const hideTryAppPanel = useCallback(() => { @@ -42,12 +43,11 @@ const Apps = () => { setIsShowCreateModal(true) }, []) const trackCurrentCreateApp = useCallback(() => { - const templateId = currApp?.app.id - if (!templateId) + if (!currentCreateAppModeRef.current) return - trackCreateApp({ source: 'studio_template_preview', templateId }) - }, [currApp?.app.id]) + trackCreateApp({ appMode: currentCreateAppModeRef.current }) + }, []) const [controlRefreshList, setControlRefreshList] = useState(0) const [controlHideCreateFromTemplatePanel, setControlHideCreateFromTemplatePanel] = useState(0) @@ -83,9 +83,10 @@ const Apps = () => { }) => { hideTryAppPanel() - const { export_data } = await fetchAppDetail( + const { export_data, mode } = await fetchAppDetail( currApp?.app.id as string, ) + currentCreateAppModeRef.current = mode const payload = { mode: DSLImportMode.YAML_CONTENT, yaml_content: export_data, diff --git a/web/app/components/base/amplitude/AmplitudeProvider.tsx b/web/app/components/base/amplitude/AmplitudeProvider.tsx index 00af15e24d..9ba64ceb30 100644 --- a/web/app/components/base/amplitude/AmplitudeProvider.tsx +++ b/web/app/components/base/amplitude/AmplitudeProvider.tsx @@ -5,7 +5,7 @@ import * as amplitude from '@amplitude/analytics-browser' import { sessionReplayPlugin } from '@amplitude/plugin-session-replay-browser' import * as React from 'react' import { useEffect } from 'react' -import { AMPLITUDE_API_KEY, isAmplitudeEnabled } from '@/config' +import { AMPLITUDE_API_KEY } from '@/config' export type IAmplitudeProps = { sessionReplaySampleRate?: number @@ -54,8 +54,8 @@ const AmplitudeProvider: FC = ({ }) => { useEffect(() => { // Only enable in Saas edition with valid API key - if (!isAmplitudeEnabled) - return + // if (!isAmplitudeEnabled) + // return // Initialize Amplitude amplitude.init(AMPLITUDE_API_KEY, { diff --git a/web/app/components/explore/app-list/__tests__/index.spec.tsx b/web/app/components/explore/app-list/__tests__/index.spec.tsx index 20913cfc7d..e3446086a7 100644 --- a/web/app/components/explore/app-list/__tests__/index.spec.tsx +++ b/web/app/components/explore/app-list/__tests__/index.spec.tsx @@ -218,7 +218,7 @@ describe('AppList', () => { categories: ['Writing'], allList: [createApp()], }; - (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml-content' }) + (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml-content', mode: AppModeEnum.CHAT }) mockHandleImportDSL.mockImplementation(async (_payload: unknown, options: { onSuccess?: () => void, onPending?: () => void }) => { options.onPending?.() }) @@ -240,8 +240,7 @@ describe('AppList', () => { await waitFor(() => { expect(mockHandleImportDSLConfirm).toHaveBeenCalledTimes(1) expect(mockTrackCreateApp).toHaveBeenCalledWith({ - source: 'explore_template_list', - templateId: 'app-basic-id', + appMode: AppModeEnum.CHAT, }) expect(onSuccess).toHaveBeenCalledTimes(1) }) @@ -315,7 +314,7 @@ describe('AppList', () => { categories: ['Writing'], allList: [createApp()], }; - (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml' }) + (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml', mode: AppModeEnum.CHAT }) renderAppList(true) fireEvent.click(screen.getByText('explore.appCard.addToWorkspace')) @@ -333,7 +332,7 @@ describe('AppList', () => { categories: ['Writing'], allList: [createApp()], }; - (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml' }) + (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml', mode: AppModeEnum.CHAT }) mockHandleImportDSL.mockImplementation(async (_payload: unknown, options: { onSuccess?: () => void }) => { options.onSuccess?.() }) @@ -346,8 +345,7 @@ describe('AppList', () => { expect(screen.queryByTestId('create-app-modal')).not.toBeInTheDocument() }) expect(mockTrackCreateApp).toHaveBeenCalledWith({ - source: 'explore_template_list', - templateId: 'app-basic-id', + appMode: AppModeEnum.CHAT, }) }) @@ -357,7 +355,7 @@ describe('AppList', () => { categories: ['Writing'], allList: [createApp()], }; - (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml' }) + (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml', mode: AppModeEnum.CHAT }) mockHandleImportDSL.mockImplementation(async (_payload: unknown, options: { onPending?: () => void }) => { options.onPending?.() }) @@ -403,7 +401,7 @@ describe('AppList', () => { categories: ['Writing'], allList: [createApp()], }; - (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml' }) + (fetchAppDetail as unknown as Mock).mockResolvedValue({ export_data: 'yaml', mode: AppModeEnum.CHAT }) mockHandleImportDSL.mockImplementation(async (_payload: unknown, options: { onSuccess?: () => void }) => { options.onSuccess?.() }) @@ -416,8 +414,7 @@ describe('AppList', () => { await waitFor(() => { expect(mockTrackCreateApp).toHaveBeenCalledWith({ - source: 'explore_template_preview', - templateId: 'app-basic-id', + appMode: AppModeEnum.CHAT, }) }) }) diff --git a/web/app/components/explore/app-list/index.tsx b/web/app/components/explore/app-list/index.tsx index 7eaef06f11..684ab9e267 100644 --- a/web/app/components/explore/app-list/index.tsx +++ b/web/app/components/explore/app-list/index.tsx @@ -6,7 +6,7 @@ import type { TryAppSelection } from '@/types/try-app' import { useDebounceFn } from 'ahooks' import { useQueryState } from 'nuqs' import * as React from 'react' -import { useCallback, useMemo, useState } from 'react' +import { useCallback, useMemo, useRef, useState } from 'react' import { useTranslation } from 'react-i18next' import DSLConfirmModal from '@/app/components/app/create-from-dsl-modal/dsl-confirm-modal' import Button from '@/app/components/base/button' @@ -92,7 +92,6 @@ const Apps = ({ const [currApp, setCurrApp] = useState(null) const [isShowCreateModal, setIsShowCreateModal] = useState(false) - const [createAppSource, setCreateAppSource] = useState<'explore_template_list' | 'explore_template_preview'>('explore_template_list') const { handleImportDSL, @@ -103,6 +102,7 @@ const Apps = ({ const [showDSLConfirmModal, setShowDSLConfirmModal] = useState(false) const [currentTryApp, setCurrentTryApp] = useState(undefined) + const currentCreateAppModeRef = useRef(null) const isShowTryAppPanel = !!currentTryApp const hideTryAppPanel = useCallback(() => { setCurrentTryApp(undefined) @@ -112,16 +112,14 @@ const Apps = ({ }, []) const handleShowFromTryApp = useCallback(() => { setCurrApp(currentTryApp?.app || null) - setCreateAppSource('explore_template_preview') setIsShowCreateModal(true) }, [currentTryApp?.app]) const trackCurrentCreateApp = useCallback(() => { - const templateId = currApp?.app.id - if (!templateId) + if (!currentCreateAppModeRef.current) return - trackCreateApp({ source: createAppSource, templateId }) - }, [createAppSource, currApp?.app.id]) + trackCreateApp({ appMode: currentCreateAppModeRef.current }) + }, []) const onCreate: CreateAppModalProps['onConfirm'] = useCallback(async ({ name, @@ -132,9 +130,10 @@ const Apps = ({ }) => { hideTryAppPanel() - const { export_data } = await fetchAppDetail( + const { export_data, mode } = await fetchAppDetail( currApp?.app.id as string, ) + currentCreateAppModeRef.current = mode const payload = { mode: DSLImportMode.YAML_CONTENT, yaml_content: export_data, @@ -240,7 +239,6 @@ const Apps = ({ canCreate={hasEditPermission} onCreate={() => { setCurrApp(app) - setCreateAppSource('explore_template_list') setIsShowCreateModal(true) }} onTry={handleTryApp} diff --git a/web/utils/__tests__/create-app-tracking.spec.ts b/web/utils/__tests__/create-app-tracking.spec.ts index 778a062a60..855f54ebca 100644 --- a/web/utils/__tests__/create-app-tracking.spec.ts +++ b/web/utils/__tests__/create-app-tracking.spec.ts @@ -1,5 +1,6 @@ import { beforeEach, describe, expect, it, vi } from 'vitest' import * as amplitude from '@/app/components/base/amplitude' +import { AppModeEnum } from '@/types/app' import { buildCreateAppEventPayload, extractExternalCreateAppAttribution, @@ -42,21 +43,58 @@ describe('create-app-tracking', () => { }) describe('buildCreateAppEventPayload', () => { - it('should build template payloads with template id', () => { + it('should build original payloads with normalized app mode and timestamp', () => { expect(buildCreateAppEventPayload({ - source: 'explore_template_preview', - templateId: 'template-1', - })).toEqual({ - source: 'explore_template_preview', - template_id: 'template-1', + appMode: AppModeEnum.ADVANCED_CHAT, + }, null, new Date(2026, 3, 13, 14, 5, 9))).toEqual({ + source: 'original', + app_mode: 'chatflow', + time: '04-13-14:05:09', + }) + }) + + it('should map agent mode into the canonical app mode bucket', () => { + expect(buildCreateAppEventPayload({ + appMode: AppModeEnum.AGENT_CHAT, + }, null, new Date(2026, 3, 13, 9, 8, 7))).toEqual({ + source: 'original', + app_mode: 'agent', + time: '04-13-09:08:07', + }) + }) + + it('should fold legacy non-agent modes into chatflow', () => { + expect(buildCreateAppEventPayload({ + appMode: AppModeEnum.CHAT, + }, null, new Date(2026, 3, 13, 8, 0, 1))).toEqual({ + source: 'original', + app_mode: 'chatflow', + time: '04-13-08:00:01', + }) + + expect(buildCreateAppEventPayload({ + appMode: AppModeEnum.COMPLETION, + }, null, new Date(2026, 3, 13, 8, 0, 2))).toEqual({ + source: 'original', + app_mode: 'chatflow', + time: '04-13-08:00:02', + }) + }) + + it('should map workflow mode into the workflow bucket', () => { + expect(buildCreateAppEventPayload({ + appMode: AppModeEnum.WORKFLOW, + }, null, new Date(2026, 3, 13, 7, 6, 5))).toEqual({ + source: 'original', + app_mode: 'workflow', + time: '04-13-07:06:05', }) }) it('should prefer external attribution when present', () => { expect(buildCreateAppEventPayload( { - source: 'studio_template_list', - templateId: 'template-2', + appMode: AppModeEnum.WORKFLOW, }, { utmSource: 'linkedin', @@ -76,7 +114,7 @@ describe('create-app-tracking', () => { searchParams: new URLSearchParams('utm_source=newsletter&slug=how-to-build-rag-agent'), }) - trackCreateApp({ source: 'studio_blank' }) + trackCreateApp({ appMode: AppModeEnum.WORKFLOW }) expect(amplitude.trackEvent).toHaveBeenNthCalledWith(1, 'create_app', { source: 'external', @@ -84,10 +122,12 @@ describe('create-app-tracking', () => { utm_campaign: 'how-to-build-rag-agent', }) - trackCreateApp({ source: 'studio_blank' }) + trackCreateApp({ appMode: AppModeEnum.WORKFLOW }) expect(amplitude.trackEvent).toHaveBeenNthCalledWith(2, 'create_app', { - source: 'studio_blank', + source: 'original', + app_mode: 'workflow', + time: expect.stringMatching(/^\d{2}-\d{2}-\d{2}:\d{2}:\d{2}$/), }) }) }) diff --git a/web/utils/create-app-tracking.ts b/web/utils/create-app-tracking.ts index b2d377a154..8be63511bb 100644 --- a/web/utils/create-app-tracking.ts +++ b/web/utils/create-app-tracking.ts @@ -1,5 +1,6 @@ import Cookies from 'js-cookie' import { trackEvent } from '@/app/components/base/amplitude' +import { AppModeEnum } from '@/types/app' const CREATE_APP_EXTERNAL_ATTRIBUTION_STORAGE_KEY = 'create_app_external_attribution' @@ -16,13 +17,11 @@ type SearchParamReader = { get: (name: string) => string | null } -type CreateAppSource = 'external' | 'explore_template_list' | 'explore_template_preview' | 'studio_blank' | 'studio_template_list' | 'studio_template_preview' | 'studio_upload' +type OriginalCreateAppMode = 'workflow' | 'chatflow' | 'agent' -type TemplateCreateAppSource = Extract - -type NonTemplateCreateAppSource = Extract - -type TrackCreateAppParams = { source: TemplateCreateAppSource, templateId: string } | { source: NonTemplateCreateAppSource } +type TrackCreateAppParams = { + appMode: AppModeEnum +} type ExternalCreateAppAttribution = { utmSource: typeof EXTERNAL_UTM_SOURCE_MAP[keyof typeof EXTERNAL_UTM_SOURCE_MAP] @@ -69,6 +68,22 @@ const mapExternalUtmSource = (value?: string) => { return EXTERNAL_UTM_SOURCE_MAP[normalized as keyof typeof EXTERNAL_UTM_SOURCE_MAP] } +const padTimeValue = (value: number) => String(value).padStart(2, '0') + +const formatCreateAppTime = (date: Date) => { + return `${padTimeValue(date.getMonth() + 1)}-${padTimeValue(date.getDate())}-${padTimeValue(date.getHours())}:${padTimeValue(date.getMinutes())}:${padTimeValue(date.getSeconds())}` +} + +const mapOriginalCreateAppMode = (appMode: AppModeEnum): OriginalCreateAppMode => { + if (appMode === AppModeEnum.WORKFLOW) + return 'workflow' + + if (appMode === AppModeEnum.AGENT_CHAT) + return 'agent' + + return 'chatflow' +} + export const extractExternalCreateAppAttribution = ({ searchParams, utmInfo, @@ -144,6 +159,7 @@ const resolveCurrentExternalCreateAppAttribution = () => { export const buildCreateAppEventPayload = ( params: TrackCreateAppParams, externalAttribution?: ExternalCreateAppAttribution | null, + currentTime = new Date(), ) => { if (externalAttribution) { return { @@ -153,15 +169,10 @@ export const buildCreateAppEventPayload = ( } satisfies Record } - if ('templateId' in params) { - return { - source: params.source, - template_id: params.templateId, - } satisfies Record - } - return { - source: params.source, + source: 'original', + app_mode: mapOriginalCreateAppMode(params.appMode), + time: formatCreateAppTime(currentTime), } satisfies Record } From 6e75b8d2084dea4d60b0e87ee41ca4aa06e5a417 Mon Sep 17 00:00:00 2001 From: hj24 Date: Mon, 13 Apr 2026 17:35:32 +0800 Subject: [PATCH 34/34] fix: db session expired issue --- api/controllers/console/app/workflow_app_log.py | 4 ++-- api/controllers/console/app/workflow_trigger.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/controllers/console/app/workflow_app_log.py b/api/controllers/console/app/workflow_app_log.py index 3b24c2a402..8ae6a78a62 100644 --- a/api/controllers/console/app/workflow_app_log.py +++ b/api/controllers/console/app/workflow_app_log.py @@ -87,7 +87,7 @@ class WorkflowAppLogApi(Resource): # get paginate workflow app logs workflow_app_service = WorkflowAppService() - with sessionmaker(db.engine).begin() as session: + with sessionmaker(db.engine, expire_on_commit=False).begin() as session: workflow_app_log_pagination = workflow_app_service.get_paginate_workflow_app_logs( session=session, app_model=app_model, @@ -124,7 +124,7 @@ class WorkflowArchivedLogApi(Resource): args = WorkflowAppLogQuery.model_validate(request.args.to_dict(flat=True)) # type: ignore workflow_app_service = WorkflowAppService() - with sessionmaker(db.engine).begin() as session: + with sessionmaker(db.engine, expire_on_commit=False).begin() as session: workflow_app_log_pagination = workflow_app_service.get_paginate_workflow_archive_logs( session=session, app_model=app_model, diff --git a/api/controllers/console/app/workflow_trigger.py b/api/controllers/console/app/workflow_trigger.py index e4a6afae1e..c457684c15 100644 --- a/api/controllers/console/app/workflow_trigger.py +++ b/api/controllers/console/app/workflow_trigger.py @@ -64,7 +64,7 @@ class WebhookTriggerApi(Resource): node_id = args.node_id - with sessionmaker(db.engine).begin() as session: + with sessionmaker(db.engine, expire_on_commit=False).begin() as session: # Get webhook trigger for this app and node webhook_trigger = session.scalar( select(WorkflowWebhookTrigger) @@ -95,7 +95,7 @@ class AppTriggersApi(Resource): assert isinstance(current_user, Account) assert current_user.current_tenant_id is not None - with sessionmaker(db.engine).begin() as session: + with sessionmaker(db.engine, expire_on_commit=False).begin() as session: # Get all triggers for this app using select API triggers = ( session.execute(