WIP: update Sentry to v8

TryGhost · May 9, 2024 · d9d3868 · d9d3868
1 parent 8c3e5ec
commit d9d3868
Show file tree

Hide file tree

Showing 8 changed files with 643 additions and 42 deletions.
diff --git a/ghost/core/core/app.js b/ghost/core/core/app.js
@@ -29,10 +29,6 @@ const maintenanceMiddleware = function maintenanceMiddleware(req, res, next) {
 
 const rootApp = () => {
  const app = express('root');
- app.use(sentry.requestHandler);
- if (config.get('sentry')?.tracing?.enabled === true) {
- app.use(sentry.tracingHandler);
- }
  app.enable('maintenance');
  app.use(maintenanceMiddleware);
 

diff --git a/ghost/core/core/frontend/helpers/get.js b/ghost/core/core/frontend/helpers/get.js
@@ -299,7 +299,7 @@ module.exports = async function get(resource, options) {
  try {
  const spanName = `{{#get "${resource}"${apiOptionsString}}} ${data.member ? 'member' : 'public'}`;
  const result = await Sentry.startSpan({
- op: 'frontend.helpers.get', 
+ op: 'frontend.helpers.get',
  name: spanName,
  tags: {
  resource,
@@ -313,19 +313,20 @@ module.exports = async function get(resource, options) {
  if (response[resource] && response[resource].length) {
  response[resource].forEach(prepareContextResource);
  }
- 
+
  // used for logging details of slow requests
  returnedRowsCount = response[resource] && response[resource].length;
- span?.setTag('returnedRows', returnedRowsCount);
-
+
+ // span?.setTag('returnedRows', returnedRowsCount);
+
  // block params allows the theme developer to name the data using something like
  // `{{#get "posts" as |result pageInfo|}}`
  const blockParams = [response[resource]];
  if (response.meta && response.meta.pagination) {
  response.pagination = response.meta.pagination;
  blockParams.push(response.meta.pagination);
  }
- 
+
  // Call the main template function
  const rendered = options.fn(response, {
  data: data,

diff --git a/ghost/core/core/frontend/web/middleware/error-handler.js b/ghost/core/core/frontend/web/middleware/error-handler.js
@@ -86,8 +86,6 @@ module.exports.handleThemeResponse = [
  prepareError,
  // Add cache-control header
  prepareErrorCacheControl(),
- // Handle the error in Sentry
- sentry.errorHandler,
  // Format the stack for the user
  prepareStack,
  // Render the error using theme template

diff --git a/ghost/core/core/shared/express.js b/ghost/core/core/shared/express.js
@@ -1,7 +1,7 @@
 const debug = require('@tryghost/debug')('shared:express');
 const express = require('express');
 const {createLazyRouter} = require('express-lazy-router');
-const sentry = require('./sentry');
+const Sentry = require('@sentry/node');
 
 const lazyLoad = createLazyRouter();
 
@@ -20,7 +20,7 @@ module.exports = (name) => {
  app.enable('trust proxy');
 
  // Sentry must be our first error handler. Mounting it here means all custom error handlers will come after
- app.use(sentry.errorHandler);
+ Sentry.setupExpressErrorHandler(app);
 
  app.lazyUse = function lazyUse(mountPath, requireFn) {
  app.use(mountPath, lazyLoad(() => {
@@ -39,7 +39,7 @@ module.exports.Router = (name, options) => {
  debug('new Router start', name);
  const router = express.Router(options);
 
- router.use(sentry.errorHandler);
+ Sentry.setupExpressErrorHandler(router);
 
  debug('new Router end', name);
  return router;

diff --git a/ghost/core/core/shared/sentry.js b/ghost/core/core/shared/sentry.js
@@ -125,8 +125,8 @@ if (sentryConfig && !sentryConfig.disabled) {
 
  // Enable tracing if sentry.tracing.enabled is true
  if (sentryConfig.tracing?.enabled === true) {
- sentryInitConfig.integrations.push(new Sentry.Integrations.Http({tracing: true}));
  sentryInitConfig.tracesSampleRate = parseFloat(sentryConfig.tracing.sampleRate) || 0.0;
+
  // Enable profiling, if configured, only if tracing is also configured
  if (sentryConfig.profiling?.enabled === true) {
  // Import Sentry's profiling integration if available
@@ -147,9 +147,6 @@ if (sentryConfig && !sentryConfig.disabled) {
  Sentry.init(sentryInitConfig);
 
  module.exports = {
- requestHandler: Sentry.Handlers.requestHandler(),
- errorHandler: Sentry.Handlers.errorHandler(),
- tracingHandler: Sentry.Handlers.tracingHandler(),
  captureException: Sentry.captureException,
  captureMessage: Sentry.captureMessage,
  beforeSend: beforeSend,
@@ -158,22 +155,16 @@ if (sentryConfig && !sentryConfig.disabled) {
  if (sentryConfig.tracing?.enabled === true) {
  const integration = new SentryKnexTracingIntegration(knex);
 
- Sentry.addIntegration(integration);
+ // Sentry.addIntegration(integration);
  }
  }
  };
 } else {
- const expressNoop = function (req, res, next) {
- next();
- };
-
  const noop = () => {};
 
  module.exports = {
- requestHandler: expressNoop,
- errorHandler: expressNoop,
- tracingHandler: expressNoop,
  captureException: noop,
+ captureMessage: noop,
  initQueryTracing: noop
  };
 }
diff --git a/ghost/core/package.json b/ghost/core/package.json
@@ -58,7 +58,7 @@
  },
  "dependencies": {
  "@extractus/oembed-extractor": "3.2.1",
- "@sentry/node": "7.114.0",
+ "@sentry/node": "8.0.0-rc.2",
  "@tryghost/adapter-base-cache": "0.1.12",
  "@tryghost/adapter-cache-redis": "0.0.0",
  "@tryghost/adapter-manager": "0.0.0",

diff --git a/ghost/mw-error-handler/lib/mw-error-handler.js b/ghost/mw-error-handler/lib/mw-error-handler.js
@@ -294,8 +294,6 @@ module.exports.handleJSONResponse = sentry => [
  module.exports.prepareError,
  // Add cache-control header
  module.exports.prepareErrorCacheControl(),
- // Handle the error in Sentry
- sentry.errorHandler,
  // Format the stack for the user
  module.exports.prepareStack,
  // Render the error using JSON format
@@ -307,8 +305,6 @@ module.exports.handleHTMLResponse = sentry => [
  module.exports.prepareError,
  // Add cache-control header
  module.exports.prepareErrorCacheControl(cacheControlValues.private),
- // Handle the error in Sentry
- sentry.errorHandler,
  // Format the stack for the user
  module.exports.prepareStack
 ];