chore: add public API alerting (#4089)

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>

Author: joanagmaia

backend/src/api/public/middlewares/errorHandler.ts

@@ -4,7 +4,13 @@ import {
   UnauthorizedError as Auth0UnauthorizedError,
 } from 'express-oauth2-jwt-bearer'
 
-import { HttpError, InsufficientScopeError, InternalError, UnauthorizedError } from '@crowd/common'
+import {
+  ConflictError,
+  HttpError,
+  InsufficientScopeError,
+  InternalError,
+  UnauthorizedError,
+} from '@crowd/common'
 import { SlackChannel, SlackPersona, sendSlackNotification } from '@crowd/slack'
 
 /**
@@ -17,6 +23,30 @@ export const errorHandler: ErrorRequestHandler = (
   res: Response,
   _next: NextFunction,
 ) => {
+  if (error instanceof ConflictError) {
+    req.log.warn({ context: error.context }, 'Public API conflict')
+    sendSlackNotification(
+      SlackChannel.CDP_LFX_SELF_SERVE_ALERTS,
+      SlackPersona.WARNING_PROPAGATOR,
+      `Public API Conflict 409: ${req.method} ${req.url}`,
+      [
+        {
+          title: 'Request',
+          text: `*Method:* \`${req.method}\`\n*URL:* \`${req.url}\``,
+        },
+        {
+          title: 'Conflict',
+          text: `*Message:* ${error.message}`,
+        },
+        ...(error.context
+          ? [{ title: 'Context', text: `\`\`\`${JSON.stringify(error.context, null, 2)}\`\`\`` }]
+          : []),
+      ],
+    )
+    res.status(error.status).json(error.toJSON())
+    return
+  }
+
   if (error instanceof HttpError) {
     res.status(error.status).json(error.toJSON())
     return

backend/src/api/public/v1/members/resolveMember.ts

@@ -32,7 +32,7 @@ export async function resolveMemberByIdentities(req: Request, res: Response): Pr
   if (memberIds.length === 0) {
     throw new NotFoundError('Member not found')
   } else if (memberIds.length > 1) {
-    throw new ConflictError('Conflicting identities')
+    throw new ConflictError('Conflicting identities', { memberIds })
   }
 
   const memberId = memberIds[0]

services/libs/common/src/errors/http.ts

@@ -70,9 +70,11 @@ export class NotFoundError extends HttpError {
 export class ConflictError extends HttpError {
   readonly code = 'CONFLICT'
   readonly status = 409
+  readonly context?: Record<string, unknown>
 
-  constructor(message = 'Conflict') {
+  constructor(message = 'Conflict', context?: Record<string, unknown>) {
     super(message)
+    this.context = context
   }
 }
 

services/libs/slack/src/channels.ts

@@ -12,6 +12,7 @@ const CHANNEL_WEBHOOK_URLS: Record<SlackChannel, string | undefined> = {
   [SlackChannel.CDP_PROJECTS_ALERTS]: process.env.CDP_PROJECTS_ALERTS_SLACK_WEBHOOK_URL,
   [SlackChannel.INSIGHTS_ALERTS]: process.env.INSIGHTS_ALERTS_SLACK_WEBHOOK_URL,
   [SlackChannel.INSIGHTS_CRITICAL_ALERTS]: process.env.INSIGHTS_CRITICAL_ALERTS_SLACK_WEBHOOK_URL,
+  [SlackChannel.CDP_LFX_SELF_SERVE_ALERTS]: process.env.CDP_LFX_SELF_SERVE_ALERTS_SLACK_WEBHOOK_URL,
 }
 
 // Check for missing webhook URLs on initialization

services/libs/slack/src/types.ts

@@ -6,6 +6,7 @@ export enum SlackChannel {
   CDP_PROJECTS_ALERTS = 'CDP_PROJECTS_ALERTS',
   INSIGHTS_ALERTS = 'INSIGHTS_ALERTS',
   INSIGHTS_CRITICAL_ALERTS = 'INSIGHTS_CRITICAL_ALERTS',
+  CDP_LFX_SELF_SERVE_ALERTS = 'CDP_LFX_SELF_SERVE_ALERTS',
 }
 
 export enum SlackPersona {