@strapi/plugin-sentry 4.16.2 → 4.18.0

package/dist/_chunks/vi-22d50e0e.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"vi-22d50e0e.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/_chunks/vi-6d3d2db0.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"vi-6d3d2db0.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/_chunks/zh-9ec5b9b1.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"zh-9ec5b9b1.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/_chunks/zh-ac6dac24.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"zh-ac6dac24.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/jest.config.js

@@ -1,6 +0,0 @@
-'use strict';
-
-module.exports = {
-  preset: '../../../jest-preset.unit.js',
-  displayName: 'Sentry plugin',
-};

package/packup.config.ts

@@ -1,42 +0,0 @@
-import { Config, defineConfig } from '@strapi/pack-up';
-import { transformWithEsbuild } from 'vite';
-
-const config: Config = defineConfig({
-  bundles: [
-    {
-      source: './admin/src/index.js',
-      import: './dist/admin/index.mjs',
-      require: './dist/admin/index.js',
-      runtime: 'web',
-    },
-  ],
-  dist: './dist',
-  /**
-   * Because we're exporting a server & client package
-   * which have different runtimes we want to ignore
-   * what they look like in the package.json
-   */
-  exports: {},
-  plugins: [
-    {
-      name: 'treat-js-files-as-jsx',
-      async transform(code, id) {
-        /**
-         * Matches all files in src/ and ee/ that end with .js
-         */
-        if (!id.match(/src\/.*\.js$/) && !id.match(/ee\/.*\.js$/)) {
-          return null;
-        }
-
-        // Use the exposed transform from vite, instead of directly
-        // transforming with esbuild
-        return transformWithEsbuild(code, id, {
-          loader: 'tsx',
-          jsx: 'automatic',
-        });
-      },
-    },
-  ],
-});
-
-export default config;

package/server/bootstrap.js

@@ -1,8 +0,0 @@
-'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

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

package/server/index.js

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

package/server/middlewares/sentry.js

@@ -1,40 +0,0 @@
-'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) {
-      sentryService.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._matchedRoute}`);
-        // 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

@@ -1,102 +0,0 @@
-'use strict';
-
-const INVALID_DSN = 'an_invalid_dsn';
-const VALID_DSN = 'a_valid_dsn';
-const mockCaptureException = jest.fn();
-
-// FIXME
-/* eslint-disable import/extensions */
-jest.mock('@sentry/node', () => {
-  return {
-    init(options = {}) {
-      if (options.dsn !== VALID_DSN) {
-        throw Error();
-      }
-    },
-    captureException: mockCaptureException,
-    withScope(configureScope) {
-      configureScope();
-    },
-  };
-});
-
-const sentryServiceLoader = require('../sentry');
-const defaultConfig = require('../../config').default;
-
-describe('Sentry service', () => {
-  beforeEach(() => {
-    // Reset Strapi state
-    global.strapi = {
-      config: {
-        get: () => defaultConfig,
-      },
-      log: {
-        warn: jest.fn(),
-        info: jest.fn(),
-      },
-    };
-  });
-
-  afterEach(() => {
-    // Reset the plugin resource state
-    jest.resetModules();
-  });
-
-  it('disables Sentry when no DSN is provided', () => {
-    const sentryService = sentryServiceLoader({ strapi });
-    sentryService.init();
-    expect(strapi.log.info).toHaveBeenCalledWith(expect.stringMatching(/disabled/i));
-
-    const instance = sentryService.getInstance();
-    expect(instance).toBeNull();
-  });
-
-  it('disables Sentry when an invalid DSN is provided', () => {
-    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));
-
-    const instance = sentryService.getInstance();
-    expect(instance).toBeNull();
-  });
-
-  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.config.get = () => ({ dsn: VALID_DSN, sendMetadata: true });
-    const sentryService = sentryServiceLoader({ strapi });
-    sentryService.init();
-
-    // Saves the instance correctly
-    const instance = sentryService.getInstance();
-    expect(instance).not.toBeNull();
-
-    // Doesn't allow re-init
-    sentryService.init();
-
-    // Send error
-    const error = Error('an error');
-    const configureScope = jest.fn();
-    sentryService.sendError(error, configureScope);
-    expect(configureScope).toHaveBeenCalled();
-    expect(mockCaptureException).toHaveBeenCalled();
-  });
-
-  it('does not not send metadata when the option is disabled', () => {
-    // Init with metadata option disabled
-    global.strapi.config.get = () => ({ dsn: VALID_DSN, sendMetadata: false });
-    const sentryService = sentryServiceLoader({ strapi });
-    sentryService.init();
-
-    // Send error
-    const error = Error('an error');
-    const configureScope = jest.fn();
-    sentryService.sendError(error, configureScope);
-    expect(configureScope).not.toHaveBeenCalled();
-  });
-});

package/server/services/index.js

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

package/server/services/sentry/index.js

@@ -1,85 +0,0 @@
-'use strict';
-
-// FIXME
-/* eslint-disable import/extensions */
-const Sentry = require('@sentry/node');
-
-const createSentryService = (strapi) => {
-  let isReady = false;
-  let instance = null;
-  let settings = {};
-
-  return {
-    /**
-     * Initialize Sentry service
-     */
-    init() {
-      // Make sure there isn't a Sentry instance already running
-      if (instance !== null) {
-        return this;
-      }
-
-      // Retrieve user settings and merge them with the default ones
-      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.get('environment'),
-            ...settings.init,
-          });
-          // Store the successfully initialized Sentry instance
-          instance = Sentry;
-          isReady = true;
-        } else {
-          strapi.log.info('@strapi/plugin-sentry is disabled because no Sentry DSN was provided');
-        }
-      } catch (error) {
-        strapi.log.warn('Could not set up Sentry, make sure you entered a valid DSN');
-      }
-
-      return this;
-    },
-
-    /**
-     * Expose Sentry instance through a getter
-     * @returns {Sentry}
-     */
-    getInstance() {
-      return instance;
-    },
-
-    /**
-     * Callback to [configure an instance of Sentry's scope]{@link https://docs.sentry.io/platforms/node/enriching-events/scopes/#configuring-the-scope}
-     * @callback configureScope
-     * @param {Sentry.scope} scope
-     * @param {Sentry=} instance An initialized Sentry instance
-     */
-
-    /**
-     * Higher level method to send exception events to Sentry
-     * @param {Error} error An error object
-     * @param {configureScope=} configureScope
-     */
-    sendError(error, configureScope) {
-      // Make sure Sentry is ready
-      if (!isReady) {
-        strapi.log.warn("Sentry wasn't properly initialized, cannot send event");
-        return;
-      }
-
-      instance.withScope((scope) => {
-        // Configure the Sentry scope using the provided callback
-        if (configureScope && settings.sendMetadata) {
-          configureScope(scope, instance);
-        }
-        // Actually send the Error to Sentry
-        instance.captureException(error);
-      });
-    },
-  };
-};
-
-module.exports = ({ strapi }) => createSentryService(strapi);