feat(api): add /api/v2/user-reports/ endpoint for superusers DEV-232 DEV-899

kobo/apps/audit_log/views.py

@@ -49,7 +49,7 @@
 
 
 @extend_schema(
-    tags=['Audit logs (superusers)'],
+    tags=['Server logs (superusers)'],
 )
 @extend_schema_view(
     list=extend_schema(
@@ -94,7 +94,7 @@ class AuditLogViewSet(mixins.ListModelMixin, viewsets.GenericViewSet):
 
 @extend_schema_view(
     list=extend_schema(
-        tags=['Audit logs (superusers)'],
+        tags=['Server logs (superusers)'],
         description=read_md('audit_log', 'access_logs/list'),
         responses=open_api_200_ok_response(
             AccessLogResponse,
@@ -157,7 +157,7 @@ class AccessLogViewSet(AuditLogViewSet):
             require_auth=False,
             validate_payload=False,
         ),
-        tags=['Audit logs (superusers)'],
+        tags=['Server logs (superusers)'],
     )
 )
 class AllProjectHistoryLogViewSet(AuditLogViewSet):
@@ -188,7 +188,7 @@ class AllProjectHistoryLogViewSet(AuditLogViewSet):
             require_auth=False,
             validate_payload=False,
         ),
-        tags=['Audit logs (superusers)'],
+        tags=['Server logs (superusers)'],
     )
     @extend_schema(
         methods=['POST'],
@@ -201,7 +201,7 @@ class AllProjectHistoryLogViewSet(AuditLogViewSet):
             require_auth=False,
             validate_payload=False,
         ),
-        tags=['Audit logs (superusers)'],
+        tags=['Server logs (superusers)'],
     )
     @action(detail=False, methods=['GET', 'POST'])
     def export(self, request, *args, **kwargs):
@@ -469,7 +469,7 @@ def list(self, request, *args, **kwargs):
 
 
 @extend_schema(
-    tags=['Audit logs (superusers)'],
+    tags=['Server logs (superusers)'],
 )
 @extend_schema_view(
     list=extend_schema(

kobo/apps/stripe/utils/billing_dates.py

@@ -3,24 +3,42 @@
 from zoneinfo import ZoneInfo
 
 from dateutil.relativedelta import relativedelta
+from django.conf import settings
 from django.db.models import F, Max, Q, Window
 from django.utils import timezone
 
 from kobo.apps.organizations.models import Organization
 from kobo.apps.organizations.types import BillingDates
 from kobo.apps.stripe.constants import ACTIVE_STRIPE_STATUSES
 from kobo.apps.stripe.utils.import_management import requires_stripe
+from kobo.apps.user_reports.typing_aliases import OrganizationIterator
 
 
-@requires_stripe
 def get_current_billing_period_dates_by_org(
-    orgs: list[Organization] = None, **kwargs
+    orgs: OrganizationIterator = None, **kwargs
 ) -> dict[str, BillingDates]:
 
     now = timezone.now().replace(tzinfo=ZoneInfo('UTC'))
     first_of_this_month = datetime(now.year, now.month, 1, tzinfo=ZoneInfo('UTC'))
     first_of_next_month = first_of_this_month + relativedelta(months=1)
 
+    if not settings.STRIPE_ENABLED:
+        results = {}
+        if orgs is not None:
+            for org in orgs:
+                results[org.id] = {
+                    'start': first_of_this_month,
+                    'end': first_of_next_month
+                }
+            return results
+
+        for org in Organization.objects.all():
+            results[org.id] = {
+                'start': first_of_this_month,
+                'end': first_of_next_month
+            }
+        return results
+
     # check 1: look for active subscriptions
     all_active_billing_dates = get_current_billing_period_dates_for_active_plans(orgs)
 

kobo/apps/user_reports/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class UserReportsConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'kobo.apps.user_reports'

kobo/apps/user_reports/migrations/0001_initial.py

@@ -0,0 +1,212 @@
+from django.db import migrations, models
+from django.db.models import Q
+
+import kpi.models.abstract_models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name='BillingAndUsageSnapshotRun',
+            fields=[
+                (
+                    'id',
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name='ID'
+                    )
+                ),
+                ('uid', kpi.fields.kpi_uid.KpiUidField(_null=False, uid_prefix='busr')),
+                (
+                    'status',
+                    models.CharField(
+                        choices=[
+                            ('in_progress', 'In Progress'),
+                            ('completed', 'Completed'),
+                            ('aborted', 'Aborted')
+                        ],
+                        default='in_progress',
+                        max_length=32
+                    )
+                ),
+                ('last_processed_org_id', models.CharField(blank=True, null=True)),
+                ('details', models.JSONField(blank=True, null=True)),
+                ('singleton', models.BooleanField(default=True, editable=False)),
+                (
+                    'date_created',
+                    models.DateTimeField(
+                        default=kpi.models.abstract_models._get_default_datetime
+                    ),
+                ),
+                (
+                    'date_modified',
+                    models.DateTimeField(
+                        default=kpi.models.abstract_models._get_default_datetime
+                    ),
+                ),
+            ],
+            options={
+                'ordering': ['-date_created'],
+            },
+        ),
+        migrations.CreateModel(
+            name='BillingAndUsageSnapshot',
+            fields=[
+                (
+                    'id',
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name='ID'
+                    )
+                ),
+                (
+                    'effective_user_id',
+                    models.IntegerField(blank=True, null=True, db_index=True)
+                ),
+                (
+                    'last_snapshot_run',
+                    models.ForeignKey(
+                        on_delete=models.deletion.CASCADE,
+                        related_name='snapshots',
+                        to='user_reports.billingandusagesnapshotrun',
+                    ),
+                ),
+                (
+                    'organization',
+                    models.OneToOneField(
+                        on_delete=models.deletion.CASCADE,
+                        to='organizations.organization',
+                    ),
+                ),
+                ('total_storage_bytes', models.BigIntegerField(default=0)),
+                ('total_submission_count_all_time', models.BigIntegerField(default=0)),
+                (
+                    'total_submission_count_current_period',
+                    models.BigIntegerField(default=0)
+                ),
+                ('billing_period_start', models.DateTimeField(blank=True, null=True)),
+                ('billing_period_end', models.DateTimeField(blank=True, null=True)),
+                (
+                    'date_created',
+                    models.DateTimeField(
+                        default=kpi.models.abstract_models._get_default_datetime
+                    ),
+                ),
+                (
+                    'date_modified',
+                    models.DateTimeField(
+                        default=kpi.models.abstract_models._get_default_datetime
+                    ),
+                ),
+                ('submission_limit', models.BigIntegerField(blank=True, null=True)),
+                ('storage_bytes_limit', models.BigIntegerField(blank=True, null=True)),
+                ('asr_seconds_limit', models.BigIntegerField(blank=True, null=True)),
+                ('mt_characters_limit', models.BigIntegerField(blank=True, null=True)),
+            ],
+        ),
+        migrations.AddIndex(
+            model_name='billingandusagesnapshot',
+            index=models.Index(fields=['effective_user_id'], name='idx_bau_user'),
+        ),
+        migrations.AddIndex(
+            model_name='billingandusagesnapshot',
+            index=models.Index(fields=['date_created'], name='idx_bau_created'),
+        ),
+        # Add index for runs
+        migrations.AddIndex(
+            model_name='billingandusagesnapshotrun',
+            index=models.Index(
+                fields=['status', 'date_modified'],
+                name='idx_bau_run_status_expires'
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name='billingandusagesnapshotrun',
+            constraint=models.UniqueConstraint(
+                fields=('singleton',),
+                condition=Q(status='in_progress'),
+                name='uniq_run_in_progress'
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name='billingandusagesnapshot',
+            constraint=models.UniqueConstraint(
+                fields=('organization',),
+                name='uniq_snapshot_per_org'
+            ),
+        ),
+        # Register the materialized-view model state (unmanaged) so Django knows
+        # the model exists for ORM queries, but doesn't try to create a migration
+        # file for it. The actual materialized view is created by the subsequent
+        # migration `0002_create_user_reports_mv.py`.
+        migrations.SeparateDatabaseAndState(
+            database_operations=[],
+            state_operations=[
+                migrations.CreateModel(
+                    name='UserReports',
+                    fields=[
+                        (
+                            'id',
+                            models.BigIntegerField(primary_key=True, serialize=False)
+                        ),
+                        (
+                            'extra_details_uid',
+                            models.CharField(max_length=255, null=True, blank=True)
+                        ),
+                        ('username', models.CharField(max_length=150)),
+                        ('first_name', models.CharField(max_length=150)),
+                        ('last_name', models.CharField(max_length=150)),
+                        ('email', models.CharField(max_length=254)),
+                        ('is_superuser', models.BooleanField()),
+                        ('is_staff', models.BooleanField()),
+                        ('is_active', models.BooleanField()),
+                        ('date_joined', models.CharField(max_length=64)),
+                        (
+                            'last_login',
+                            models.CharField(max_length=64, null=True, blank=True)
+                        ),
+                        ('validated_email', models.BooleanField()),
+                        ('validated_password', models.BooleanField()),
+                        ('mfa_is_active', models.BooleanField()),
+                        ('sso_is_active', models.BooleanField()),
+                        ('accepted_tos', models.BooleanField()),
+                        ('social_accounts', models.JSONField(null=True, blank=True)),
+                        ('organizations', models.JSONField(null=True, blank=True)),
+                        ('metadata', models.JSONField(null=True, blank=True)),
+                        ('subscriptions', models.JSONField(null=True, blank=True)),
+                        ('asset_count', models.IntegerField(default=0)),
+                        ('deployed_asset_count', models.IntegerField(default=0)),
+                        (
+                            'current_period_start',
+                            models.DateTimeField(null=True, blank=True)
+                        ),
+                        (
+                            'current_period_end',
+                            models.DateTimeField(null=True, blank=True)
+                        ),
+                        (
+                            'organization_id',
+                            models.IntegerField(null=True, blank=True)
+                        ),
+                        (
+                            'service_usage',
+                            models.JSONField(null=True, blank=True),
+                        ),
+                    ],
+                    options={
+                        'managed': False,
+                        'db_table': 'user_reports_userreportsmv',
+                    },
+                ),
+            ],
+        ),
+    ]