add canvas to options event

Author: billyvg

packages/replay/src/replay.ts

@@ -223,6 +223,13 @@ export class ReplayContainer implements ReplayContainerInterface {
     return this._isPaused;
   }
 
+  /**
+   * Determine if canvas recording is enabled
+   */
+  public isRecordingCanvas(): boolean {
+    return Boolean(this._canvas);
+  }
+
   /** Get the replay integration options. */
   public getOptions(): ReplayPluginOptions {
     return this._options;

packages/replay/src/types/replay.ts

@@ -485,6 +485,7 @@ export interface ReplayContainer {
   ) => typeof THROTTLED | typeof SKIPPED | Promise<AddEventResult | null>;
   isEnabled(): boolean;
   isPaused(): boolean;
+  isRecordingCanvas(): boolean;
   getContext(): InternalEventContext;
   initializeSampling(): void;
   start(): void;

packages/replay/src/types/replayFrame.ts

@@ -114,6 +114,7 @@ export interface ReplayMultiClickFrame extends ReplayBaseBreadcrumbFrame {
 
 interface ReplayOptionFrame {
   blockAllMedia: boolean;
+  canvas: boolean;
   errorSampleRate: number;
   maskAllInputs: boolean;
   maskAllText: boolean;

packages/replay/src/util/handleRecordingEmit.ts

@@ -122,6 +122,7 @@ export function createOptionsEvent(replay: ReplayContainer): ReplayOptionFrameEv
     data: {
       tag: 'options',
       payload: {
+        canvas: replay.isRecordingCanvas(),
         sessionSampleRate: options.sessionSampleRate,
         errorSampleRate: options.errorSampleRate,
         useCompressionOption: options.useCompression,