Spaces:
Sleeping
Sleeping
File size: 15,125 Bytes
3493993 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 | from __future__ import annotations
from collections import defaultdict
from datetime import datetime, timedelta, timezone
from typing import Any
from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
from app.analytics.errors import AnalyticsValidationError
from app.analytics.models import AnalyticsSyncRun
from app.analytics.repository import AnalyticsRepository
from app.analytics.schemas import (
AnalyticsCapabilities,
AnalyticsFreshness,
AnalyticsMetric,
AnalyticsOverview,
AnalyticsPostList,
AnalyticsQuery,
AnalyticsSyncRequest,
AnalyticsSyncRunView,
AnalyticsTimeseries,
)
from app.core.logger import get_logger
from app.social.providers.registry import ProviderRegistry
from app.social.services.analytics_service import AnalyticsService as SocialAnalyticsService
from app.social.services.audit_service import SocialAuditService
logger = get_logger(__name__)
COMMON_METRICS = ("views", "impressions", "likes", "comments", "shares", "engagement_rate")
PROVIDER_METRICS: dict[str, tuple[str, ...]] = {
"facebook": ("views", "impressions", "likes", "comments", "shares"),
"instagram": ("views", "likes", "comments", "shares"),
"tiktok": ("views", "likes", "comments", "shares"),
"x": ("impressions", "likes", "comments", "shares"),
"youtube": ("views", "likes", "comments"),
"linkedin": ("impressions", "likes", "comments", "shares", "engagement_rate"),
}
class AnalyticsDomainService:
"""Tenant-scoped analytics aggregation over provider-reported snapshots."""
def __init__(
self,
repository: AnalyticsRepository,
providers: ProviderRegistry,
social_analytics: SocialAnalyticsService,
accounts: object,
audit: SocialAuditService,
projects: object | None = None,
) -> None:
self.repository = repository
self.providers = providers
self.social_analytics = social_analytics
self.accounts = accounts
self.audit = audit
self.projects = projects
self.ready = False
async def initialize(self, social_ready: bool) -> None:
self.ready = social_ready
def ensure_ready(self) -> None:
if not self.ready:
from app.social.domain.errors import SocialProviderUnavailableError
raise SocialProviderUnavailableError(
"Analytics database schema is unavailable. Apply the analytics migration."
)
@staticmethod
def _range(query: AnalyticsQuery) -> tuple[datetime, datetime, str]:
end = query.date_to or datetime.now(timezone.utc)
start = query.date_from or end - timedelta(days=30)
if start.tzinfo is None or end.tzinfo is None:
raise AnalyticsValidationError("Analytics dates must include a UTC offset.")
if end <= start:
raise AnalyticsValidationError("date_to must be after date_from.")
if end - start > timedelta(days=366):
raise AnalyticsValidationError("Analytics date ranges are limited to 366 days.")
try:
ZoneInfo(query.timezone)
except ZoneInfoNotFoundError as exc:
raise AnalyticsValidationError("timezone must be a valid IANA timezone.") from exc
return start.astimezone(timezone.utc), end.astimezone(timezone.utc), query.timezone
@staticmethod
def _metric_view(row: Any) -> AnalyticsMetric:
return AnalyticsMetric(
provider=row.provider,
post_id=row.social_post_id,
project_id=row.project_id,
metric_date=row.metric_date,
views=row.views,
impressions=row.impressions,
likes=row.likes,
comments=row.comments,
shares=row.shares,
engagement_rate=row.engagement_rate,
collected_at=row.collected_at,
source=row.source,
)
async def capabilities(self) -> list[AnalyticsCapabilities]:
result: list[AnalyticsCapabilities] = []
for adapter in self.providers.list():
capabilities = adapter.capabilities
available = bool(capabilities.analytics)
result.append(
AnalyticsCapabilities(
provider=capabilities.provider.value,
implementation_status=capabilities.implementation_status,
status="available" if available else "unsupported",
metrics=(
list(PROVIDER_METRICS.get(capabilities.provider.value, ()))
if available
else []
),
required_scopes=list(capabilities.analytics_required_scopes),
)
)
return result
async def create_sync(
self, workspace_id: str, user_id: str, payload: AnalyticsSyncRequest
) -> AnalyticsSyncRunView:
query = AnalyticsQuery(
date_from=payload.date_from,
date_to=payload.date_to,
timezone=payload.timezone,
provider=payload.provider,
project_id=payload.project_id,
)
start, end, tz = self._range(query)
if not payload.idempotency_key:
raise AnalyticsValidationError(
"Idempotency-Key is required for analytics synchronization."
)
if payload.provider:
self.providers.get(payload.provider)
if payload.project_id and self.projects is not None:
await self.projects.get(
workspace_id=workspace_id,
user_id=user_id,
project_id=payload.project_id,
)
run = await self.repository.create_sync(
AnalyticsSyncRun(
workspace_id=workspace_id,
project_id=payload.project_id,
provider=payload.provider,
date_from=start,
date_to=end,
timezone=tz,
idempotency_key=payload.idempotency_key,
requested_by=user_id,
)
)
await self.audit.record(
workspace_id=workspace_id,
event_type="analytics.sync_requested",
metadata={"sync_run_id": run.id, "provider": payload.provider},
)
return self._sync_view(run)
async def sync_once(self, run: AnalyticsSyncRun) -> AnalyticsSyncRunView:
targets = await self.repository.published_targets(
run.workspace_id,
project_id=run.project_id,
provider=run.provider,
date_from=run.date_from,
date_to=run.date_to,
)
await self.audit.record(
workspace_id=run.workspace_id,
event_type="analytics.sync_started",
metadata={"sync_run_id": run.id},
)
errors = 0
count = 0
by_post: dict[str, tuple[Any, list[Any]]] = {}
for post, target in targets:
by_post.setdefault(post.id, (post, []))[1].append(target)
for post, post_targets in by_post.values():
try:
latest = await self.repository.get_sync(run.workspace_id, run.id)
if latest.status == "cancelled":
return self._sync_view(latest)
result = await self.social_analytics.post(run.workspace_id, post.id)
for target in post_targets:
matches = [
item
for item in result.get("metrics", [])
if isinstance(item, dict) and item.get("provider") == target.provider
]
if not matches:
errors += 1
continue
metric = matches[-1]
await self.repository.upsert_post_metric(
workspace_id=run.workspace_id,
post=post,
target=target,
metric=metric,
collected_at=datetime.now(timezone.utc),
)
count += 1
if result.get("unavailable"):
errors += 1
except Exception as exc:
errors += 1
logger.warning(
"analytics target synchronization failed",
extra={"sync_run_id": run.id, "post_id": post.id},
)
if not getattr(exc, "code", None):
logger.debug("analytics sync exception", exc_info=True)
status = (
"failed" if targets and count == 0 and errors else "partial" if errors else "succeeded"
)
if not targets:
status = "succeeded"
updated = await self.repository.update_sync(run.id, status=status, metrics_count=count)
await self.audit.record(
workspace_id=run.workspace_id,
event_type=(
"analytics.sync_completed" if status != "failed" else "analytics.sync_failed"
),
metadata={"sync_run_id": run.id, "status": status, "metrics_count": count},
)
return self._sync_view(updated)
async def overview(self, workspace_id: str, query: AnalyticsQuery) -> AnalyticsOverview:
start, end, tz = self._range(query)
rows = await self.repository.metric_rows(
workspace_id,
{
"date_from": start,
"date_to": end,
"provider": query.provider,
"project_id": query.project_id,
"social_account_id": query.social_account_id,
"post_id": query.post_id,
"search": query.search,
},
)
totals = self._totals(rows)
grouped: dict[str, list[Any]] = defaultdict(list)
for row in rows:
grouped[row.provider].append(row)
platforms = [
{"provider": provider, "posts": len(items), **self._totals(items)}
for provider, items in sorted(grouped.items())
]
top = sorted(
rows, key=lambda row: self._sort_value(row, query.sort), reverse=query.descending
)[:10]
return AnalyticsOverview(
date_from=start,
date_to=end,
timezone=tz,
timezone_source="requested" if query.timezone != "UTC" else "utc_fallback",
totals=totals,
platforms=platforms,
top_posts=[self._metric_view(row) for row in top],
freshness=await self._freshness(workspace_id, query),
)
async def timeseries(self, workspace_id: str, query: AnalyticsQuery) -> AnalyticsTimeseries:
start, end, tz_name = self._range(query)
rows = await self.repository.metric_rows(
workspace_id,
{
"date_from": start,
"date_to": end,
"provider": query.provider,
"project_id": query.project_id,
"social_account_id": query.social_account_id,
"post_id": query.post_id,
"search": query.search,
},
)
zone = ZoneInfo(tz_name)
points: dict[str, dict[str, Any]] = {}
for row in rows:
local = row.metric_date.astimezone(zone)
if query.granularity == "month":
key = local.strftime("%Y-%m-01")
elif query.granularity == "week":
monday = local.date() - timedelta(days=local.weekday())
key = monday.isoformat()
else:
key = local.date().isoformat()
item = points.setdefault(key, {"bucket": key, "value": 0, "posts": 0})
value = getattr(row, query.metric or "views")
if value is not None:
item["value"] += value
item["posts"] += 1
return AnalyticsTimeseries(
date_from=start,
date_to=end,
timezone=tz_name,
granularity=query.granularity,
metric=query.metric or "views",
points=[points[key] for key in sorted(points)],
freshness=await self._freshness(workspace_id, query),
)
async def posts(self, workspace_id: str, query: AnalyticsQuery) -> AnalyticsPostList:
start, end, _ = self._range(query)
rows = await self.repository.metric_rows(
workspace_id,
{
"date_from": start,
"date_to": end,
"provider": query.provider,
"project_id": query.project_id,
"social_account_id": query.social_account_id,
"post_id": query.post_id,
"search": query.search,
},
)
rows.sort(key=lambda row: self._sort_value(row, query.sort), reverse=query.descending)
return AnalyticsPostList(
items=[
self._metric_view(row) for row in rows[query.offset : query.offset + query.limit]
],
offset=query.offset,
limit=query.limit,
freshness=await self._freshness(workspace_id, query),
)
async def post(
self, workspace_id: str, post_id: str, query: AnalyticsQuery
) -> AnalyticsPostList:
query.post_id = post_id
return await self.posts(workspace_id, query)
async def _freshness(self, workspace_id: str, query: AnalyticsQuery) -> AnalyticsFreshness:
run = await self.repository.latest_sync(
workspace_id, provider=query.provider, project_id=query.project_id
)
if run is None:
return AnalyticsFreshness(
status="not_synchronized", reason="No analytics sync has completed."
)
status = (
"fresh"
if run.completed_at
and run.completed_at >= datetime.now(timezone.utc) - timedelta(hours=24)
else "stale"
)
if run.status == "partial":
status = "partial"
return AnalyticsFreshness(
status=status, last_collected_at=run.completed_at, last_sync_id=run.id
)
@staticmethod
def _totals(rows: list[Any]) -> dict[str, int | float | None]:
result: dict[str, int | float | None] = {}
for name in COMMON_METRICS:
values = [getattr(row, name) for row in rows if getattr(row, name) is not None]
result[name] = (
(sum(values) / len(values) if name == "engagement_rate" else sum(values))
if values
else None
)
return result
@staticmethod
def _sort_value(row: Any, field: str) -> float:
if field == "date":
return row.metric_date.timestamp()
value = getattr(row, field, None)
return float(value) if isinstance(value, (int, float)) else 0.0
@staticmethod
def _sync_view(run: AnalyticsSyncRun) -> AnalyticsSyncRunView:
return AnalyticsSyncRunView.model_validate(run, from_attributes=True)
|