feat(wasm): Adds a WASM integration (#3080)

* feat(wasm): Adds a WASM integration

Co-authored-by: Kamil Ogórek <[email protected]>
Co-authored-by: Daniel Griesser <[email protected]>

Author: 3 people

.craft.yml

@@ -53,6 +53,11 @@ targets:
     onlyIfPresent: /^sentry-angular-.*\.tgz$/
     config:
       canonical: 'npm:@sentry/angular'
+  - name: registry
+    type: sdk
+    onlyIfPresent: /^sentry-wasm-.*\.tgz$/
+    config:
+      canonical: 'npm:@sentry/wasm'
   - name: aws-lambda-layer
     includeNames: /^sentry-node-serverless-\d+(\.\d+)*\.zip$/
     layerName: SentryNodeServerlessSDK

package.json

@@ -36,6 +36,7 @@
     "packages/types",
     "packages/typescript",
     "packages/utils",
+    "packages/wasm",
     "packages/vue"
   ],
   "devDependencies": {
@@ -65,7 +66,8 @@
     "typescript": "3.7.5"
   },
   "resolutions": {
-    "**/agent-base": "5"
+    "**/agent-base": "5",
+    "**/jest-environment-node": "24"
   },
   "version": "0.0.0"
 }

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;
+}

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 { Primitive } from './misc';
@@ -42,6 +43,7 @@ export interface Event {
   type?: EventType;
   spans?: Span[];
   measurements?: Measurements;
+  debug_meta?: DebugMeta;
 }
 
 /** JSDoc */

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';

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 };
 }

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',
+  },
+};

packages/wasm/.gitignore

@@ -0,0 +1,4 @@
+*.js.map
+*.d.ts
+!test/*.js
+!.eslintrc.js

packages/wasm/.npmignore

@@ -0,0 +1,6 @@
+*
+!*.js.map
+!*.d.ts
+!*.js
+!/esm/**/*
+jest.config.js

packages/wasm/LICENSE

@@ -0,0 +1,29 @@
+MIT License
+
+Copyright (c) 2021, 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.