Track and display "viewed by" avatars for replays

[IanWoodard]

Problem Statement

When looking through replays, I often find myself clicking on the same one multiple times thinking I haven't seen it when I already have. Currently there is no indication if you (or any of your teammates) have already seen a given replay.

Solution Brainstorm

One solution would be to take a similar approach to issues and bolden the titles of the replays you haven't seen before, and possibly show a list of viewers for each replay.

Product Area

Replays

[getsantry]

Routing to @getsentry/product-owners-replays for triage ⏲️

[ryan953]

cc @cmanallen for onboarding

[cmanallen]

@aliu3ntry This would be a cool feature to add and I think well within your capabilities.

1. We need a database model capable of tracking the user_id and replay_id.
   • Will require a migration.
2. We need an API endpoint which can retrieve all of the users who have viewed a replay.
3. We need an API endpoint which can create a new replay_id <> user_id row.
4. The Javascript web app needs to be able to fetch and write to these endpoints.
   • Create a new resource blueprint in replays/blueprints/api.md
5. Schedule a meeting with relevent members of the replay engineering team or bring it up at our weekly engineering sync on Wednesday.

Start with the blueprint. Think about the use cases, how you want to store the data, how you want to present it to clients.

[cmanallen]

@aliu3ntry

• Add a new field to the /replays query has_viewed. A boolean which returns true if the currently authorized user appears in the set.
• Create a viewed-by endpoint in sentry/replays/endpoints.
  • Add one method for the GET operation and one method for the POST operation.
  • It should return response data matching the blueprint.

  • sentry/src/sentry/replays/blueprints/api.md

    Line 615 in bd8b048

    ## Replay Viewed By [/organizations/<organization_slug>/replays/<replay_id>/viewed-by/]

• Register the endpoints in sentry/api/urls.py
• Add a new viewed_by_id attribute to the entity and storage schemas.
  • https://github.com/getsentry/snuba/blob/87f601a85dcead059a1d6573d2d39205442b999c/snuba/datasets/configuration/replays/entities/replays.yaml#L1
  • https://github.com/getsentry/snuba/blob/87f601a85dcead059a1d6573d2d39205442b999c/snuba/datasets/configuration/replays/storages/replays.yaml#L1
• Create a Snuba migration for the new attribute.
  • https://github.com/getsentry/snuba/blob/87f601a85dcead059a1d6573d2d39205442b999c/snuba/snuba_migrations/replays/0017_add_component_name_column.py#L1
• Update the rust snuba processor to accept a new viewed message type.
  • Example: https://github.com/getsentry/snuba/blob/87f601a85dcead059a1d6573d2d39205442b999c/rust_snuba/src/processors/replays.rs#L342-L359
  • This must be done on a separate PR from the schema changes.
  • Migrations are merged before the processor.
• On POST publish a message to the replay topic containing the currently authorized user's ID. This message should use the format defined in the processor.
• Add test coverage for each endpoint.
  • If you're unsure what to do, reference the issues platform code. How do they test this behavior? Can some of it be copied?
  • The group-details test module is very large but it covers a lot of behavior unrelated to viewing issues.

  • sentry/tests/sentry/api/endpoints/test_group_details.py

    Line 1 in b4a1e5f

    from datetime import timedelta

• Add mock functions for generating replay-viewed rows.
  • This will be useful for testing the endpoints.

[ryan953]

We're going to mark the replay as viewed if:

You land on the Replay Details page
You play a replay-clip from within anywhere in the app (ie: issue-details, feedback, profiling, etc).

[cmanallen]

@aliu3ntry Check out the GroupSeen serializer https://github.com/getsentry/sentry/blob/b4a1e5f349864dcc3d6026ba08b24f9ea0557e0c/src/sentry/api/serializers/models/groupseen.py#L6-L25

How its called is unimportant. Look at the code paths in the function. You should be able to reproduce something for replays (we don't need a serializer class).