feat: AngularJS integration

Author: kamilogorek

packages/integrations/package.json

@@ -21,6 +21,7 @@
     "tslib": "^1.9.3"
   },
   "devDependencies": {
+    "@types/angular": "^1.6.54",
     "chai": "^4.1.2",
     "jest": "^24.1.0",
     "npm-run-all": "^4.1.2",
@@ -31,11 +32,7 @@
     "typescript": "^3.3.3"
   },
   "scripts": {
-    "build": "run-s clean && run-p build:es5 build:esm",
-    "build:es5": "tsc -p tsconfig.build.json",
-    "build:esm": "run-s build:esm:transpile build:esm:rewrite",
-    "build:esm:transpile": "tsc -p tsconfig.esm.json",
-    "build:esm:rewrite": "node ../../scripts/esm-rewrite.js",
+    "build": "tsc -p tsconfig.build.json",
     "build:watch": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
     "clean": "rimraf dist coverage *.js *.js.map *.d.ts",
     "lint": "run-s lint:prettier lint:tslint",

packages/integrations/src/angular.ts

@@ -0,0 +1,102 @@
+import { captureException, getCurrentHub, withScope } from '@sentry/core';
+import { Event, Integration } from '@sentry/types';
+import { logger } from '@sentry/utils/logger';
+import { getGlobalObject } from '@sentry/utils/misc';
+
+// See https://github.com/angular/angular.js/blob/v1.4.7/src/minErr.js
+const angularPattern = /^\[((?:[$a-zA-Z0-9]+:)?(?:[$a-zA-Z0-9]+))\] (.*?)\n?(\S+)$/;
+
+/**
+ * AngularJS integration
+ *
+ * Provides an $exceptionHandler for AngularJS
+ */
+export class Angular implements Integration {
+  /**
+   * @inheritDoc
+   */
+  public name: string = Angular.id;
+
+  /**
+   * @inheritDoc
+   */
+  public static id: string = 'AngularJS';
+
+  /**
+   * moduleName used in Angular's DI resolution algorithm
+   */
+  public static moduleName: string = 'ngSentry';
+
+  /**
+   * Angular's instance
+   */
+  private readonly angular: ng.IAngularStatic;
+
+  /**
+   * @inheritDoc
+   */
+  public constructor(options: { angular?: ng.IAngularStatic } = {}) {
+    this.angular =
+      options.angular ||
+      (getGlobalObject() as {
+        angular: ng.IAngularStatic;
+      }).angular;
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public setupOnce(): void {
+    if (!this.angular) {
+      logger.error('AngularIntegration is missing an Angular instance');
+      return;
+    }
+
+    this.angular.module(Angular.moduleName, []).config([
+      '$provide',
+      ($provide: ng.auto.IProvideService) => {
+        $provide.decorator('$exceptionHandler', ['$delegate', this.$exceptionHandlerDecorator.bind(this)]);
+      },
+    ]);
+  }
+
+  /**
+   * Angular's exceptionHandler for Sentry integration
+   */
+  private $exceptionHandlerDecorator($delegate: ng.IExceptionHandlerService): ng.IExceptionHandlerService {
+    return (exception: Error, cause?: string) => {
+      if (getCurrentHub().getIntegration(Angular)) {
+        withScope(scope => {
+          if (cause) {
+            scope.setExtra('cause', cause);
+          }
+
+          scope.addEventProcessor((event: Event) => {
+            const ex = event.exception && event.exception.values && event.exception.values[0];
+
+            if (ex) {
+              const matches = angularPattern.exec(ex.value || '');
+
+              if (matches) {
+                // This type now becomes something like: $rootScope:inprog
+                ex.type = matches[1];
+                ex.value = matches[2];
+                event.message = `${ex.type}: ${ex.value}`;
+                // auto set a new tag specifically for the angular error url
+                event.extra = {
+                  ...event.extra,
+                  angularDocs: matches[3].substr(0, 250),
+                };
+              }
+            }
+
+            return event;
+          });
+
+          captureException(exception);
+        });
+      }
+      $delegate(exception, cause);
+    };
+  }
+}

packages/integrations/tsconfig.build.json

@@ -3,7 +3,8 @@
   "compilerOptions": {
     "baseUrl": ".",
     "outDir": ".",
-    "rootDir": "src"
+    "rootDir": "src",
+    "types": ["angular"]
   },
   "exclude": [],
   "include": ["src/**/*.ts"]

packages/integrations/tsconfig.esm.json

@@ -4,6 +4,6 @@
   "exclude": ["dist"],
   "compilerOptions": {
     "rootDir": ".",
-    "types": ["node", "jest"]
+    "types": ["node", "jest", "angular"]
   }
 }

packages/integrations/tsconfig.json

@@ -895,6 +895,11 @@
     array-from "^2.1.1"
     lodash "^4.17.11"
 
+"@types/angular@^1.6.54":
+  version "1.6.54"
+  resolved "https://registry.yarnpkg.com/@types/angular/-/angular-1.6.54.tgz#f9d5a03e4da7b021a6dabe5d63e899ed4567a5bd"
+  integrity sha512-xA1FuozWXeRQ7FClUbvk8ePL+dydBeDoCWRPFTHU5+8uvVtIIfLGiHA8CMkwsbddFCYnTDVbLxG85a/HBx7LtA==
+
 "@types/caseless@*":
   version "0.12.1"
   resolved "https://registry.yarnpkg.com/@types/caseless/-/caseless-0.12.1.tgz#9794c69c8385d0192acc471a540d1f8e0d16218a"