Skip to content

feat(replays): Add an SDK _experiments configuration flag to enable canvas recording #9723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Dec 7, 2023
Merged

feat(replays): Add an SDK _experiments configuration flag to enable canvas recording #9723

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
708b839
add canvas to experiment
c298lee Dec 1, 2023
083a533
update test
c298lee Dec 1, 2023
8e228d4
ref
c298lee Dec 1, 2023
e9e09b6
update test again
c298lee Dec 1, 2023
9b806f3
lint
c298lee Dec 1, 2023
c0baf30
configuration update
c298lee Dec 5, 2023
c62dce1
Merge branch 'develop' into experimental-canvas
c298lee Dec 5, 2023
3b8a57f
fix lint
c298lee Dec 5, 2023
b17b4bc
reduce bundle size
c298lee Dec 5, 2023
b1174da
Merge branch 'develop' into experimental-canvas
c298lee Dec 5, 2023
ac14ad0
Update packages/replay/src/replay.ts
c298lee Dec 5, 2023
0ffa8fa
update import
c298lee Dec 5, 2023
aab0c2a
update types
c298lee Dec 5, 2023
fc94d44
fix default
c298lee Dec 6, 2023
6b54826
add types for canvas manager
billyvg Dec 6, 2023
67d7dd1
fix lint
c298lee Dec 6, 2023
3275143
styling
c298lee Dec 7, 2023
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
6 changes: 6 additions & 0 deletions packages/replay/src/replay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,12 @@ export class ReplayContainer implements ReplayContainerInterface {
...(this.recordingMode === 'buffer' && { checkoutEveryNms: BUFFER_CHECKOUT_TIME }),
emit: getHandleRecordingEmit(this),
onMutation: this._onMutationHandler,
...(this._options._experiments.canvas && {
Copy link
Member

Choose a reason for hiding this comment

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

l: Could we extract this out to avoid having so many repetitions here, as they are quite long? Something like this:

const canvas = this._options._experiments.canvas;
// ...
onMutation: this._onMutationHandler,
...(canvas && { 
  recordCanvas: true,
  sampling: {
    canvas: canvas.fps || 4,
    // ...
  }
}

recordCanvas: true,
sampling: { canvas: this._options._experiments.canvas.fps || 4 },
dataURLOptions: { quality: this._options._experiments.canvas.quality || 0.6 },
getCanvasManager: this._options._experiments.canvas.manager,
}),
});
} catch (err) {
this._handleException(err);
Expand Down
7 changes: 6 additions & 1 deletion packages/replay/src/types/replay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import type { SKIPPED, THROTTLED } from '../util/throttle';
import type { AllPerformanceEntry, AllPerformanceEntryData, ReplayPerformanceEntry } from './performance';
import type { ReplayFrameEvent } from './replayFrame';
import type { ReplayNetworkRequestOrResponse } from './request';
import type { ReplayEventWithTime, RrwebRecordOptions } from './rrweb';
import type { CanvasManagerInterface, GetCanvasManagerOptions, ReplayEventWithTime, RrwebRecordOptions } from './rrweb';

export type RecordingEvent = ReplayFrameEvent | ReplayEventWithTime;
export type RecordingOptions = RrwebRecordOptions;
Expand Down Expand Up @@ -232,6 +232,11 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
_experiments: Partial<{
captureExceptions: boolean;
traceInternals: boolean;
canvas: {
fps?: number;
quality?: number;
manager: (options: GetCanvasManagerOptions) => CanvasManagerInterface;
};
}>;
}

Expand Down
20 changes: 20 additions & 0 deletions packages/replay/src/types/rrweb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,23 @@ export type RrwebRecordOptions = {
blockSelector?: string;
maskInputOptions?: Record<string, boolean>;
} & Record<string, unknown>;

export interface CanvasManagerInterface {
reset(): void;
freeze(): void;
unfreeze(): void;
lock(): void;
unlock(): void;
}

export interface GetCanvasManagerOptions {
recordCanvas: boolean;
blockClass: string | RegExp;
blockSelector: string | null;
unblockSelector: string | null;
sampling?: 'all' | number;
dataURLOptions: Partial<{
type: string;
quality: number;
}>;
}