TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-22 11:16:01 +03:00
Code Issues Projects Releases Wiki Activity

ENG-1526 Added logs and sentry messages in Router Controller (#20955)

Browse Source 
Ref:
https://linear.app/tryghost/issue/ENG-1526/errors-from-members-api-routercontroller-are-being-lost

The try/catch/re-throw pattern, that hides errors, is used throughout
the RouterController.js file.
I have not changed the try/catch/re-throw pattern because it helps in
sending clean messages to the users. We may not want to return internal
errors as API responses.
I have added logs and Sentry messages that will help us debug without
losing error messages.
This commit is contained in:
Princi Vershwal 2024-09-10 16:47:12 +05:30 committed by GitHub
parent 9860371df7
commit b14b44faa4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
ghost/members-api/lib/controllers/RouterController.js
View File

@ -40,6 +40,7 @@ module.exports = class RouterController {
* @param {any} deps.sendEmailWithMagicLink
* @param {{isSet(name: string): boolean}} deps.labsService
* @param {any} deps.newslettersService
* @param {any} deps.sentry
*/
constructor({
offersAPI,
@ -54,7 +55,8 @@ module.exports = class RouterController {
memberAttributionService,
sendEmailWithMagicLink,
labsService,
newslettersService
newslettersService,
sentry
}) {
this._offersAPI = offersAPI;
this._paymentsService = paymentsService;
@ -69,6 +71,7 @@ module.exports = class RouterController {
this._memberAttributionService = memberAttributionService;
this.labsService = labsService;
this._newslettersService = newslettersService;
this._sentry = sentry || undefined;
}
async ensureStripe(_req, res, next) {
@ -80,6 +83,7 @@ module.exports = class RouterController {
await this._stripeAPIService.ready();
next();
} catch (err) {
logging.error(err);
res.writeHead(500);
return res.end('There was an error configuring stripe');
}
@ -102,6 +106,7 @@ module.exports = class RouterController {
email = claims && claims.sub;
}
} catch (err) {
logging.error(err);
res.writeHead(401);
return res.end('Unauthorized');
}
@ -270,6 +275,8 @@ module.exports = class RouterController {
throw undefined;
}
} catch (err) {
logging.error(err);
this._sentry?.captureException?.(err);
throw new BadRequestError({
message: tpl(messages.tierNotFound),
context: 'Tier with id "' + tierId + '" not found'
@ -351,6 +358,8 @@ module.exports = class RouterController {
return {url: paymentLink};
} catch (err) {
logging.error(err);
this._sentry?.captureException?.(err);
throw new BadRequestError({
err,
message: tpl(messages.unableToCheckout)
@ -381,6 +390,8 @@ module.exports = class RouterController {
return {url: paymentLink};
} catch (err) {
logging.error(err);
this._sentry?.captureException?.(err);
throw new BadRequestError({
err,
message: tpl(messages.unableToCheckout)
@ -418,6 +429,8 @@ module.exports = class RouterController {
isAuthenticated = true;
}
} catch (err) {
logging.error(err);
this._sentry?.captureException?.(err);
throw new UnauthorizedError({err});
}
} else if (req.body.customerEmail) {
@ -592,6 +605,7 @@ module.exports = class RouterController {
res.writeHead(400);
return res.end('Bad Request.');
}
logging.error(err);
// Let the normal error middleware handle this error
throw err;

3
ghost/members-api/lib/members-api.js
View File

@ -192,7 +192,8 @@ module.exports = function MembersAPI({
sendEmailWithMagicLink,
memberAttributionService,
labsService,
newslettersService
newslettersService,
sentry
});
const wellKnownController = new WellKnownController({