feat(wasm): Adds a WASM integration

mitsuhiko · mitsuhiko · commit c67e15484883 · 2020-11-27T00:10:50.000+01:00
diff --git a/package.json b/package.json
@@ -35,7 +35,8 @@
     "packages/tracing",
     "packages/types",
     "packages/typescript",
-    "packages/utils"
+    "packages/utils",
+    "packages/wasm"
   ],
   "devDependencies": {
     "@google-cloud/storage": "^2.5.0",
diff --git a/packages/types/src/debugMeta.ts b/packages/types/src/debugMeta.ts
@@ -0,0 +1,22 @@
+/**
+ * Holds meta information to customize the behavior of sentry's event processing.
+ **/
+export interface DebugMeta {
+  images?: Array<DebugImage>;
+}
+
+/**
+ * Possible choices for debug images.
+ */
+export type DebugImageType = 'wasm' | 'macho' | 'elf' | 'pe';
+
+/**
+ * References to debug images.
+ */
+export interface DebugImage {
+  type: DebugImageType;
+  debug_id: string;
+  code_id?: string | null;
+  code_file: string;
+  debug_file?: string | null;
+}
diff --git a/packages/types/src/event.ts b/packages/types/src/event.ts
@@ -1,5 +1,6 @@
 import { Breadcrumb } from './breadcrumb';
 import { Contexts } from './context';
+import { DebugMeta } from './debugMeta';
 import { Exception } from './exception';
 import { Extras } from './extra';
 import { Request } from './request';
@@ -41,6 +42,7 @@ export interface Event {
   type?: EventType;
   spans?: Span[];
   measurements?: Measurements;
+  debug_meta?: DebugMeta;
 }
 
 /** JSDoc */
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -2,6 +2,7 @@ export { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 export { Client } from './client';
 export { Context, Contexts } from './context';
 export { Dsn, DsnComponents, DsnLike, DsnProtocol } from './dsn';
+export { DebugImage, DebugImageType, DebugMeta } from './debugMeta';
 export { ExtendedError } from './error';
 export { Event, EventHint } from './event';
 export { EventProcessor } from './eventprocessor';
diff --git a/packages/types/src/stackframe.ts b/packages/types/src/stackframe.ts
@@ -11,5 +11,7 @@ export interface StackFrame {
   pre_context?: string[];
   post_context?: string[];
   in_app?: boolean;
+  instruction_addr?: string;
+  addr_mode?: string;
   vars?: { [key: string]: any };
 }
diff --git a/packages/wasm/.eslintrc.js b/packages/wasm/.eslintrc.js
@@ -0,0 +1,29 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  extends: ['@sentry-internal/sdk'],
+  ignorePatterns: ['build/**', 'dist/**', 'esm/**', 'examples/**', 'scripts/**'],
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx', '*.d.ts'],
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    {
+      files: ['test/**'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+      },
+    },
+  ],
+  rules: {
+    'max-lines': 'off',
+  },
+};
diff --git a/packages/wasm/.gitignore b/packages/wasm/.gitignore
@@ -0,0 +1,4 @@
+*.js.map
+*.d.ts
+*.js
+!.eslintrc.js
diff --git a/packages/wasm/.npmignore b/packages/wasm/.npmignore
@@ -0,0 +1,6 @@
+*
+!*.js.map
+!*.d.ts
+!*.js
+!/esm/**/*
+jest.config.js
diff --git a/packages/wasm/LICENSE b/packages/wasm/LICENSE
@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Sentry
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/packages/wasm/README.md b/packages/wasm/README.md
@@ -0,0 +1,22 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+# Sentry JavaScript WebAssembly Support
+
+[![npm version](https://img.shields.io/npm/v/@sentry/wasm.svg)](https://www.npmjs.com/package/@sentry/wasm)
+[![npm dm](https://img.shields.io/npm/dm/@sentry/wasm.svg)](https://www.npmjs.com/package/@sentry/wasm)
+[![npm dt](https://img.shields.io/npm/dt/@sentry/wasm.svg)](https://www.npmjs.com/package/@sentry/wasm)
+[![typedoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](http://getsentry.github.io/sentry-javascript/)
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/quickstart/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
+
+## General
+
+This package provides support for WebAssembly in stack traces.
diff --git a/packages/wasm/package.json b/packages/wasm/package.json
@@ -0,0 +1,76 @@
+{
+  "name": "@sentry/wasm",
+  "version": "5.27.6",
+  "description": "Support for WASM.",
+  "repository": "git://github.com/getsentry/sentry-javascript.git",
+  "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/wasm",
+  "author": "Sentry",
+  "license": "BSD-3-Clause",
+  "engines": {
+    "node": ">=6"
+  },
+  "main": "dist/index.js",
+  "module": "esm/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@sentry/types": "5.27.6",
+    "@sentry/browser": "5.27.6",
+    "tslib": "^1.9.3"
+  },
+  "devDependencies": {
+    "@sentry-internal/eslint-config-sdk": "5.27.6",
+    "chai": "^4.1.2",
+    "eslint": "7.6.0",
+    "jest": "^24.7.1",
+    "npm-run-all": "^4.1.2",
+    "prettier": "1.19.0",
+    "rimraf": "^2.6.3",
+    "typescript": "3.7.5"
+  },
+  "scripts": {
+    "build": "run-p build:es5 build:esm",
+    "build:es5": "tsc -p tsconfig.build.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:watch": "run-p build:watch:es5 build:watch:esm",
+    "build:watch:es5": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
+    "build:watch:esm": "tsc -p tsconfig.esm.json -w --preserveWatchOutput",
+    "clean": "rimraf dist esm coverage *.js *.js.map *.d.ts",
+    "link:yarn": "yarn link",
+    "lint": "run-s lint:prettier lint:eslint",
+    "lint:prettier": "prettier --check \"{src,test}/**/*.ts\"",
+    "lint:eslint": "eslint . --cache --cache-location '../../eslintcache/' --format stylish",
+    "fix": "run-s fix:eslint fix:prettier",
+    "fix:prettier": "prettier --write \"{src,test}/**/*.ts\"",
+    "fix:eslint": "eslint . --format stylish --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "pack": "npm pack"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "jest": {
+    "collectCoverage": true,
+    "transform": {
+      "^.+\\.ts$": "ts-jest"
+    },
+    "moduleFileExtensions": [
+      "js",
+      "ts"
+    ],
+    "testEnvironment": "node",
+    "testMatch": [
+      "**/*.test.ts"
+    ],
+    "globals": {
+      "ts-jest": {
+        "tsConfig": "./tsconfig.json",
+        "diagnostics": false
+      }
+    }
+  },
+  "sideEffects": false
+}
diff --git a/packages/wasm/src/index.ts b/packages/wasm/src/index.ts
@@ -0,0 +1,78 @@
+import { DebugImage, Hub, EventProcessor, Integration, StackFrame } from '@sentry/types';
+import { patchWebAssembly } from './patchWebAssembly';
+import { getImage, getImages } from './registry';
+
+export const IMAGES: Array<DebugImage> = [];
+
+export interface ModuleInfo {
+  buildId: string | null;
+  debugFile: string | null;
+}
+
+function patchFrames(frames: Array<StackFrame>): boolean {
+  let haveWasm = false;
+  frames.forEach((frame) => {
+    if (!frame.filename) {
+      return;
+    }
+    const match = frame.filename.match(/^(.*?):wasm-function\[\d+\]:(0x[a-fA-F0-9]+)$/);
+    if (match !== null) {
+      const index = getImage(match[1]);
+      if (index >= 0) {
+        frame.instruction_addr = match[2];
+        frame.addr_mode = `rel:${index}`;
+        frame.filename = match[1];
+        frame.platform = 'native';
+        haveWasm = true;
+      }
+    }
+  });
+  return haveWasm;
+}
+
+/**
+ * Process WASM stack traces to support server-side symbolication.
+ *
+ * This also hooks the WebAssembly loading browser API so that module
+ * registraitons are intercepted.
+ */
+export class Wasm implements Integration {
+  /**
+   * @inheritDoc
+   */
+  public static id: string = 'Wasm';
+
+  /**
+   * @inheritDoc
+   */
+  public name: string = Wasm.id;
+
+  /**
+   * @inheritDoc
+   */
+  public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void, _getCurrentHub: () => Hub): void {
+    patchWebAssembly();
+
+    addGlobalEventProcessor((event) => {
+      let haveWasm = false;
+
+      if (event.exception && event.exception.values) {
+        event.exception.values.forEach((exception) => {
+          if (exception?.stacktrace?.frames) {
+            haveWasm = haveWasm || patchFrames(exception.stacktrace.frames);
+          }
+        });
+      }
+      if (event.stacktrace?.frames) {
+        haveWasm = haveWasm || patchFrames(event.stacktrace.frames);
+      }
+
+      if (haveWasm) {
+        event.debug_meta = event.debug_meta || {};
+        event.debug_meta.images = getImages();
+      }
+
+      return event;
+    });
+  }
+}
diff --git a/packages/wasm/src/patchWebAssembly.ts b/packages/wasm/src/patchWebAssembly.ts
@@ -0,0 +1,34 @@
+import { registerModule } from './registry';
+
+/**
+ * Patches the web assembly runtime.
+ */
+export function patchWebAssembly() {
+  const origInstantiateStreaming = WebAssembly.instantiateStreaming;
+  const origCompileStreaming = WebAssembly.compileStreaming;
+
+  function recordedInstanticateStreaming(promise: Promise<any>, obj: any) {
+    return Promise.resolve(promise).then(resp => {
+      return origInstantiateStreaming(resp, obj).then(rv => {
+        if (resp.url) {
+          registerModule(rv.module, resp.url);
+        }
+        return rv;
+      });
+    });
+  }
+
+  function recordedCompileStreaming(promise: Promise<any>) {
+    return Promise.resolve(promise).then(resp => {
+      return origCompileStreaming(resp).then(module => {
+        if (resp.url) {
+          registerModule(module, resp.url);
+        }
+        return module;
+      });
+    });
+  }
+
+  (WebAssembly as any).instantiateStreaming = recordedInstanticateStreaming;
+  (WebAssembly as any).compileStreaming = recordedCompileStreaming;
+}
diff --git a/packages/wasm/src/registry.ts b/packages/wasm/src/registry.ts
diff --git a/packages/wasm/tsconfig.build.json b/packages/wasm/tsconfig.build.json
diff --git a/packages/wasm/tsconfig.esm.json b/packages/wasm/tsconfig.esm.json
diff --git a/packages/wasm/tsconfig.json b/packages/wasm/tsconfig.json
diff --git a/packages/wasm/yarn.lock b/packages/wasm/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,7 @@ export interface StackFrame {`
`11`	`11`	`pre_context?: string[];`
`12`	`12`	`post_context?: string[];`
`13`	`13`	`in_app?: boolean;`
	`14`	`+ instruction_addr?: string;`
	`15`	`+ addr_mode?: string;`
`14`	`16`	`vars?: { [key: string]: any };`
`15`	`17`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +*.js.map
 +*.d.ts
 +*.js
 +!.eslintrc.js