(PC-32268)[API] feat: Return individual or collective statistics only if offerer is concerned

Author: pcharlet-pass

api/src/pcapi/connectors/clickhouse/queries/yearly_revenue.py

@@ -16,9 +16,25 @@ class Config:
         extra = "forbid"
 
 
+class IndividualOnlyRevenue(pydantic_v1.BaseModel):
+    total: Decimal
+    individual: Decimal
+
+    class Config:
+        extra = "forbid"
+
+
+class CollectiveOnlyRevenue(pydantic_v1.BaseModel):
+    total: Decimal
+    collective: Decimal
+
+    class Config:
+        extra = "forbid"
+
+
 class AggregatedRevenue(pydantic_v1.BaseModel):
-    revenue: Revenue
-    expected_revenue: Revenue
+    revenue: Revenue | IndividualOnlyRevenue | CollectiveOnlyRevenue
+    expected_revenue: Revenue | IndividualOnlyRevenue | CollectiveOnlyRevenue
 
     class Config:
         extra = "forbid"
@@ -34,16 +50,25 @@ class Config:
 
 
 class YearlyAggregatedRevenueQuery(BaseQuery[YearlyAggregatedRevenueModel]):
+    def __init__(self, venues_have_individual: bool, venues_have_collective: bool) -> None:
+        self.venues_have_individual = venues_have_individual
+        self.venues_have_collective = venues_have_collective
+        super().__init__()
+
     def _format_result(self, results: list) -> dict:
-        return {
-            "incomeByYear": {
-                result.year: {
-                    "revenue": json.loads(result.revenue),
-                    "expectedRevenue": json.loads(result.expected_revenue),
-                }
-                for result in results
-            }
-        }
+        income_by_year = {}
+        for result in results:
+            revenue = json.loads(result.revenue)
+            expected_revenue = json.loads(result.expected_revenue)
+            if not self.venues_have_individual:
+                revenue.pop("individual", None)
+                expected_revenue.pop("individual", None)
+            if not self.venues_have_collective:
+                revenue.pop("collective", None)
+                expected_revenue.pop("collective", None)
+            income_by_year.update({result.year: {"revenue": revenue, "expectedRevenue": expected_revenue}})
+
+        return {"incomeByYear": income_by_year}
 
     @property
     def raw_query(self) -> str:

api/src/pcapi/core/offers/repository.py

@@ -1326,3 +1326,14 @@ def merge_products(to_keep: models.Product, to_delete: models.Product) -> models
     db.session.delete(to_delete)
 
     return to_keep
+
+
+def venues_have_individual_and_collective_offers(venue_ids: list[int]) -> tuple[bool, bool]:
+    return (
+        db.session.query(offers_model.Offer.query.filter(offers_model.Offer.venueId.in_(venue_ids)).exists()).scalar(),
+        db.session.query(
+            educational_models.CollectiveOffer.query.filter(
+                educational_models.CollectiveOffer.venueId.in_(venue_ids)
+            ).exists()
+        ).scalar(),
+    )

api/src/pcapi/routes/pro/statistics.py

@@ -2,6 +2,7 @@
 from flask_login import login_required
 
 from pcapi.connectors.clickhouse import queries as clickhouse_queries
+from pcapi.core.offers.repository import venues_have_individual_and_collective_offers
 from pcapi.models.api_errors import ApiErrors
 from pcapi.routes.apis import private_api
 from pcapi.routes.serialization.statistics_serialize import StatisticsModel
@@ -26,5 +27,8 @@ def get_statistics(query: StatisticsQueryModel) -> StatisticsModel:
             status_code=422,
         )
     check_user_has_access_to_venues(current_user, venue_ids)
-    result = clickhouse_queries.YearlyAggregatedRevenueQuery().execute(tuple(venue_ids))
+    venues_have_individual, venues_have_collective = venues_have_individual_and_collective_offers(venue_ids)
+    result = clickhouse_queries.YearlyAggregatedRevenueQuery(venues_have_individual, venues_have_collective).execute(
+        tuple(venue_ids)
+    )
     return StatisticsModel.from_query(income_by_year=result.income_by_year)

api/tests/connectors/clickhouse/clickhouse_test.py

@@ -14,7 +14,7 @@ def test_get_yearly_revenue(self):
 
         with mock.patch("pcapi.connectors.clickhouse.testing_backend.TestingBackend.run_query") as mock_run_query:
             mock_run_query.return_value = fixtures.YEARLY_AGGREGATED_VENUE_REVENUE
-            result = clickhouse_queries.YearlyAggregatedRevenueQuery().execute(venue_ids)
+            result = clickhouse_queries.YearlyAggregatedRevenueQuery(True, True).execute(venue_ids)
 
         assert result.income_by_year["2024"].revenue.total == Decimal("24.24")
         assert result.income_by_year["2024"].revenue.individual == Decimal("12.12")

api/tests/routes/pro/get_statistics_test.py

@@ -3,7 +3,9 @@
 import pytest
 
 from pcapi.core import testing
+import pcapi.core.educational.factories as educational_factories
 import pcapi.core.offerers.factories as offerers_factories
+import pcapi.core.offers.factories as offers_factories
 import pcapi.core.users.factories as users_factories
 
 from tests.connectors.clickhouse import fixtures
@@ -18,10 +20,14 @@ def test_get_statistics_from_one_venue(self, run_query, client):
         offerers_factories.UserOffererFactory(user=user, offerer=offerer)
         venue = offerers_factories.VenueFactory(managingOfferer=offerer)
         venue_id = venue.id
+        educational_factories.CollectiveOfferFactory(venue=venue)
+        offers_factories.OfferFactory(venue=venue)
 
         test_client = client.with_session_auth(email=user.email)
         num_queries = testing.AUTHENTICATION_QUERIES
         num_queries += 1  # select Offerer
+        num_queries += 1  # select Offer
+        num_queries += 1  # select CollectiveOffer
         with testing.assert_num_queries(num_queries):
             run_query.return_value = fixtures.YEARLY_AGGREGATED_VENUE_REVENUE
             response = test_client.get(f"/get-statistics/?venue_ids={venue_id}")
@@ -44,10 +50,14 @@ def test_get_statistics_from_multiple_venues(self, run_query, client):
         venue2 = offerers_factories.VenueFactory(managingOfferer=offerer)
         venue_id = venue.id
         venue2_id = venue2.id
+        educational_factories.CollectiveOfferFactory(venue=venue)
+        offers_factories.OfferFactory(venue=venue)
 
         test_client = client.with_session_auth(email=user.email)
         num_queries = testing.AUTHENTICATION_QUERIES
         num_queries += 1  # select Offerer
+        num_queries += 1  # select Offer
+        num_queries += 1  # select CollectiveOffer
         with testing.assert_num_queries(num_queries):
             run_query.return_value = fixtures.YEARLY_AGGREGATED_VENUE_REVENUE
             response = test_client.get(f"/get-statistics/?venue_ids={venue_id}&venue_ids={venue2_id}")
@@ -70,10 +80,14 @@ def test_get_statistics_multiple_years(self, run_query, client):
         venue2 = offerers_factories.VenueFactory(managingOfferer=offerer)
         venue_id = venue.id
         venue2_id = venue2.id
+        educational_factories.CollectiveOfferFactory(venue=venue)
+        offers_factories.OfferFactory(venue=venue)
 
         test_client = client.with_session_auth(email=user.email)
         num_queries = testing.AUTHENTICATION_QUERIES
         num_queries += 1  # select Offerer
+        num_queries += 1  # select Offer
+        num_queries += 1  # select CollectiveOffer
         with testing.assert_num_queries(num_queries):
             run_query.return_value = fixtures.YEARLY_AGGREGATED_VENUE_REVENUE_MULTIPLE_YEARS
             response = test_client.get(f"/get-statistics/?venue_ids={venue_id}&venue_ids={venue2_id}")
@@ -92,16 +106,84 @@ def test_get_statistics_multiple_years(self, run_query, client):
             }
         }
 
+    @patch("pcapi.connectors.clickhouse.testing_backend.TestingBackend.run_query")
+    def test_get_statistics_only_collective(self, run_query, client):
+        user = users_factories.UserFactory()
+        offerer = offerers_factories.OffererFactory()
+        offerers_factories.UserOffererFactory(user=user, offerer=offerer)
+        venue = offerers_factories.VenueFactory(managingOfferer=offerer)
+        venue_id = venue.id
+        educational_factories.CollectiveOfferFactory(venue=venue)
+
+        test_client = client.with_session_auth(email=user.email)
+        num_queries = testing.AUTHENTICATION_QUERIES
+        num_queries += 1  # select Offerer
+        num_queries += 1  # select Offer
+        num_queries += 1  # select CollectiveOffer
+        with testing.assert_num_queries(num_queries):
+            run_query.return_value = fixtures.YEARLY_AGGREGATED_VENUE_REVENUE_MULTIPLE_YEARS
+            response = test_client.get(f"/get-statistics/?venue_ids={venue_id}")
+            assert response.status_code == 200
+        assert response.json == {
+            "incomeByYear": {
+                "2022": {
+                    "expectedRevenue": {"collective": 22.12, "total": 44.24},
+                    "revenue": {"collective": 22.12, "total": 44.24},
+                },
+                "2023": {},
+                "2024": {
+                    "expectedRevenue": {"collective": 13.12, "total": 26.24},
+                    "revenue": {"collective": 12.12, "total": 24.24},
+                },
+            }
+        }
+
+    @patch("pcapi.connectors.clickhouse.testing_backend.TestingBackend.run_query")
+    def test_get_statistics_only_individual(self, run_query, client):
+        user = users_factories.UserFactory()
+        offerer = offerers_factories.OffererFactory()
+        offerers_factories.UserOffererFactory(user=user, offerer=offerer)
+        venue = offerers_factories.VenueFactory(managingOfferer=offerer)
+        venue_id = venue.id
+        offers_factories.OfferFactory(venue=venue)
+
+        test_client = client.with_session_auth(email=user.email)
+        num_queries = testing.AUTHENTICATION_QUERIES
+        num_queries += 1  # select Offerer
+        num_queries += 1  # select Offer
+        num_queries += 1  # select CollectiveOffer
+        with testing.assert_num_queries(num_queries):
+            run_query.return_value = fixtures.YEARLY_AGGREGATED_VENUE_REVENUE_MULTIPLE_YEARS
+            response = test_client.get(f"/get-statistics/?venue_ids={venue_id}")
+            assert response.status_code == 200
+        assert response.json == {
+            "incomeByYear": {
+                "2022": {
+                    "expectedRevenue": {"individual": 22.12, "total": 44.24},
+                    "revenue": {"individual": 22.12, "total": 44.24},
+                },
+                "2023": {},
+                "2024": {
+                    "expectedRevenue": {"individual": 13.12, "total": 26.24},
+                    "revenue": {"individual": 12.12, "total": 24.24},
+                },
+            }
+        }
+
     def test_get_statistics_empty_result(self, client):
         user = users_factories.UserFactory()
         offerer = offerers_factories.OffererFactory()
         offerers_factories.UserOffererFactory(user=user, offerer=offerer)
         venue = offerers_factories.VenueFactory(managingOfferer=offerer)
         venue_id = venue.id
+        educational_factories.CollectiveOfferFactory(venue=venue)
+        offers_factories.OfferFactory(venue=venue)
 
         test_client = client.with_session_auth(email=user.email)
         num_queries = testing.AUTHENTICATION_QUERIES
         num_queries += 1  # select Offerer
+        num_queries += 1  # select Offer
+        num_queries += 1  # select CollectiveOffer
         with testing.assert_num_queries(num_queries):
             response = test_client.get(f"/get-statistics/?venue_ids={venue_id}")
             assert response.status_code == 200