@strapi/plugin-sentry 4.0.0-next.0 → 4.0.0-next.12

package/README.md

@@ -49,7 +49,7 @@ module.exports = ({ env }) => ({
 You can access a Sentry service throughout your app.
 
 ```js
-const sentryService = strapi.plugins.sentry.services.sentry;
+const sentryService = strapi.plugin('sentry').service('sentry');
 ```
 
 This service exposes the following methods:
@@ -65,13 +65,19 @@ try {
   // Your code here
 } catch (error) {
   // Either send a simple error
-  strapi.plugins.sentry.services.sentry.sendError(error);
+  strapi
+    .plugin('sentry')
+    .service('sentry')
+    .sendError(error);
 
   // Or send an error with a customized Sentry scope
-  strapi.plugins.sentry.services.sentry.sendError(error, (scope, sentryInstance) => {
-    // Customize the scope here
-    scope.setTag('my_custom_tag', 'Tag value');
-  });
+  strapi
+    .plugin('sentry')
+    .service('sentry')
+    .sendError(error, (scope, sentryInstance) => {
+      // Customize the scope here
+      scope.setTag('my_custom_tag', 'Tag value');
+    });
   throw error;
 }
 ```
@@ -83,7 +89,10 @@ Use it if you need direct access to the Sentry instance, which should already al
 **Example**
 
 ```js
-const sentryInstance = strapi.plugins.sentry.services.sentry.getInstance();
+const sentryInstance = strapi
+  .plugin('sentry')
+  .service('sentry')
+  .getInstance();
 ```
 
 ## Disabling

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@strapi/plugin-sentry",
-  "version": "4.0.0-next.0",
+  "version": "4.0.0-next.12",
   "description": "Send Strapi error events to Sentry",
   "strapi": {
-    "name": "Sentry",
+    "name": "sentry",
+    "displayName": "Sentry",
     "icon": "plug",
-    "description": "sentry.plugin.description"
+    "description": "sentry.plugin.description",
+    "kind": "plugin"
   },
   "dependencies": {
     "@sentry/node": "6.7.1"
@@ -26,5 +28,6 @@
     "node": ">=12.x.x <=16.x.x",
     "npm": ">=6.0.0"
   },
-  "license": "SEE LICENSE IN LICENSE"
+  "license": "SEE LICENSE IN LICENSE",
+  "gitHead": "67af23d827fd48e7782e509a78d0ba66e67e2215"
 }

package/{config/functions → server}/bootstrap.js

@@ -2,6 +2,8 @@
 
 module.exports = async () => {
   // Initialize the Sentry service exposed by this plugin
-  const { sentry } = strapi.plugins.sentry.services;
-  sentry.init();
+  strapi
+    .plugin('sentry')
+    .service('sentry')
+    .init();
 };

package/server/config.js

@@ -0,0 +1,10 @@
+'use strict';
+
+module.exports = {
+  default: {
+    dsn: null,
+    sendMetadata: true,
+    init: {},
+  },
+  validator() {},
+};

package/server/middlewares/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const sentry = require('./sentry');
+
+module.exports = {
+  sentry,
+};

package/server/middlewares/sentry/index.js

@@ -0,0 +1,36 @@
+'use strict';
+
+module.exports = {
+  defaults: { sentry: { enabled: true } },
+  load: {
+    beforeInitialize() {
+      strapi.config.middleware.load.after.unshift('sentry');
+    },
+    initialize() {
+      const sentry = strapi.plugin('sentry').service('sentry');
+      sentry.init();
+
+      strapi.server.use(async (ctx, next) => {
+        try {
+          await next();
+        } catch (error) {
+          sentry.sendError(error, (scope, sentryInstance) => {
+            scope.addEventProcessor(event => {
+              // Parse Koa context to add error metadata
+              return sentryInstance.Handlers.parseRequest(event, ctx.request, {
+                // Don't parse the transaction name, we'll do it manually
+                transaction: false,
+              });
+            });
+            // Manually add transaction name
+            scope.setTag('transaction', `${ctx.method} ${ctx.request.url}`);
+            // Manually add Strapi version
+            scope.setTag('strapi_version', strapi.config.info.strapi);
+            scope.setTag('method', ctx.method);
+          });
+          throw error;
+        }
+      });
+    },
+  },
+};

package/{services → server/services}/__tests__/sentry.test.js

@@ -19,25 +19,21 @@ jest.mock('@sentry/node', () => {
   };
 });
 
-let sentryService = require('../sentry');
-const defaultConfig = require('../../config/settings.json');
+const sentryServiceLoader = require('../sentry');
+const defaultConfig = require('../../config').default;
 
 describe('Sentry service', () => {
   beforeEach(() => {
     // Reset Strapi state
     global.strapi = {
-      config: {},
-      plugins: {
-        sentry: {
-          config: defaultConfig,
-        },
+      config: {
+        get: () => defaultConfig,
       },
       log: {
         warn: jest.fn(),
         info: jest.fn(),
       },
     };
-    sentryService = require('../sentry');
   });
 
   afterEach(() => {
@@ -46,6 +42,7 @@ describe('Sentry service', () => {
   });
 
   it('disables Sentry when no DSN is provided', () => {
+    const sentryService = sentryServiceLoader({ strapi });
     sentryService.init();
     expect(strapi.log.info).toHaveBeenCalledWith(expect.stringMatching(/disabled/i));
 
@@ -54,9 +51,8 @@ describe('Sentry service', () => {
   });
 
   it('disables Sentry when an invalid DSN is provided', () => {
-    global.strapi.plugins.sentry.config = {
-      dsn: INVALID_DSN,
-    };
+    global.strapi.config.get = () => ({ dsn: INVALID_DSN });
+    const sentryService = sentryServiceLoader({ strapi });
     sentryService.init();
     expect(strapi.log.warn).toHaveBeenCalledWith(expect.stringMatching(/could not set up sentry/i));
 
@@ -65,14 +61,14 @@ describe('Sentry service', () => {
   });
 
   it("doesn't send events before init", () => {
+    const sentryService = sentryServiceLoader({ strapi });
     sentryService.sendError(Error());
     expect(strapi.log.warn).toHaveBeenCalledWith(expect.stringMatching(/cannot send event/i));
   });
 
   it('initializes and sends errors', () => {
-    global.strapi.plugins.sentry.config = {
-      dsn: VALID_DSN,
-    };
+    global.strapi.config.get = () => ({ dsn: VALID_DSN, sendMetadata: true });
+    const sentryService = sentryServiceLoader({ strapi });
     sentryService.init();
 
     // Saves the instance correctly
@@ -92,10 +88,8 @@ describe('Sentry service', () => {
 
   it('does not not send metadata when the option is disabled', () => {
     // Init with metadata option disabled
-    global.strapi.plugins.sentry.config = {
-      dsn: VALID_DSN,
-      sendMetadata: false,
-    };
+    global.strapi.config.get = () => ({ dsn: VALID_DSN, sendMetadata: false });
+    const sentryService = sentryServiceLoader({ strapi });
     sentryService.init();
 
     // Send error

package/server/services/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const sentry = require('./sentry');
+
+module.exports = {
+  sentry,
+};

package/{services/sentry.js → server/services/sentry/index.js}

@@ -2,9 +2,8 @@
 // FIXME
 /* eslint-disable import/extensions */
 const Sentry = require('@sentry/node');
-const defaultSettings = require('../config/settings.json');
 
-const createSentryService = () => {
+const createSentryService = strapi => {
   let isReady = false;
   let instance = null;
   let settings = {};
@@ -15,22 +14,19 @@ const createSentryService = () => {
      */
     init() {
       // Make sure there isn't a Sentry instance already running
-      if (instance != null) {
+      if (instance !== null) {
         return this;
       }
 
       // Retrieve user settings and merge them with the default ones
-      settings = {
-        ...defaultSettings,
-        ...strapi.plugins.sentry.config,
-      };
+      settings = strapi.config.get('plugin.sentry');
 
       try {
         // Don't init Sentry if no DSN was provided
         if (settings.dsn) {
           Sentry.init({
             dsn: settings.dsn,
-            environment: strapi.config.environment,
+            environment: strapi.config.get('environment'),
             ...settings.init,
           });
           // Store the successfully initialized Sentry instance
@@ -85,4 +81,4 @@ const createSentryService = () => {
   };
 };
 
-module.exports = createSentryService();
+module.exports = ({ strapi }) => createSentryService(strapi);

package/strapi-server.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const bootstrap = require('./server/bootstrap');
+const services = require('./server/services');
+const middlewares = require('./server/middlewares');
+const config = require('./server/config');
+
+module.exports = () => ({
+  bootstrap,
+  config,
+  middlewares,
+  services,
+});

package/config/routes.json

@@ -1,3 +0,0 @@
-{
-  "routes": []
-}

package/config/settings.json

@@ -1,5 +0,0 @@
-{
-  "dsn": null,
-  "sendMetadata": true,
-  "init": {}
-}

package/controllers/sentry.js

@@ -1,9 +0,0 @@
-'use strict';
-
-/**
- * sentry.js controller
- *
- * @description: A set of functions called "actions" of the `sentry` plugin.
- */
-
-module.exports = {};

package/middlewares/sentry/defaults.json

@@ -1,5 +0,0 @@
-{
-  "sentry": {
-    "enabled": true
-  }
-}

package/middlewares/sentry/index.js

@@ -1,33 +0,0 @@
-'use strict';
-
-module.exports = strapi => ({
-  beforeInitialize() {
-    strapi.config.middleware.load.after.unshift('sentry');
-  },
-  initialize() {
-    const { sentry } = strapi.plugins.sentry.services;
-    sentry.init();
-
-    strapi.app.use(async (ctx, next) => {
-      try {
-        await next();
-      } catch (error) {
-        sentry.sendError(error, (scope, sentryInstance) => {
-          scope.addEventProcessor(event => {
-            // Parse Koa context to add error metadata
-            return sentryInstance.Handlers.parseRequest(event, ctx.request, {
-              // Don't parse the transaction name, we'll do it manually
-              transaction: false,
-            });
-          });
-          // Manually add transaction name
-          scope.setTag('transaction', `${ctx.method} ${ctx.request.url}`);
-          // Manually add Strapi version
-          scope.setTag('strapi_version', strapi.config.info.strapi);
-          scope.setTag('method', ctx.method);
-        });
-        throw error;
-      }
-    });
-  },
-});