@strapi/plugin-sentry 4.0.0-next.7 → 4.0.1

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/admin/src/translations/ko.json

@@ -1 +1,4 @@
-{}
+{
+  "plugin.description.long": "Strapi 에러 이벤트를 Sentry에 보냅니다.",
+  "plugin.description.short": "Strapi 에러 이벤트를 Sentry에 보냅니다."
+}

package/jest.config.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const baseConfig = require('../../../jest.base-config');
+const pkg = require('./package');
+
+module.exports = {
+  ...baseConfig,
+  displayName: (pkg.strapi && pkg.strapi.name) || pkg.name,
+  roots: [__dirname],
+};

package/package.json

@@ -1,32 +1,40 @@
 {
   "name": "@strapi/plugin-sentry",
-  "version": "4.0.0-next.7",
+  "version": "4.0.1",
   "description": "Send Strapi error events to Sentry",
-  "strapi": {
-    "name": "Sentry",
-    "icon": "plug",
-    "description": "sentry.plugin.description",
-    "kind": "plugin"
-  },
-  "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"
     }
   ],
+  "scripts": {
+    "test:unit": "jest --verbose"
+  },
+  "dependencies": {
+    "@sentry/node": "6.7.1"
+  },
   "engines": {
     "node": ">=12.x.x <=16.x.x",
     "npm": ">=6.0.0"
   },
-  "license": "SEE LICENSE IN LICENSE",
-  "gitHead": "522d6afd54b68ed3376dd0c807fab6c1315f1931"
+  "strapi": {
+    "name": "sentry",
+    "displayName": "Sentry",
+    "description": "Send Strapi error events to Sentry.",
+    "kind": "plugin"
+  },
+  "gitHead": "e2cd01e8c6cbfeba15ad7787e38b6eebcbb92221"
 }

package/server/bootstrap.js

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

package/server/config.js

@@ -6,5 +6,5 @@ module.exports = {
     sendMetadata: true,
     init: {},
   },
-  validator: () => {},
+  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/server/services/__tests__/sentry.test.js

@@ -2,7 +2,8 @@
 
 const INVALID_DSN = 'an_invalid_dsn';
 const VALID_DSN = 'a_valid_dsn';
-const captureException = jest.fn();
+const mockCaptureException = jest.fn();
+
 // FIXME
 /* eslint-disable import/extensions */
 jest.mock('@sentry/node', () => {
@@ -12,7 +13,7 @@ jest.mock('@sentry/node', () => {
         throw Error();
       }
     },
-    captureException,
+    captureException: mockCaptureException,
     withScope(configureScope) {
       configureScope();
     },
@@ -83,7 +84,7 @@ describe('Sentry service', () => {
     const configureScope = jest.fn();
     sentryService.sendError(error, configureScope);
     expect(configureScope).toHaveBeenCalled();
-    expect(captureException).toHaveBeenCalled();
+    expect(mockCaptureException).toHaveBeenCalled();
   });
 
   it('does not not send metadata when the option is disabled', () => {

package/strapi-admin.js

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

package/strapi-server.js

@@ -1,13 +1,3 @@
 '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,
-});
+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/server/middlewares/index.js

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

package/server/middlewares/sentry/index.js

@@ -1,36 +0,0 @@
-'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.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;
-        }
-      });
-    },
-  },
-};