feat: Add @sentry/ember

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
+- [ember] feat: Add `@sentry/ember` (#2739)
 
 ## 5.20.1
 

package.json

@@ -22,6 +22,7 @@
     "packages/apm",
     "packages/browser",
     "packages/core",
+    "packages/ember",
     "packages/gatsby",
     "packages/hub",
     "packages/integrations",

packages/ember/.ember-cli

@@ -0,0 +1,9 @@
+{
+  /**
+    Ember CLI sends analytics information by default. The data is completely
+    anonymous, but there are times when you might want to disable this behavior.
+
+    Setting `disableAnalytics` to true will prevent any data from being sent.
+  */
+  "disableAnalytics": false
+}

packages/ember/.eslintignore

@@ -0,0 +1,20 @@
+# unconventional js
+/blueprints/*/files/
+/vendor/
+
+# compiled output
+/dist/
+/tmp/
+
+# dependencies
+/bower_components/
+/node_modules/
+
+# misc
+/coverage/
+!.*
+
+# ember-try
+/.node_modules.ember-try/
+/bower.json.ember-try
+/package.json.ember-try

packages/ember/.eslintrc.js

@@ -0,0 +1,57 @@
+'use strict';
+
+module.exports = {
+  root: true,
+  parser: 'babel-eslint',
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+    ecmaFeatures: {
+      legacyDecorators: true
+    }
+  },
+  plugins: [
+    'ember'
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:ember/recommended'
+  ],
+  env: {
+    browser: true
+  },
+  globals: {
+    "QUnit": true
+  },
+  rules: {},
+  overrides: [
+    // node files
+    {
+      files: [
+        '.eslintrc.js',
+        '.template-lintrc.js',
+        'ember-cli-build.js',
+        'index.js',
+        'testem.js',
+        'blueprints/*/index.js',
+        'config/**/*.js',
+        'tests/dummy/config/**/*.js'
+      ],
+      excludedFiles: [
+        'addon/**',
+        'addon-test-support/**',
+        'app/**',
+        'tests/dummy/app/**'
+      ],
+      parserOptions: {
+        sourceType: 'script'
+      },
+      env: {
+        browser: false,
+        node: true
+      },
+      plugins: ['node'],
+      extends: ['plugin:node/recommended']
+    }
+  ]
+};

packages/ember/.gitignore

@@ -0,0 +1,25 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist/
+/tmp/
+
+# dependencies
+/bower_components/
+/node_modules/
+
+# misc
+/.env*
+/.pnp*
+/.sass-cache
+/connect.lock
+/coverage/
+/libpeerconnection.log
+/npm-debug.log*
+/testem.log
+/yarn-error.log
+
+# ember-try
+/.node_modules.ember-try/
+/bower.json.ember-try
+/package.json.ember-try

packages/ember/.npmignore

@@ -0,0 +1,32 @@
+# compiled output
+/dist/
+/tmp/
+
+# dependencies
+/bower_components/
+
+# misc
+/.bowerrc
+/.editorconfig
+/.ember-cli
+/.env*
+/.eslintignore
+/.eslintrc.js
+/.git/
+/.gitignore
+/.template-lintrc.js
+/.travis.yml
+/.watchmanconfig
+/bower.json
+/config/ember-try.js
+/CONTRIBUTING.md
+/ember-cli-build.js
+/testem.js
+/tests/
+/yarn.lock
+.gitkeep
+
+# ember-try
+/.node_modules.ember-try/
+/bower.json.ember-try
+/package.json.ember-try

packages/ember/.template-lintrc.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+  extends: 'octane'
+};

packages/ember/.watchmanconfig

@@ -0,0 +1,3 @@
+{
+  "ignore_dirs": ["tmp", "dist"]
+}

packages/ember/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2020, Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/ember/README.md

@@ -0,0 +1,82 @@
+<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>
+
+# Official Sentry SDK for Ember.js
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/quickstart/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
+
+## General
+
+This package is an Ember addon that wraps `@sentry/browser`, with added functionality related to Ember. All methods available in
+`@sentry/browser` can be imported from `@sentry/ember`.
+
+### Installation
+
+As with other Ember addons, run:
+`ember install @sentry/ember`
+
+Then add the following config to `config/environment.js`
+
+```javascript
+  ENV['@sentry/ember'] = {
+    sentry: {
+      dsn: '__DSN__' // replace __DSN__ with your DSN
+    }
+  };
+```
+
+### Usage
+
+To use this SDK, call `InitSentryForEmber` before the application is initialized, in `app.js`. This will load Sentry config from `environment.js` for you.
+
+```javascript
+import Application from '@ember/application';
+import Resolver from 'ember-resolver';
+import loadInitializers from 'ember-load-initializers';
+import config from './config/environment';
+import { InitSentryForEmber } from '@sentry/ember';
+
+InitSentryForEmber();
+
+export default class App extends Application {
+  modulePrefix = config.modulePrefix;
+  podModulePrefix = config.podModulePrefix;
+  Resolver = Resolver;
+}
+```
+
+### Additional Configuration
+
+Aside from configuration passed from this addon into `@sentry/browser` via the `sentry` property, there is also the following Ember specific configuration.
+
+```javascript
+  ENV['@sentry/ember'] = {
+    ignoreEmberOnErrorWarning: false, // Will silence Ember.onError warning without the need of using Ember debugging tools. False by default.
+    sentry: ... // See sentry-javascript configuration https://docs.sentry.io/error-reporting/configuration/?platform=javascript
+  };
+```
+
+### Supported Versions
+
+`@sentry/ember` currently supports Ember **3.8+** for error monitoring.
+
+### Previous Integration
+
+Previously we've recommended using the Ember integration from `@sentry/integrations` but moving forward we will be using
+this Ember addon to offer more Ember-specific error and performancing monitoring.
+
+## Testing
+
+You can find example instrumentation in the `dummy` application, which is also used for testing. To test with the dummy
+application, you must pass the dsn as an environment variable.
+
+```javascript
+SENTRY_DSN=__DSN__ ember serve
+```

packages/ember/addon/declarations.d.ts

@@ -0,0 +1,3 @@
+declare module 'ember-get-config' {
+    export default object;
+}

packages/ember/addon/index.ts

@@ -0,0 +1,57 @@
+import * as Sentry from '@sentry/browser';
+import { addGlobalEventProcessor, SDK_VERSION, BrowserOptions } from '@sentry/browser';
+import environmentConfig from 'ember-get-config';
+
+import { next } from '@ember/runloop';
+import { assert, warn, runInDebug } from '@ember/debug';
+import Ember from 'ember';
+
+export function InitSentryForEmber(_runtimeConfig: BrowserOptions | undefined) {
+  const config = environmentConfig['@sentry/ember'];
+  assert('Missing configuration', config);
+  assert('Missing configuration for Sentry.', config.sentry);
+
+  const initConfig = Object.assign({}, config.sentry, _runtimeConfig || {});
+
+  createEmberEventProcessor();
+
+  Sentry.init(initConfig);
+
+  runInDebug(() => {
+    if (config.ignoreEmberOnErrorWarning) {
+      return;
+    }
+    next(null, function () {
+      warn(
+        'Ember.onerror found. Using Ember.onerror can hide some errors (such as flushed runloop errors) from Sentry. Use Sentry.captureException to capture errors within Ember.onError or remove it to have errors caught by Sentry directly. This error can be silenced via addon configuration.',
+        !Ember.onerror,
+        {
+          id: '@sentry/ember.ember-onerror-detected',
+        },
+      );
+    });
+  });
+}
+
+function createEmberEventProcessor(): void {
+  if (addGlobalEventProcessor) {
+    addGlobalEventProcessor((event) => {
+      event.sdk = {
+        ...event.sdk,
+        name: 'sentry.javascript.ember',
+        packages: [
+          ...((event.sdk && event.sdk.packages) || []),
+          {
+            name: 'npm:@sentry/ember',
+            version: SDK_VERSION,
+          },
+        ],
+        version: SDK_VERSION,
+      };
+
+      return event;
+    });
+  }
+}
+
+export * from '@sentry/browser';