feat: canvas replay #19583

daibhin · 2024-01-03T18:37:24Z

Problem

Related to PostHog/posthog-js#946 and #14555

Provide config via decide & playback canvas mutation events

Changes

Implement plugin to replace canvas with decoded image from event
Add new session_recording_config to store all future settings related to replay in a single bag
Add feature flag to prevent setting up the feature unless enabled
Add settings to enable / disable canvas recording with warning about PII

How did you test this code?

Wrote team & decide tests

Jan-19-2024.17-39-57.mp4

daibhin · 2024-01-03T18:38:02Z

frontend/src/scenes/session-recordings/player/rrweb/canvas/canvas-plugin.ts

+import { CanvasArg, type canvasMutationData, type canvasMutationParam, eventWithTime } from '@rrweb/types'
+import { EventType, IncrementalSource, Replayer } from 'rrweb'
+// TODO: figure out how to import this method
+import canvasMutation from 'rrweb/es/rrweb/packages/rrweb/src/replay/canvas'


Hoping to get this in via rrweb-io/rrweb#1383

marandaneto · 2024-01-04T14:24:04Z

posthog/api/test/__snapshots__/test_decide.ambr

@@ -89,22 +87,6 @@
  LIMIT 21 /*controller='team-detail',route='api/projects/%28%3FP%3Cid%3E%5B%5E/.%5D%2B%29/%3F%24'*/
  '
 ---
-# name: TestDecide.test_decide_doesnt_error_out_when_database_is_down.10


Nice cleaning up

marandaneto · 2024-01-04T14:25:10Z

posthog/api/team.py

+        if not all(key in ["record_canvas"] for key in value.keys()):
+            raise exceptions.ValidationError("Must provide a dictionary with only 'record_canvas' key.")


Maybe it should not be a dictionary then?

Ah, I'd forgotten my pre-xmas good citizen push that we should move session replay config into one place so we can stop adding more nad more columns to the team model

Maybe we should get this in and then I use it for the config in #19887

posthog-bot · 2024-01-16T07:31:08Z

This PR hasn't seen activity in a week! Should it be merged, closed, or further worked on? If you want to keep it open, post a comment or remove the stale label – otherwise this will be closed in another week.

github-actions · 2024-01-19T18:04:21Z

Size Change: +46 B (0%)

Total Size: 2 MB

ℹ️ View Unchanged

Filename	Size	Change
`frontend/dist/toolbar.js`	2 MB	+46 B (0%)

_{compressed-size-action}

pauldambra

👍 I can validate that it doesn't break existing recordings :)

How do I test canvas recordings? (maybe being silly)

pauldambra · 2024-01-22T11:39:30Z

frontend/src/scenes/session-recordings/player/sessionRecordingPlayerLogic.ts

@@ -526,6 +527,10 @@ export const sessionRecordingPlayerLogic = kea<sessionRecordingPlayerLogicType>(
                plugins.push(CorsPlugin)
            }

+            if (values.featureFlags[FEATURE_FLAGS.SESSION_REPLAY_CANVAS]) {


is it possible to get in a state where I'm collecting canvas recordings but this flag is off?

not blocking here but we should have a good story for "this replay has a canvas in it"

also makes me think it'd be good to have a PostHog insight showing web vs android vs canvas vs etc playback so we can measure feature usage

Yes, possibly could be. We should also consider in future that recordings might be captured with canvas and then the config option is turned off. Should we continue to playback recordings with the canvas or not in that situation 🤔

Good news is that it's pretty easy to know if a recording contains a canvas in the rrweb plugin during playback

pauldambra · 2024-01-22T11:42:28Z

posthog/api/team.py

+        if not all(key in ["record_canvas"] for key in value.keys()):
+            raise exceptions.ValidationError("Must provide a dictionary with only 'record_canvas' key.")


Ah, I'd forgotten my pre-xmas good citizen push that we should move session replay config into one place so we can stop adding more nad more columns to the team model

Maybe we should get this in and then I use it for the config in #19887

pauldambra · 2024-01-22T11:44:08Z

posthog/models/team/team.py

@@ -184,6 +184,7 @@ class Team(UUIDClassicModel):
    )
    session_recording_linked_flag: models.JSONField = models.JSONField(null=True, blank=True)
    session_recording_network_payload_capture_config: models.JSONField = models.JSONField(null=True, blank=True)
+    session_recording_config: models.JSONField = models.JSONField(null=True, blank=True)


nitpicking... should it be session_replay_config? (am open to be convinced not :))

Nope, think you're right

pauldambra · 2024-01-22T11:53:24Z

Occurs to me that we've added a bunch of stuff to config... Maybe we should be tagging them with LemonTag<"NEW"> so folk can see what has changed?

daibhin · 2024-01-22T12:21:55Z

@pauldambra it's a little tricky / awkward. I added a /canvas route to the NextJS playgorund app in posthog-js. I run that app with NEXT_PUBLIC_POSTHOG_KEY=<% ph_local_key %> NEXT_PUBLIC_POSTHOG_HOST=http://localhost:8000 yarn dev to point at my local instance.

I also have an exported recording that I can send you 😄

daibhin added 12 commits December 28, 2023 09:45

feat: canvas replay

4c97723

Merge branch 'master' into dn-feat/canvas-replay

f26b5a8

allow canvas replay

e142002

implement canvas image snapshotting

b31cfe0

Merge branch 'master' into dn-feat/canvas-replay

11dd3d1

replicate unimported files

74fda4c

remove unnecessary replay flag

bf2fd51

Merge branch 'master' into dn-feat/canvas-replay

0cf8814

add feature flagged canvas recording settings

6f695be

include settings migration

cd3bc4a

tdd decide response

e98434b

cleanup canvasMutation import

ff770d3

daibhin commented Jan 3, 2024

View reviewed changes

daibhin changed the title ~~Dn feat/canvas replay~~ feat: canvas replay Jan 3, 2024

marandaneto reviewed Jan 4, 2024

View reviewed changes

posthog-bot added the stale label Jan 16, 2024

marandaneto removed the stale label Jan 16, 2024

daibhin added 4 commits January 18, 2024 16:16

Merge branch 'master' into dn-feat/canvas-replay

272fb38

update migration

c35814b

Merge branch 'master' into dn-feat/canvas-replay

aad21d8

canvas playback

8fde514

daibhin force-pushed the dn-feat/canvas-replay branch from 21514d4 to 8fde514 Compare January 19, 2024 17:41

daibhin requested a review from a team January 19, 2024 17:42

daibhin added 2 commits January 22, 2024 11:22

Merge branch 'master' into dn-feat/canvas-replay

5cfd8ac

cleanup

03f508e

daibhin force-pushed the dn-feat/canvas-replay branch from 5726a7d to 03f508e Compare January 22, 2024 11:25

pauldambra approved these changes Jan 22, 2024

View reviewed changes

daibhin added 3 commits January 22, 2024 12:28

add new label

0087042

rename column

d4e5183

fix tests

5855334

daibhin force-pushed the dn-feat/canvas-replay branch from 9c094ba to 5855334 Compare January 22, 2024 14:21

daibhin added 2 commits January 22, 2024 14:31

Merge branch 'master' into dn-feat/canvas-replay

ea9d7db

make new badge success

d6a7660

daibhin force-pushed the dn-feat/canvas-replay branch from 87acdc6 to d6a7660 Compare January 22, 2024 14:32

update snapshot

e0993a9

daibhin force-pushed the dn-feat/canvas-replay branch from 839f073 to e0993a9 Compare January 22, 2024 15:14

github-actions bot added 5 commits January 22, 2024 15:20

Update query snapshots

38bfddd

Update query snapshots

fadd150

Update query snapshots

4a7e848

Update query snapshots

ea4d85a

Update query snapshots

caa2c4d

daibhin merged commit ed87468 into master Jan 22, 2024
100 checks passed

daibhin deleted the dn-feat/canvas-replay branch January 22, 2024 15:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: canvas replay #19583

feat: canvas replay #19583

daibhin commented Jan 3, 2024 •

edited

Loading

daibhin Jan 3, 2024

marandaneto Jan 4, 2024

marandaneto Jan 4, 2024

pauldambra Jan 22, 2024

posthog-bot commented Jan 16, 2024

github-actions bot commented Jan 19, 2024 •

edited

Loading

pauldambra left a comment

pauldambra Jan 22, 2024

pauldambra Jan 22, 2024

daibhin Jan 22, 2024

pauldambra Jan 22, 2024

pauldambra Jan 22, 2024

daibhin Jan 22, 2024

pauldambra commented Jan 22, 2024

daibhin commented Jan 22, 2024

		if not all(key in ["record_canvas"] for key in value.keys()):
		raise exceptions.ValidationError("Must provide a dictionary with only 'record_canvas' key.")

feat: canvas replay #19583

feat: canvas replay #19583

Conversation

daibhin commented Jan 3, 2024 • edited Loading

Problem

Changes

How did you test this code?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

posthog-bot commented Jan 16, 2024

github-actions bot commented Jan 19, 2024 • edited Loading

pauldambra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pauldambra commented Jan 22, 2024

daibhin commented Jan 22, 2024

daibhin commented Jan 3, 2024 •

edited

Loading

github-actions bot commented Jan 19, 2024 •

edited

Loading