@openobserve/browser-core 0.3.4 → 0.4.0-beta.2

package/src/domain/contexts/userContext.spec.ts

@@ -1,156 +0,0 @@
-import type { Hooks } from '../../../test'
-import { createHooks, registerCleanupTask } from '../../../test'
-import { mockRumConfiguration } from '../../../../rum-core/test'
-import type { ContextManager } from '../context/contextManager'
-import type { RelativeTime } from '../../tools/utils/timeUtils'
-import { HookNames } from '../../tools/abstractHooks'
-import { removeStorageListeners } from '../context/storeContextManager'
-import type { Configuration } from '../configuration'
-import type { SessionContext } from '../session/sessionManager'
-import { startUserContext } from './userContext'
-
-describe('user context', () => {
-  let userContext: ContextManager
-  let hooks: Hooks
-  const mockSessionManager = {
-    findTrackedSession: () =>
-      ({
-        anonymousId: 'device-123',
-      }) as SessionContext<string>,
-  }
-
-  beforeEach(() => {
-    hooks = createHooks()
-    userContext = startUserContext(
-      hooks,
-      mockRumConfiguration({ trackAnonymousUser: false }),
-      mockSessionManager,
-      'some_product_key'
-    )
-  })
-
-  it('should sanitize predefined properties', () => {
-    userContext.setContext({ id: false, name: 2, email: { bar: 'qux' } })
-
-    expect(userContext.getContext()).toEqual({
-      email: '[object Object]',
-      id: 'false',
-      name: '2',
-    })
-  })
-
-  describe('assemble hook', () => {
-    it('should set the user', () => {
-      userContext.setContext({ id: '123', foo: 'bar' })
-      const defaultRumEventAttributes = hooks.triggerHook(HookNames.Assemble, {
-        eventType: 'view',
-        startTime: 0 as RelativeTime,
-      })
-
-      expect(defaultRumEventAttributes).toEqual({
-        type: 'view',
-        usr: {
-          id: '123',
-          foo: 'bar',
-        },
-      })
-    })
-
-    it('should set anonymous_id when trackAnonymousUser is true', () => {
-      userContext = startUserContext(
-        hooks,
-        { trackAnonymousUser: true } as Configuration,
-        mockSessionManager,
-        'some_product_key'
-      )
-      userContext.setContext({ id: '123' })
-      const defaultRumEventAttributes = hooks.triggerHook(HookNames.Assemble, {
-        eventType: 'view',
-        startTime: 0 as RelativeTime,
-      })
-
-      expect(defaultRumEventAttributes).toEqual({
-        type: 'view',
-        usr: {
-          id: '123',
-          anonymous_id: 'device-123',
-        },
-      })
-    })
-
-    it('should not override customer provided anonymous_id when trackAnonymousUser is true', () => {
-      userContext = startUserContext(
-        hooks,
-        { trackAnonymousUser: true } as Configuration,
-        mockSessionManager,
-        'some_product_key'
-      )
-      userContext.setContext({ id: '123', anonymous_id: 'foo' })
-      const defaultRumEventAttributes = hooks.triggerHook(HookNames.Assemble, {
-        eventType: 'view',
-        startTime: 0 as RelativeTime,
-      })
-
-      expect(defaultRumEventAttributes).toEqual({
-        type: 'view',
-        usr: {
-          id: '123',
-          anonymous_id: 'foo',
-        },
-      })
-    })
-  })
-
-  describe('assemble telemetry hook', () => {
-    it('should set the anonymous_id', () => {
-      const defaultRumEventAttributes = hooks.triggerHook(HookNames.AssembleTelemetry, {
-        startTime: 0 as RelativeTime,
-      })
-
-      expect(defaultRumEventAttributes).toEqual({
-        anonymous_id: 'device-123',
-      })
-    })
-  })
-})
-
-describe('user context across pages', () => {
-  let userContext: ContextManager
-  let hooks: Hooks
-  const mockSessionManager = { findTrackedSession: () => undefined }
-
-  beforeEach(() => {
-    hooks = createHooks()
-
-    registerCleanupTask(() => {
-      localStorage.clear()
-      removeStorageListeners()
-    })
-  })
-
-  it('when disabled, should store contexts only in memory', () => {
-    userContext = startUserContext(
-      hooks,
-      { storeContextsAcrossPages: false } as Configuration,
-      mockSessionManager,
-      'some_product_key'
-    )
-    userContext.setContext({ id: '123' })
-
-    expect(userContext.getContext()).toEqual({ id: '123' })
-    expect(localStorage.getItem('_oo_c_some_product_key_1')).toBeNull()
-  })
-
-  it('when enabled, should maintain the user in local storage', () => {
-    userContext = startUserContext(
-      hooks,
-      { storeContextsAcrossPages: true } as Configuration,
-      mockSessionManager,
-      'some_product_key'
-    )
-
-    userContext.setContext({ id: 'foo', qux: 'qix' })
-    expect(userContext.getContext()).toEqual({ id: 'foo', qux: 'qix' })
-    expect(localStorage.getItem('_oo_c_some_product_key_1')).toBe('{"id":"foo","qux":"qix"}')
-  })
-})

package/src/domain/error/error.spec.ts

@@ -1,294 +0,0 @@
-import { clocksNow } from '../../tools/utils/timeUtils'
-import type { StackTrace } from '../../tools/stackTrace/computeStackTrace'
-import { registerCleanupTask } from '../../../test'
-import {
-  computeRawError,
-  getFileFromStackTraceString,
-  flattenErrorCauses,
-  isError,
-  NO_ERROR_STACK_PRESENT_MESSAGE,
-} from './error'
-import type { RawErrorCause, ErrorWithCause } from './error.types'
-import { ErrorHandling, ErrorSource, NonErrorPrefix } from './error.types'
-
-describe('computeRawError', () => {
-  const DEFAULT_RAW_ERROR_PARAMS = {
-    startClocks: clocksNow(),
-    nonErrorPrefix: NonErrorPrefix.UNCAUGHT,
-    source: ErrorSource.CUSTOM,
-  }
-
-  it('should format an error instance', () => {
-    const error = new TypeError('oh snap!')
-    // This stack was generated in Chrome.
-    error.stack = `TypeError: Oh snap!
-  at foo (http://path/to/file.js:52:15)
-  at <anonymous>:3:1`
-
-    const formatted = computeRawError({
-      ...DEFAULT_RAW_ERROR_PARAMS,
-      originalError: error,
-      handling: ErrorHandling.HANDLED,
-    })
-
-    expect(formatted.message).toEqual('oh snap!')
-    expect(formatted.type).toEqual('TypeError')
-    expect(formatted.stack).toEqual(`TypeError: oh snap!
-  at foo @ http://path/to/file.js:52:15
-  at <anonymous> @ <anonymous>:3:1`)
-  })
-
-  it('should format an error instance with an empty message', () => {
-    const error = new TypeError('oh snap!')
-    error.message = ''
-
-    const formatted = computeRawError({
-      ...DEFAULT_RAW_ERROR_PARAMS,
-      originalError: error,
-      handling: ErrorHandling.HANDLED,
-    })
-
-    expect(formatted.message).toEqual('Empty message')
-  })
-
-  it('should format a string error', () => {
-    const error = 'oh snap!'
-
-    const formatted = computeRawError({
-      ...DEFAULT_RAW_ERROR_PARAMS,
-      originalError: error,
-      handling: ErrorHandling.HANDLED,
-    })
-
-    expect(formatted.message).toEqual('Uncaught "oh snap!"')
-    expect(formatted.stack).toEqual(NO_ERROR_STACK_PRESENT_MESSAGE)
-  })
-
-  it('should format an object error', () => {
-    const error = { foo: 'bar' }
-
-    const formatted = computeRawError({
-      ...DEFAULT_RAW_ERROR_PARAMS,
-      originalError: error,
-      handling: ErrorHandling.HANDLED,
-    })
-
-    expect(formatted.message).toEqual('Uncaught {"foo":"bar"}')
-    expect(formatted.stack).toEqual(NO_ERROR_STACK_PRESENT_MESSAGE)
-  })
-
-  it('does not define the stack if useFallbackStack is false', () => {
-    const error = 'foo is undefined'
-
-    const formatted = computeRawError({
-      ...DEFAULT_RAW_ERROR_PARAMS,
-      originalError: error,
-      handling: ErrorHandling.HANDLED,
-      useFallbackStack: false,
-    })
-
-    expect(formatted.stack).toEqual(undefined)
-  })
-
-  it('uses the provided stack trace object', () => {
-    const stackTrace: StackTrace = {
-      message: 'oh snap!',
-      name: 'TypeError',
-      stack: [
-        {
-          args: ['1', 'bar'],
-          column: 15,
-          func: 'foo',
-          line: 52,
-          url: 'http://path/to/file.js',
-        },
-        {
-          args: [],
-          column: undefined,
-          func: '?',
-          line: 12,
-          url: 'http://path/to/file.js',
-        },
-        {
-          args: ['baz'],
-          column: undefined,
-          func: '?',
-          line: undefined,
-          url: 'http://path/to/file.js',
-        },
-      ],
-    }
-
-    const formatted = computeRawError({
-      ...DEFAULT_RAW_ERROR_PARAMS,
-      originalError: 'toto',
-      handling: ErrorHandling.HANDLED,
-      stackTrace,
-    })
-
-    expect(formatted.message).toEqual('oh snap!')
-    expect(formatted.stack).toEqual(`TypeError: oh snap!
-  at foo(1, bar) @ http://path/to/file.js:52:15
-  at <anonymous> @ http://path/to/file.js:12
-  at <anonymous>(baz) @ http://path/to/file.js`)
-    expect(formatted.type).toEqual('TypeError')
-  })
-
-  it('should set handling according to given parameter', () => {
-    const error = { foo: 'bar' }
-
-    expect(
-      computeRawError({
-        ...DEFAULT_RAW_ERROR_PARAMS,
-        originalError: error,
-        handling: ErrorHandling.HANDLED,
-      }).handling
-    ).toEqual(ErrorHandling.HANDLED)
-
-    expect(
-      computeRawError({
-        ...DEFAULT_RAW_ERROR_PARAMS,
-        originalError: error,
-        handling: ErrorHandling.UNHANDLED,
-      }).handling
-    ).toEqual(ErrorHandling.UNHANDLED)
-  })
-
-  it('should compute an object error with causes', () => {
-    const error = new Error('foo: bar') as ErrorWithCause
-    error.stack = 'Error: foo: bar\n    at <anonymous>:1:15'
-
-    const nestedError = new Error('biz: buz') as ErrorWithCause
-    nestedError.stack = 'NestedError: biz: buz\n    at <anonymous>:2:15'
-
-    const deepNestedError = new TypeError('fiz: buz') as ErrorWithCause
-    deepNestedError.stack = 'NestedError: fiz: buz\n    at <anonymous>:3:15'
-
-    error.cause = nestedError
-    nestedError.cause = deepNestedError
-
-    const formatted = computeRawError({
-      ...DEFAULT_RAW_ERROR_PARAMS,
-      originalError: error,
-      handling: ErrorHandling.HANDLED,
-      source: ErrorSource.SOURCE,
-    })
-
-    expect(formatted.type).toEqual('Error')
-    expect(formatted.message).toEqual('foo: bar')
-    expect(formatted.causes!.length).toBe(2)
-    expect(formatted.stack).toContain('Error: foo: bar')
-
-    const causes = formatted.causes as RawErrorCause[]
-
-    expect(causes[0].message).toContain(nestedError.message)
-    expect(causes[0].source).toContain(ErrorSource.SOURCE)
-    expect(causes[0].type).toEqual(nestedError.name)
-    expect(causes[0].stack).toContain('Error: biz: buz')
-
-    expect(causes[1].message).toContain(deepNestedError.message)
-    expect(causes[1].source).toContain(ErrorSource.SOURCE)
-    expect(causes[1].type).toEqual(deepNestedError.name)
-    expect(causes[1].stack).toContain('Error: fiz: buz')
-  })
-
-  it('should propagate the original error without modifications', () => {
-    const error = { description: 'syntax error' }
-
-    const formattedWithoutStackTrace = computeRawError({
-      ...DEFAULT_RAW_ERROR_PARAMS,
-      originalError: error,
-      handling: ErrorHandling.HANDLED,
-    })
-
-    const formattedWithStackTrace = computeRawError({
-      ...DEFAULT_RAW_ERROR_PARAMS,
-      originalError: error,
-      handling: ErrorHandling.HANDLED,
-    })
-
-    expect(formattedWithStackTrace.originalError).toBe(error)
-    expect(formattedWithoutStackTrace.originalError).toBe(error)
-  })
-})
-
-describe('getFileFromStackTraceString', () => {
-  it('should get the first source file of the stack', () => {
-    expect(
-      getFileFromStackTraceString(`TypeError: oh snap!
-  at foo(1, bar) @ http://path/to/file.js:52:15
-  at <anonymous> @ http://path/to/file.js:12
-  at <anonymous>(baz) @ http://path/to/file.js`)
-    ).toEqual('http://path/to/file.js:52:15')
-  })
-
-  it('should get undefined if no source file is in the stack', () => {
-    expect(getFileFromStackTraceString('TypeError: oh snap!')).not.toBeDefined()
-  })
-})
-
-describe('flattenErrorCauses', () => {
-  it('should return undefined if no cause found', () => {
-    const error = new Error('foo') as ErrorWithCause
-    const errorCauses = flattenErrorCauses(error, ErrorSource.LOGGER)
-    expect(errorCauses).toEqual(undefined)
-  })
-
-  it('should return undefined if cause is not of type Error', () => {
-    const error = new Error('foo') as ErrorWithCause
-    const nestedError = { biz: 'buz', cause: new Error('boo') } as unknown as Error
-
-    error.cause = nestedError
-
-    const errorCauses = flattenErrorCauses(error, ErrorSource.LOGGER)
-    expect(errorCauses?.length).toEqual(undefined)
-  })
-
-  it('should use error to extract stack trace', () => {
-    const error = new Error('foo') as ErrorWithCause
-
-    error.cause = new Error('bar')
-
-    const errorCauses = flattenErrorCauses(error, ErrorSource.LOGGER)
-    expect(errorCauses?.[0].type).toEqual('Error')
-  })
-
-  it('should only return the first 10 errors if nested chain is longer', () => {
-    const error = new Error('foo') as ErrorWithCause
-    error.cause = error
-    const errorCauses = flattenErrorCauses(error, ErrorSource.LOGGER)
-    expect(errorCauses?.length).toEqual(10)
-  })
-})
-
-describe('isError', () => {
-  it('should correctly identify an error object from a different window context', () => {
-    const iframe = document.createElement('iframe')
-    document.body.appendChild(iframe)
-    registerCleanupTask(() => document.body.removeChild(iframe))
-
-    const iframeWindow = iframe.contentWindow as Window & { Error: ErrorConstructor }
-
-    expect(isError(new iframeWindow.Error())).toBe(true)
-  })
-})
-
-describe('tryToGetContext', () => {
-  it('should extract dd_context from an error object', () => {
-    const context = { key: 'value' }
-    const error = new Error('Test error') as any
-    error.dd_context = context
-
-    const rawError = computeRawError({
-      originalError: error,
-      handlingStack: undefined,
-      componentStack: undefined,
-      startClocks: clocksNow(),
-      nonErrorPrefix: NonErrorPrefix.UNCAUGHT,
-      source: ErrorSource.CUSTOM,
-      handling: ErrorHandling.HANDLED,
-    })
-
-    expect(rawError.context).toEqual(context)
-  })
-})