Files
chat_backend/llm_be/chat_backend/serializers.py
T
westfarn 841c0962d9
Deploy Beta / unit-tests (push) Successful in 10s
Unit Tests / test (push) Successful in 9s
Deploy Beta / docker (push) Successful in 18s
Deploy Beta / deploy-beta (push) Successful in 46s
Multi-plan subscriptions, quotas, and token usage APIs (#16 #17 #36) (#37)
## Summary
Implements [#16](#16), [#17](#17), and [#36](#36) in one backend PR.

- **#36 Multi-plan catalog**: Founders ($10, public), Standard ($15), Pro ($40), Business ($99), Backer ($0). Future tiers seeded but hidden/`is_selectable=false`. Backer email whitelist auto-assigns Founders-level access with no checkout.
- **#36 Feature + prompt gating**: plan feature flags (text vs image); rolling **6h** prompt windows (100 / 200 / 300 / 300 / 300). Enforced in both chat consumers when `ENFORCE_SUBSCRIPTION_GATES=true`.
- **#17 Token-period quotas**: optional `monthly_token_quota` on plans + per-user override; calendar-month aggregation from `PromptMetric`; warn/block when reported token totals exceed cap. Null provider usage never fabricated as 0; tracked via `turns_missing_token_usage`.
- **#16 Token API exposure**: `tokens_in` / `tokens_out` on conversation + prompt serializers (null when unknown). `GET /api/finance/subscription/` returns plan + usage snapshot for the FE.
- Checkout defaults to **Founders**; Stripe paid webhooks assign Founders. Registration/OAuth redeem Backer whitelist and return `needs_checkout`.

Companion FE PR: `chat_web_app` branch `feature/plans-quotas-token-usage`.

## Test plan
- [ ] `manage.py migrate` seeds five plans; admin can add Backer emails
- [ ] Public `GET /api/finance/plans/` returns only Founders
- [ ] Register with Backer email → active Backer, `needs_checkout=false`, checkout rejected
- [ ] Founders checkout + paid webhook → active Founders subscription
- [ ] Chat turn blocked without subscription / when prompt window exceeded / when token period exceeded
- [ ] Standard plan denies image feature; Pro/Founders/Backer allow
- [ ] Conversation/prompt API returns `null` tokens when unreported, sums when present
- [ ] `finance.tests.test_plans_quotas` + existing finance/checkout tests passReviewed-on: #37
2026-07-31 04:24:20 -07:00

265 lines
7.6 KiB
Python

from rest_framework_simplejwt.serializers import TokenObtainPairSerializer
from rest_framework import serializers
from django.db.models import Count, Q, Sum
from .models import (
CustomUser,
Announcement,
Company,
Conversation,
Prompt,
PromptMetric,
Feedback,
FEEDBACK_CATEGORIES,
DocumentWorkspace,
Document,
)
class MyTokenObtainPairSerializer(TokenObtainPairSerializer):
@classmethod
def get_token(cls, user):
token = super(MyTokenObtainPairSerializer, cls).get_token(user)
# add custom claim
token["company"] = "something here"
return token
class CompanySerializer(serializers.ModelSerializer):
class Meta:
model = Company
fields = "__all__"
class AnnouncmentSerializer(serializers.ModelSerializer):
class Meta:
model = Announcement
fields = "__all__"
class FeedbackSerializer(serializers.ModelSerializer):
class Meta:
model = Feedback
fields = "__all__"
class CustomUserSerializer(serializers.ModelSerializer):
email = serializers.EmailField(required=True)
username = serializers.CharField()
password = serializers.CharField(min_length=8, write_only=True)
company = CompanySerializer()
has_usable_password = serializers.BooleanField()
subscription = serializers.SerializerMethodField()
class Meta:
model = CustomUser
fields = "__all__"
extra_kwargs = {"password": {"write_only": True}}
def get_subscription(self, obj):
from finance.services.plans import needs_checkout, plan_to_dict
from finance.models import UserSubscription
try:
sub = obj.subscription
except UserSubscription.DoesNotExist:
return {
"plan": None,
"status": UserSubscription.Status.NONE,
"source": UserSubscription.Source.NONE,
"needs_checkout": True,
}
return {
"plan": plan_to_dict(sub.plan) if sub.plan_id else None,
"status": sub.status,
"source": sub.source,
"needs_checkout": needs_checkout(obj),
}
class SelfServeRegistrationSerializer(serializers.Serializer):
"""Minimal payload for public self-serve sign-up (gated by settings)."""
email = serializers.EmailField(required=True)
password = serializers.CharField(min_length=8, write_only=True)
first_name = serializers.CharField(
required=False, allow_blank=True, max_length=150, default=""
)
last_name = serializers.CharField(
required=False, allow_blank=True, max_length=150, default=""
)
company_name = serializers.CharField(
required=False, allow_blank=True, max_length=256, default=""
)
def validate_email(self, value: str) -> str:
email = value.strip().lower()
if CustomUser.objects.filter(email__iexact=email).exists():
raise serializers.ValidationError("A user with this email already exists.")
if CustomUser.objects.filter(username__iexact=email).exists():
raise serializers.ValidationError("A user with this email already exists.")
return email
def create(self, validated_data):
from finance.services.plans import try_redeem_backer_email
email = validated_data["email"]
password = validated_data["password"]
first_name = (validated_data.get("first_name") or "").strip()
last_name = (validated_data.get("last_name") or "").strip()
company_name = (validated_data.get("company_name") or "").strip()
if not company_name:
company_name = f"{email}'s workspace"
company = Company.objects.create(
name=company_name,
state="NA",
zipcode="00000",
address="N/A",
)
user = CustomUser.objects.create_user(
username=email,
email=email,
password=password,
first_name=first_name,
last_name=last_name,
company=company,
is_company_manager=True,
)
try_redeem_backer_email(user)
return user
def _conversation_token_totals(conversation_id: int):
"""
Sum PromptMetric tokens for a conversation.
Returns nulls when the provider never reported usage (never fabricate 0).
"""
agg = PromptMetric.objects.filter(conversation_id=conversation_id).aggregate(
tin=Sum("tokens_in"),
tout=Sum("tokens_out"),
with_in=Count("id", filter=Q(tokens_in__isnull=False)),
with_out=Count("id", filter=Q(tokens_out__isnull=False)),
)
return (
agg["tin"] if agg["with_in"] else None,
agg["tout"] if agg["with_out"] else None,
)
def _prompt_token_pair(prompt_id: int):
metric = (
PromptMetric.objects.filter(prompt_id=prompt_id)
.order_by("-created")
.only("tokens_in", "tokens_out")
.first()
)
if metric is None:
return None, None
return metric.tokens_in, metric.tokens_out
class ConversationSerializer(serializers.ModelSerializer):
tokens_in = serializers.SerializerMethodField()
tokens_out = serializers.SerializerMethodField()
class Meta:
model = Conversation
fields = (
"title",
"created",
"last_modified",
"id",
"tokens_in",
"tokens_out",
)
def _token_pair(self, obj):
cache = self.context.setdefault("_conversation_token_cache", {})
if obj.id not in cache:
cache[obj.id] = _conversation_token_totals(obj.id)
return cache[obj.id]
def get_tokens_in(self, obj):
tin, _ = self._token_pair(obj)
return tin
def get_tokens_out(self, obj):
_, tout = self._token_pair(obj)
return tout
class PromptSerializer(serializers.ModelSerializer):
tokens_in = serializers.SerializerMethodField()
tokens_out = serializers.SerializerMethodField()
class Meta:
model = Prompt
fields = (
"message",
"user_created",
"created",
"id",
"tokens_in",
"tokens_out",
)
def _token_pair(self, obj):
cache = self.context.setdefault("_prompt_token_cache", {})
if obj.id not in cache:
cache[obj.id] = _prompt_token_pair(obj.id)
return cache[obj.id]
def get_tokens_in(self, obj):
tin, _ = self._token_pair(obj)
return tin
def get_tokens_out(self, obj):
_, tout = self._token_pair(obj)
return tout
def validate_message(self, value: str) -> str:
if value is None or not str(value).strip():
raise serializers.ValidationError("Message text cannot be empty.")
return str(value).strip()
class BasicUserSerializer(serializers.ModelSerializer):
class Meta:
model = CustomUser
fields = (
"email",
"first_name",
"last_name",
"is_active",
"has_usable_password",
"is_company_manager",
"has_signed_tos",
)
# document serializers
class DocumentWorkspaceSerializer(serializers.ModelSerializer):
class Meta:
model = DocumentWorkspace
fields = ["id", "name", "created"]
read_only_fields = ["id", "created"]
class DocumentSerializer(serializers.ModelSerializer):
class Meta:
model = Document
fields = [
"id",
"workspace",
"file",
"uploaded_at",
"processed",
"created",
"active",
]
read_only_fields = ["id", "uploaded_at", "processed", "created"]