This commit is contained in:
2026-05-11 03:27:21 +03:30
parent cf7cbb937c
commit d0e68a1a56
854 changed files with 102985 additions and 76 deletions
@@ -0,0 +1,7 @@
from django.apps import AppConfig
class EconomicOverviewConfig(AppConfig):
default_auto_field = "django.db.models.BigAutoField"
name = "economic_overview"
verbose_name = "Economic Overview"
@@ -0,0 +1,8 @@
EMPTY_ECONOMIC_OVERVIEW = {
"economicData": [],
"chartSeries": [],
"chartCategories": [],
"status": "empty",
"source": "db",
"warnings": ["No persisted economic overview data is available for this farm."],
}
@@ -0,0 +1,28 @@
from django.db import migrations, models
import django.db.models.deletion
import uuid
class Migration(migrations.Migration):
initial = True
dependencies = [
("farm_hub", "0001_initial"),
]
operations = [
migrations.CreateModel(
name="EconomicOverviewLog",
fields=[
("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
("uuid", models.UUIDField(default=uuid.uuid4, editable=False, unique=True, db_index=True)),
("farm", models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name="economic_overview_logs", to="farm_hub.farmhub")),
("economic_data", models.JSONField(blank=True, default=list)),
("chart_series", models.JSONField(blank=True, default=list)),
("chart_categories", models.JSONField(blank=True, default=list)),
("fetched_at", models.DateTimeField(auto_now_add=True)),
],
options={"db_table": "economic_overview_logs", "ordering": ["-fetched_at"]},
),
]
@@ -0,0 +1,37 @@
ECONOMIC_OVERVIEW = {
"economicData": [
{
"title": "هزینه آب",
"value": "€720",
"subtitle": "این ماه",
"avatarIcon": "tabler-droplet",
"avatarColor": "primary",
},
{
"title": "صرفه‌جویی آب هوشمند",
"value": "€156",
"subtitle": "۱۸٪ صرفه‌جویی شده",
"avatarIcon": "tabler-bulb",
"avatarColor": "success",
},
{
"title": "بازده سرمایه پلتفرم",
"value": "127%",
"subtitle": "نسبت به سال گذشته",
"avatarIcon": "tabler-chart-line",
"avatarColor": "info",
},
{
"title": "پیش‌بینی درآمد",
"value": "€42k",
"subtitle": "این فصل",
"avatarIcon": "tabler-currency-euro",
"avatarColor": "success",
},
],
"chartSeries": [
{"name": "هزینه آب", "data": [120, 115, 110, 125, 118, 122]},
{"name": "کود", "data": [80, 85, 90, 75, 82, 78]},
],
"chartCategories": ["ژانویه", "فوریه", "مارس", "آوریل", "می", "ژوئن"],
}
@@ -0,0 +1,28 @@
import uuid as uuid_lib
from django.db import models
from farm_hub.models import FarmHub
class EconomicOverviewLog(models.Model):
uuid = models.UUIDField(default=uuid_lib.uuid4, unique=True, editable=False, db_index=True)
farm = models.ForeignKey(
FarmHub,
on_delete=models.CASCADE,
related_name="economic_overview_logs",
null=True,
blank=True,
)
economic_data = models.JSONField(default=list, blank=True)
chart_series = models.JSONField(default=list, blank=True)
chart_categories = models.JSONField(default=list, blank=True)
fetched_at = models.DateTimeField(auto_now_add=True)
class Meta:
db_table = "economic_overview_logs"
ordering = ["-fetched_at"]
def __str__(self):
farm_label = str(self.farm_id) if self.farm_id else "no-farm"
return f"{farm_label}{self.fetched_at}"
@@ -0,0 +1,26 @@
from rest_framework import serializers
class EconomicDataItemSerializer(serializers.Serializer):
title = serializers.CharField(help_text="عنوان شاخص اقتصادی.")
value = serializers.CharField(help_text="مقدار شاخص اقتصادی.")
subtitle = serializers.CharField(help_text="توضیح تکمیلی شاخص.")
avatarIcon = serializers.CharField(help_text="آیکون نمایشی شاخص.")
avatarColor = serializers.CharField(help_text="رنگ نمایشی شاخص.")
class ChartSeriesSerializer(serializers.Serializer):
name = serializers.CharField()
data = serializers.ListField(child=serializers.FloatField())
class EconomicOverviewSerializer(serializers.Serializer):
farm_uuid = serializers.CharField(required=False, allow_blank=True, help_text="UUID مزرعه.")
source = serializers.CharField(required=False, allow_blank=True, help_text="منبع داده یا نوع تولید پاسخ.")
economicData = EconomicDataItemSerializer(many=True)
chartSeries = ChartSeriesSerializer(many=True)
chartCategories = serializers.ListField(child=serializers.CharField(), help_text="برچسب‌های محور افقی نمودار اقتصادی.")
class EconomicOverviewRequestSerializer(serializers.Serializer):
farm_uuid = serializers.UUIDField(required=True, help_text="UUID مزرعه برای دریافت نمای اقتصادی.")
@@ -0,0 +1,27 @@
from copy import deepcopy
from .defaults import EMPTY_ECONOMIC_OVERVIEW
from .models import EconomicOverviewLog
def get_economic_overview_data(farm=None):
data = deepcopy(EMPTY_ECONOMIC_OVERVIEW)
if farm is None:
return data
log = EconomicOverviewLog.objects.filter(farm=farm).first()
if log is None:
return data
data["status"] = "success"
data["source"] = "db"
data["warnings"] = []
if log.economic_data:
data["economicData"] = deepcopy(log.economic_data)
if log.chart_series:
data["chartSeries"] = deepcopy(log.chart_series)
if log.chart_categories:
data["chartCategories"] = deepcopy(log.chart_categories)
return data
@@ -0,0 +1,97 @@
from unittest.mock import patch
from django.contrib.auth import get_user_model
from django.test import TestCase
from django.urls import Resolver404, resolve
from rest_framework.test import APIRequestFactory, force_authenticate
from external_api_adapter.adapter import AdapterResponse
from farm_hub.models import FarmHub, FarmType
from .views import EconomyOverviewView
class EconomyOverviewViewTests(TestCase):
def setUp(self):
self.factory = APIRequestFactory()
self.user = get_user_model().objects.create_user(
username="farmer",
password="secret123",
email="farmer@example.com",
phone_number="09120000000",
)
self.other_user = get_user_model().objects.create_user(
username="other-farmer",
password="secret123",
email="other@example.com",
phone_number="09120000001",
)
self.farm_type = FarmType.objects.create(name="زراعی")
self.farm = FarmHub.objects.create(owner=self.user, farm_type=self.farm_type, name="Farm 1")
self.other_farm = FarmHub.objects.create(owner=self.other_user, farm_type=self.farm_type, name="Farm 2")
@patch("economic_overview.views.external_api_request")
def test_overview_proxies_to_ai_service(self, mock_external_api_request):
mock_external_api_request.return_value = AdapterResponse(
status_code=200,
data={
"data": {
"result": {
"source": "mock",
"economicData": [{"title": "Revenue", "value": "10"}],
"chartSeries": [{"name": "Revenue", "data": [1.0, 2.0]}],
"chartCategories": ["فروردین", "اردیبهشت"],
}
}
},
)
request = self.factory.post("/api/economy/overview/", {"farm_uuid": str(self.farm.farm_uuid)}, format="json")
force_authenticate(request, user=self.user)
response = EconomyOverviewView.as_view()(request)
self.assertEqual(response.status_code, 200)
self.assertEqual(response.data["code"], 200)
self.assertEqual(response.data["data"]["farm_uuid"], str(self.farm.farm_uuid))
self.assertEqual(response.data["data"]["source"], "mock")
mock_external_api_request.assert_called_once_with(
"ai",
"/api/economy/overview/",
method="POST",
payload={"farm_uuid": str(self.farm.farm_uuid)},
)
def test_overview_rejects_foreign_farm_uuid(self):
request = self.factory.post("/api/economy/overview/", {"farm_uuid": str(self.other_farm.farm_uuid)}, format="json")
force_authenticate(request, user=self.user)
response = EconomyOverviewView.as_view()(request)
self.assertEqual(response.status_code, 404)
self.assertEqual(response.data["code"], 404)
def test_economy_routes_exist_only_under_economy_prefix(self):
self.assertIs(resolve("/api/economy/overview/").func.view_class, EconomyOverviewView)
with self.assertRaises(Resolver404):
resolve("/api/economy/summary/")
with self.assertRaises(Resolver404):
resolve("/api/economic-overview/summary/")
@patch("economic_overview.views.external_api_request")
def test_overview_returns_structured_502_for_invalid_upstream_payload(self, mock_external_api_request):
mock_external_api_request.return_value = AdapterResponse(
status_code=200,
data={"data": []},
)
request = self.factory.post("/api/economy/overview/", {"farm_uuid": str(self.farm.farm_uuid)}, format="json")
force_authenticate(request, user=self.user)
response = EconomyOverviewView.as_view()(request)
self.assertEqual(response.status_code, 502)
self.assertEqual(response.data["data"]["error_code"], "invalid_payload")
self.assertEqual(response.data["data"]["source"], "ai_provider")
@@ -0,0 +1,7 @@
from django.urls import path
from .views import EconomyOverviewView
urlpatterns = [
path("overview/", EconomyOverviewView.as_view(), name="economy-overview"),
]
+143
View File
@@ -0,0 +1,143 @@
import logging
from drf_spectacular.utils import extend_schema
from rest_framework import status
from rest_framework.response import Response
from rest_framework.views import APIView
from config.failure_contract import StructuredServiceError
from config.swagger import status_response
from external_api_adapter import request as external_api_request
from external_api_adapter.exceptions import ExternalAPIRequestError
from farm_hub.models import FarmHub
from .models import EconomicOverviewLog
from .serializers import EconomicOverviewRequestSerializer, EconomicOverviewSerializer
logger = logging.getLogger(__name__)
class EconomicOverviewAdapterError(StructuredServiceError):
def __init__(self, *, error_code: str, message: str, source: str, retriable: bool = False, details: dict | None = None):
super().__init__(
error_code=error_code,
message=message,
source=source,
retriable=retriable,
details=details,
)
class EconomyOverviewView(APIView):
@staticmethod
def _extract_result_or_error(adapter_data):
if not isinstance(adapter_data, dict):
raise EconomicOverviewAdapterError(
error_code="invalid_payload",
message="Economic overview adapter returned a non-object payload.",
source="ai_provider",
)
data = adapter_data.get("data")
if isinstance(data, dict) and isinstance(data.get("result"), dict):
return data["result"]
if isinstance(data, dict):
return data
result = adapter_data.get("result")
if isinstance(result, dict):
return result
raise EconomicOverviewAdapterError(
error_code="invalid_payload",
message="Economic overview adapter payload did not contain structured result data.",
source="ai_provider",
)
@staticmethod
def _get_farm(request, farm_uuid):
if not farm_uuid:
return None, Response(
{"code": 400, "msg": "error", "data": {"farm_uuid": ["This field is required."]}},
status=status.HTTP_400_BAD_REQUEST,
)
try:
return FarmHub.objects.get(farm_uuid=farm_uuid, owner=request.user), None
except FarmHub.DoesNotExist:
return None, Response(
{"code": 404, "msg": "error", "data": {"farm_uuid": ["Farm not found."]}},
status=status.HTTP_404_NOT_FOUND,
)
@staticmethod
def _persist_log(farm, overview_data):
if not isinstance(overview_data, dict):
raise EconomicOverviewAdapterError(
error_code="invalid_payload",
message="Economic overview data must be a JSON object before persistence.",
source="backend",
)
EconomicOverviewLog.objects.create(
farm=farm,
economic_data=overview_data.get("economicData", []),
chart_series=overview_data.get("chartSeries", []),
chart_categories=overview_data.get("chartCategories", []),
)
@extend_schema(
tags=["Economy"],
request=EconomicOverviewRequestSerializer,
responses={200: status_response("EconomyOverviewResponse", data=EconomicOverviewSerializer())},
)
def post(self, request):
serializer = EconomicOverviewRequestSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
farm, error_response = self._get_farm(request, serializer.validated_data["farm_uuid"])
if error_response is not None:
return error_response
payload = {"farm_uuid": str(farm.farm_uuid)}
try:
adapter_response = external_api_request(
"ai",
"/api/economy/overview/",
method="POST",
payload=payload,
)
except ExternalAPIRequestError as exc:
logger.error("Economic overview upstream request failed for farm_uuid=%s: %s", farm.farm_uuid, exc)
failure = EconomicOverviewAdapterError(
error_code="upstream_unavailable",
message="Economic overview upstream request failed.",
source="ai_provider",
retriable=True,
details={"farm_uuid": str(farm.farm_uuid)},
)
return Response(
{"code": 503, "msg": "error", "data": failure.to_dict()},
status=status.HTTP_503_SERVICE_UNAVAILABLE,
)
if adapter_response.status_code >= 400:
response_data = (
adapter_response.data
if isinstance(adapter_response.data, dict)
else {"message": str(adapter_response.data)}
)
return Response(
{"code": adapter_response.status_code, "msg": "error", "data": response_data},
status=adapter_response.status_code,
)
try:
overview_data = self._extract_result_or_error(adapter_response.data)
if isinstance(overview_data, dict):
overview_data.setdefault("farm_uuid", str(farm.farm_uuid))
self._persist_log(farm, overview_data)
except EconomicOverviewAdapterError as exc:
logger.error("Economic overview payload handling failed for farm_uuid=%s: %s", farm.farm_uuid, exc)
return Response(
{"code": 502, "msg": "error", "data": exc.to_dict()},
status=status.HTTP_502_BAD_GATEWAY,
)
return Response({"code": 200, "msg": "success", "data": overview_data}, status=status.HTTP_200_OK)