@strapi/plugin-sentry 4.0.0-next.6 → 4.0.0

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/admin/src/index.js

@@ -1,22 +1,14 @@
 import { prefixPluginTranslations } from '@strapi/helper-plugin';
 import pluginPkg from '../../package.json';
 import pluginId from './pluginId';
-import pluginLogo from './assets/images/logo.svg';
 
-const pluginDescription = pluginPkg.strapi.description || pluginPkg.description;
-const icon = pluginPkg.strapi.icon;
 const name = pluginPkg.strapi.name;
 
 export default {
   register(app) {
     app.registerPlugin({
-      description: pluginDescription,
-      icon,
       id: pluginId,
-      isReady: true,
-      isRequired: pluginPkg.strapi.required || false,
       name,
-      pluginLogo,
     });
   },
   bootstrap() {},

package/package.json

@@ -1,31 +1,37 @@
 {
   "name": "@strapi/plugin-sentry",
-  "version": "4.0.0-next.6",
+  "version": "4.0.0",
   "description": "Send Strapi error events to Sentry",
-  "strapi": {
-    "name": "Sentry",
-    "icon": "plug",
-    "description": "sentry.plugin.description"
-  },
-  "dependencies": {
-    "@sentry/node": "6.7.1"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/strapi/strapi.git",
+    "directory": "packages/plugins/sentry"
   },
+  "license": "SEE LICENSE IN LICENSE",
   "author": {
-    "name": "Strapi team",
+    "name": "Strapi Solutions SAS",
     "email": "hi@strapi.io",
     "url": "https://strapi.io"
   },
   "maintainers": [
     {
-      "name": "Strapi team",
+      "name": "Strapi Solutions SAS",
       "email": "hi@strapi.io",
       "url": "https://strapi.io"
     }
   ],
+  "dependencies": {
+    "@sentry/node": "6.7.1"
+  },
   "engines": {
     "node": ">=12.x.x <=16.x.x",
     "npm": ">=6.0.0"
   },
-  "license": "SEE LICENSE IN LICENSE",
-  "gitHead": "f528a865cb9c4234f2cda4f0df5b40e7c427ff9a"
+  "strapi": {
+    "name": "sentry",
+    "displayName": "Sentry",
+    "description": "Send Strapi error events to Sentry.",
+    "kind": "plugin"
+  },
+  "gitHead": "b181702f0202b2c6d645d42b195a831f25cd0b03"
 }

package/server/bootstrap.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const initSentryMiddleware = require('./middlewares/sentry');
+
+module.exports = async ({ strapi }) => {
+  // Initialize the Sentry service exposed by this plugin
+  initSentryMiddleware({ strapi });
+};

package/server/config.js

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

package/server/index.js

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

package/server/middlewares/sentry.js

@@ -0,0 +1,40 @@
+'use strict';
+
+/**
+ * Programmatic sentry middleware. We do not want to expose it in the plugin
+ * @param {{ strapi: import('@strapi/strapi').Strapi }}
+ */
+module.exports = ({ strapi }) => {
+  const sentryService = strapi.plugin('sentry').service('sentry');
+  sentryService.init();
+  const sentry = sentryService.getInstance();
+
+  if (!sentry) {
+    // initialization failed
+    return;
+  }
+
+  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-admin.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./admin/src').default;

package/strapi-server.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./server');

package/admin/src/assets/images/logo.svg

@@ -1 +0,0 @@
-<svg class="css-15xgryy e10nushx5" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 72 66" width="400" height="367"><path d="M29,2.26a4.67,4.67,0,0,0-8,0L14.42,13.53A32.21,32.21,0,0,1,32.17,40.19H27.55A27.68,27.68,0,0,0,12.09,17.47L6,28a15.92,15.92,0,0,1,9.23,12.17H4.62A.76.76,0,0,1,4,39.06l2.94-5a10.74,10.74,0,0,0-3.36-1.9l-2.91,5a4.54,4.54,0,0,0,1.69,6.24A4.66,4.66,0,0,0,4.62,44H19.15a19.4,19.4,0,0,0-8-17.31l2.31-4A23.87,23.87,0,0,1,23.76,44H36.07a35.88,35.88,0,0,0-16.41-31.8l4.67-8a.77.77,0,0,1,1.05-.27c.53.29,20.29,34.77,20.66,35.17a.76.76,0,0,1-.68,1.13H40.6q.09,1.91,0,3.81h4.78A4.59,4.59,0,0,0,50,39.43a4.49,4.49,0,0,0-.62-2.28Z" fill="#362d59" transform="translate(11, 11)"></path></svg>

package/config/functions/bootstrap.js

@@ -1,7 +0,0 @@
-'use strict';
-
-module.exports = async () => {
-  // Initialize the Sentry service exposed by this plugin
-  const { sentry } = strapi.plugins.sentry.services;
-  sentry.init();
-};

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