sentinel/static/app/utils/profiling/frame.tsx

import type {SymbolicatorStatus} from 'sentry/components/events/interfaces/types';
import {t} from 'sentry/locale';

const ROOT_KEY = 'sentry root';
const BROWSER_EXTENSION_REGEXP = /^(\@moz-extension\:\/\/|chrome-extension\:\/\/)/;
export class Frame {
  readonly key: string | number;
  readonly name: string;
  readonly file?: string;
  readonly line?: number;
  readonly column?: number;
  readonly is_application: boolean;
  readonly is_browser_extension?: boolean;
  readonly path?: string;
  readonly package?: string;
  readonly module?: string;
  readonly resource?: string;
  readonly threadId?: number;
  readonly inline?: boolean;
  readonly instructionAddr?: string;
  readonly symbol?: string;
  readonly symbolAddr?: string;
  readonly symbolicatorStatus?: SymbolicatorStatus;
  readonly isRoot: boolean;

  totalWeight: number = 0;
  selfWeight: number = 0;
  aggregateDuration: number = 0;

  static Root = new Frame({
    key: ROOT_KEY,
    name: ROOT_KEY,
    is_application: false,
  });

  constructor(
    frameInfo: Profiling.FrameInfo,
    type?: 'mobile' | 'javascript' | 'node' | string,
    // In aggregate mode, we miss certain info like lineno/col and so
    // we need to make sure we don't try to use it or infer data based on it
    mode?: 'detailed' | 'aggregate'
  ) {
    this.key = frameInfo.key;
    this.file = frameInfo.file;
    this.name = frameInfo.name;
    this.resource = frameInfo.resource;
    this.line = frameInfo.line;
    this.column = frameInfo.column;
    this.is_application = !!frameInfo.is_application;
    this.package = frameInfo.package;
    this.module = frameInfo.module ?? frameInfo.image;
    this.threadId = frameInfo.threadId;
    this.path = frameInfo.path;
    this.instructionAddr = frameInfo.instructionAddr;
    this.symbol = frameInfo.symbol;
    this.symbolAddr = frameInfo.symbolAddr;
    this.symbolicatorStatus = frameInfo.symbolicatorStatus;
    this.isRoot = this.key === ROOT_KEY;

    // We are remapping some of the keys as they differ between platforms.
    // This is a temporary solution until we adopt a unified format.
    if (frameInfo.columnNumber && this.column === undefined) {
      this.column = frameInfo.columnNumber;
    }
    if (frameInfo.lineNumber && this.column === undefined) {
      this.line = frameInfo.lineNumber;
    }
    if (frameInfo.scriptName && this.column === undefined) {
      this.resource = frameInfo.scriptName;
    }

    // If the frame is a web frame and there is no name associated to it, then it was likely invoked as an iife or anonymous callback as
    // most modern browser engines properly show anonymous functions when they are assigned to references (e.g. `let foo = function() {};`)
    if (type === 'javascript' || type === 'node') {
      if (this.name === '(garbage collector)' || this.name === '(root)') {
        this.is_application = false;
      }

      if (!this.name || this.name === 'unknown') {
        this.name = t('<anonymous>');
      }

      // If the frame had no line or column, it was part of the native code, (e.g. calling String.fromCharCode)
      if (this.line === undefined && this.column === undefined && mode !== 'aggregate') {
        this.name += ` ${t('[native code]')}`;
        this.is_application = false;
      }

      if (!this.file && this.path) {
        this.file = this.path;
      }

      this.is_browser_extension = !!(
        this.file && BROWSER_EXTENSION_REGEXP.test(this.file)
      );
      if (this.is_browser_extension && this.is_application) {
        this.is_application = false;
      }

      // Doing this on the frontend while we figure out how to do this on the backend/client properly
      // @TODO Our old node.js incorrectly sends file instead of path (fixed in SDK, but not all SDK's are upgraded :rip:)
      const pathOrFile = this.path || this.file;

      if (pathOrFile) {
        if (pathOrFile.startsWith('node:internal')) {
          this.is_application = false;
        }

        if (this.module === undefined && pathOrFile) {
          const match =
            /node_modules(\/|\\)(?<maybeScopeOrPackage>.*?)(\/|\\)((?<maybePackage>.*)((\/|\\)))?/.exec(
              pathOrFile
            );
          if (match?.groups) {
            const {maybeScopeOrPackage, maybePackage} = match.groups;

            if (maybeScopeOrPackage.startsWith('@')) {
              this.module = `${maybeScopeOrPackage}/${maybePackage}`;
            } else {
              this.module = match.groups.maybeScopeOrPackage;
            }
            this.is_application = false;
          }
        }

        // Extract the first component of node:namespace/pkg if there is one
        // else return just the node:namespace
        if (pathOrFile?.substring(0, 5) === 'node:') {
          let image = '';
          const l = pathOrFile.length;

          for (let i = 0; i < l; i++) {
            if (pathOrFile.charAt(i) === '/') {
              image += '/';
              i++;
              while (i < l && pathOrFile.charAt(i) !== '/') {
                image += pathOrFile.charAt(i);
                i++;
              }
              break;
            }
            image += pathOrFile.charAt(i);
          }

          if (image) {
            this.module = image;
          }
        }
      }
    }

    if (!this.name) {
      this.name = t('<unknown>');
    }
  }
}