Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

fix(devex): page the remaining lists and log endpoints with the shared kit (#126462)

Julian Bezc13a0e77931b
diff --git a/frontend/src/generated/core/api.schemas.ts b/frontend/src/generated/core/api.schemas.ts
index dec5ed9247be..55427278f789 100644
--- a/frontend/src/generated/core/api.schemas.ts
+++ b/frontend/src/generated/core/api.schemas.ts
@@ -6983,6 +6983,7 @@ export type FileSystemListParams = {
include_tags?: boolean
/**
* Number of results to return per page.
+ * @maximum 1000
*/
limit?: number
/**
diff --git a/posthog/api/file_system/file_system.py b/posthog/api/file_system/file_system.py
index 23f2aff21c57..4d537fbdcc39 100644
--- a/posthog/api/file_system/file_system.py
+++ b/posthog/api/file_system/file_system.py
@@ -28,7 +28,7 @@ from django.db.models.functions import Concat, Lower
from django.utils import timezone
from drf_spectacular.utils import OpenApiResponse, extend_schema
-from rest_framework import filters, pagination, serializers, status, viewsets
+from rest_framework import filters, serializers, status, viewsets
from rest_framework.exceptions import PermissionDenied
from rest_framework.request import Request
from rest_framework.response import Response
@@ -50,6 +50,7 @@ from posthog.api.file_system.file_system_logging import log_api_file_system_view
from posthog.api.file_system.ranked_search import FileRef, FileSystemRankedSearch, search_session
from posthog.api.file_system.visibility import apply_file_system_visibility_filters
from posthog.api.mixins import validated_request
+from posthog.api.pagination import FacadeLimitOffsetPagination, facade_page_response
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.api.shared import UserBasicSerializer
from posthog.api.utils import action
@@ -78,6 +79,7 @@ from posthog.models.tagged_item import TaggedItem
from posthog.models.tagged_item_registry import object_column_for
from posthog.models.team import Team
from posthog.models.user import User
+from posthog.paging import Page, PageRequest
from posthog.settings import EE_AVAILABLE
from posthog.utils import str_to_bool
@@ -236,7 +238,7 @@ class FileSystemSerializer(FileSystemAccessLevelSerializerMixin, serializers.Mod
return file_system
-class FileSystemsLimitOffsetPagination(pagination.LimitOffsetPagination):
+class FileSystemsLimitOffsetPagination(FacadeLimitOffsetPagination):
default_limit = 100
@@ -816,21 +818,29 @@ class FileSystemViewSet(TeamAndOrgViewSetMixin, viewsets.ModelViewSet):
def _list_typed_by_views(self, request: Request, *, descending: bool) -> Response:
queryset = self.filter_queryset(self.get_queryset()).order_by()
- paginator = cast(FileSystemsLimitOffsetPagination, self.paginator)
- paginator.request = request
- paginator.limit = paginator.get_limit(request)
- paginator.offset = paginator.get_offset(request)
- paginator.count = queryset.count()
- if paginator.offset >= paginator.count:
- response = paginator.get_paginated_response([])
- response.data["users"] = []
- return response
- limit = paginator.limit or paginator.default_limit
-
views = FileSystemViewLog.objects.filter(
team_id__in=Team.objects.filter(project_id=self.team.project_id).values("id"),
user_id=cast(User, request.user).id,
)
+
+ def fetch(page: PageRequest) -> Page[FileSystem]:
+ count = queryset.count()
+ if page.offset >= count:
+ return Page(results=[], count=count)
+ return Page(results=self._typed_page_by_views(queryset, views, page, descending=descending), count=count)
+
+ response = facade_page_response(self, fetch)
+ response.data["users"] = self._created_by_users(response.data["results"])
+ return response
+
+ def _typed_page_by_views(
+ self,
+ queryset: QuerySet[FileSystem],
+ views: QuerySet[FileSystemViewLog],
+ page: PageRequest,
+ *,
+ descending: bool,
+ ) -> builtins.list[FileSystem]:
files_sql, files_params = queryset.values("id", "team_id", "type", "ref", "created_at").query.sql_with_params()
views_sql, views_params = views.order_by().values("team_id", "type", "ref", "viewed_at").query.sql_with_params()
direction = "DESC" if descending else "ASC"
@@ -849,24 +859,21 @@ class FileSystemViewSet(TeamAndOrgViewSetMixin, viewsets.ModelViewSet):
LIMIT %s OFFSET %s
"""
with connection.cursor() as cursor:
- cursor.execute(page_sql, [*views_params, *files_params, limit, paginator.offset])
+ cursor.execute(page_sql, [*views_params, *files_params, page.limit, page.offset])
page_ids = [row[0] for row in cursor.fetchall()]
- if len(page_ids) < limit:
+ if len(page_ids) < page.limit:
own_view = views.filter(team_id=OuterRef("team_id"), type=OuterRef("type"), ref=OuterRef("ref"))
unseen_offset = 0
- if not page_ids and paginator.offset:
+ if not page_ids and page.offset:
viewed_count = queryset.filter(Exists(own_view)).count()
- unseen_offset = max(0, paginator.offset - viewed_count)
+ unseen_offset = max(0, page.offset - viewed_count)
page_ids.extend(
queryset.filter(~Exists(own_view))
.order_by("-created_at", "id")
- .values_list("id", flat=True)[unseen_offset : unseen_offset + limit - len(page_ids)]
+ .values_list("id", flat=True)[unseen_offset : unseen_offset + page.limit - len(page_ids)]
)
rows = {row.id: row for row in queryset.filter(id__in=page_ids)}
- results = self.get_serializer([rows[row_id] for row_id in page_ids if row_id in rows], many=True).data
- response = paginator.get_paginated_response(results)
- response.data["users"] = self._created_by_users(results)
- return response
+ return [rows[row_id] for row_id in page_ids if row_id in rows]
@extend_schema(parameters=[FileSystemListQuerySerializer])
def list(self, request: Request, *args: Any, **kwargs: Any) -> Response:
diff --git a/posthog/session_recordings/session_recording_playlist_api.py b/posthog/session_recordings/session_recording_playlist_api.py
index f70cdec6c556..5b87e84e57af 100644
--- a/posthog/session_recordings/session_recording_playlist_api.py
+++ b/posthog/session_recordings/session_recording_playlist_api.py
@@ -19,13 +19,13 @@ from drf_spectacular.utils import OpenApiParameter
from opentelemetry import trace
from rest_framework import request, response, serializers, viewsets
from rest_framework.exceptions import ValidationError
-from rest_framework.pagination import LimitOffsetPagination
from posthog.schema import RecordingsQuery
from posthog.api.documentation import extend_schema
from posthog.api.file_system.file_system_logging import log_api_file_system_view
from posthog.api.forbid_destroy_model import ForbidDestroyModel
+from posthog.api.pagination import FacadeLimitOffsetPagination, facade_page_response
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.api.shared import UserBasicSerializer
from posthog.api.utils import action
@@ -36,6 +36,7 @@ from posthog.models import SessionRecording, SessionRecordingPlaylist, SessionRe
from posthog.models.activity_logging.activity_log import Change, Detail, changes_between, log_activity
from posthog.models.team.team import Team
from posthog.models.utils import UUIDT
+from posthog.paging import Page, PageRequest
from posthog.rate_limit import ClickHouseBurstRateThrottle, ClickHouseSustainedRateThrottle
from posthog.redis import get_client
from posthog.session_recordings.data_retention import retention_period_in_days
@@ -84,13 +85,7 @@ class PlaylistPageSplit:
db_items: builtins.list[SessionRecordingPlaylist]
-@dataclass(frozen=True)
-class PaginationLinks:
- next_link: Optional[str]
- previous_link: Optional[str]
-
-
-class SessionRecordingPlaylistPagination(LimitOffsetPagination):
+class SessionRecordingPlaylistPagination(FacadeLimitOffsetPagination):
default_limit = 100
max_limit = PLAYLIST_LIST_MAX_LIMIT
@@ -758,65 +753,50 @@ class SessionRecordingPlaylistViewSet(
sorted_synthetics = self._order_playlists(request, filtered_synthetics)
synth_count = len(sorted_synthetics)
- total_count = db_count + synth_count
-
- paging = SessionRecordingPlaylistListQuerySerializer(data=request.GET)
- paging.is_valid(raise_exception=True)
- # A limit of 0 makes the next link point back at the same offset (infinite paging), so it means
- # the default, as in DRF's LimitOffsetPagination.
- requested_limit: int = paging.validated_data["limit"] or SessionRecordingPlaylistPagination.default_limit
- limit = min(requested_limit, PLAYLIST_LIST_MAX_LIMIT)
- offset: int = paging.validated_data["offset"]
-
+ # Bad paging input answers 400 rather than a silent fall back to the first page.
+ SessionRecordingPlaylistListQuerySerializer(data=request.GET).is_valid(raise_exception=True)
span.set_attribute("team_id", self.team.id)
span.set_attribute("db_count", db_count)
span.set_attribute("synth_count", synth_count)
- span.set_attribute("limit", limit)
- span.set_attribute("offset", offset)
-
- # Pair each synthetic with its global rank at the source so the two never
- # drift, then split the requested window into in-page synthetics + DB slice.
- with tracer.start_as_current_span("rank_synthetics"):
- synth_ranks = self._synthetic_global_ranks(request, queryset, db_count, sorted_synthetics)
- ranked_synthetics = list(zip(synth_ranks, sorted_synthetics))
-
- with tracer.start_as_current_span("split_page"):
- page_split = self._split_page(offset, limit, ranked_synthetics, queryset)
-
- with tracer.start_as_current_span("order_combined_page"):
- combined = self._order_playlists(request, page_split.synthetics + page_split.db_items)
- span.set_attribute("page_size", len(combined))
-
- # Batch-fetch recording counts for the page to avoid the per-playlist
- # N+1 queries performed by SessionRecordingPlaylistSerializer.get_recordings_counts.
- # On failure we log and attach empty prefetched attrs so the serializer
- # short-circuits to default empty counts instead of retrying per-playlist
- # (which amplifies load during a Redis/DB partial outage).
- with tracer.start_as_current_span("precompute_recordings_counts"):
- try:
- precompute_recordings_counts(combined, cast(User, request.user), self.team)
- except Exception as e:
- logger.exception(
- "playlist_recordings_counts_precompute_failed",
- team_id=self.team.id,
- page_size=len(combined),
- )
- posthoganalytics.capture_exception(e)
- _attach_empty_recordings_counts(combined)
-
- with tracer.start_as_current_span("serialize"):
- results = self.get_serializer(combined, many=True).data
-
- links = self._pagination_links(request, total_count, limit, offset)
- return response.Response(
- {
- "count": total_count,
- "next": links.next_link,
- "previous": links.previous_link,
- "results": results,
- }
- )
+ def fetch(page: PageRequest) -> Page[SessionRecordingPlaylist]:
+ span.set_attribute("limit", page.limit)
+ span.set_attribute("offset", page.offset)
+
+ # Pair each synthetic with its global rank at the source so the two never
+ # drift, then split the requested window into in-page synthetics + DB slice.
+ with tracer.start_as_current_span("rank_synthetics"):
+ synth_ranks = self._synthetic_global_ranks(request, queryset, db_count, sorted_synthetics)
+ ranked_synthetics = list(zip(synth_ranks, sorted_synthetics))
+
+ with tracer.start_as_current_span("split_page"):
+ page_split = self._split_page(page.offset, page.limit, ranked_synthetics, queryset)
+
+ with tracer.start_as_current_span("order_combined_page"):
+ combined = self._order_playlists(request, page_split.synthetics + page_split.db_items)
+
+ span.set_attribute("page_size", len(combined))
+
+ # Batch-fetch recording counts for the page to avoid the per-playlist
+ # N+1 queries performed by SessionRecordingPlaylistSerializer.get_recordings_counts.
+ # On failure we log and attach empty prefetched attrs so the serializer
+ # short-circuits to default empty counts instead of retrying per-playlist
+ # (which amplifies load during a Redis/DB partial outage).
+ with tracer.start_as_current_span("precompute_recordings_counts"):
+ try:
+ precompute_recordings_counts(combined, cast(User, request.user), self.team)
+ except Exception as e:
+ logger.exception(
+ "playlist_recordings_counts_precompute_failed",
+ team_id=self.team.id,
+ page_size=len(combined),
+ )
+ posthoganalytics.capture_exception(e)
+ _attach_empty_recordings_counts(combined)
+
+ return Page(results=combined, count=db_count + synth_count)
+
+ return facade_page_response(self, fetch)
def _split_page(
self,
@@ -840,17 +820,6 @@ class SessionRecordingPlaylistViewSet(
db_items = list(queryset[db_offset : db_offset + db_take]) if db_take > 0 else []
return PlaylistPageSplit(synthetics=synth_for_page, db_items=db_items)
- def _pagination_links(
- self, request: request.Request, total_count: int, limit: int, offset: int
- ) -> "PaginationLinks":
- """next/previous links over the merged total via a directly-seeded paginator."""
- paginator = SessionRecordingPlaylistPagination()
- paginator.count = total_count
- paginator.limit = limit
- paginator.offset = offset
- paginator.request = request
- return PaginationLinks(next_link=paginator.get_next_link(), previous_link=paginator.get_previous_link())
-
def _synthetic_global_ranks(
self,
request: request.Request,
diff --git a/posthog/test/test_plugin_log_entry.py b/posthog/test/test_plugin_log_entry.py
index b80b63218c92..f517b6145f2b 100644
--- a/posthog/test/test_plugin_log_entry.py
+++ b/posthog/test/test_plugin_log_entry.py
@@ -12,6 +12,7 @@ from products.cdp.backend.models.plugin import (
PluginConfig,
PluginLogEntrySource,
PluginLogEntryType,
+ PluginLogFilters,
fetch_plugin_log_entries,
)
@@ -62,9 +63,11 @@ class TestPluginLogEntry(BaseTest):
)
results = fetch_plugin_log_entries(
- plugin_config_id=some_plugin_config.pk,
- after=datetime.datetime.min,
- before=timezone.now() + datetime.timedelta(seconds=5),
+ PluginLogFilters(
+ plugin_config_id=some_plugin_config.pk,
+ after=datetime.datetime.min,
+ before=timezone.now() + datetime.timedelta(seconds=5),
+ )
)
self.assertEqual(len(results), 1)
@@ -95,7 +98,7 @@ class TestPluginLogEntry(BaseTest):
instance_id=plugin_server_instance_id,
)
- results = fetch_plugin_log_entries(plugin_config_id=some_plugin_config.pk, search="somethinG")
+ results = fetch_plugin_log_entries(PluginLogFilters(plugin_config_id=some_plugin_config.pk, search="somethinG"))
self.assertEqual(len(results), 1)
self.assertEqual(results[0].message, "Something happened!")
@@ -135,8 +138,10 @@ class TestPluginLogEntry(BaseTest):
)
results = fetch_plugin_log_entries(
- plugin_config_id=some_plugin_config.pk,
- type_filter=[PluginLogEntryType.ERROR, PluginLogEntryType.DEBUG],
+ PluginLogFilters(
+ plugin_config_id=some_plugin_config.pk,
+ type_filter=(PluginLogEntryType.ERROR, PluginLogEntryType.DEBUG),
+ )
)
self.assertEqual(len(results), 2)
@@ -168,7 +173,7 @@ class TestPluginLogEntry(BaseTest):
instance_id=plugin_server_instance_id,
)
- results = fetch_plugin_log_entries(plugin_config_id=some_plugin_config.pk, limit=1)
+ results = fetch_plugin_log_entries(PluginLogFilters(plugin_config_id=some_plugin_config.pk), limit=1)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].message, "Random error")
diff --git a/products/cdp/backend/api/plugin_log_entry.py b/products/cdp/backend/api/plugin_log_entry.py
index eda859bc6e7c..abbfc035182d 100644
--- a/products/cdp/backend/api/plugin_log_entry.py
+++ b/products/cdp/backend/api/plugin_log_entry.py
@@ -1,14 +1,23 @@
-from datetime import datetime
-from typing import Optional
+from typing import Any
-from rest_framework import exceptions, viewsets
+from drf_spectacular.utils import extend_schema
+from rest_framework import serializers, viewsets
+from rest_framework.request import Request
from rest_framework.response import Response
from rest_framework_dataclasses.serializers import DataclassSerializer
+from posthog.api.pagination import FacadeLimitOffsetPagination, facade_page_response
from posthog.api.routing import TeamAndOrgViewSetMixin
+from posthog.paging import Page, PageRequest
from products.cdp.backend.api.plugin import PluginsAccessLevelPermission
-from products.cdp.backend.models.plugin import PluginLogEntry, PluginLogEntryType, fetch_plugin_log_entries
+from products.cdp.backend.models.plugin import (
+ PluginLogEntry,
+ PluginLogEntryType,
+ PluginLogFilters,
+ count_plugin_log_entries,
+ fetch_plugin_log_entries,
+)
class PluginLogEntrySerializer(DataclassSerializer):
@@ -16,47 +25,60 @@ class PluginLogEntrySerializer(DataclassSerializer):
dataclass = PluginLogEntry
+class PluginLogEntryPagination(FacadeLimitOffsetPagination):
+ # `PluginLogEntryRequestSerializer.limit` uses these bounds, so it rejects a limit the paginator would cut.
+ default_limit = 100
+
+
+class PluginLogEntryRequestSerializer(serializers.Serializer):
+ limit = serializers.IntegerField(
+ required=False,
+ min_value=1,
+ max_value=PluginLogEntryPagination.max_limit,
+ help_text=(
+ "Maximum number of log entries to return "
+ f"(1-{PluginLogEntryPagination.max_limit}, default {PluginLogEntryPagination.default_limit})."
+ ),
+ )
+ after = serializers.DateTimeField(required=False, help_text="Only return entries after this ISO 8601 timestamp.")
+ before = serializers.DateTimeField(required=False, help_text="Only return entries before this ISO 8601 timestamp.")
+ search = serializers.CharField(
+ required=False, allow_blank=True, help_text="Case-insensitive substring search across log messages."
+ )
+ type_filter = serializers.ListField(
+ child=serializers.ChoiceField(choices=PluginLogEntryType.choices),
+ required=False,
+ help_text="Log types to include. Repeat the parameter to include more than one type.",
+ )
+
+
class PluginLogEntryViewSet(TeamAndOrgViewSetMixin, viewsets.GenericViewSet):
scope_object = "plugin"
serializer_class = PluginLogEntrySerializer
permission_classes = [PluginsAccessLevelPermission]
+ pagination_class = PluginLogEntryPagination
+
+ @extend_schema(parameters=[PluginLogEntryRequestSerializer])
+ def list(self, request: Request, *args: Any, **kwargs: Any) -> Response:
+ param_serializer = PluginLogEntryRequestSerializer(data=request.query_params)
+ param_serializer.is_valid(raise_exception=True)
+ params = param_serializer.validated_data
- def list(self, request, *args, **kwargs):
- limit_raw = request.GET.get("limit")
- limit: Optional[int]
- if limit_raw:
- try:
- limit = int(limit_raw)
- except ValueError:
- raise exceptions.ValidationError("Query param limit must be omitted or an integer!")
- else:
- limit = None
-
- after_raw: Optional[str] = request.GET.get("after")
- after: Optional[datetime] = None
- if after_raw is not None:
- after = datetime.fromisoformat(after_raw.replace("Z", "+00:00"))
-
- before_raw: Optional[str] = request.GET.get("before")
- before: Optional[datetime] = None
- if before_raw is not None:
- before = datetime.fromisoformat(before_raw.replace("Z", "+00:00"))
-
- type_filter = [PluginLogEntryType[t] for t in (request.GET.getlist("type_filter", []))]
- data = fetch_plugin_log_entries(
+ filters = PluginLogFilters(
team_id=self.team_id,
plugin_config_id=self.parents_query_dict["plugin_config_id"],
- after=after,
- before=before,
- search=request.GET.get("search"),
- limit=limit,
- type_filter=type_filter,
+ after=params.get("after"),
+ before=params.get("before"),
+ search=params.get("search"),
+ type_filter=tuple(PluginLogEntryType[name] for name in params.get("type_filter", [])),
)
- page = self.paginate_queryset(data)
- if page is not None:
- serializer = self.get_serializer(page, many=True)
- return self.get_paginated_response(serializer.data)
+ def fetch(page: PageRequest) -> Page[PluginLogEntry]:
+ rows = fetch_plugin_log_entries(filters, limit=page.limit, offset=page.offset)
+ # A short page is the last page, so it gives the total without a second scan. An empty page
+ # past the first one gives no total, because the offset can be past the end.
+ if len(rows) < page.limit and (rows or page.offset == 0):
+ return Page(results=rows, count=page.offset + len(rows))
+ return Page(results=rows, count=count_plugin_log_entries(filters))
- serializer = self.get_serializer(data, many=True)
- return Response(serializer.data)
+ return facade_page_response(self, fetch)
diff --git a/products/cdp/backend/api/test/test_plugin.py b/products/cdp/backend/api/test/test_plugin.py
index ba76584a9ebb..4b149e4bf980 100644
--- a/products/cdp/backend/api/test/test_plugin.py
+++ b/products/cdp/backend/api/test/test_plugin.py
@@ -20,15 +20,23 @@ from posthog.constants import FROZEN_POSTHOG_VERSION
from posthog.models.organization import Organization, OrganizationMembership
from posthog.models.team.team import Team
from posthog.models.user import User
+from posthog.models.utils import UUIDT
from posthog.plugins.access import can_configure_plugins, can_globally_manage_plugins, can_install_plugins
from posthog.plugins.test.mock import mocked_plugin_github_request, mocked_plugin_requests_get
from posthog.plugins.test.plugin_archives import HELLO_WORLD_PLUGIN_GITHUB_ATTACHMENT_ZIP, HELLO_WORLD_PLUGIN_GITHUB_ZIP
+from posthog.test.test_plugin_log_entry import create_plugin_log_entry
from products.cdp.backend.api.plugin import SECRET_FIELD_VALUE
from products.cdp.backend.api.test.test_hog_function_templates import MOCK_NODE_TEMPLATES
from products.cdp.backend.filters import RUNTIME_CONTRACT
from products.cdp.backend.models.hog_functions.hog_function import HogFunction
-from products.cdp.backend.models.plugin import Plugin, PluginConfig, PluginSourceFile
+from products.cdp.backend.models.plugin import (
+ Plugin,
+ PluginConfig,
+ PluginLogEntrySource,
+ PluginLogEntryType,
+ PluginSourceFile,
+)
from products.cdp.backend.templates.helpers import mock_transpile
from products.cdp.backend.templates.hog_function_template import sync_template_to_db
@@ -1061,6 +1069,46 @@ class TestPluginAPI(APIBaseTest, QueryMatchingTest):
self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), {"count": 0, "next": None, "previous": None, "results": []})
+ def test_retrieving_plugin_config_logs_second_page(self, mock_get, mock_reload):
+ plugin = Plugin.objects.create(organization=self.organization)
+ plugin_config = PluginConfig.objects.create(plugin=plugin, enabled=True, team=self.team, order=0)
+ for index in range(3):
+ create_plugin_log_entry(
+ team_id=self.team.pk,
+ plugin_id=plugin.pk,
+ plugin_config_id=plugin_config.pk,
+ source=PluginLogEntrySource.CONSOLE,
+ type=PluginLogEntryType.INFO,
+ message=f"entry {index}",
+ instance_id=str(UUIDT()),
+ )
+ url = f"/api/environments/{self.team.pk}/plugin_configs/{plugin_config.id}/logs/"
+
+ first_page = self.client.get(url, {"limit": "2", "search": ""}).json()
+ second_page = self.client.get(url, {"limit": 2, "offset": 2}).json()
+ past_the_end = self.client.get(url, {"limit": 2, "offset": 5}).json()
+
+ self.assertEqual(first_page["count"], 3)
+ self.assertEqual(second_page["count"], 3)
+ self.assertEqual(past_the_end["count"], 3)
+ self.assertEqual(past_the_end["results"], [])
+ self.assertEqual(len(second_page["results"]), 1)
+ messages = {entry["message"] for entry in first_page["results"] + second_page["results"]}
+ self.assertEqual(messages, {"entry 0", "entry 1", "entry 2"})
+
+ @parameterized.expand(
+ [("after", "not-a-date"), ("before", "not-a-date"), ("type_filter", "NOT_A_TYPE"), ("limit", "5000")]
+ )
+ def test_retrieving_plugin_config_logs_rejects_bad_filter(self, mock_get, mock_reload, param, value):
+ plugin = Plugin.objects.create(organization=self.organization)
+ plugin_config = PluginConfig.objects.create(plugin=plugin, enabled=True, team=self.team, order=0)
+
+ response = self.client.get(
+ f"/api/environments/{self.team.pk}/plugin_configs/{plugin_config.id}/logs/", {param: value}
+ )
+
+ self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+
@time_machine.travel("2021-12-05T13:23:00Z", tick=False)
def test_plugin_config_list(self, mock_get, mock_reload):
plugin = Plugin.objects.create(organization=self.organization)
diff --git a/products/cdp/backend/models/plugin.py b/products/cdp/backend/models/plugin.py
index 62490d487899..68a5a26780cd 100644
--- a/products/cdp/backend/models/plugin.py
+++ b/products/cdp/backend/models/plugin.py
@@ -17,6 +17,8 @@ from semantic_version.base import SimpleSpec
from posthog.cloud_utils import is_cloud
from posthog.constants import FROZEN_POSTHOG_VERSION
+from posthog.dataclasses import frozen
+from posthog.enums import LabeledStrEnum
from posthog.models.organization import Organization
from posthog.models.signals import mutable_receiver
from posthog.models.team import Team
@@ -324,7 +326,7 @@ class PluginLogEntrySource(StrEnum):
CONSOLE = "CONSOLE"
-class PluginLogEntryType(StrEnum):
+class PluginLogEntryType(LabeledStrEnum):
DEBUG = "DEBUG"
LOG = "LOG"
INFO = "INFO"
@@ -507,45 +509,65 @@ class PluginLogEntry:
instance_id: UUID
-def fetch_plugin_log_entries(
- *,
- team_id: Optional[int] = None,
- plugin_config_id: Optional[int] = None,
- after: Optional[datetime.datetime] = None,
- before: Optional[datetime.datetime] = None,
- search: Optional[str] = None,
- limit: Optional[int] = None,
- type_filter: Optional[list[PluginLogEntryType]] = None,
-) -> list[PluginLogEntry]:
- if type_filter is None:
- type_filter = []
+@frozen
+class PluginLogFilters:
+ team_id: Optional[int] = None
+ plugin_config_id: Optional[int] = None
+ after: Optional[datetime.datetime] = None
+ before: Optional[datetime.datetime] = None
+ search: Optional[str] = None
+ type_filter: tuple[PluginLogEntryType, ...] = ()
+
+
+def _plugin_log_entries_conditions(filters: PluginLogFilters) -> tuple[str, dict[str, Any]]:
clickhouse_where_parts: list[str] = []
clickhouse_kwargs: dict[str, Any] = {}
- if team_id is not None:
+ if filters.team_id is not None:
clickhouse_where_parts.append("team_id = %(team_id)s")
- clickhouse_kwargs["team_id"] = team_id
- if plugin_config_id is not None:
+ clickhouse_kwargs["team_id"] = filters.team_id
+ if filters.plugin_config_id is not None:
clickhouse_where_parts.append("plugin_config_id = %(plugin_config_id)s")
- clickhouse_kwargs["plugin_config_id"] = plugin_config_id
- if after is not None:
+ clickhouse_kwargs["plugin_config_id"] = filters.plugin_config_id
+ if filters.after is not None:
clickhouse_where_parts.append("timestamp > toDateTime64(%(after)s, 6)")
- clickhouse_kwargs["after"] = after.isoformat().replace("+00:00", "")
- if before is not None:
+ clickhouse_kwargs["after"] = filters.after.isoformat().replace("+00:00", "")
+ if filters.before is not None:
clickhouse_where_parts.append("timestamp < toDateTime64(%(before)s, 6)")
- clickhouse_kwargs["before"] = before.isoformat().replace("+00:00", "")
- if search:
+ clickhouse_kwargs["before"] = filters.before.isoformat().replace("+00:00", "")
+ if filters.search:
clickhouse_where_parts.append("message ILIKE %(search)s")
- clickhouse_kwargs["search"] = f"%{search}%"
- if len(type_filter) > 0:
+ clickhouse_kwargs["search"] = f"%{filters.search}%"
+ if filters.type_filter:
clickhouse_where_parts.append("type in %(types)s")
- clickhouse_kwargs["types"] = type_filter
+ clickhouse_kwargs["types"] = list(filters.type_filter)
+ return " AND ".join(clickhouse_where_parts), clickhouse_kwargs
+
+
+def fetch_plugin_log_entries(
+ filters: PluginLogFilters, *, limit: Optional[int] = None, offset: int = 0
+) -> list[PluginLogEntry]:
+ where, clickhouse_kwargs = _plugin_log_entries_conditions(filters)
+ clickhouse_kwargs = {**clickhouse_kwargs, "offset": offset}
+ limit_clause = ""
+ if limit:
+ limit_clause = "LIMIT %(limit)s"
+ clickhouse_kwargs["limit"] = limit
+ # Entries can share a timestamp. The id gives them the same order in every query, so a page
+ # boundary between them cannot skip or repeat an entry.
clickhouse_query = f"""
SELECT id, team_id, plugin_id, plugin_config_id, timestamp, source, type, message, instance_id FROM plugin_log_entries
- WHERE {" AND ".join(clickhouse_where_parts)} ORDER BY timestamp DESC {f"LIMIT {limit}" if limit else ""}
+ WHERE {where} ORDER BY timestamp DESC, id {limit_clause} OFFSET %(offset)s
"""
return [PluginLogEntry(*result) for result in cast(list, sync_execute(clickhouse_query, clickhouse_kwargs))]
+def count_plugin_log_entries(filters: PluginLogFilters) -> int:
+ where, clickhouse_kwargs = _plugin_log_entries_conditions(filters)
+ clickhouse_query = f"SELECT count() FROM plugin_log_entries WHERE {where}"
+ rows = cast(list, sync_execute(clickhouse_query, clickhouse_kwargs))
+ return int(rows[0][0])
+
+
@receiver(models.signals.post_save, sender=Organization)
def preinstall_plugins_for_new_organization(sender, instance: Organization, created: bool, **kwargs):
if created and not is_cloud() and can_install_plugins(instance):
diff --git a/products/cdp/frontend/generated/api.schemas.ts b/products/cdp/frontend/generated/api.schemas.ts
index 623b47846c49..58935825f96e 100644
--- a/products/cdp/frontend/generated/api.schemas.ts
+++ b/products/cdp/frontend/generated/api.schemas.ts
@@ -802,11 +802,11 @@ export const PluginLogEntrySourceEnumApi = {
} as const
/**
- * * `DEBUG` - DEBUG
- * * `LOG` - LOG
- * * `INFO` - INFO
- * * `WARN` - WARN
- * * `ERROR` - ERROR
+ * * `DEBUG` - Debug
+ * * `LOG` - Log
+ * * `INFO` - Info
+ * * `WARN` - Warn
+ * * `ERROR` - Error
*/
export type PluginLogEntryTypeEnumApi = (typeof PluginLogEntryTypeEnumApi)[keyof typeof PluginLogEntryTypeEnumApi]
@@ -1056,15 +1056,51 @@ export type HogFunctionsRevisionsListParams = {
export type PluginConfigsLogsListParams = {
/**
- * Number of results to return per page.
+ * Only return entries after this ISO 8601 timestamp.
+ */
+ after?: string
+ /**
+ * Only return entries before this ISO 8601 timestamp.
+ */
+ before?: string
+ /**
+ * Maximum number of log entries to return (1-1000, default 100).
+ * @minimum 1
+ * @maximum 1000
*/
limit?: number
/**
* The initial index from which to return the results.
*/
offset?: number
+ /**
+ * Case-insensitive substring search across log messages.
+ */
+ search?: string
+ /**
+ * Log types to include. Repeat the parameter to include more than one type.
+ */
+ type_filter?: PluginConfigsLogsListTypeFilterItem[]
}
+/**
+ * * `DEBUG` - Debug
+ * * `LOG` - Log
+ * * `INFO` - Info
+ * * `WARN` - Warn
+ * * `ERROR` - Error
+ */
+export type PluginConfigsLogsListTypeFilterItem =
+ (typeof PluginConfigsLogsListTypeFilterItem)[keyof typeof PluginConfigsLogsListTypeFilterItem]
+
+export const PluginConfigsLogsListTypeFilterItem = {
+ Debug: 'DEBUG',
+ Log: 'LOG',
+ Info: 'INFO',
+ Warn: 'WARN',
+ Error: 'ERROR',
+} as const
+
export type PublicHogFunctionTemplatesListParams = {
/**
* Number of results to return per page.
diff --git a/products/cross_project_dashboards/backend/facade/api.py b/products/cross_project_dashboards/backend/facade/api.py
index 671d243445a4..b3b6e229fbae 100644
--- a/products/cross_project_dashboards/backend/facade/api.py
+++ b/products/cross_project_dashboards/backend/facade/api.py
@@ -4,6 +4,7 @@ from typing import Any
from uuid import UUID
from posthog.models import User
+from posthog.paging import Page, PageRequest
from ..logic import dashboards
from ..logic.filters import validate_cross_project_filters as _validate_cross_project_filters
@@ -15,9 +16,11 @@ def validate_cross_project_filters(filters: Any) -> dict[str, Any]:
return _validate_cross_project_filters(filters)
-def list_dashboards(*, organization_id: UUID | str, user: User, offset: int, limit: int) -> contracts.DashboardPage:
+def list_dashboards(
+ *, organization_id: UUID | str, user: User, page: PageRequest
+) -> Page[contracts.CrossProjectDashboardSummary]:
"""One page of the organization's dashboards. Each counts only the tiles from projects the user can open."""
- return dashboards.list_dashboards(organization_id=organization_id, user=user, offset=offset, limit=limit)
+ return dashboards.list_dashboards(organization_id=organization_id, user=user, page=page)
def get_dashboard(*, organization_id: UUID | str, dashboard_id: UUID, user: User) -> contracts.CrossProjectDashboard:
@@ -46,12 +49,10 @@ def delete_dashboard(*, organization_id: UUID | str, dashboard_id: UUID, user: U
def list_tiles(
- *, organization_id: UUID | str, dashboard_id: UUID, user: User, offset: int, limit: int
-) -> contracts.TilePage:
+ *, organization_id: UUID | str, dashboard_id: UUID, user: User, page: PageRequest
+) -> Page[contracts.CrossProjectTile]:
"""One page of the dashboard's tiles from projects the user can open. Empty for a deleted dashboard."""
- return dashboards.list_tiles(
- organization_id=organization_id, dashboard_id=dashboard_id, user=user, offset=offset, limit=limit
- )
+ return dashboards.list_tiles(organization_id=organization_id, dashboard_id=dashboard_id, user=user, page=page)
def get_tile(
diff --git a/products/cross_project_dashboards/backend/facade/contracts.py b/products/cross_project_dashboards/backend/facade/contracts.py
index d31c05892fb4..0d4ab5b6b01e 100644
--- a/products/cross_project_dashboards/backend/facade/contracts.py
+++ b/products/cross_project_dashboards/backend/facade/contracts.py
@@ -66,18 +66,6 @@ class CrossProjectDashboardSummary:
updated_at: datetime | None
-@dataclass(frozen=True)
-class DashboardPage:
- results: list[CrossProjectDashboardSummary]
- count: int
-
-
-@dataclass(frozen=True)
-class TilePage:
- results: list[CrossProjectTile]
- count: int
-
-
@dataclass(frozen=True)
class NewDashboard:
name: str
diff --git a/products/cross_project_dashboards/backend/logic/dashboards.py b/products/cross_project_dashboards/backend/logic/dashboards.py
index 30fdfacdc11e..48a9149fd2d7 100644
--- a/products/cross_project_dashboards/backend/logic/dashboards.py
+++ b/products/cross_project_dashboards/backend/logic/dashboards.py
@@ -11,6 +11,8 @@ from rest_framework import serializers
from posthog.models import Team, User
from posthog.models.activity_logging.activity_log import Change, Detail, log_activity
from posthog.models.activity_logging.model_activity import get_was_impersonated
+from posthog.paging import Page, PageRequest
+from posthog.queryset_paging import select_page
from products.cross_project_dashboards.backend.facade import contracts
from products.cross_project_dashboards.backend.logic.access import assert_can_reference_insight, visible_project_ids
@@ -215,7 +217,9 @@ def _lock_tile_for_change(
return tile, dashboard
-def list_dashboards(*, organization_id: UUID | str, user: User, offset: int, limit: int) -> contracts.DashboardPage:
+def list_dashboards(
+ *, organization_id: UUID | str, user: User, page: PageRequest
+) -> Page[contracts.CrossProjectDashboardSummary]:
readable = Q(tiles__project_id__in=visible_project_ids(user, organization_id)) | ~Q(
tiles__project_id__in=_existing_projects(organization_id)
)
@@ -229,8 +233,7 @@ def list_dashboards(*, organization_id: UUID | str, user: User, offset: int, lim
)
.order_by("-created_at", "-id")
)
- page = dashboards[offset : offset + limit]
- return contracts.DashboardPage(results=[_to_summary(dashboard) for dashboard in page], count=dashboards.count())
+ return select_page(dashboards, page).map(_to_summary)
def get_dashboard(*, organization_id: UUID | str, dashboard_id: UUID, user: User) -> contracts.CrossProjectDashboard:
@@ -271,11 +274,9 @@ def delete_dashboard(*, organization_id: UUID | str, dashboard_id: UUID, user: U
def list_tiles(
- *, organization_id: UUID | str, dashboard_id: UUID, user: User, offset: int, limit: int
-) -> contracts.TilePage:
- tiles = _tiles(organization_id, dashboard_id, user)
- page = tiles[offset : offset + limit]
- return contracts.TilePage(results=[_to_tile(tile) for tile in page], count=tiles.count())
+ *, organization_id: UUID | str, dashboard_id: UUID, user: User, page: PageRequest
+) -> Page[contracts.CrossProjectTile]:
+ return select_page(_tiles(organization_id, dashboard_id, user), page).map(_to_tile)
def get_tile(
diff --git a/products/cross_project_dashboards/backend/presentation/views.py b/products/cross_project_dashboards/backend/presentation/views.py
index 1da445d523a8..248a369dae52 100644
--- a/products/cross_project_dashboards/backend/presentation/views.py
+++ b/products/cross_project_dashboards/backend/presentation/views.py
@@ -7,11 +7,11 @@ from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import OpenApiParameter, extend_schema
from rest_framework import status, viewsets
from rest_framework.exceptions import NotFound, PermissionDenied
-from rest_framework.pagination import LimitOffsetPagination
from rest_framework.permissions import BasePermission
from rest_framework.request import Request
from rest_framework.response import Response
+from posthog.api.pagination import FacadeLimitOffsetPagination, facade_page_response
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.models import User
from posthog.permissions import PostHogFeatureFlagPermission, get_authenticator_scoped_team_ids
@@ -39,8 +39,7 @@ def _uuid(value: str) -> UUID:
raise NotFound()
-class CrossProjectDashboardPagination(LimitOffsetPagination):
- # The shared paginator has no ceiling, so ?limit= could ask a single request for every row.
+class CrossProjectDashboardPagination(FacadeLimitOffsetPagination):
default_limit = 100
max_limit = 100
@@ -58,23 +57,7 @@ class OrganizationWideCredentialPermission(BasePermission):
return get_authenticator_scoped_team_ids(getattr(request, "successful_authenticator", None)) is None
-class _FacadePageMixin:
- def _paginated(self, request: Request, page: contracts.DashboardPage | contracts.TilePage, data: Any) -> Response:
- paginator = self.paginator # type: ignore[attr-defined]
- paginator.request = request
- paginator.limit = paginator.get_limit(request)
- paginator.offset = paginator.get_offset(request)
- paginator.count = page.count
- return paginator.get_paginated_response(data)
-
- def _offset(self, request: Request) -> int:
- return self.paginator.get_offset(request) # type: ignore[attr-defined]
-
- def _limit(self, request: Request) -> int:
- return self.paginator.get_limit(request) # type: ignore[attr-defined]
-
-
-class CrossProjectDashboardViewSet(TeamAndOrgViewSetMixin, _FacadePageMixin, viewsets.GenericViewSet):
+class CrossProjectDashboardViewSet(TeamAndOrgViewSetMixin, viewsets.GenericViewSet):
"""Dashboards the organization owns, holding insights from one or more projects."""
# Any organization member may create one, and may edit or delete one whose tiles all come from
@@ -96,13 +79,11 @@ class CrossProjectDashboardViewSet(TeamAndOrgViewSetMixin, _FacadePageMixin, vie
@extend_schema(responses={200: CrossProjectDashboardListItemSerializer(many=True)})
def list(self, request: Request, **kwargs: Any) -> Response:
- page = api.list_dashboards(
- organization_id=self.organization_id,
- user=self._user(),
- offset=self._offset(request),
- limit=self._limit(request),
+ return facade_page_response(
+ self,
+ lambda page: api.list_dashboards(organization_id=self.organization_id, user=self._user(), page=page),
+ serializer_class=CrossProjectDashboardListItemSerializer,
)
- return self._paginated(request, page, CrossProjectDashboardListItemSerializer(page.results, many=True).data)
@extend_schema(request=CrossProjectDashboardSerializer, responses={201: CrossProjectDashboardSerializer})
def create(self, request: Request, **kwargs: Any) -> Response:
@@ -157,7 +138,7 @@ class CrossProjectDashboardViewSet(TeamAndOrgViewSetMixin, _FacadePageMixin, vie
return Response(status=status.HTTP_204_NO_CONTENT)
-class CrossProjectDashboardTileViewSet(TeamAndOrgViewSetMixin, _FacadePageMixin, viewsets.GenericViewSet):
+class CrossProjectDashboardTileViewSet(TeamAndOrgViewSetMixin, viewsets.GenericViewSet):
"""Tiles on one cross-project dashboard, edited one at a time.
Writes are per tile rather than a whole-set replace, so two people editing the same
@@ -182,14 +163,12 @@ class CrossProjectDashboardTileViewSet(TeamAndOrgViewSetMixin, _FacadePageMixin,
@extend_schema(parameters=[PARENT_DASHBOARD_ID], responses={200: CrossProjectDashboardTileSerializer(many=True)})
def list(self, request: Request, **kwargs: Any) -> Response:
- page = api.list_tiles(
- organization_id=self.organization_id,
- dashboard_id=self._dashboard_id(),
- user=self._user(),
- offset=self._offset(request),
- limit=self._limit(request),
+ return facade_page_response(
+ self,
+ lambda page: api.list_tiles(
+ organization_id=self.organization_id, dashboard_id=self._dashboard_id(), user=self._user(), page=page
+ ),
)
- return self._paginated(request, page, CrossProjectDashboardTileSerializer(page.results, many=True).data)
@extend_schema(
parameters=[PARENT_DASHBOARD_ID],
diff --git a/products/cross_project_dashboards/frontend/generated/api.schemas.ts b/products/cross_project_dashboards/frontend/generated/api.schemas.ts
index a865e51d9dc1..d07e8a3599cf 100644
--- a/products/cross_project_dashboards/frontend/generated/api.schemas.ts
+++ b/products/cross_project_dashboards/frontend/generated/api.schemas.ts
@@ -167,6 +167,7 @@ export interface PatchedCrossProjectDashboardApi {
export type CrossProjectDashboardsListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number
/**
@@ -178,6 +179,7 @@ export type CrossProjectDashboardsListParams = {
export type CrossProjectDashboardsTilesListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number
/**
diff --git a/products/replay/frontend/generated/api.schemas.ts b/products/replay/frontend/generated/api.schemas.ts
index 0085bd196e65..18f2c818404e 100644
--- a/products/replay/frontend/generated/api.schemas.ts
+++ b/products/replay/frontend/generated/api.schemas.ts
@@ -411,6 +411,7 @@ export type SessionRecordingPlaylistsListParams = {
created_by?: number
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number
/**
diff --git a/products/warehouse_sources/backend/presentation/views/external_data_schema.py b/products/warehouse_sources/backend/presentation/views/external_data_schema.py
index 0d7b7ae86115..8e99decb6a06 100644
--- a/products/warehouse_sources/backend/presentation/views/external_data_schema.py
+++ b/products/warehouse_sources/backend/presentation/views/external_data_schema.py
@@ -16,7 +16,7 @@ from rest_framework.response import Response
from posthog.hogql.database.database import Database
-from posthog.api.log_entries import LogEntryRequestSerializer, LogEntrySerializer, fetch_log_entries
+from posthog.api.log_entries import LogEntryPagination, LogEntryRequestSerializer, log_entries_response
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.api.utils import action
from posthog.exceptions_capture import capture_exception
@@ -2427,28 +2427,10 @@ class ExternalDataSchemaViewset(TeamAndOrgViewSetMixin, viewsets.ModelViewSet):
)
@extend_schema(parameters=[LogEntryRequestSerializer])
- @action(methods=["GET"], detail=True, filter_backends=[])
+ @action(methods=["GET"], detail=True, filter_backends=[], pagination_class=LogEntryPagination)
def logs(self, request: Request, *args: Any, **kwargs: Any) -> Response:
instance: ExternalDataSchema = self.get_object()
- param_serializer = LogEntryRequestSerializer(data=request.query_params)
- if not param_serializer.is_valid():
- raise ValidationError(param_serializer.errors)
- params = param_serializer.validated_data
- data = fetch_log_entries(
- team_id=self.team_id,
- log_source="external_data_jobs",
- log_source_id=str(instance.id),
- limit=params["limit"],
- instance_id=params.get("instance_id"),
- after=params.get("after"),
- before=params.get("before"),
- search=params.get("search"),
- level=params["level"].split(",") if params.get("level") else None,
- )
- page = self.paginate_queryset(data)
- if page is not None:
- return self.get_paginated_response(LogEntrySerializer(page, many=True).data)
- return Response(LogEntrySerializer(data, many=True).data)
+ return log_entries_response(self, request, log_source="external_data_jobs", log_source_id=str(instance.id))
@extend_schema(
request=None,
diff --git a/products/warehouse_sources/backend/tests/api/test_external_data_schema.py b/products/warehouse_sources/backend/tests/api/test_external_data_schema.py
index 9ab473e87342..4c16c197cb1a 100644
--- a/products/warehouse_sources/backend/tests/api/test_external_data_schema.py
+++ b/products/warehouse_sources/backend/tests/api/test_external_data_schema.py
@@ -5,7 +5,7 @@ from typing import Any
import pytest
import time_machine
-from posthog.test.base import APIBaseTest
+from posthog.test.base import APIBaseTest, ClickhouseTestMixin
from unittest import mock
from django.conf import settings
@@ -22,6 +22,7 @@ from rest_framework.request import Request
from rest_framework.test import APIRequestFactory
from temporalio.service import RPCError, RPCStatusCode
+from posthog.api.test.test_log_entries import create_log_entry
from posthog.api.test.test_organization import create_organization
from posthog.api.test.test_team import create_team
from posthog.api.test.test_user import create_user
@@ -5599,6 +5600,28 @@ class TestSchemaDisplayStatus(SimpleTestCase):
assert schema_display_status(ExternalDataSchema(status=raw_status)) == expected
+class TestExternalDataSchemaLogs(ClickhouseTestMixin, APIBaseTest):
+ @time_machine.travel("2023-09-23 12:00:00", tick=False)
+ def test_pages_logs_by_offset(self) -> None:
+ source = ExternalDataSource.objects.create(team=self.team, source_type=ExternalDataSourceType.STRIPE)
+ schema = ExternalDataSchema.objects.create(name="customers", team=self.team, source=source)
+ for hour in range(1, 4):
+ create_log_entry(
+ team_id=self.team.pk,
+ log_source="external_data_jobs",
+ log_source_id=str(schema.id),
+ message=f"entry {hour}",
+ level="INFO",
+ timestamp=f"2023-09-22 0{hour}:00:00",
+ )
+
+ url = f"/api/environments/{self.team.pk}/external_data_schemas/{schema.id}/logs/"
+ second_page = self.client.get(url, {"limit": 2, "offset": 2}).json()
+
+ assert second_page["count"] == 3
+ assert [entry["message"] for entry in second_page["results"]] == ["entry 1"]
+
+
class TestExternalDataSchemaIntrospection(SimpleTestCase):
def test_schema_generation_needs_no_team_context(self) -> None:
view = ExternalDataSchemaViewset()
diff --git a/products/warehouse_suggestions/backend/facade/api.py b/products/warehouse_suggestions/backend/facade/api.py
index 7232de5f38b5..4ff553ab7460 100644
--- a/products/warehouse_suggestions/backend/facade/api.py
+++ b/products/warehouse_suggestions/backend/facade/api.py
@@ -5,6 +5,9 @@ from dataclasses import asdict
from typing import TYPE_CHECKING
from uuid import UUID
+from posthog.paging import Page, PageRequest
+from posthog.queryset_paging import select_page
+
from products.warehouse_sources.backend.facade.api import source_locations_for_tables
from products.warehouse_sources.backend.facade.contracts import TableSourceLocation
@@ -23,7 +26,6 @@ from .contracts import (
Suggestion,
SuggestionDraft,
SuggestionNotFoundError,
- SuggestionPage,
SuggestionPayloadView,
SuggestionReviewer,
SuggestionStatus,
@@ -67,9 +69,8 @@ def list_suggestions(
subject_id: UUID | None,
assignee_id: int | None = None,
subject_kinds: SubjectKinds,
- limit: int,
- offset: int,
-) -> SuggestionPage:
+ page: PageRequest,
+) -> Page[Suggestion]:
visible, access = visible_suggestions(
team_id,
user_access_control,
@@ -79,8 +80,8 @@ def list_suggestions(
assignee_id=assignee_id,
subject_kinds=subject_kinds,
)
- page = list(visible[offset : offset + limit])
- return SuggestionPage(count=visible.count(), results=_to_contracts(team_id, user_access_control, page, access))
+ rows = select_page(visible, page)
+ return Page(results=_to_contracts(team_id, user_access_control, rows.results, access), count=rows.count)
def suggestion_status(team_id: int) -> SuggestionStatus:
diff --git a/products/warehouse_suggestions/backend/facade/contracts.py b/products/warehouse_suggestions/backend/facade/contracts.py
index e902455ba4a2..eeefb95da502 100644
--- a/products/warehouse_suggestions/backend/facade/contracts.py
+++ b/products/warehouse_suggestions/backend/facade/contracts.py
@@ -209,12 +209,6 @@ class SuggestionStatus:
refreshed_at: datetime | None
-@frozen
-class SuggestionPage:
- count: int
- results: list[Suggestion]
-
-
class SuggestionNotFoundError(Exception):
pass
diff --git a/products/warehouse_suggestions/backend/presentation/views.py b/products/warehouse_suggestions/backend/presentation/views.py
index 04ec883d665f..329d56ff1c46 100644
--- a/products/warehouse_suggestions/backend/presentation/views.py
+++ b/products/warehouse_suggestions/backend/presentation/views.py
@@ -8,13 +8,13 @@ from uuid import UUID
from drf_spectacular.utils import OpenApiResponse, extend_schema
from rest_framework import viewsets
from rest_framework.exceptions import APIException, NotFound, PermissionDenied, ValidationError
-from rest_framework.pagination import LimitOffsetPagination
from rest_framework.permissions import BasePermission, IsAuthenticated
from rest_framework.request import Request
from rest_framework.response import Response
from rest_framework.views import APIView
from posthog.api.mixins import TypedRequest, ValidatedRequest, validated_request
+from posthog.api.pagination import FacadeLimitOffsetPagination, facade_page_response
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.api.utils import action
from posthog.exceptions import Conflict
@@ -42,7 +42,6 @@ from ..facade.contracts import (
SuggestionNotFoundError,
SuggestionNotOpenError,
SuggestionOutdatedError,
- SuggestionPage,
SuggestionSubjectGoneError,
)
from ..facade.enums import WarehouseSuggestionKind, WarehouseSuggestionStatus, WarehouseSuggestionSubjectKind
@@ -80,18 +79,10 @@ ACCEPT_SCOPES = ["data_catalog_approval:write", "warehouse_view:write"]
ScopeLevel = Literal["read", "write"]
-class SuggestionPagination(LimitOffsetPagination):
+class SuggestionPagination(FacadeLimitOffsetPagination):
default_limit = DEFAULT_PAGE_SIZE
max_limit = DEFAULT_PAGE_SIZE
- def paginate(self, request: Request, fetch_page: Callable[[int, int], SuggestionPage]) -> Response:
- self.request = request
- self.limit = self.get_limit(request) or DEFAULT_PAGE_SIZE
- self.offset = self.get_offset(request)
- page = fetch_page(self.limit, self.offset)
- self.count = page.count
- return self.get_paginated_response(WarehouseSuggestionSerializer(page.results, many=True).data)
-
class ProjectAccessPermission(BasePermission):
def has_permission(self, request: Request, view: APIView) -> bool:
@@ -151,9 +142,9 @@ class WarehouseSuggestionViewSet(TeamAndOrgViewSetMixin, viewsets.GenericViewSet
def list(self, request: ValidatedRequest, **kwargs: Any) -> Response:
kind = request.validated_query_data.get("kind")
status = request.validated_query_data.get("status")
- return cast(SuggestionPagination, self.paginator).paginate(
- request,
- lambda limit, offset: api.list_suggestions(
+ return facade_page_response(
+ self,
+ lambda page: api.list_suggestions(
self.team_id,
self.user_access_control,
kind=WarehouseSuggestionKind(kind) if kind else None,
@@ -161,9 +152,9 @@ class WarehouseSuggestionViewSet(TeamAndOrgViewSetMixin, viewsets.GenericViewSet
subject_id=request.validated_query_data.get("subject_id"),
assignee_id=request.validated_query_data.get("assignee_id"),
subject_kinds=self._subject_kinds,
- limit=limit,
- offset=offset,
+ page=page,
),
+ serializer_class=WarehouseSuggestionSerializer,
)
@extend_schema(responses={200: WarehouseSuggestionStatusSerializer})
diff --git a/products/warehouse_suggestions/frontend/generated/api.schemas.ts b/products/warehouse_suggestions/frontend/generated/api.schemas.ts
index 14b4bc852c9d..04ec2b33d23b 100644
--- a/products/warehouse_suggestions/frontend/generated/api.schemas.ts
+++ b/products/warehouse_suggestions/frontend/generated/api.schemas.ts
@@ -428,6 +428,7 @@ export type WarehouseSuggestionsListParams = {
kind?: WarehouseSuggestionsListKind
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number
/**
diff --git a/products/wizard/backend/facade/api.py b/products/wizard/backend/facade/api.py
index 88fad4389087..2a764844f6a2 100644
--- a/products/wizard/backend/facade/api.py
+++ b/products/wizard/backend/facade/api.py
@@ -15,6 +15,8 @@ from uuid import UUID
from redis.asyncio.client import PubSub
+from posthog.paging import Page, PageRequest
+
from products.wizard.backend import metrics
from products.wizard.backend.facade.contracts import (
CreatePullRequestArtifactInput,
@@ -30,7 +32,6 @@ from products.wizard.backend.facade.contracts import (
WizardRunCreationResult,
WizardRunDTO,
WizardRunGitDiffArtifactDTO,
- WizardRunPage,
WizardRunPullRequestArtifactDTO,
WizardRunTaskDTO,
WizardScanResult,
@@ -82,16 +83,9 @@ def list_for_team(
workflow_id: str | None = None,
skill_id: str | None = None,
*,
- offset: int = 0,
- limit: int | None = None,
-) -> list[WizardSessionDTO]:
- return sessions.list_sessions(
- team_id,
- workflow_id=workflow_id,
- skill_id=skill_id,
- offset=offset,
- limit=limit,
- )
+ page: PageRequest,
+) -> Page[WizardSessionDTO]:
+ return sessions.list_sessions(team_id, workflow_id=workflow_id, skill_id=skill_id, page=page)
@asynccontextmanager
@@ -153,8 +147,8 @@ async def subscribe_to_run_updates(team_id: int, run_id: UUID) -> AsyncIterator[
yield subscription
-def list_runs(params: ListWizardRunsInput) -> WizardRunPage:
- return run_service.list_runs(params)
+def list_runs(params: ListWizardRunsInput, page: PageRequest) -> Page[WizardRunDTO]:
+ return run_service.list_runs(params, page)
def update_run_stage(team_id: int, run_id: UUID, stage: WizardRunStage) -> WizardRunDTO:
diff --git a/products/wizard/backend/facade/contracts.py b/products/wizard/backend/facade/contracts.py
index e7b0bc0921ad..a208ee7fafc6 100644
--- a/products/wizard/backend/facade/contracts.py
+++ b/products/wizard/backend/facade/contracts.py
@@ -241,18 +241,10 @@ class WizardInstallStatusDTO:
@frozen
class ListWizardRunsInput:
team_id: int
- offset: int
- limit: int
statuses: tuple[WizardRunStatus, ...] = ()
created_after: datetime | None = None
-@frozen
-class WizardRunPage:
- results: tuple[WizardRunDTO, ...]
- count: int
-
-
@frozen
class CreatePullRequestArtifactInput:
team_id: int
diff --git a/products/wizard/backend/logic/runs/lifecycle.py b/products/wizard/backend/logic/runs/lifecycle.py
index aba656ff56f7..a62c68718cc6 100644
--- a/products/wizard/backend/logic/runs/lifecycle.py
+++ b/products/wizard/backend/logic/runs/lifecycle.py
@@ -9,6 +9,7 @@ from django.utils import timezone
import structlog
from posthog.models import Team, User
+from posthog.paging import Page, PageRequest
from products.wizard.backend.facade.config import DEFAULT_WIZARD_VERSION
from products.wizard.backend.facade.contracts import (
@@ -19,7 +20,6 @@ from products.wizard.backend.facade.contracts import (
UpdateWizardRunTaskInput,
WizardRunCreationResult,
WizardRunDTO,
- WizardRunPage,
WizardRunTaskDTO,
)
from products.wizard.backend.facade.enums import (
@@ -167,8 +167,8 @@ def get_run(team_id: int, run_id: UUID) -> WizardRunDTO:
return store.get_run(team_id, run_id)
-def list_runs(params: ListWizardRunsInput) -> WizardRunPage:
- return store.list_runs(params)
+def list_runs(params: ListWizardRunsInput, page: PageRequest) -> Page[WizardRunDTO]:
+ return store.list_runs(params, page)
def start_run(team_id: int, run_id: UUID) -> WizardRunDTO:
diff --git a/products/wizard/backend/logic/runs/store.py b/products/wizard/backend/logic/runs/store.py
index b3ccaf082cda..74b4dcd182ee 100644
--- a/products/wizard/backend/logic/runs/store.py
+++ b/products/wizard/backend/logic/runs/store.py
@@ -8,13 +8,15 @@ from django.utils import timezone
import structlog
+from posthog.paging import Page, PageRequest
+from posthog.queryset_paging import select_page
+
from products.wizard.backend.facade.config import WIZARD_RUN_DEADLINE
from products.wizard.backend.facade.contracts import (
ListWizardRunsInput,
WizardProgram,
WizardRunCreationResult,
WizardRunDTO,
- WizardRunPage,
WizardRunTaskDTO,
WizardWorkspace,
)
@@ -178,15 +180,15 @@ def get_run_for_update(team_id: int, run_id: UUID) -> WizardRunDTO:
return record_to_run(run)
-def list_runs(params: ListWizardRunsInput) -> WizardRunPage:
+def list_runs(params: ListWizardRunsInput, page: PageRequest) -> Page[WizardRunDTO]:
runs = WizardRun.objects.for_team(params.team_id).select_related("created_by").order_by("-created_at")
if params.statuses:
runs = runs.filter(status__in=params.statuses)
if params.created_after is not None:
runs = runs.filter(created_at__gt=params.created_after)
- page = runs[params.offset : params.offset + params.limit]
+ rows = select_page(runs, page)
results: list[WizardRunDTO] = []
- for run in page:
+ for run in rows.results:
try:
results.append(record_to_run(run))
except ValueError:
@@ -195,7 +197,7 @@ def list_runs(params: ListWizardRunsInput) -> WizardRunPage:
team_id=params.team_id,
run_id=str(run.id),
)
- return WizardRunPage(results=tuple(results), count=runs.count())
+ return Page(results=results, count=rows.count)
def set_run_status(
diff --git a/products/wizard/backend/logic/sessions/lifecycle.py b/products/wizard/backend/logic/sessions/lifecycle.py
index b94f5000b2f9..529428baf16a 100644
--- a/products/wizard/backend/logic/sessions/lifecycle.py
+++ b/products/wizard/backend/logic/sessions/lifecycle.py
@@ -10,6 +10,9 @@ from django.db import IntegrityError, transaction
import structlog
from kombu.exceptions import OperationalError
+from posthog.paging import Page, PageRequest
+from posthog.queryset_paging import select_page
+
from products.wizard.backend.facade.contracts import UpsertWizardSessionInput, WizardSessionDTO
from products.wizard.backend.facade.enums import WizardSessionRunPhase
from products.wizard.backend.facade.errors import WizardSessionOwnershipError
@@ -157,15 +160,9 @@ def list_sessions(
workflow_id: str | None = None,
skill_id: str | None = None,
*,
- offset: int = 0,
- limit: int | None = None,
-) -> list[WizardSessionDTO]:
- """List sessions for a team, ordered by `started_at` desc.
-
- `offset`/`limit` are applied at the SQL layer (LIMIT/OFFSET) so the read
- cost stays bounded regardless of how many sessions the team has. The view
- layer should always pass a `limit`.
- """
+ page: PageRequest,
+) -> Page[WizardSessionDTO]:
+ """One page of a team's sessions, ordered by `started_at` desc and paged in SQL."""
qs = WizardSession.objects.select_related("created_by").filter(team_id=team_id)
if workflow_id:
qs = qs.filter(workflow_id=workflow_id)
@@ -173,8 +170,4 @@ def list_sessions(
qs = qs.filter(skill_id=skill_id)
# created_at breaks ties on equal (client-supplied, second-granularity) started_at
qs = qs.order_by("-started_at", "-created_at")
- if limit is not None:
- qs = qs[offset : offset + limit]
- elif offset:
- qs = qs[offset:]
- return [to_session_dto(instance) for instance in qs]
+ return select_page(qs, page).map(to_session_dto)
diff --git a/products/wizard/backend/presentation/runs/pagination.py b/products/wizard/backend/presentation/runs/pagination.py
index c5807af0cd64..6459f2c6e753 100644
--- a/products/wizard/backend/presentation/runs/pagination.py
+++ b/products/wizard/backend/presentation/runs/pagination.py
@@ -1,50 +1,6 @@
-from datetime import datetime
-from typing import cast
+from posthog.api.pagination import FacadeLimitOffsetPagination
-from rest_framework import serializers
-from rest_framework.exceptions import ValidationError
-from rest_framework.pagination import LimitOffsetPagination
-from rest_framework.request import Request
-from rest_framework.response import Response
-from products.wizard.backend.facade import api as wizard_facade
-from products.wizard.backend.facade.contracts import ListWizardRunsInput
-from products.wizard.backend.facade.enums import WizardRunStatus
-from products.wizard.backend.presentation.runs.serializers import WizardRunSerializer
-
-
-class WizardRunPagination(LimitOffsetPagination):
+class WizardRunPagination(FacadeLimitOffsetPagination):
default_limit = 100
max_limit = 100
-
- def paginate_runs(self, request: Request, *, team_id: int) -> Response:
- limit = self.get_limit(request)
- assert limit is not None
- offset = self.get_offset(request)
- raw_status = request.query_params.get("status")
- try:
- statuses = (
- tuple(WizardRunStatus(value) for value in raw_status.split(",")) if raw_status is not None else ()
- )
- except ValueError as error:
- raise ValidationError({"status": "Invalid run status."}) from error
- raw_created_after = request.query_params.get("created_after")
- created_after = (
- cast(datetime, serializers.DateTimeField().run_validation(raw_created_after))
- if raw_created_after is not None
- else None
- )
- page = wizard_facade.list_runs(
- ListWizardRunsInput(
- team_id=team_id,
- offset=offset,
- limit=limit,
- statuses=statuses,
- created_after=created_after,
- )
- )
- self.request = request
- self.limit = limit
- self.offset = offset
- self.count = page.count
- return self.get_paginated_response(WizardRunSerializer(page.results, many=True).data)
diff --git a/products/wizard/backend/presentation/runs/views.py b/products/wizard/backend/presentation/runs/views.py
index 41a471a24446..b6e4a2ed1ada 100644
--- a/products/wizard/backend/presentation/runs/views.py
+++ b/products/wizard/backend/presentation/runs/views.py
@@ -7,11 +7,12 @@ from django.http import HttpResponse
from django.http.response import HttpResponseBase
from drf_spectacular.utils import OpenApiParameter, OpenApiResponse, extend_schema
-from rest_framework import status, viewsets
-from rest_framework.exceptions import NotFound, PermissionDenied
+from rest_framework import serializers, status, viewsets
+from rest_framework.exceptions import NotFound, PermissionDenied, ValidationError
from rest_framework.request import Request
from rest_framework.response import Response
+from posthog.api.pagination import facade_page_response
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.api.streaming import sse_streaming_response
from posthog.api.utils import action
@@ -19,7 +20,7 @@ from posthog.auth import OAuthAccessTokenAuthentication, SessionAuthentication
from posthog.exceptions import Conflict
from products.wizard.backend.facade import api as wizard_facade
-from products.wizard.backend.facade.contracts import WizardRunDTO
+from products.wizard.backend.facade.contracts import ListWizardRunsInput, WizardRunDTO
from products.wizard.backend.facade.enums import WizardRunEnvironment, WizardRunStatus
from products.wizard.backend.facade.errors import IllegalStatusTransitionError, WizardRunNotFoundError
from products.wizard.backend.presentation.permissions import WizardRunSessionAuthenticationRequired
@@ -91,8 +92,23 @@ class WizardRunViewSet(TeamAndOrgViewSetMixin, viewsets.GenericViewSet):
)
def list(self, request: Request, *args: object, **kwargs: object) -> Response:
# GET /projects/:projectId/wizard/runs
- paginator = cast(WizardRunPagination, self.paginator)
- return paginator.paginate_runs(request, team_id=self.team_id)
+ raw_status = request.query_params.get("status")
+ try:
+ statuses = (
+ tuple(WizardRunStatus(value) for value in raw_status.split(",")) if raw_status is not None else ()
+ )
+ except ValueError as error:
+ raise ValidationError({"status": "Invalid run status."}) from error
+ raw_created_after = request.query_params.get("created_after")
+ created_after = (
+ cast(datetime, serializers.DateTimeField().run_validation(raw_created_after))
+ if raw_created_after is not None
+ else None
+ )
+ filters = ListWizardRunsInput(team_id=self.team_id, statuses=statuses, created_after=created_after)
+ return facade_page_response(
+ self, lambda page: wizard_facade.list_runs(filters, page), serializer_class=WizardRunSerializer
+ )
@extend_schema(
request=WizardRunCreateRequestSerializer,
diff --git a/products/wizard/backend/presentation/sessions/serializers.py b/products/wizard/backend/presentation/sessions/serializers.py
index efeb1ffa473d..9120cc6955ec 100644
--- a/products/wizard/backend/presentation/sessions/serializers.py
+++ b/products/wizard/backend/presentation/sessions/serializers.py
@@ -40,7 +40,7 @@ class WizardSessionListQuerySerializer(serializers.Serializer):
limit = serializers.IntegerField(
required=False,
default=DEFAULT_LIST_LIMIT,
- min_value=0,
+ min_value=1,
max_value=MAX_LIST_LIMIT,
help_text="Maximum number of sessions to return.",
)
diff --git a/products/wizard/backend/presentation/sessions/views.py b/products/wizard/backend/presentation/sessions/views.py
index b371746eecd1..4190341c08cf 100644
--- a/products/wizard/backend/presentation/sessions/views.py
+++ b/products/wizard/backend/presentation/sessions/views.py
@@ -7,7 +7,7 @@ returns DTO-shaped responses. No model imports.
import time
from collections.abc import AsyncIterator, Mapping
-from typing import Any
+from typing import Any, cast
from django.conf import settings
from django.http import HttpResponse
@@ -23,6 +23,8 @@ from rest_framework.renderers import BaseRenderer
from rest_framework.request import Request
from rest_framework.response import Response
+from posthog.api.mixins import ValidatedRequest, validated_request
+from posthog.api.pagination import FacadeLimitOffsetPagination, facade_page_response
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.api.streaming import sse_streaming_response
from posthog.models.scoping import team_scope
@@ -38,6 +40,8 @@ from products.wizard.backend.facade.enums import WizardSessionRunPhase
from products.wizard.backend.facade.errors import WizardSessionOwnershipError
from products.wizard.backend.presentation.sessions import config as session_config
from products.wizard.backend.presentation.sessions.serializers import (
+ DEFAULT_LIST_LIMIT,
+ MAX_LIST_LIMIT,
UpsertWizardSessionRequestSerializer,
WizardSessionListQuerySerializer,
WizardSessionLookupQuerySerializer,
@@ -112,12 +116,30 @@ def _wizard_sync_killswitch_enabled(distinct_id: str) -> bool:
)
+class WizardSessionPagination(FacadeLimitOffsetPagination):
+ """Pages with the limit and offset that `WizardSessionListQuerySerializer` validated.
+
+ The base class parses the raw query params again, which turns an accepted value such as
+ `limit=1.0` into the default limit.
+ """
+
+ default_limit = DEFAULT_LIST_LIMIT
+ max_limit = MAX_LIST_LIMIT
+
+ def get_limit(self, request: Request) -> int:
+ return cast(ValidatedRequest, request).validated_query_data["limit"]
+
+ def get_offset(self, request: Request) -> int:
+ return cast(ValidatedRequest, request).validated_query_data["offset"]
+
+
class WizardSessionViewSet(TeamAndOrgViewSetMixin, viewsets.GenericViewSet):
scope_object = "wizard_session"
scope_object_read_actions = ["list", "retrieve", "stream", "latest"]
scope_object_write_actions = ["create"]
http_method_names = ["get", "post", "head", "options"]
lookup_field = "session_id"
+ pagination_class = WizardSessionPagination
# Negative lookahead so a session_id of `stream` or `latest` can't collide
# with the `@action(url_path=...)` detail-vs-action routes.
lookup_value_regex = r"(?!(?:stream|latest)$)[^/]+"
@@ -139,30 +161,26 @@ class WizardSessionViewSet(TeamAndOrgViewSetMixin, viewsets.GenericViewSet):
_log_request_auth(request, action=getattr(self, "action", "<unknown>"), team_id=team_id)
super().check_permissions(request)
- @extend_schema(
+ @validated_request(
+ query_serializer=WizardSessionListQuerySerializer,
description=(
"List wizard sessions for the project, ordered by started_at desc. "
"This should only be called by the PostHog Wizard. "
"Optional filters: ?workflow_id=<id> and ?skill_id=<id>."
),
- parameters=[WizardSessionListQuerySerializer],
responses={200: WizardSessionSerializer(many=True)},
)
- def list(self, request: Request, *args: Any, **kwargs: Any) -> Response:
+ def list(self, request: ValidatedRequest, *args: Any, **kwargs: Any) -> Response:
# GET /projects/:projectId/wizard/sessions
- query = WizardSessionListQuerySerializer(data=request.query_params)
- query.is_valid(raise_exception=True)
- sessions = wizard_facade.list_for_team(
- self.team_id,
- workflow_id=query.validated_data.get("workflow_id"),
- skill_id=query.validated_data.get("skill_id") or None,
- offset=query.validated_data["offset"],
- limit=query.validated_data["limit"],
+ workflow_id = request.validated_query_data.get("workflow_id")
+ skill_id = request.validated_query_data.get("skill_id") or None
+ return facade_page_response(
+ self,
+ lambda page: wizard_facade.list_for_team(
+ self.team_id, workflow_id=workflow_id, skill_id=skill_id, page=page
+ ),
+ serializer_class=WizardSessionSerializer,
)
- page = self.paginate_queryset(sessions)
- if page is not None:
- return self.get_paginated_response(WizardSessionSerializer(page, many=True).data)
- return Response(WizardSessionSerializer(sessions, many=True).data)
@extend_schema(
description="Retrieve a single wizard session by its session_id.",
diff --git a/products/wizard/backend/tests/sessions/test_logic.py b/products/wizard/backend/tests/sessions/test_logic.py
index bc0b72eae628..d3ea845c75a7 100644
--- a/products/wizard/backend/tests/sessions/test_logic.py
+++ b/products/wizard/backend/tests/sessions/test_logic.py
@@ -10,6 +10,7 @@ from django.test.utils import CaptureQueriesContext
from kombu.exceptions import OperationalError
from posthog.models import Team, User
+from posthog.paging import PageRequest
from products.event_definitions.backend.models import EventDefinition
from products.wizard.backend.facade import api as wizard_facade
@@ -102,7 +103,7 @@ def test_upsert_with_same_session_id_replaces_state(_mock_sync, team):
assert sum("FOR UPDATE" in query["sql"] for query in queries.captured_queries) == 1
assert updated.run_phase == WizardSessionRunPhase.COMPLETED
assert updated.tasks[0].status == WizardSessionTaskStatus.COMPLETED
- assert len(wizard_facade.list_for_team(team.id, limit=100)) == 1
+ assert wizard_facade.list_for_team(team.id, page=PageRequest(limit=100)).count == 1
@pytest.mark.django_db
@@ -286,7 +287,7 @@ def test_upsert_with_different_session_id_creates_new_row(team):
wizard_facade.upsert(_input(team.id, session_id="run-1"))
wizard_facade.upsert(_input(team.id, session_id="run-2"))
- assert len(wizard_facade.list_for_team(team.id, limit=100)) == 2
+ assert wizard_facade.list_for_team(team.id, page=PageRequest(limit=100)).count == 2
@pytest.mark.django_db
@@ -401,8 +402,8 @@ def test_list_for_team_returns_sessions_ordered_by_started_at_desc(team):
)
)
- sessions = wizard_facade.list_for_team(team.id, limit=100)
- assert [s.session_id for s in sessions] == ["run-late", "run-early"]
+ sessions = wizard_facade.list_for_team(team.id, page=PageRequest(limit=100))
+ assert [s.session_id for s in sessions.results] == ["run-late", "run-early"]
@pytest.mark.django_db
diff --git a/products/wizard/backend/tests/sessions/test_session_presentation.py b/products/wizard/backend/tests/sessions/test_session_presentation.py
index cd4f9eadbcb3..ce09ecb4c8af 100644
--- a/products/wizard/backend/tests/sessions/test_session_presentation.py
+++ b/products/wizard/backend/tests/sessions/test_session_presentation.py
@@ -163,7 +163,8 @@ class TestWizardSessionViewSet(APIBaseTest):
self.assertEqual(WizardSession.objects.unscoped().filter(team=self.team).count(), 2)
- def test_list_returns_sessions_ordered_by_started_at_desc(self):
+ @parameterized.expand([("1", "1"), ("1.0", "1.0")])
+ def test_list_returns_sessions_ordered_by_started_at_desc(self, limit, offset):
self.client.post(
self._url(),
self._payload(
@@ -188,6 +189,10 @@ class TestWizardSessionViewSet(APIBaseTest):
self.assertEqual(results[0]["started_at"], "2026-05-19T19:00:00Z")
self.assertEqual(results[1]["started_at"], "2026-05-19T09:00:00Z")
+ second_page = self.client.get(self._url() + f"?limit={limit}&offset={offset}").json()
+ self.assertEqual(second_page["count"], 2)
+ self.assertEqual([row["started_at"] for row in second_page["results"]], ["2026-05-19T09:00:00Z"])
+
def test_list_filters_by_workflow_and_skill(self):
self.client.post(
self._url(),
diff --git a/products/wizard/frontend/generated/api.schemas.ts b/products/wizard/frontend/generated/api.schemas.ts
index b73f3ecc2767..1fec823fa99f 100644
--- a/products/wizard/frontend/generated/api.schemas.ts
+++ b/products/wizard/frontend/generated/api.schemas.ts
@@ -869,6 +869,7 @@ export type WizardRunsListParams = {
created_after?: string
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number
/**
@@ -905,7 +906,7 @@ export type WizardRunsArtifactsListParams = {
export type WizardSessionsListParams = {
/**
* Maximum number of sessions to return.
- * @minimum 0
+ * @minimum 1
* @maximum 200
*/
limit?: number
diff --git a/products/workflows/backend/facade/contracts.py b/products/workflows/backend/facade/contracts.py
index d4f1ffe457b2..b161fb7f82e1 100644
--- a/products/workflows/backend/facade/contracts.py
+++ b/products/workflows/backend/facade/contracts.py
@@ -744,14 +744,6 @@ class WorkflowListQuery:
field_filters: Mapping[str, str] = field(default_factory=dict)
-@frozen
-class WorkflowPage:
- """One limit/offset page of a workflow list, and how many workflows the whole list holds."""
-
- count: int
- results: list[Workflow]
-
-
@frozen
class WorkflowListFilterError:
message: str
diff --git a/products/workflows/backend/facade/proposals.py b/products/workflows/backend/facade/proposals.py
index 6f7d1b176ad8..bae632a57352 100644
--- a/products/workflows/backend/facade/proposals.py
+++ b/products/workflows/backend/facade/proposals.py
@@ -7,7 +7,6 @@ from products.workflows.backend.services.workflow_proposals import (
PROPOSAL_MERGE_BY_ID_FIELDS,
absolute_window,
as_the_serializer_stores_it,
- count_proposals,
create_proposal,
get_proposal,
get_proposal_by_source_id,
@@ -31,7 +30,6 @@ __all__ = [
"HOG_FLOW_VERSION_APP_SOURCE",
"PROPOSAL_MERGE_BY_ID_FIELDS",
"as_the_serializer_stores_it",
- "count_proposals",
"create_proposal",
"get_proposal",
"get_proposal_by_source_id",
diff --git a/products/workflows/backend/facade/revisions.py b/products/workflows/backend/facade/revisions.py
index 59726b2a4683..039063ab37ab 100644
--- a/products/workflows/backend/facade/revisions.py
+++ b/products/workflows/backend/facade/revisions.py
@@ -1,14 +1,8 @@
"""A workflow's version history: one content snapshot per live change, and restoring one into the draft."""
-from products.workflows.backend.services.hog_flow_revisions import (
- count_revisions,
- get_revision,
- list_revisions,
- restore_revision,
-)
+from products.workflows.backend.services.hog_flow_revisions import get_revision, list_revisions, restore_revision
__all__ = [
- "count_revisions",
"get_revision",
"list_revisions",
"restore_revision",
diff --git a/products/workflows/backend/presentation/views/hog_flow.py b/products/workflows/backend/presentation/views/hog_flow.py
index fd14b82ee905..2ee37b09a7c7 100644
--- a/products/workflows/backend/presentation/views/hog_flow.py
+++ b/products/workflows/backend/presentation/views/hog_flow.py
@@ -3,7 +3,7 @@ import json
import uuid as uuid_mod
import hashlib
import dataclasses
-from collections.abc import Callable, Mapping, Sequence
+from collections.abc import Callable, Mapping
from copy import deepcopy
from datetime import datetime, timedelta
from time import monotonic
@@ -30,7 +30,6 @@ from drf_spectacular.utils import (
)
from rest_framework import exceptions, serializers, status, viewsets
from rest_framework.decorators import action
-from rest_framework.pagination import LimitOffsetPagination
from rest_framework.request import Request
from rest_framework.response import Response
from rest_framework.serializers import BaseSerializer
@@ -52,6 +51,7 @@ from posthog.api.app_metrics2 import (
from posthog.api.documentation import _FallbackSerializer
from posthog.api.log_entries import LogEntryMixin
from posthog.api.mixins import ValidatedRequest, validated_request
+from posthog.api.pagination import FacadeLimitOffsetPagination, facade_page_response
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.api.shared import UserBasicSerializer
from posthog.api.tagged_item import (
@@ -67,6 +67,7 @@ from posthog.exceptions_capture import capture_exception
from posthog.helpers.impersonation import is_impersonated
from posthog.models import Team, User
from posthog.models.property.parse import expand_cohort_properties, parse_property_group_data
+from posthog.paging import Page, PageRequest
from posthog.permissions import (
AccessControlPermission,
get_authenticator_scoped_team_ids,
@@ -205,7 +206,6 @@ from products.workflows.backend.facade.contracts import (
WorkflowProposalResolved,
WorkflowRef,
WorkflowRevisionNotFound,
- WorkflowRevisionSummary,
WorkflowSchedule,
WorkflowScheduleNotFound,
WorkflowStale,
@@ -244,7 +244,6 @@ from products.workflows.backend.facade.proposals import (
absolute_window,
approve_proposal,
as_the_serializer_stores_it,
- count_proposals,
create_proposal,
get_proposal,
get_proposal_by_source_id,
@@ -260,7 +259,7 @@ from products.workflows.backend.facade.proposals import (
target_metric_in,
version_outcome,
)
-from products.workflows.backend.facade.revisions import count_revisions, get_revision, list_revisions, restore_revision
+from products.workflows.backend.facade.revisions import get_revision, list_revisions, restore_revision
from products.workflows.backend.facade.schedules import (
compute_next_occurrences,
create_schedule,
@@ -4858,33 +4857,7 @@ def _validate_merge_keys(field: str, items: Any) -> None:
seen.add(key)
-class _RevisionPages:
- """Lets LimitOffsetPagination page revisions in the database, as it did over a queryset."""
-
- def __init__(self, hog_flow_id: uuid_mod.UUID) -> None:
- self.hog_flow_id = hog_flow_id
-
- def count(self) -> int:
- return count_revisions(self.hog_flow_id)
-
- def __getitem__(self, page: slice) -> list[WorkflowRevisionSummary]:
- return list_revisions(self.hog_flow_id, offset=page.start or 0, limit=page.stop - (page.start or 0))
-
-
-class _ProposalPages:
- def __init__(self, hog_flow_id: uuid_mod.UUID, status: str | None) -> None:
- self.hog_flow_id = hog_flow_id
- self.status = status
-
- def count(self) -> int:
- return count_proposals(hog_flow_id=self.hog_flow_id, status=self.status)
-
- def __getitem__(self, page: slice) -> list[WorkflowProposalRecord]:
- offset = page.start or 0
- return list_proposals(hog_flow_id=self.hog_flow_id, status=self.status, offset=offset, limit=page.stop - offset)
-
-
-class HogFlowPagination(LimitOffsetPagination):
+class HogFlowPagination(FacadeLimitOffsetPagination):
default_limit = 100
max_limit = 500
@@ -5116,6 +5089,8 @@ class HogFlowViewSet(
app_source = "hog_flow"
function_kind = "hog_flow"
_workflow_last_runs: dict[uuid_mod.UUID, WorkflowLastRunDTO] | None = None
+ # WorkflowProposalSerializer reads the workflow to tell whether each proposal is stale.
+ _proposals_hog_flow: WorkflowEditState | None = None
@extend_schema(parameters=[HogFlowVersionMetricsRequestSerializer], responses=AppMetricResponseSerializer)
@action(detail=True, methods=["GET"], url_path="metrics/version")
@@ -5258,6 +5233,8 @@ class HogFlowViewSet(
context["event_source"] = get_event_source(self.request)
if self._workflow_last_runs is not None:
context["workflow_last_runs"] = self._workflow_last_runs
+ if self._proposals_hog_flow is not None:
+ context["hog_flow"] = self._proposals_hog_flow
return context
def safely_get_queryset(self, queryset: QuerySet) -> QuerySet:
@@ -5348,40 +5325,34 @@ class HogFlowViewSet(
def list(self, request: Request, *args: Any, **kwargs: Any) -> Response:
query = self._list_query()
- paginator = cast(HogFlowPagination, self.paginator)
- # The default page size always applies, so there is always a limit.
- limit = cast(int, paginator.get_limit(request))
- offset = paginator.get_offset(request)
- try:
- page = list_workflows(
- team_id=self.team_id,
- query=query,
- # Service credentials are synthetic users that UserAccessControl cannot evaluate.
- user_access_control=None if is_service_auth(request) else self.user_access_control,
- # Half implemented: admins may want to list workflows they cannot open.
- include_all_if_admin=request.GET.get("admin_include_all") == "true",
- offset=offset,
- limit=limit,
- )
- except WorkflowListFiltersInvalid as invalid:
- raise exceptions.ValidationError(
- {
- name: [exceptions.ErrorDetail(error.message, code=error.code) for error in errors]
- for name, errors in invalid.errors.items()
- }
- )
- # The MCP summary serializer has no last_run, so only the full list row pays for the lookup.
- if self.get_serializer_class() is HogFlowMinimalSerializer:
- # One lookup for every loop on the page, so each row does not query tasks on its own.
- loop_ids = [flow.id for flow in page.results if flow.origin_product == HogFlowOriginProduct.LOOPS]
- self._workflow_last_runs = list_workflow_last_runs(self.team_id, request.user.id, loop_ids)
+ def fetch(page_request: PageRequest) -> Page[Workflow]:
+ try:
+ page = list_workflows(
+ team_id=self.team_id,
+ query=query,
+ # Service credentials are synthetic users that UserAccessControl cannot evaluate.
+ user_access_control=None if is_service_auth(request) else self.user_access_control,
+ # Half implemented: admins may want to list workflows they cannot open.
+ include_all_if_admin=request.GET.get("admin_include_all") == "true",
+ page=page_request,
+ )
+ except WorkflowListFiltersInvalid as invalid:
+ raise exceptions.ValidationError(
+ {
+ name: [exceptions.ErrorDetail(error.message, code=error.code) for error in errors]
+ for name, errors in invalid.errors.items()
+ }
+ )
+
+ # The MCP summary serializer has no last_run, so only the full list row pays for the lookup.
+ if self.get_serializer_class() is HogFlowMinimalSerializer:
+ # One lookup for every loop on the page, so each row does not query tasks on its own.
+ loop_ids = [flow.id for flow in page.results if flow.origin_product == HogFlowOriginProduct.LOOPS]
+ self._workflow_last_runs = list_workflow_last_runs(self.team_id, request.user.id, loop_ids)
+ return page
- paginator.request = request
- paginator.limit = limit
- paginator.offset = offset
- paginator.count = page.count
- return paginator.get_paginated_response(self.get_serializer(page.results, many=True).data)
+ return facade_page_response(self, fetch)
@validated_request(
query_serializer=SendCalendarQuerySerializer,
@@ -6105,8 +6076,11 @@ class HogFlowViewSet(
# Version history: one snapshot per live-content change, newest first. Content is fetched
# per-version via the detail endpoint — the list stays light.
instance = self._workflow_ref()
- page = self.paginate_queryset(cast(Sequence[Any], _RevisionPages(instance.id)))
- return self.get_paginated_response(HogFlowRevisionBasicSerializer(page, many=True).data)
+ return facade_page_response(
+ self,
+ lambda page: list_revisions(instance.id, page),
+ serializer_class=HogFlowRevisionBasicSerializer,
+ )
@extend_schema(
parameters=[OpenApiParameter("version", int, OpenApiParameter.PATH, description="Workflow version to fetch.")],
@@ -6191,9 +6165,11 @@ class HogFlowViewSet(
raise exceptions.ValidationError(
{"status": f"Must be one of: {', '.join(WorkflowProposalStatus.values)}."}
)
- page = self.paginate_queryset(cast(Sequence[Any], _ProposalPages(instance.id, requested_status or None)))
- return self.get_paginated_response(
- WorkflowProposalSerializer(page, many=True, context={"hog_flow": instance}).data
+ self._proposals_hog_flow = instance
+ return facade_page_response(
+ self,
+ lambda page: list_proposals(hog_flow_id=instance.id, status=requested_status or None, page=page),
+ serializer_class=WorkflowProposalSerializer,
)
param_serializer = WorkflowProposalCreateSerializer(data=request.data)
diff --git a/products/workflows/backend/services/hog_flow_reads.py b/products/workflows/backend/services/hog_flow_reads.py
index 9f8e59bd1d74..e42ea390d215 100644
--- a/products/workflows/backend/services/hog_flow_reads.py
+++ b/products/workflows/backend/services/hog_flow_reads.py
@@ -16,6 +16,8 @@ from django_filters import BooleanFilter, FilterSet
from posthog.api.tagged_item import current_tag_names
from posthog.models import TaggedItem
+from posthog.paging import Page, PageRequest
+from posthog.queryset_paging import select_page
from products.workflows.backend.facade.contracts import (
Workflow,
@@ -26,7 +28,6 @@ from products.workflows.backend.facade.contracts import (
WorkflowListFiltersInvalid,
WorkflowListQuery,
WorkflowNotFound,
- WorkflowPage,
WorkflowRef,
)
from products.workflows.backend.facade.enums import HogFlowScheduleStatus, WorkflowProposalStatus
@@ -214,23 +215,17 @@ def list_workflows(
query: WorkflowListQuery,
user_access_control: "UserAccessControl | None",
include_all_if_admin: bool,
- offset: int,
- limit: int,
-) -> WorkflowPage:
+ page: PageRequest,
+) -> Page[Workflow]:
"""One page of the team's workflows that match `query` and that the reader may see. Pass None
for `user_access_control` to skip the access filter, as a service credential does. Raises
WorkflowListFiltersInvalid when a field filter does not parse."""
queryset = _list_queryset(team_id, query, user_access_control, include_all_if_admin)
- count = queryset.count()
- # The same bounds LimitOffsetPagination applies to a queryset.
- flows = [] if count == 0 or offset > count else list(queryset[offset : offset + limit])
- if user_access_control is not None and flows:
- user_access_control.preload_object_access_controls(cast("list[models.Model]", flows))
+ flows = select_page(queryset, page)
+ if user_access_control is not None and flows.results:
+ user_access_control.preload_object_access_controls(cast("list[models.Model]", flows.results))
template_cache: TemplateCache = {}
- return WorkflowPage(
- count=count,
- results=[_to_workflow(flow, user_access_control, template_cache, with_schedules=False) for flow in flows],
- )
+ return flows.map(lambda flow: _to_workflow(flow, user_access_control, template_cache, with_schedules=False))
def _list_queryset(
diff --git a/products/workflows/backend/services/hog_flow_revisions.py b/products/workflows/backend/services/hog_flow_revisions.py
index 4cdaec5aeda9..67c564197858 100644
--- a/products/workflows/backend/services/hog_flow_revisions.py
+++ b/products/workflows/backend/services/hog_flow_revisions.py
@@ -4,6 +4,9 @@ from uuid import UUID
from django.db import transaction
from django.utils import timezone
+from posthog.paging import Page, PageRequest
+from posthog.queryset_paging import select_page
+
from products.workflows.backend.facade.contracts import (
WorkflowDraftChanged,
WorkflowDraftExists,
@@ -18,21 +21,17 @@ from products.workflows.backend.services.hog_flow_writes import field_values
from products.workflows.backend.services.workflow_proposals import unstage_proposals_for_flow
-def count_revisions(hog_flow_id: UUID) -> int:
- return HogFlowRevision.objects.filter(hog_flow_id=hog_flow_id).count()
-
-
-def list_revisions(hog_flow_id: UUID, *, offset: int, limit: int) -> list[WorkflowRevisionSummary]:
+def list_revisions(hog_flow_id: UUID, page: PageRequest) -> Page[WorkflowRevisionSummary]:
# Content is fetched per version via get_revision, so the list stays light.
revisions = (
HogFlowRevision.objects.filter(hog_flow_id=hog_flow_id)
.order_by("-version")
.select_related("created_by")
- .defer("content")[offset : offset + limit]
+ .defer("content")
+ )
+ return select_page(revisions, page).map(
+ lambda r: WorkflowRevisionSummary(version=r.version, created_at=r.created_at, created_by=r.created_by)
)
- return [
- WorkflowRevisionSummary(version=r.version, created_at=r.created_at, created_by=r.created_by) for r in revisions
- ]
def get_revision(*, hog_flow_id: UUID, version: int) -> WorkflowRevision | None:
diff --git a/products/workflows/backend/services/workflow_proposals.py b/products/workflows/backend/services/workflow_proposals.py
index dd42fa56d4c4..036a27ebac69 100644
--- a/products/workflows/backend/services/workflow_proposals.py
+++ b/products/workflows/backend/services/workflow_proposals.py
@@ -12,6 +12,8 @@ from django.utils import timezone
from posthog.api.app_metrics2 import fetch_app_metric_totals
from posthog.dataclasses import frozen
+from posthog.paging import Page, PageRequest
+from posthog.queryset_paging import select_page
from products.workflows.backend.facade.contracts import CreatedWorkflowProposal, ProposalChanges, WorkflowProposalRecord
from products.workflows.backend.facade.enums import WorkflowProposalStatus
@@ -76,13 +78,9 @@ def _proposals(hog_flow_id: UUID, status: str | None) -> QuerySet[WorkflowPropos
return queryset
-def count_proposals(*, hog_flow_id: UUID, status: str | None) -> int:
- return _proposals(hog_flow_id, status).count()
-
-
-def list_proposals(*, hog_flow_id: UUID, status: str | None, offset: int, limit: int) -> list[WorkflowProposalRecord]:
+def list_proposals(*, hog_flow_id: UUID, status: str | None, page: PageRequest) -> Page[WorkflowProposalRecord]:
queryset = _proposals(hog_flow_id, status).select_related("resolved_by")
- return [_to_record(proposal) for proposal in queryset[offset : offset + limit]]
+ return select_page(queryset, page).map(_to_record)
def get_proposal(*, team_id: int, hog_flow_id: UUID, proposal_id: UUID) -> WorkflowProposalRecord | None:
diff --git a/products/workflows/frontend/generated/api.schemas.ts b/products/workflows/frontend/generated/api.schemas.ts
index 91dfa741f4ee..95e5fe37f053 100644
--- a/products/workflows/frontend/generated/api.schemas.ts
+++ b/products/workflows/frontend/generated/api.schemas.ts
@@ -3120,6 +3120,7 @@ export type HogFlowsListParams = {
latest_send_first?: boolean
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number
/**
@@ -3533,6 +3534,7 @@ export const HogFlowsMetricsVersionRetrieveInterval = {
export type HogFlowsProposalsListParams = {
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number
/**
@@ -3557,6 +3559,7 @@ export const HogFlowsProposalsListStatus = {
export type HogFlowsRevisionsListParams = {
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number
/**
diff --git a/services/mcp/src/api/generated.ts b/services/mcp/src/api/generated.ts
index 27aec3391d5a..331e9f1fbf88 100644
--- a/services/mcp/src/api/generated.ts
+++ b/services/mcp/src/api/generated.ts
@@ -79314,11 +79314,11 @@ export namespace Schemas {
} as const;
/**
- * * `DEBUG` - DEBUG
- * * `LOG` - LOG
- * * `INFO` - INFO
- * * `WARN` - WARN
- * * `ERROR` - ERROR
+ * * `DEBUG` - Debug
+ * * `LOG` - Log
+ * * `INFO` - Info
+ * * `WARN` - Warn
+ * * `ERROR` - Error
*/
export type PluginLogEntryTypeEnum = typeof PluginLogEntryTypeEnum[keyof typeof PluginLogEntryTypeEnum];
@@ -130400,6 +130400,7 @@ export namespace Schemas {
export type CrossProjectDashboardsListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number;
/**
@@ -130411,6 +130412,7 @@ export namespace Schemas {
export type CrossProjectDashboardsTilesListParams = {
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number;
/**
@@ -137701,6 +137703,7 @@ export namespace Schemas {
include_tags?: boolean;
/**
* Number of results to return per page.
+ * @maximum 1000
*/
limit?: number;
/**
@@ -138161,6 +138164,7 @@ export namespace Schemas {
latest_send_first?: boolean;
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number;
/**
@@ -138576,6 +138580,7 @@ export namespace Schemas {
export type HogFlowsProposalsListParams = {
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number;
/**
@@ -138601,6 +138606,7 @@ export namespace Schemas {
export type HogFlowsRevisionsListParams = {
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number;
/**
@@ -141767,15 +141773,51 @@ export namespace Schemas {
export type PluginConfigsLogsListParams = {
/**
- * Number of results to return per page.
+ * Only return entries after this ISO 8601 timestamp.
+ */
+ after?: string;
+ /**
+ * Only return entries before this ISO 8601 timestamp.
+ */
+ before?: string;
+ /**
+ * Maximum number of log entries to return (1-1000, default 100).
+ * @minimum 1
+ * @maximum 1000
*/
limit?: number;
/**
* The initial index from which to return the results.
*/
offset?: number;
+ /**
+ * Case-insensitive substring search across log messages.
+ */
+ search?: string;
+ /**
+ * Log types to include. Repeat the parameter to include more than one type.
+ */
+ type_filter?: PluginConfigsLogsListTypeFilterItem[];
};
+ /**
+ * * `DEBUG` - Debug
+ * * `LOG` - Log
+ * * `INFO` - Info
+ * * `WARN` - Warn
+ * * `ERROR` - Error
+ */
+ export type PluginConfigsLogsListTypeFilterItem = typeof PluginConfigsLogsListTypeFilterItem[keyof typeof PluginConfigsLogsListTypeFilterItem];
+
+
+ export const PluginConfigsLogsListTypeFilterItem = {
+ Debug: 'DEBUG',
+ Log: 'LOG',
+ Info: 'INFO',
+ Warn: 'WARN',
+ Error: 'ERROR',
+ } as const;
+
export type PrecomputeDebugStateParams = {
/**
* Maximum number of hash groups to return (1–200).
@@ -142443,6 +142485,7 @@ export namespace Schemas {
created_by?: number;
/**
* Number of results to return per page.
+ * @maximum 500
*/
limit?: number;
/**
@@ -145806,6 +145849,7 @@ export namespace Schemas {
kind?: WarehouseSuggestionsListKind;
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number;
/**
@@ -146055,6 +146099,7 @@ export namespace Schemas {
created_after?: string;
/**
* Number of results to return per page.
+ * @maximum 100
*/
limit?: number;
/**
@@ -146092,7 +146137,7 @@ export namespace Schemas {
export type WizardSessionsListParams = {
/**
* Maximum number of sessions to return.
- * @minimum 0
+ * @minimum 1
* @maximum 200
*/
limit?: number;
diff --git a/services/mcp/src/generated/cross_project_dashboards/api.ts b/services/mcp/src/generated/cross_project_dashboards/api.ts
index 50002d1ebc25..f2e47857667e 100644
--- a/services/mcp/src/generated/cross_project_dashboards/api.ts
+++ b/services/mcp/src/generated/cross_project_dashboards/api.ts
@@ -19,8 +19,14 @@ export const CrossProjectDashboardsListParams = () => zod.object({
),
})
+export const crossProjectDashboardsListQueryLimitMax = 100
+
export const CrossProjectDashboardsListQueryParams = () => zod.object({
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod
+ .number()
+ .max(crossProjectDashboardsListQueryLimitMax)
+ .optional()
+ .describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
})
@@ -39,8 +45,14 @@ export const CrossProjectDashboardsTilesListParams = () => zod.object({
),
})
+export const crossProjectDashboardsTilesListQueryLimitMax = 100
+
export const CrossProjectDashboardsTilesListQueryParams = () => zod.object({
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod
+ .number()
+ .max(crossProjectDashboardsTilesListQueryLimitMax)
+ .optional()
+ .describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
})
diff --git a/services/mcp/src/generated/replay/api.ts b/services/mcp/src/generated/replay/api.ts
index 42f1cca9bf09..4603199076dc 100644
--- a/services/mcp/src/generated/replay/api.ts
+++ b/services/mcp/src/generated/replay/api.ts
@@ -25,9 +25,15 @@ export const SessionRecordingPlaylistsListParams = () => zod.object({
),
})
+export const sessionRecordingPlaylistsListQueryLimitMax = 500
+
export const SessionRecordingPlaylistsListQueryParams = () => zod.object({
created_by: zod.number().optional(),
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod
+ .number()
+ .max(sessionRecordingPlaylistsListQueryLimitMax)
+ .optional()
+ .describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
short_id: zod.string().optional(),
})
diff --git a/services/mcp/src/generated/warehouse_suggestions/api.ts b/services/mcp/src/generated/warehouse_suggestions/api.ts
index 08326cf52745..2ee3cca48a14 100644
--- a/services/mcp/src/generated/warehouse_suggestions/api.ts
+++ b/services/mcp/src/generated/warehouse_suggestions/api.ts
@@ -16,6 +16,8 @@ export const WarehouseSuggestionsListParams = () => zod.object({
),
})
+export const warehouseSuggestionsListQueryLimitMax = 100
+
export const WarehouseSuggestionsListQueryParams = () => zod.object({
assignee_id: zod.number().optional().describe('Only return suggestions assigned to the user with this ID.'),
kind: zod
@@ -24,7 +26,11 @@ export const WarehouseSuggestionsListQueryParams = () => zod.object({
.describe(
'Only return suggestions of this kind.\n\n\* `certify` - Certify\n\* `deprecate` - Deprecate\n\* `materialize` - Materialize\n\* `unmaterialize` - Unmaterialize'
),
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod
+ .number()
+ .max(warehouseSuggestionsListQueryLimitMax)
+ .optional()
+ .describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
status: zod
.enum(['proposed', 'accepted', 'dismissed', 'expired', 'auto_resolved'])
diff --git a/services/mcp/src/generated/workflows/api.ts b/services/mcp/src/generated/workflows/api.ts
index c1f4e3bb9840..065e4831fd23 100644
--- a/services/mcp/src/generated/workflows/api.ts
+++ b/services/mcp/src/generated/workflows/api.ts
@@ -16,6 +16,8 @@ export const HogFlowsListParams = () => zod.object({
),
})
+export const hogFlowsListQueryLimitMax = 500
+
export const HogFlowsListQueryParams = () => zod.object({
broadcast_eligible: zod
.boolean()
@@ -38,7 +40,7 @@ export const HogFlowsListQueryParams = () => zod.object({
.describe(
"Pass `true` to order by when each workflow's newest completed run finished, newest first. Workflows that never finished a run come last."
),
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod.number().max(hogFlowsListQueryLimitMax).optional().describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
optimization_enabled: zod.boolean().optional().describe('Only workflows someone turned suggestions on for.'),
origin_product: zod
@@ -1176,8 +1178,14 @@ export const HogFlowsProposalsListParams = () => zod.object({
),
})
+export const hogFlowsProposalsListQueryLimitMax = 500
+
export const HogFlowsProposalsListQueryParams = () => zod.object({
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod
+ .number()
+ .max(hogFlowsProposalsListQueryLimitMax)
+ .optional()
+ .describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
status: zod
.enum(['applied', 'approved', 'rejected', 'suggested'])
@@ -1275,8 +1283,14 @@ export const HogFlowsRevisionsListParams = () => zod.object({
),
})
+export const hogFlowsRevisionsListQueryLimitMax = 500
+
export const HogFlowsRevisionsListQueryParams = () => zod.object({
- limit: zod.number().optional().describe('Number of results to return per page.'),
+ limit: zod
+ .number()
+ .max(hogFlowsRevisionsListQueryLimitMax)
+ .optional()
+ .describe('Number of results to return per page.'),
offset: zod.number().optional().describe('The initial index from which to return the results.'),
})
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/session-recording-playlists-list.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/session-recording-playlists-list.json
index 411d2518a97b..d30a11f7f7d8 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/session-recording-playlists-list.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/session-recording-playlists-list.json
@@ -6,6 +6,7 @@
},
"limit": {
"description": "Number of results to return per page.",
+ "maximum": 500,
"type": "number"
},
"offset": {
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/warehouse-suggestions-list.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/warehouse-suggestions-list.json
index 6c689fce39a6..669efa93c7ee 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/warehouse-suggestions-list.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/warehouse-suggestions-list.json
@@ -12,6 +12,7 @@
},
"limit": {
"description": "Number of results to return per page.",
+ "maximum": 100,
"type": "number"
},
"offset": {
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-proposals.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-proposals.json
index 3ee82c13aa9e..a7f8d5fbb1ee 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-proposals.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-proposals.json
@@ -7,6 +7,7 @@
},
"limit": {
"description": "Number of results to return per page.",
+ "maximum": 500,
"type": "number"
},
"offset": {
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-revisions.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-revisions.json
index 42d84da8dd75..bc3ba46a4067 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-revisions.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-revisions.json
@@ -7,6 +7,7 @@
},
"limit": {
"description": "Number of results to return per page.",
+ "maximum": 500,
"type": "number"
},
"offset": {
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-versions.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-versions.json
index 42d84da8dd75..bc3ba46a4067 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-versions.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list-versions.json
@@ -7,6 +7,7 @@
},
"limit": {
"description": "Number of results to return per page.",
+ "maximum": 500,
"type": "number"
},
"offset": {
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list.json
index 438c56b10baf..48119e241016 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/workflows-list.json
@@ -27,6 +27,7 @@
},
"limit": {
"description": "Number of results to return per page.",
+ "maximum": 500,
"type": "number"
},
"offset": {