Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions ee/api/ee_event_definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from drf_spectacular.extensions import OpenApiSerializerExtension
from rest_framework import serializers

from posthog.api.object_media_preview import visible_previews, with_preview_media
from posthog.api.shared import UserBasicSerializer
from posthog.api.tagged_item import TaggedItemSerializerMixin
from posthog.event_usage import groups
Expand Down Expand Up @@ -247,9 +248,7 @@ def get_media_preview_urls(self, obj) -> list[str]:

if not obj.id:
return []
previews = (
ObjectMediaPreview.objects.filter(event_definition_id=obj.id)
.select_related("uploaded_media", "exported_asset")
.order_by("-updated_at")
previews = with_preview_media(ObjectMediaPreview.objects.filter(event_definition_id=obj.id)).order_by(
"-updated_at"
)
return [p.media_url for p in previews if p.media_url]
return [p.media_url for p in visible_previews(previews, self.context.get("view")) if p.media_url]
28 changes: 28 additions & 0 deletions ee/api/test/test_event_definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
from posthog.models import ActivityLog, ObjectMediaPreview, Tag, Team, UploadedMedia, User

from products.event_definitions.backend.models.event_definition import EventDefinition
from products.exports.backend.models.exported_asset import ExportedAsset

from ee.models.event_definition import EnterpriseEventDefinition
from ee.models.license import License, LicenseManager
Expand Down Expand Up @@ -905,6 +906,33 @@ def test_list_includes_media_preview_urls(self):
assert len(event_data["media_preview_urls"]) == 1
assert "uploaded_media" in event_data["media_preview_urls"][0]

@parameterized.expand(
[
("other_members_export", None, False),
("event_screenshot", "session-1", True),
]
)
def test_media_preview_urls_follow_export_access(self, _name, session_recording_id, expects_url):
super(LicenseManager, cast(LicenseManager, License.objects)).create(
plan="enterprise", valid_until=datetime(2500, 1, 19, 3, 14, 7)
)
other_user = User.objects.create_and_join(self.organization, "other@example.com", "password")
event = EnterpriseEventDefinition.objects.create(team=self.demo_team, name="event_with_export")
asset = ExportedAsset.objects.create(
team=self.demo_team,
export_format="image/png",
created_by=None if session_recording_id else other_user,
export_context={"session_recording_id": session_recording_id} if session_recording_id else None,
)
ObjectMediaPreview.objects.create(team=self.demo_team, event_definition=event, exported_asset=asset)

list_response = self.client.get("/api/projects/@current/event_definitions/")
retrieve_response = self.client.get(f"/api/projects/@current/event_definitions/{event.id}")

listed = next(r for r in list_response.json()["results"] if r["name"] == "event_with_export")
for urls in (listed["media_preview_urls"], retrieve_response.json()["media_preview_urls"]):
assert len(urls) == (1 if expects_url else 0)

def test_list_media_preview_urls_empty_when_no_media(self):
"""Events without media previews return empty media_preview_urls."""
super(LicenseManager, cast(LicenseManager, License.objects)).create(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
paramsToProps: ({ params: { id } }) => ({ id: decodeDefinitionId(id) }),
}

export function DefinitionEdit(rawProps: DefinitionLogicProps): JSX.Element {

Check warning on line 60 in frontend/src/scenes/data-management/definition/DefinitionEdit.tsx

View workflow job for this annotation

GitHub Actions / Frontend formatting

lint:complexity

`DefinitionEdit` has cyclomatic complexity 33 (warn >10)
// The app renders scene components with raw route params, so decode the id like paramsToProps does
const props = { ...rawProps, id: decodeDefinitionId(rawProps.id) }
const logic = definitionEditLogic(props)
Expand All @@ -76,6 +76,8 @@
const showHiddenOption = 'hidden' in editDefinition

const { previews, previewsLoading } = useValues(definitionLogicInstance)
// A preview without a URL has nothing to show, and the delete handler below matches previews by URL
const visiblePreviews = previews?.filter((p: ObjectMediaPreview) => p.media_url) ?? []
const { createMediaPreview, deleteMediaPreview } = useActions(definitionLogicInstance)

const { setFilesToUpload, filesToUpload, uploading } = useUploadFiles({
Expand Down Expand Up @@ -268,12 +270,12 @@
/>
</div>

{(previewsLoading || (previews && previews.length > 0)) && (
{(previewsLoading || visiblePreviews.length > 0) && (
<ImageCarousel
loading={previewsLoading}
imageUrls={previews?.map((p: ObjectMediaPreview) => p.media_url) ?? []}
imageUrls={visiblePreviews.map((p: ObjectMediaPreview) => p.media_url)}
onDelete={(url: string) => {
const preview = previews.find(
const preview = visiblePreviews.find(
(p: ObjectMediaPreview) => p.media_url === url
)
if (preview) {
Expand Down
9 changes: 4 additions & 5 deletions posthog/api/event_definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
from posthog.api.event_definition_generators.golang import GolangGenerator
from posthog.api.event_definition_generators.python import PythonGenerator
from posthog.api.event_definition_generators.typescript import TypeScriptGenerator
from posthog.api.object_media_preview import visible_previews, with_preview_media
from posthog.api.pagination import CappedCountLimitOffsetPagination
from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.api.shared import UserBasicSerializer
Expand Down Expand Up @@ -434,7 +435,7 @@
search_fields = ["name"]
ordering_fields = ["name", "last_seen_at", "created_at"]

def dangerously_get_queryset(self):

Check warning on line 438 in posthog/api/event_definition.py

View workflow job for this annotation

GitHub Actions / Python code quality (depot-ubuntu-24.04)

lint:complexity

`dangerously_get_queryset` has cyclomatic complexity 12 (warn >10)

Check warning on line 438 in posthog/api/event_definition.py

View workflow job for this annotation

GitHub Actions / Python code quality (depot-ubuntu-24.04)

`dangerously_get_queryset` has cyclomatic complexity 12 (warn >10)
# Only `event_custom` and `event_posthog` change the rows, in `_event_definitions_source_sql`.
event_type = self._requested_event_type()

Expand Down Expand Up @@ -783,12 +784,10 @@
event_ids = [obj.id for obj in objects]
media_map: dict[str, list[str]] = defaultdict(list)
if event_ids:
previews = (
previews = with_preview_media(
ObjectMediaPreview.objects.filter(event_definition_id__in=event_ids)
.select_related("uploaded_media", "exported_asset")
.order_by("-updated_at")
)
for p in previews:
).order_by("-updated_at")
for p in visible_previews(previews, self):
if p.media_url:
media_map[str(p.event_definition_id)].append(p.media_url)

Expand Down
195 changes: 146 additions & 49 deletions posthog/api/object_media_preview.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
import uuid
from collections.abc import Iterable

from django.db.models import QuerySet

from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import OpenApiParameter, extend_schema
from rest_framework import serializers, status, viewsets
from rest_framework.decorators import action
from rest_framework.exceptions import ValidationError
Expand All @@ -7,18 +14,84 @@

from posthog.api.routing import TeamAndOrgViewSetMixin
from posthog.models import ObjectMediaPreview, UploadedMedia
from posthog.permissions import is_scout_sandbox_request
from posthog.models.utils import strict_fetch
from posthog.permissions import is_scout_sandbox_request, scopes_caller_lacks
from posthog.taxonomy.scout_writes import refuse_scout_taxonomy_write

from products.event_definitions.backend.models import EventDefinition
from products.exports.backend.facade.auth import viewable_exported_asset_ids


def with_preview_media(queryset: QuerySet[ObjectMediaPreview]) -> QuerySet[ObjectMediaPreview]:
# An export's content column can hold the whole file when object storage is off, and no preview path reads it
return queryset.select_related("uploaded_media", "exported_asset").defer("exported_asset__content")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 · Preload the export relations used to build preview URLs

With DEBUG or TEST enabled, listing an authorized insight/dashboard preview without export_context.filename raises FieldFetchBlocked. strict_fetch() propagates to the asset, and ExportedAsset.filename reads its unloaded relations. Eagerly load both relations, as the endpoint guide requires.



PREFERRED_EXPORTED_SCAN_LIMIT = 50


def visible_exported_asset_ids(previews: Iterable[ObjectMediaPreview], view: object) -> set[int]:
"""Ids of the exported assets behind these previews that the requesting user may read.

An exported asset's URL is a long-lived token that works without a session, so it is only handed to
viewers the exports API would serve the asset to: the user must pass its access checks, and a scoped
token must hold `export:read`. Without a request user and access control, no exported asset is visible.
"""
request = getattr(view, "request", None)
user_access_control = getattr(view, "user_access_control", None)
user_id = getattr(getattr(request, "user", None), "id", None)
team_id = getattr(view, "team_id", None)
asset_ids = {preview.exported_asset_id for preview in previews if preview.exported_asset_id is not None}
if user_access_control is None or user_id is None or team_id is None or not asset_ids:
return set()
if scopes_caller_lacks(request, ["export:read"]):
return set()
return viewable_exported_asset_ids(
asset_ids, team_id=team_id, user_id=user_id, user_access_control=user_access_control
)


def visible_previews(previews: Iterable[ObjectMediaPreview], view: object) -> list[ObjectMediaPreview]:
"""The previews the requesting user may see, in their original order."""
previews = list(previews)
visible_ids = visible_exported_asset_ids(previews, view)
return [
preview
for preview in previews
if preview.uploaded_media_id or (preview.exported_asset_id and preview.exported_asset_id in visible_ids)
]


def _as_uuids(values: Iterable[object]) -> list[uuid.UUID]:
"""The values that parse as UUIDs. A malformed id in the URL then matches nothing instead of raising."""
parsed = []
for value in values:
try:
parsed.append(uuid.UUID(str(value)))
except ValueError:
pass
return parsed


class ObjectMediaPreviewSerializer(serializers.ModelSerializer):
media_url = serializers.SerializerMethodField()
media_type = serializers.SerializerMethodField()
uploaded_media_id = serializers.UUIDField(write_only=True, required=False, allow_null=True)
exported_asset_id = serializers.UUIDField(write_only=True, required=False, allow_null=True)
event_definition_id = serializers.UUIDField(write_only=True, required=False, allow_null=True)
media_url = serializers.SerializerMethodField(
help_text="URL of the preview image. For an exported asset this is a signed link that works without a session."
)
media_type = serializers.SerializerMethodField(
help_text="Where the image comes from: 'uploaded' for user-uploaded media, 'exported' for an exported asset."
)
uploaded_media_id = serializers.UUIDField(
write_only=True,
required=False,
allow_null=True,
help_text="ID of uploaded media in this project to use as the preview. Required when creating a preview.",
)
event_definition_id = serializers.UUIDField(
write_only=True,
required=False,
allow_null=True,
help_text="ID of the event definition the preview belongs to. Required when creating a preview.",
)

class Meta:
model = ObjectMediaPreview
Expand All @@ -30,13 +103,18 @@ class Meta:
"media_type",
"metadata",
"uploaded_media_id",
"exported_asset_id",
"event_definition_id",
)
read_only_fields = ("id", "created_at", "updated_at", "media_url", "media_type")

def get_media_url(self, obj: ObjectMediaPreview) -> str:
return obj.media_url
if obj.uploaded_media_id:
return obj.media_url
# The viewset leaves out previews the viewer may not read and passes the asset ids it allowed. A
# serializer used without that context therefore returns no long-lived token for an exported asset.
if obj.exported_asset_id and obj.exported_asset_id in self.context.get("visible_exported_asset_ids", set()):
return obj.media_url
return ""

def get_media_type(self, obj: ObjectMediaPreview) -> str:
"""Return 'uploaded' or 'exported' based on which media is set"""
Expand All @@ -50,31 +128,18 @@ def create(self, validated_data):
team = self.context["get_team"]()

uploaded_media_id = validated_data.pop("uploaded_media_id", None)
exported_asset_id = validated_data.pop("exported_asset_id", None)
event_definition_id = validated_data.pop("event_definition_id", None)

if bool(uploaded_media_id) + bool(exported_asset_id) != 1:
raise ValidationError("Exactly one of uploaded_media_id or exported_asset_id must be provided")
if not uploaded_media_id:
raise ValidationError("uploaded_media_id must be provided")

if not event_definition_id:
raise ValidationError("event_definition_id must be provided")

uploaded_media = None
exported_asset = None

if uploaded_media_id:
try:
uploaded_media = UploadedMedia.objects.get(id=uploaded_media_id, team=team)
except UploadedMedia.DoesNotExist:
raise ValidationError("Uploaded media not found or does not belong to this team")

if exported_asset_id:
from products.exports.backend.models.exported_asset import ExportedAsset

try:
exported_asset = ExportedAsset.objects.get(id=exported_asset_id, team=team)
except ExportedAsset.DoesNotExist:
raise ValidationError("Exported asset not found or does not belong to this team")
try:
uploaded_media = UploadedMedia.objects.get(id=uploaded_media_id, team=team)
except UploadedMedia.DoesNotExist:
raise ValidationError("Uploaded media not found or does not belong to this team")

try:
event_definition = EventDefinition.objects.get(id=event_definition_id, team=team)
Expand All @@ -84,7 +149,6 @@ def create(self, validated_data):
preview = ObjectMediaPreview.objects.create(
team=team,
uploaded_media=uploaded_media,
exported_asset=exported_asset,
event_definition=event_definition,
**validated_data,
)
Expand All @@ -106,18 +170,50 @@ def check_permissions(self, request: Request) -> None:
refuse_scout_taxonomy_write(is_scout_sandbox_request(request))

def safely_get_queryset(self, queryset):
# Filter by event_definition if provided
# The mixin applies its team filter only after this method returns, and the access check below
# loads every exported preview in the queryset, so scope to the team first.
queryset = (
with_preview_media(queryset.filter(team_id=self.team_id))
.select_related("event_definition")
.order_by("-updated_at", "-id")
)
event_definition_id = self.request.query_params.get("event_definition")
if self.action == "list" and not event_definition_id:
raise ValidationError("event_definition query parameter is required")
if event_definition_id:
return (
queryset.filter(event_definition_id=event_definition_id)
.select_related("uploaded_media", "exported_asset", "event_definition")
.order_by("-updated_at", "-id")
)
queryset = queryset.filter(event_definition_id=event_definition_id)
if self.action == "list":
queryset = strict_fetch(queryset)
return self._without_hidden_exports(queryset)

return queryset.select_related("uploaded_media", "exported_asset", "event_definition").order_by(
"-updated_at", "-id"
)
def _without_hidden_exports(self, queryset):
# Hidden previews are removed from the result, not returned with an empty URL, because their metadata
# (session id, page URL) is about the recording the viewer may not read.
exported_previews = queryset.filter(exported_asset__isnull=False)
if self.kwargs.get("pk"):
exported_previews = exported_previews.filter(pk__in=_as_uuids([self.kwargs["pk"]]))
exported = list(exported_previews)
self._visible_exported_asset_ids = visible_exported_asset_ids(exported, self)
hidden_ids = [p.id for p in exported if p.exported_asset_id not in self._visible_exported_asset_ids]
return queryset.exclude(id__in=hidden_ids) if hidden_ids else queryset

def get_serializer_context(self):
context = super().get_serializer_context()
context["visible_exported_asset_ids"] = getattr(self, "_visible_exported_asset_ids", set())
return context

@extend_schema(
parameters=[
OpenApiParameter(
"event_definition",
OpenApiTypes.UUID,
required=True,
description="ID of the event definition whose previews to list.",
)
]
)
def list(self, request, *args, **kwargs):
return super().list(request, *args, **kwargs)

@action(methods=["GET"], detail=False, url_path="preferred_for_event")
def preferred_for_event(self, request, *args, **kwargs):
Expand Down Expand Up @@ -146,20 +242,21 @@ def preferred_for_event(self, request, *args, **kwargs):
serializer = self.get_serializer(user_uploaded)
return Response(serializer.data)

# Fall back to most recent exported asset
exported = (
ObjectMediaPreview.objects.filter(
event_definition_id=event_definition_id,
team=self.team,
exported_asset__isnull=False,
exported = list(
with_preview_media(
ObjectMediaPreview.objects.filter(
event_definition_id=event_definition_id,
team=self.team,
exported_asset__isnull=False,
)
)
.select_related("exported_asset", "event_definition")
.order_by("-updated_at", "-id")
.first()
.select_related("event_definition")
.order_by("-updated_at", "-id")[:PREFERRED_EXPORTED_SCAN_LIMIT]
)
self._visible_exported_asset_ids = visible_exported_asset_ids(exported, self)
preferred = next((p for p in exported if p.exported_asset_id in self._visible_exported_asset_ids), None)

if exported:
serializer = self.get_serializer(exported)
return Response(serializer.data)
if preferred:
return Response(self.get_serializer(preferred).data)

return Response({"detail": "No media preview found"}, status=status.HTTP_404_NOT_FOUND)
Loading
Loading