@kubesense/kubesense-browser-rum 1.8.0 → 2.0.0-beta.1

package/esm/types/sessionReplayConstants.d.ts

@@ -1,49 +0,0 @@
-import type * as SessionReplay from './sessionReplay';
-export declare const RecordType: {
-    FullSnapshot: SessionReplay.BrowserFullSnapshotRecord['type'];
-    IncrementalSnapshot: SessionReplay.BrowserIncrementalSnapshotRecord['type'];
-    Meta: SessionReplay.MetaRecord['type'];
-    Focus: SessionReplay.FocusRecord['type'];
-    ViewEnd: SessionReplay.ViewEndRecord['type'];
-    VisualViewport: SessionReplay.VisualViewportRecord['type'];
-    FrustrationRecord: SessionReplay.FrustrationRecord['type'];
-};
-export type RecordType = (typeof RecordType)[keyof typeof RecordType];
-export declare const NodeType: {
-    Document: SessionReplay.DocumentNode['type'];
-    DocumentType: SessionReplay.DocumentTypeNode['type'];
-    Element: SessionReplay.ElementNode['type'];
-    Text: SessionReplay.TextNode['type'];
-    CDATA: SessionReplay.CDataNode['type'];
-    DocumentFragment: SessionReplay.DocumentFragmentNode['type'];
-};
-export type NodeType = (typeof NodeType)[keyof typeof NodeType];
-export declare const IncrementalSource: {
-    Mutation: SessionReplay.BrowserMutationData['source'];
-    MouseMove: Exclude<SessionReplay.MousemoveData['source'], 6>;
-    MouseInteraction: SessionReplay.MouseInteractionData['source'];
-    Scroll: SessionReplay.ScrollData['source'];
-    ViewportResize: SessionReplay.ViewportResizeData['source'];
-    Input: SessionReplay.InputData['source'];
-    TouchMove: Exclude<SessionReplay.MousemoveData['source'], 1>;
-    MediaInteraction: SessionReplay.MediaInteractionData['source'];
-    StyleSheetRule: SessionReplay.StyleSheetRuleData['source'];
-};
-export type IncrementalSource = (typeof IncrementalSource)[keyof typeof IncrementalSource];
-export declare const MouseInteractionType: {
-    readonly MouseUp: 0;
-    readonly MouseDown: 1;
-    readonly Click: 2;
-    readonly ContextMenu: 3;
-    readonly DblClick: 4;
-    readonly Focus: 5;
-    readonly Blur: 6;
-    readonly TouchStart: 7;
-    readonly TouchEnd: 9;
-};
-export type MouseInteractionType = (typeof MouseInteractionType)[keyof typeof MouseInteractionType];
-export declare const MediaInteractionType: {
-    readonly Play: 0;
-    readonly Pause: 1;
-};
-export type MediaInteractionType = (typeof MediaInteractionType)[keyof typeof MediaInteractionType];

package/esm/types/sessionReplayConstants.js

@@ -1,46 +0,0 @@
-export const RecordType = {
-    FullSnapshot: 2,
-    IncrementalSnapshot: 3,
-    Meta: 4,
-    Focus: 6,
-    ViewEnd: 7,
-    VisualViewport: 8,
-    FrustrationRecord: 9,
-};
-export const NodeType = {
-    Document: 0,
-    DocumentType: 1,
-    Element: 2,
-    Text: 3,
-    CDATA: 4,
-    DocumentFragment: 11,
-};
-export const IncrementalSource = {
-    Mutation: 0,
-    MouseMove: 1,
-    MouseInteraction: 2,
-    Scroll: 3,
-    ViewportResize: 4,
-    Input: 5,
-    TouchMove: 6,
-    MediaInteraction: 7,
-    StyleSheetRule: 8,
-    // CanvasMutation : 9,
-    // Font : 10,
-};
-export const MouseInteractionType = {
-    MouseUp: 0,
-    MouseDown: 1,
-    Click: 2,
-    ContextMenu: 3,
-    DblClick: 4,
-    Focus: 5,
-    Blur: 6,
-    TouchStart: 7,
-    TouchEnd: 9,
-};
-export const MediaInteractionType = {
-    Play: 0,
-    Pause: 1,
-};
-//# sourceMappingURL=sessionReplayConstants.js.map

package/esm/types/sessionReplayConstants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sessionReplayConstants.js","sourceRoot":"","sources":["../../src/types/sessionReplayConstants.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,UAAU,GAQnB;IACF,YAAY,EAAE,CAAC;IACf,mBAAmB,EAAE,CAAC;IACtB,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,CAAC;IACR,OAAO,EAAE,CAAC;IACV,cAAc,EAAE,CAAC;IACjB,iBAAiB,EAAE,CAAC;CACZ,CAAA;AAIV,MAAM,CAAC,MAAM,QAAQ,GAOjB;IACF,QAAQ,EAAE,CAAC;IACX,YAAY,EAAE,CAAC;IACf,OAAO,EAAE,CAAC;IACV,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,CAAC;IACR,gBAAgB,EAAE,EAAE;CACZ,CAAA;AAIV,MAAM,CAAC,MAAM,iBAAiB,GAU1B;IACF,QAAQ,EAAE,CAAC;IACX,SAAS,EAAE,CAAC;IACZ,gBAAgB,EAAE,CAAC;IACnB,MAAM,EAAE,CAAC;IACT,cAAc,EAAE,CAAC;IACjB,KAAK,EAAE,CAAC;IACR,SAAS,EAAE,CAAC;IACZ,gBAAgB,EAAE,CAAC;IACnB,cAAc,EAAE,CAAC;IACjB,sBAAsB;IACtB,aAAa;CACL,CAAA;AAIV,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,OAAO,EAAE,CAAC;IACV,SAAS,EAAE,CAAC;IACZ,KAAK,EAAE,CAAC;IACR,WAAW,EAAE,CAAC;IACd,QAAQ,EAAE,CAAC;IACX,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,UAAU,EAAE,CAAC;IACb,QAAQ,EAAE,CAAC;CACH,CAAA;AAIV,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,CAAC;CACA,CAAA"}

package/src/boot/isBrowserSupported.ts

@@ -1,14 +0,0 @@
-/**
- * Test for Browser features used while recording
- */
-export function isBrowserSupported() {
-  return (
-    // Array.from is a bit less supported by browsers than CSSSupportsRule, but has higher chances
-    // to be polyfilled. Test for both to be more confident. We could add more things if we find out
-    // this test is not sufficient.
-    typeof Array.from === 'function' &&
-    typeof CSSSupportsRule === 'function' &&
-    typeof URL.createObjectURL === 'function' &&
-    'forEach' in NodeList.prototype
-  )
-}

package/src/boot/startRecording.ts

@@ -1,70 +0,0 @@
-import type { RawError, HttpRequest, DeflateEncoder, Telemetry } from '@kubesense/kubesense-browser-core'
-import { createHttpRequest, addTelemetryDebug, canUseEventBridge, noop } from '@kubesense/kubesense-browser-core'
-import type { LifeCycle, ViewHistory, RumConfiguration, RumSessionManager } from '@kubesense/kubesense-browser-rum-core'
-import { LifeCycleEventType } from '@kubesense/kubesense-browser-rum-core'
-
-import { record } from '../domain/record'
-import type { SerializationStats } from '../domain/record'
-import type { ReplayPayload } from '../domain/segmentCollection'
-import { startSegmentCollection, SEGMENT_BYTES_LIMIT, startSegmentTelemetry } from '../domain/segmentCollection'
-import type { BrowserRecord } from '../types'
-import { startRecordBridge } from '../domain/startRecordBridge'
-
-export function startRecording(
-  lifeCycle: LifeCycle,
-  configuration: RumConfiguration,
-  sessionManager: RumSessionManager,
-  viewHistory: ViewHistory,
-  encoder: DeflateEncoder,
-  telemetry: Telemetry,
-  httpRequest?: HttpRequest<ReplayPayload>
-) {
-  const cleanupTasks: Array<() => void> = []
-
-  const reportError = (error: RawError) => {
-    lifeCycle.notify(LifeCycleEventType.RAW_ERROR_COLLECTED, { error })
-    // monitor-until: forever, to keep an eye on the errors reported to customers
-    addTelemetryDebug('Error reported to customer', { 'error.message': error.message })
-  }
-
-  const replayRequest =
-    httpRequest || createHttpRequest([configuration.sessionReplayEndpointBuilder], reportError, SEGMENT_BYTES_LIMIT)
-
-  let addRecord: (record: BrowserRecord) => void
-  let addStats: (stats: SerializationStats) => void
-
-  if (!canUseEventBridge()) {
-    const segmentCollection = startSegmentCollection(
-      lifeCycle,
-      configuration,
-      sessionManager,
-      viewHistory,
-      replayRequest,
-      encoder
-    )
-    addRecord = segmentCollection.addRecord
-    addStats = segmentCollection.addStats
-    cleanupTasks.push(segmentCollection.stop)
-
-    const segmentTelemetry = startSegmentTelemetry(telemetry, replayRequest.observable)
-    cleanupTasks.push(segmentTelemetry.stop)
-  } else {
-    ;({ addRecord } = startRecordBridge(viewHistory))
-    addStats = noop
-  }
-
-  const { stop: stopRecording } = record({
-    emitRecord: addRecord,
-    emitStats: addStats,
-    configuration,
-    lifeCycle,
-    viewHistory,
-  })
-  cleanupTasks.push(stopRecording)
-
-  return {
-    stop: () => {
-      cleanupTasks.forEach((task) => task())
-    },
-  }
-}

package/src/domain/profiling/transport/assembly.ts

@@ -1,78 +0,0 @@
-import { buildTags, currentDrift } from '@kubesense/kubesense-browser-core'
-import type { RumConfiguration } from '@kubesense/kubesense-browser-rum-core'
-import type { RumProfilerTrace } from '../types'
-import { buildProfileEventAttributes } from './buildProfileEventAttributes'
-import type { ProfileEventAttributes } from './buildProfileEventAttributes'
-
-export interface ProfileEvent extends ProfileEventAttributes {
-  attachments: string[]
-  start: string // ISO date
-  end: string // ISO date
-  family: 'chrome'
-  runtime: 'chrome'
-  format: 'json'
-  version: 4
-  tags_profiler: string
-  _kubesense: {
-    clock_drift: number
-  }
-}
-
-export interface ProfileEventPayload {
-  event: ProfileEvent
-  'wall-time.json': RumProfilerTrace
-}
-
-export function assembleProfilingPayload(
-  profilerTrace: RumProfilerTrace,
-  configuration: RumConfiguration,
-  sessionId: string | undefined
-): ProfileEventPayload {
-  const event = buildProfileEvent(profilerTrace, configuration, sessionId)
-
-  return {
-    event,
-    'wall-time.json': profilerTrace,
-  }
-}
-
-function buildProfileEvent(
-  profilerTrace: RumProfilerTrace,
-  configuration: RumConfiguration,
-  sessionId: string | undefined
-): ProfileEvent {
-  const tags = buildTags(configuration) // TODO: get that from the tagContext hook
-  const profileAttributes = buildProfileEventAttributes(profilerTrace, configuration.applicationId, sessionId)
-  const profileEventTags = buildProfileEventTags(tags)
-
-  const profileEvent: ProfileEvent = {
-    ...profileAttributes,
-    attachments: ['wall-time.json'],
-    start: new Date(profilerTrace.startClocks.timeStamp).toISOString(),
-    end: new Date(profilerTrace.endClocks.timeStamp).toISOString(),
-    family: 'chrome',
-    runtime: 'chrome',
-    format: 'json',
-    version: 4, // Ingestion event version (not the version application tag)
-    tags_profiler: profileEventTags.join(','),
-    _kubesense: {
-      clock_drift: currentDrift(),
-    },
-  }
-
-  return profileEvent
-}
-
-/**
- * Builds tags for the Profile Event.
- *
- * @param tags - RUM tags
- * @returns Combined tags for the Profile Event.
- */
-function buildProfileEventTags(tags: string[]): string[] {
-  // Tags already contains the common tags for all events. (service, env, version, etc.)
-  // Here we are adding some specific-to-profiling tags.
-  const profileEventTags = tags.concat(['language:javascript', 'runtime:chrome', 'family:chrome', 'host:browser'])
-
-  return profileEventTags
-}

package/src/domain/profiling/transport/buildProfileEventAttributes.ts

@@ -1,66 +0,0 @@
-import type { RumProfilerTrace, RumViewEntry } from '../types'
-
-export interface ProfileEventAttributes {
-  application: { id: string }
-  session?: { id: string }
-  view?: { id: string[]; name: string[] }
-  long_task?: { id: string[] }
-}
-
-/**
- * Builds attributes for the Profile Event.
- *
- * @param profilerTrace - Profiler trace
- * @param applicationId - application id.
- * @param sessionId - session id.
- * @returns Additional attributes.
- */
-export function buildProfileEventAttributes(
-  profilerTrace: RumProfilerTrace,
-  applicationId: string,
-  sessionId: string | undefined
-): ProfileEventAttributes {
-  const attributes: ProfileEventAttributes = {
-    application: {
-      id: applicationId,
-    },
-  }
-  if (sessionId) {
-    attributes.session = {
-      id: sessionId,
-    }
-  }
-
-  // Extract view ids and names from the profiler trace and add them as attributes of the profile event.
-  // This will be used to filter the profiles by @view.id and/or @view.name.
-  const { ids, names } = extractViewIdsAndNames(profilerTrace.views)
-
-  if (ids.length) {
-    attributes.view = {
-      id: ids,
-      name: names,
-    }
-  }
-  const longTaskIds: string[] = profilerTrace.longTasks.map((longTask) => longTask.id).filter((id) => id !== undefined)
-
-  if (longTaskIds.length) {
-    attributes.long_task = { id: longTaskIds }
-  }
-  return attributes
-}
-
-function extractViewIdsAndNames(views: RumViewEntry[]): { ids: string[]; names: string[] } {
-  const result: { ids: string[]; names: string[] } = { ids: [], names: [] }
-  for (const view of views) {
-    result.ids.push(view.viewId)
-
-    if (view.viewName) {
-      result.names.push(view.viewName)
-    }
-  }
-
-  // Remove duplicates
-  result.names = Array.from(new Set(result.names))
-
-  return result
-}

package/src/domain/profiling/types/index.ts

@@ -1,2 +0,0 @@
-export type * from './profilerApi.types'
-export type * from './rumProfiler.types'

package/src/domain/profiling/types/profilerApi.types.ts

@@ -1,87 +0,0 @@
-// Define types for the new Profiler API
-// https://wicg.github.io/js-self-profiling/
-
-export interface ProfilerFrame {
-  /** A function instance name. */
-  readonly name: string
-  /** Index in the trace.resources array. */
-  readonly resourceId?: number
-  /** 1-based index of the line. */
-  readonly line?: number
-  /** 1-based index of the column. */
-  readonly column?: number
-}
-
-export interface ProfilerStack {
-  /** Index in the trace.stacks array. */
-  readonly parentId?: number
-  /** Index in the trace.frames array. */
-  readonly frameId: number
-}
-
-export interface ProfilerSample {
-  /** High resolution time relative to the profiling session's time origin. */
-  readonly timestamp: number
-  /** Index in the trace.stacks array. */
-  readonly stackId?: number
-}
-
-export type ProfilerResource = string
-
-export interface ProfilerTrace {
-  /** An array of profiler resources. */
-  readonly resources: ProfilerResource[]
-  /** An array of profiler frames. */
-  readonly frames: ProfilerFrame[]
-  /** An array of profiler stacks. */
-  readonly stacks: ProfilerStack[]
-  /** An array of profiler samples. */
-  readonly samples: ProfilerSample[]
-}
-
-export interface ProfilerInitOptions {
-  /** Sample interval in ms. */
-  readonly sampleInterval: number
-  /** Max buffer size in number of samples. */
-  readonly maxBufferSize: number
-}
-
-export interface Profiler extends EventTarget {
-  /** Sample interval in ms. */
-  readonly sampleInterval: number
-  /** True if profiler is stopped. */
-  readonly stopped: boolean
-
-  // eslint-disable-next-line @typescript-eslint/no-misused-new
-  new (options: ProfilerInitOptions): Profiler
-  stop(): Promise<ProfilerTrace>
-
-  addEventListener<K extends keyof ProfilerEventMap>(
-    type: K,
-    listener: (this: typeof globalThis, ev: ProfilerEventMap[K]) => any,
-    options?: boolean | AddEventListenerOptions
-  ): void
-  addEventListener(
-    type: string,
-    listener: EventListenerOrEventListenerObject,
-    options?: boolean | AddEventListenerOptions
-  ): void
-  removeEventListener<K extends keyof ProfilerEventMap>(
-    type: K,
-    listener: (this: typeof globalThis, ev: ProfilerEventMap[K]) => any,
-    options?: boolean | EventListenerOptions
-  ): void
-  removeEventListener(
-    type: string,
-    listener: EventListenerOrEventListenerObject,
-    options?: boolean | EventListenerOptions
-  ): void
-}
-
-interface ProfilerEventMap {
-  samplebufferfull: SampleBufferFullEvent
-}
-
-export interface SampleBufferFullEvent extends Event {
-  readonly target: Profiler
-}

package/src/domain/profiling/utils/getNumberOfSamples.ts

@@ -1,16 +0,0 @@
-import type { ProfilerSample } from '../types'
-
-/**
- * Counts number of samples when the thread was not idle (stackId is defined)
- * @param samples Array of collected samples
- * @returns Number of samples
- */
-export function getNumberOfSamples(samples: ProfilerSample[]): number {
-  let numberOfSamples = 0
-  for (const sample of samples) {
-    if (sample.stackId !== undefined) {
-      numberOfSamples++
-    }
-  }
-  return numberOfSamples
-}

package/src/domain/record/eventIds.ts

@@ -1,17 +0,0 @@
-export interface EventIds {
-  getIdForEvent(event: Event): number
-}
-
-export function createEventIds(): EventIds {
-  const eventIds = new WeakMap<Event, number>()
-  let nextId = 1
-
-  return {
-    getIdForEvent(event: Event): number {
-      if (!eventIds.has(event)) {
-        eventIds.set(event, nextId++)
-      }
-      return eventIds.get(event)!
-    },
-  }
-}

package/src/domain/record/nodeIds.ts

@@ -1,46 +0,0 @@
-import { getParentNode, isNodeShadowRoot } from '@kubesense/kubesense-browser-rum-core'
-
-export type NodeWithSerializedNode = Node & { __brand: 'NodeWithSerializedNode' }
-export type NodeId = number & { __brand: 'NodeId' }
-
-export const enum NodeIdConstants {
-  FIRST_ID = 0,
-}
-
-export interface NodeIds {
-  assign(node: Node): NodeId
-  get(node: Node): NodeId | undefined
-  areAssignedForNodeAndAncestors(node: Node): node is NodeWithSerializedNode
-}
-
-export function createNodeIds(): NodeIds {
-  const nodeIds = new WeakMap<Node, NodeId>()
-  let nextNodeId = NodeIdConstants.FIRST_ID
-
-  const get = (node: Node): NodeId | undefined => nodeIds.get(node)
-
-  return {
-    assign: (node: Node): NodeId => {
-      // Try to reuse any existing id.
-      let nodeId = get(node)
-      if (nodeId === undefined) {
-        nodeId = nextNodeId++ as NodeId
-        nodeIds.set(node, nodeId)
-      }
-      return nodeId
-    },
-
-    get,
-
-    areAssignedForNodeAndAncestors: (node: Node): node is NodeWithSerializedNode => {
-      let current: Node | null = node
-      while (current) {
-        if (get(current) === undefined && !isNodeShadowRoot(current)) {
-          return false
-        }
-        current = getParentNode(current)
-      }
-      return true
-    },
-  }
-}

package/src/domain/record/serialization/serializeDocument.ts

@@ -1,13 +0,0 @@
-import type { DocumentNode, SerializedNodeWithId } from '../../../types'
-import { serializeNode } from './serializeNode'
-import type { SerializationTransaction } from './serializationTransaction'
-
-export function serializeDocument(
-  document: Document,
-  transaction: SerializationTransaction
-): DocumentNode & SerializedNodeWithId {
-  const defaultPrivacyLevel = transaction.scope.configuration.defaultPrivacyLevel
-  const serializedNode = serializeNode(document, defaultPrivacyLevel, transaction)
-  // We are sure that Documents are never ignored, so this function never returns null
-  return serializedNode as DocumentNode & SerializedNodeWithId
-}

package/src/domain/record/serialization/serializeStyleSheets.ts

@@ -1,18 +0,0 @@
-import type { StyleSheet } from '../../../types'
-
-export function serializeStyleSheets(cssStyleSheets: CSSStyleSheet[] | undefined): StyleSheet[] | undefined {
-  if (cssStyleSheets === undefined || cssStyleSheets.length === 0) {
-    return undefined
-  }
-  return cssStyleSheets.map((cssStyleSheet) => {
-    const rules = cssStyleSheet.cssRules || cssStyleSheet.rules
-    const cssRules = Array.from(rules, (cssRule) => cssRule.cssText)
-
-    const styleSheet: StyleSheet = {
-      cssRules,
-      disabled: cssStyleSheet.disabled || undefined,
-      media: cssStyleSheet.media.length > 0 ? Array.from(cssStyleSheet.media) : undefined,
-    }
-    return styleSheet
-  })
-}

package/src/domain/record/trackers/trackFrustration.ts

@@ -1,41 +0,0 @@
-import type { LifeCycle } from '@kubesense/kubesense-browser-rum-core'
-import { ActionType, RumEventType, LifeCycleEventType } from '@kubesense/kubesense-browser-rum-core'
-import type { FrustrationRecord } from '../../../types'
-import { RecordType } from '../../../types'
-import type { EmitRecordCallback } from '../record.types'
-import type { RecordingScope } from '../recordingScope'
-import type { Tracker } from './tracker.types'
-
-export type FrustrationCallback = (record: FrustrationRecord) => void
-
-export function trackFrustration(
-  lifeCycle: LifeCycle,
-  emitRecord: EmitRecordCallback<FrustrationRecord>,
-  scope: RecordingScope
-): Tracker {
-  const frustrationSubscription = lifeCycle.subscribe(LifeCycleEventType.RAW_RUM_EVENT_COLLECTED, (data) => {
-    if (
-      data.rawRumEvent.type === RumEventType.ACTION &&
-      data.rawRumEvent.action.type === ActionType.CLICK &&
-      data.rawRumEvent.action.frustration?.type?.length &&
-      'events' in data.domainContext &&
-      data.domainContext.events &&
-      data.domainContext.events.length
-    ) {
-      emitRecord({
-        timestamp: data.rawRumEvent.date,
-        type: RecordType.FrustrationRecord,
-        data: {
-          frustrationTypes: data.rawRumEvent.action.frustration.type,
-          recordIds: data.domainContext.events.map((e) => scope.eventIds.getIdForEvent(e)),
-        },
-      })
-    }
-  })
-
-  return {
-    stop: () => {
-      frustrationSubscription.unsubscribe()
-    },
-  }
-}