@multiplayer-app/session-recorder-common 0.0.1

package/src/constants.base.ts

@@ -0,0 +1,61 @@
+export const MULTIPLAYER_TRACE_DOC_PREFIX = 'd0cd0c'
+
+export const MULTIPLAYER_TRACE_DEBUG_PREFIX = 'debdeb'
+
+export const MULTIPLAYER_TRACE_CONTINUOUS_DEBUG_PREFIX = 'cdbcdb'
+
+export const MULTIPLAYER_TRACE_DEBUG_SESSION_SHORT_ID_LENGTH = 16
+
+export const MULTIPLAYER_OTEL_DEFAULT_TRACES_EXPORTER_URL = 'https://api.multiplayer.app/v1/traces'
+
+export const MULTIPLAYER_OTEL_DEFAULT_LOGS_EXPORTER_URL = 'https://api.multiplayer.app/v1/logs'
+
+export const MULTIPLAYER_ATTRIBUTE_PREFIX = 'multiplayer.'
+
+export const ATTR_MULTIPLAYER_WORKSPACE_ID = 'multiplayer.workspace.id'
+
+export const ATTR_MULTIPLAYER_PROJECT_ID = 'multiplayer.project.id'
+
+export const ATTR_MULTIPLAYER_PLATFORM_ID = 'multiplayer.platform.id'
+
+export const ATTR_MULTIPLAYER_CONTINUOUS_SESSION_AUTO_SAVE = 'multiplayer.session.auto-save'
+
+export const ATTR_MULTIPLAYER_CONTINUOUS_SESSION_AUTO_SAVE_REASON = 'multiplayer.session.auto-save.reason'
+
+export const ATTR_MULTIPLAYER_PLATFORM_NAME = 'multiplayer.platform.name'
+
+export const ATTR_MULTIPLAYER_CLIENT_ID = 'multiplayer.client.id'
+
+export const ATTR_MULTIPLAYER_INTEGRATION_ID = 'multiplayer.integration.id'
+
+export const ATTR_MULTIPLAYER_SESSION_ID = 'multiplayer.session.id'
+
+export const ATTR_MULTIPLAYER_HTTP_REQUEST_BODY = 'multiplayer.http.request.body'
+
+export const ATTR_MULTIPLAYER_HTTP_RESPONSE_BODY = 'multiplayer.http.response.body'
+
+export const ATTR_MULTIPLAYER_HTTP_REQUEST_HEADERS = 'multiplayer.http.request.headers'
+
+export const ATTR_MULTIPLAYER_HTTP_RESPONSE_HEADERS = 'multiplayer.http.response.headers'
+
+export const ATTR_MULTIPLAYER_HTTP_RESPONSE_BODY_ENCODING = 'multiplayer.http.response.body.encoding'
+
+export const ATTR_MULTIPLAYER_RPC_REQUEST_MESSAGE = 'multiplayer.rpc.request.message'
+
+export const ATTR_MULTIPLAYER_RPC_REQUEST_MESSAGE_ENCODING = 'multiplayer.rpc.request.message.encoding'
+
+export const ATTR_MULTIPLAYER_RPC_RESPONSE_MESSAGE = 'multiplayer.rpc.response.message'
+
+export const ATTR_MULTIPLAYER_GRPC_REQUEST_MESSAGE = 'multiplayer.rpc.grpc.request.message'
+
+export const ATTR_MULTIPLAYER_GRPC_REQUEST_MESSAGE_ENCODING = 'multiplayer.rpc.request.message.encoding'
+
+export const ATTR_MULTIPLAYER_GRPC_RESPONSE_MESSAGE = 'multiplayer.rpc.grpc.response.message'
+
+export const ATTR_MULTIPLAYER_MESSAGING_MESSAGE_BODY = 'multiplayer.messaging.message.body'
+
+export const ATTR_MULTIPLAYER_MESSAGING_MESSAGE_BODY_ENCODING = 'multiplayer.messaging.message.body.encoding'
+
+export const ATTR_MULTIPLAYER_SESSION_RECORDER_VERSION = 'multiplayer.session-recorder.version'
+
+export const MASK_PLACEHOLDER = '***MASKED***'

package/src/constants.browser.ts

@@ -0,0 +1 @@
+export * from './constants.base'

package/src/constants.node.ts

@@ -0,0 +1,5 @@
+export * from './constants.base'
+
+export const MULTIPLAYER_MAX_HTTP_REQUEST_RESPONSE_SIZE = process.env.MULTIPLAYER_MAX_HTTP_REQUEST_RESPONSE_SIZE
+  ? Number(process.env.MULTIPLAYER_MAX_HTTP_REQUEST_RESPONSE_SIZE)
+  : 500000

package/src/index-browser.ts

@@ -0,0 +1,7 @@
+export * from './constants.browser'
+export { SessionRecorderHttpTraceExporterBrowser } from './SessionRecorderHttpTraceExporterBrowser'
+export { SessionRecorderIdGenerator } from './SessionRecorderIdGenerator'
+export { SessionRecorderJsonTraceSerializer } from './SessionRecorderJsonTraceSerializer'
+export { SessionRecorderTraceIdRatioBasedSampler } from './SessionRecorderTraceIdRatioBasedSampler'
+export * as SessionRecorderSdk from './sdk'
+export * from './type'

package/src/index-node.ts

@@ -0,0 +1,7 @@
+export * from './constants.node'
+export { SessionRecorderHttpInstrumentationHooksNode } from './SessionRecorderHttpInstrumentationHooksNode'
+export { SessionRecorderIdGenerator } from './SessionRecorderIdGenerator'
+export { SessionRecorderJsonTraceSerializer } from './SessionRecorderJsonTraceSerializer'
+export { SessionRecorderTraceIdRatioBasedSampler } from './SessionRecorderTraceIdRatioBasedSampler'
+export * as SessionRecorderSdk from './sdk'
+export * from './type'

package/src/index.ts

@@ -0,0 +1,8 @@
+export * from './constants.node'
+export { SessionRecorderHttpTraceExporterBrowser } from './SessionRecorderHttpTraceExporterBrowser'
+export { SessionRecorderHttpInstrumentationHooksNode } from './SessionRecorderHttpInstrumentationHooksNode'
+export { SessionRecorderIdGenerator } from './SessionRecorderIdGenerator'
+export { SessionRecorderJsonTraceSerializer } from './SessionRecorderJsonTraceSerializer'
+export { SessionRecorderTraceIdRatioBasedSampler } from './SessionRecorderTraceIdRatioBasedSampler'
+export * as SessionRecorderSdk from './sdk'
+export * from './type'

package/src/sdk/capture-exception.ts

@@ -0,0 +1,19 @@
+import { context, trace, SpanStatusCode } from '@opentelemetry/api'
+
+/**
+ * @description Add error to current span
+ * @param {Error} error 
+ * @returns {void}
+ */
+export const captureException = (error: Error) => {
+  if (!error) return;
+
+  const span = trace.getSpan(context.active())
+  if (!span) return;
+
+  span.recordException(error)
+  span.setStatus({
+    code: SpanStatusCode.ERROR,
+    message: error.message,
+  })
+}

package/src/sdk/id-generator.ts

@@ -0,0 +1,17 @@
+const SHARED_CHAR_CODES_ARRAY = Array(32)
+
+export const getIdGenerator = (bytes: number) => {
+    return function generateId() {
+        for (let i = 0; i < bytes * 2; i++) {
+            SHARED_CHAR_CODES_ARRAY[i] = Math.floor(Math.random() * 16) + 48
+            // valid hex characters in the range 48-57 and 97-102
+            if (SHARED_CHAR_CODES_ARRAY[i] >= 58) {
+                SHARED_CHAR_CODES_ARRAY[i] += 39
+            }
+        }
+        return String.fromCharCode.apply(
+            null,
+            SHARED_CHAR_CODES_ARRAY.slice(0, bytes * 2),
+        )
+    }
+}

package/src/sdk/index.ts

@@ -0,0 +1,7 @@
+export { default as mask, sensitiveFields, sensitiveHeaders } from './mask'
+export { default as schemify } from './schemify'
+export * from './is-gzip'
+export * from './id-generator'
+export * from './capture-exception'
+export * from './set-attribute'
+export * from './save-continuous-deb-session'

package/src/sdk/is-gzip.ts

@@ -0,0 +1,7 @@
+export const isGzip = (buf: Buffer | Uint8Array) => {
+  if (!buf || buf.length < 3) {
+    return false
+  }
+
+  return buf[0] === 0x1F && buf[1] === 0x8B && buf[2] === 0x08
+}

package/src/sdk/mask.ts

@@ -0,0 +1,161 @@
+import type { Span } from '@opentelemetry/api'
+import { MASK_PLACEHOLDER } from '../constants.base'
+
+const MAX_DEPTH = 8
+export const sensitiveFields: string[] = [
+  'password',
+  'pass',
+  'passwd',
+  'pwd',
+  'token',
+  'access_token',
+  'accessToken',
+  'refresh_token',
+  'refreshToken',
+  'secret',
+  'api_key',
+  'apiKey',
+  'authorization',
+  'auth_token',
+  'authToken',
+  'jwt',
+  'session_id',
+  'sessionId',
+  'sessionToken',
+  'client_secret',
+  'clientSecret',
+  'private_key',
+  'privateKey',
+  'public_key',
+  'publicKey',
+  'key',
+  'encryption_key',
+  'encryptionKey',
+  'credit_card',
+  'creditCard',
+  'card_number',
+  'cardNumber',
+  'cvv',
+  'cvc',
+  'ssn',
+  'sin',
+  'pin',
+  'security_code',
+  'securityCode',
+  'bank_account',
+  'bankAccount',
+  'iban',
+  'swift',
+  'bic',
+  'routing_number',
+  'routingNumber',
+  'license_key',
+  'licenseKey',
+  'otp',
+  'mfa_code',
+  'mfaCode',
+  'phone_number',
+  'phoneNumber',
+  'email',
+  'address',
+  'dob',
+  'tax_id',
+  'taxId',
+  'passport_number',
+  'passportNumber',
+  'driver_license',
+  'driverLicense',
+
+  'set-cookie',
+  'cookie',
+  'authorization',
+  'proxyAuthorization',
+]
+
+export const sensitiveHeaders: string[] = [
+  'set-cookie',
+  'cookie',
+  'authorization',
+  'proxyAuthorization',
+]
+
+const maskAll = (value: any, depth = 0) => {
+  const type = typeof value
+  const isObject = type === 'object'
+  let isArray = false
+
+  if (Array.isArray(value)) {
+    isArray = true
+  }
+
+  if (depth > MAX_DEPTH && (isObject || isArray)) {
+    return undefined
+  }
+
+  if (isArray) {
+    return value.map((val: any) => maskAll(val, depth + 1), value)
+  }
+
+  if (isObject) {
+    for (const key in value) {
+      value[key] = maskAll(value[key], depth + 1)
+    }
+
+    return value
+  }
+
+  if (type === 'string') {
+    return MASK_PLACEHOLDER
+  }
+
+  return value
+}
+
+const maskSelected = (value: any, keysToMask: string[]): any => {
+  const type = typeof value
+  const isObject = type === 'object'
+
+  const _keysToMask = new Set(keysToMask)
+
+  if (Array.isArray(value)) {
+    return value.map((val: any) => maskSelected(val, keysToMask), value)
+  }
+
+  if (isObject) {
+    for (const key in value) {
+      if (_keysToMask.has(key)) {
+        value[key] = MASK_PLACEHOLDER
+      } else {
+        value[key] = maskSelected(value[key],keysToMask)
+      }
+    }
+
+    return value
+  }
+
+  if (type === 'string') {
+    return value
+  }
+
+  return value
+}
+
+export default (keysToMask: string[] = []) => (value: any, span: Span): any => {
+  let payloadJson
+  try {
+    payloadJson = JSON.parse(value)
+  } catch {
+    payloadJson = value
+  }
+  let maskedData
+  if (keysToMask.length) {
+    maskedData = maskSelected(payloadJson, keysToMask)
+  } else {
+    maskedData = maskAll(payloadJson)
+  }
+  if (typeof maskedData !== 'string') {
+    maskedData = JSON.stringify(maskedData)
+  }
+
+  return maskedData
+}

package/src/sdk/save-continuous-deb-session.ts

@@ -0,0 +1,28 @@
+import { context, trace } from '@opentelemetry/api'
+import { 
+    ATTR_MULTIPLAYER_CONTINUOUS_SESSION_AUTO_SAVE,
+    ATTR_MULTIPLAYER_CONTINUOUS_SESSION_AUTO_SAVE_REASON
+ } from '../constants.base'
+/**
+ * @description Set auto save attribute to span
+ * @param {String} reason 
+ * @returns {void}
+ */
+export const saveContinuousSession = (
+    reason?: string
+) => {
+    const span = trace.getSpan(context.active())
+
+    if (!span) {
+        return
+        // create span
+    }
+
+    span?.setAttribute(ATTR_MULTIPLAYER_CONTINUOUS_SESSION_AUTO_SAVE, true)
+
+    if (reason?.length) {
+        span?.addEvent(ATTR_MULTIPLAYER_CONTINUOUS_SESSION_AUTO_SAVE_REASON, {
+            reason
+        })
+    }
+}

package/src/sdk/schemify.ts

@@ -0,0 +1,58 @@
+import * as _toJsonSchema from 'to-json-schema'
+
+// eslint-disable-next-line
+// @ts-ignore
+const toJsonSchema = _toJsonSchema?.default || _toJsonSchema
+
+const defaultSchemifyOptions: _toJsonSchema.Options = {
+  strings: {
+    preProcessFnc: (value: string, defaultFnc: any) => {
+      if (value?.length >= 30) {
+        return defaultFnc('some_string')
+      }
+
+
+      return defaultFnc(value)
+    },
+  },
+  arrays: {
+    mode: 'first',
+  },
+}
+
+export default (
+  payload: string | object | undefined,
+  stringify = true,
+  options: _toJsonSchema.Options = defaultSchemifyOptions,
+): any => {
+  if (!payload) {
+    return ''
+  }
+
+  let payloadJson: any
+
+  if (typeof payload === 'string') {
+    try {
+      payloadJson = JSON.parse(payload)
+    } catch {
+      return payload
+    }
+  } else if (typeof payload === 'object') {
+    payloadJson = payload
+  } else {
+    return payload
+  }
+
+  try {
+    const schema = toJsonSchema(payloadJson, options)
+
+    if (stringify) {
+      return JSON.stringify(schema)
+    }
+
+    return schema
+  } catch (err) {
+    // error can happen when array has items like ['test', 'asd', '1'], type for '1' is null
+    return ''
+  }
+}

package/src/sdk/set-attribute.ts

@@ -0,0 +1,210 @@
+import {
+  trace,
+  AttributeValue,
+  context
+} from '@opentelemetry/api'
+import {
+  ATTR_MULTIPLAYER_HTTP_RESPONSE_BODY,
+  ATTR_MULTIPLAYER_HTTP_RESPONSE_HEADERS,
+  ATTR_MULTIPLAYER_HTTP_REQUEST_BODY,
+  ATTR_MULTIPLAYER_HTTP_REQUEST_HEADERS,
+  ATTR_MULTIPLAYER_RPC_REQUEST_MESSAGE,
+  ATTR_MULTIPLAYER_RPC_RESPONSE_MESSAGE,
+  ATTR_MULTIPLAYER_GRPC_REQUEST_MESSAGE,
+  ATTR_MULTIPLAYER_GRPC_RESPONSE_MESSAGE,
+  ATTR_MULTIPLAYER_MESSAGING_MESSAGE_BODY
+} from '../constants.base'
+import mask, { sensitiveFields, sensitiveHeaders } from './mask'
+
+/**
+ * @description Set attribute to current span
+ * @param {string} key
+ * @param {AttributeValue} value
+ * @returns {void}
+ */
+export const setAttribute = (key: string, value: AttributeValue) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  span.setAttribute(key, value)
+}
+
+/**
+ * @description Set request body to current span attributes
+ * @param body
+ * @param {{ mask: boolean }} options
+ * @returns {void}
+ */
+export const setHttpRequestBody = (
+  body: any,
+  options: { mask: boolean } = { mask: true }
+) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  if (options?.mask) {
+    body = mask(sensitiveFields)(body, span)
+  }
+
+  span.setAttribute(ATTR_MULTIPLAYER_HTTP_REQUEST_BODY, body)
+}
+
+/**
+ * @description Set request headers to current span attributes
+ * @param body
+ * @param {{ mask: boolean }} options
+ * @returns {void}
+ */
+export const setHttpRequestHeaders = (
+  body: any,
+  options: { mask: boolean } = { mask: true }
+) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  if (options?.mask) {
+    body = mask(sensitiveHeaders)(body, span)
+  }
+
+  span.setAttribute(ATTR_MULTIPLAYER_HTTP_REQUEST_HEADERS, body)
+}
+
+/**
+ * @description Set response body to current span attributes
+ * @param body
+ * @param {{ mask: boolean }} options
+ * @returns {void}
+ */
+export const setHttpResponseBody = (
+  body: any,
+  options: { mask: boolean } = { mask: true }
+) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  if (options?.mask) {
+    body = mask(sensitiveFields)(body, span)
+  }
+
+  span.setAttribute(ATTR_MULTIPLAYER_HTTP_RESPONSE_BODY, body)
+}
+
+/**
+ * @description Set response body to current span attributes
+ * @param body
+ * @param {{ mask: boolean }} options
+ * @returns {void}
+ */
+export const setHttpResponseHeaders = (
+  body: any,
+  options: { mask: boolean } = { mask: true }
+) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  if (options?.mask) {
+    body = mask(sensitiveFields)(body, span)
+  }
+
+  span.setAttribute(ATTR_MULTIPLAYER_HTTP_RESPONSE_HEADERS, body)
+}
+
+/**
+ * @description Set message body to current span attributes
+ * @param body
+ * @param {{ mask: boolean }} options
+ * @returns {void}
+ */
+export const setMessageBody = (
+  body: any,
+  options: { mask: boolean } = { mask: true }
+) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  if (options?.mask) {
+    body = mask(sensitiveFields)(body, span)
+  }
+
+  span.setAttribute(ATTR_MULTIPLAYER_MESSAGING_MESSAGE_BODY, body)
+}
+
+/**
+ * @description Set rpc request message to current span attributes
+ * @param body
+ * @param {{ mask: boolean }} options
+ * @returns {void}
+ */
+export const setRpcRequestMessage = (
+  body: any,
+  options: { mask: boolean } = { mask: true }
+) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  if (options?.mask) {
+    body = mask(sensitiveFields)(body, span)
+  }
+
+  span.setAttribute(ATTR_MULTIPLAYER_RPC_REQUEST_MESSAGE, body)
+}
+
+/**
+ * @description Set rpc response message to current span attributes
+ * @param body
+ * @param {{ mask: boolean }} options
+ * @returns {void}
+ */
+export const setRpcResponseMessage = (
+  body: any,
+  options: { mask: boolean } = { mask: true }
+) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  if (options?.mask) {
+    body = mask(sensitiveFields)(body, span)
+  }
+
+  span.setAttribute(ATTR_MULTIPLAYER_RPC_RESPONSE_MESSAGE, body)
+}
+
+/**
+ * @description Set grpc request message to current span attributes
+ * @param body
+ * @param {{ mask: boolean }} options
+ * @returns {void}
+ */
+export const setGrpcRequestMessage = (
+  body: any,
+  options: { mask: boolean } = { mask: true }
+) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  if (options?.mask) {
+    body = mask(sensitiveFields)(body, span)
+  }
+
+  span.setAttribute(ATTR_MULTIPLAYER_GRPC_REQUEST_MESSAGE, body)
+}
+
+/**
+ * @description Set grpc response message to current span attributes
+ * @param body
+ * @param {{ mask: boolean }} options
+ * @returns {void}
+ */
+export const setGrpcResponseMessage = (
+  body: any,
+  options: { mask: boolean } = { mask: true }
+) => {
+  const span = trace.getSpan(context.active())
+  if (!span) return
+
+  if (options?.mask) {
+    body = mask(sensitiveFields)(body, span)
+  }
+
+  span.setAttribute(ATTR_MULTIPLAYER_GRPC_RESPONSE_MESSAGE, body)
+}

package/src/type/index.ts

@@ -0,0 +1 @@
+export * from './session-type.enum'

package/src/type/session-type.enum.ts

@@ -0,0 +1,4 @@
+export enum SessionType {
+  CONTINUOUS = 'CONTINUOUS',
+  PLAIN = 'MANUAL'
+}

package/tsconfig.base.es5.json

@@ -0,0 +1,8 @@
+
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "target": "es5",
+    "downlevelIteration": true
+  }
+}

package/tsconfig.base.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.base.es5.json",
+  "compilerOptions": {
+    "module": "ES6",
+    "moduleResolution": "node"
+  }
+}

package/tsconfig.base.esnext.json

@@ -0,0 +1,10 @@
+
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "module": "esnext",
+    // target should be aligned with tsconfig.base.json
+    "target": "es2017",
+    "moduleResolution": "node"
+  },
+}

package/tsconfig.base.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "forceConsistentCasingInFileNames": true,
+    "incremental": true,
+    "inlineSources": true,
+    "module": "commonjs",
+    "newLine": "LF",
+    "noEmitOnError": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "pretty": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "target": "es2017",
+    "useUnknownInCatchVariables": false,
+    "lib": [
+      "es2017",
+      "dom",
+      "dom.iterable"
+    ]
+  },
+  "exclude": [
+    "node_modules"
+  ]
+}