diff --git a/packages/twenty-server/src/engine/core-modules/auth/middlewares/workspace-auth-context.middleware.ts b/packages/twenty-server/src/engine/core-modules/auth/middlewares/workspace-auth-context.middleware.ts index c446be9c32..23c87cd7d8 100644 --- a/packages/twenty-server/src/engine/core-modules/auth/middlewares/workspace-auth-context.middleware.ts +++ b/packages/twenty-server/src/engine/core-modules/auth/middlewares/workspace-auth-context.middleware.ts @@ -13,6 +13,7 @@ import { buildApiKeyAuthContext } from 'src/engine/core-modules/auth/utils/build import { buildApplicationAuthContext } from 'src/engine/core-modules/auth/utils/build-application-auth-context.util'; import { buildPendingActivationUserAuthContext } from 'src/engine/core-modules/auth/utils/build-pending-activation-user-auth-context.util'; import { buildUserAuthContext } from 'src/engine/core-modules/auth/utils/build-user-auth-context.util'; +import { applyWorkspaceSentryContext } from 'src/engine/core-modules/sentry/utils/apply-workspace-sentry-context.util'; @Injectable() export class WorkspaceAuthContextMiddleware implements NestMiddleware { @@ -25,6 +26,8 @@ export class WorkspaceAuthContextMiddleware implements NestMiddleware { const authContext = this.buildAuthContext(req); + applyWorkspaceSentryContext(authContext); + withWorkspaceAuthContext(authContext, () => { next(); }); diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/bullmq.driver.ts b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/bullmq.driver.ts index 0f94e52594..dedb66ac09 100644 --- a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/bullmq.driver.ts +++ b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/bullmq.driver.ts @@ -4,6 +4,7 @@ import { type OnModuleInit, } from '@nestjs/common'; +import * as Sentry from '@sentry/node'; import { type JobsOptions, MetricsTime, @@ -28,6 +29,7 @@ import { type MessageQueue } from 'src/engine/core-modules/message-queue/message import { getJobKey } from 'src/engine/core-modules/message-queue/utils/get-job-key.util'; import { type MetricsService } from 'src/engine/core-modules/metrics/metrics.service'; import { MetricsKeys } from 'src/engine/core-modules/metrics/types/metrics-keys.type'; +import { applyWorkspaceSentryContextFromJobData } from 'src/engine/core-modules/sentry/utils/apply-workspace-sentry-context-from-job-data.util'; export type BullMQDriverOptions = QueueOptions; @@ -108,25 +110,28 @@ export class BullMQDriver this.workerMap[queueName] = new Worker( queueName, - async (job) => { - // TODO: Correctly support for job.id - const timeStart = performance.now(); - const workspaceId = job.data?.workspaceId; - const workspaceSuffix = workspaceId - ? ` [workspace=${workspaceId}]` - : ''; + async (job) => + Sentry.withIsolationScope(async () => { + applyWorkspaceSentryContextFromJobData(job.data); - this.logger.log( - `Processing job ${job.id} with name ${job.name} on queue ${queueName}${workspaceSuffix}`, - ); - await handler({ data: job.data, id: job.id ?? '', name: job.name }); - const timeEnd = performance.now(); - const executionTime = timeEnd - timeStart; + // TODO: Correctly support for job.id + const timeStart = performance.now(); + const workspaceId = job.data?.workspaceId; + const workspaceSuffix = workspaceId + ? ` [workspace=${workspaceId}]` + : ''; - this.logger.log( - `Job ${job.id} with name ${job.name} processed on queue ${queueName} in ${executionTime.toFixed(2)}ms${workspaceSuffix}`, - ); - }, + this.logger.log( + `Processing job ${job.id} with name ${job.name} on queue ${queueName}${workspaceSuffix}`, + ); + await handler({ data: job.data, id: job.id ?? '', name: job.name }); + const timeEnd = performance.now(); + const executionTime = timeEnd - timeStart; + + this.logger.log( + `Job ${job.id} with name ${job.name} processed on queue ${queueName} in ${executionTime.toFixed(2)}ms${workspaceSuffix}`, + ); + }), workerOptions, ); diff --git a/packages/twenty-server/src/engine/core-modules/sentry/utils/apply-workspace-sentry-context-from-job-data.util.ts b/packages/twenty-server/src/engine/core-modules/sentry/utils/apply-workspace-sentry-context-from-job-data.util.ts new file mode 100644 index 0000000000..0d78ba3515 --- /dev/null +++ b/packages/twenty-server/src/engine/core-modules/sentry/utils/apply-workspace-sentry-context-from-job-data.util.ts @@ -0,0 +1,25 @@ +import { applyWorkspaceSentryFields } from 'src/engine/core-modules/sentry/utils/apply-workspace-sentry-fields.util'; + +export const applyWorkspaceSentryContextFromJobData = ( + jobData: unknown, +): void => { + if (typeof jobData !== 'object' || jobData === null) { + return; + } + + const workspaceId = (jobData as { workspaceId?: unknown }).workspaceId; + const userWorkspaceId = (jobData as { userWorkspaceId?: unknown }) + .userWorkspaceId; + + if (typeof workspaceId !== 'string' || workspaceId.length === 0) { + return; + } + + applyWorkspaceSentryFields({ + workspaceId, + userWorkspaceId: + typeof userWorkspaceId === 'string' && userWorkspaceId.length > 0 + ? userWorkspaceId + : undefined, + }); +}; diff --git a/packages/twenty-server/src/engine/core-modules/sentry/utils/apply-workspace-sentry-context.util.ts b/packages/twenty-server/src/engine/core-modules/sentry/utils/apply-workspace-sentry-context.util.ts new file mode 100644 index 0000000000..3c9ea343d8 --- /dev/null +++ b/packages/twenty-server/src/engine/core-modules/sentry/utils/apply-workspace-sentry-context.util.ts @@ -0,0 +1,27 @@ +import { type WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type'; +import { applyWorkspaceSentryFields } from 'src/engine/core-modules/sentry/utils/apply-workspace-sentry-fields.util'; + +export const applyWorkspaceSentryContext = ( + authContext: WorkspaceAuthContext, +): void => { + const workspaceId = authContext.workspace?.id; + + if (!workspaceId) { + return; + } + + switch (authContext.type) { + case 'user': + case 'pendingActivationUser': + applyWorkspaceSentryFields({ + workspaceId, + userWorkspaceId: authContext.userWorkspaceId, + }); + return; + case 'apiKey': + case 'application': + case 'system': + applyWorkspaceSentryFields({ workspaceId }); + return; + } +}; diff --git a/packages/twenty-server/src/engine/core-modules/sentry/utils/apply-workspace-sentry-fields.util.ts b/packages/twenty-server/src/engine/core-modules/sentry/utils/apply-workspace-sentry-fields.util.ts new file mode 100644 index 0000000000..a65e17d3d5 --- /dev/null +++ b/packages/twenty-server/src/engine/core-modules/sentry/utils/apply-workspace-sentry-fields.util.ts @@ -0,0 +1,26 @@ +import * as Sentry from '@sentry/node'; + +type WorkspaceSentryFields = { + workspaceId: string; + userWorkspaceId?: string; +}; + +export const applyWorkspaceSentryFields = ( + fields: WorkspaceSentryFields, +): void => { + Sentry.setUser({ + id: fields.userWorkspaceId ?? fields.workspaceId, + }); + + Sentry.setTag('twenty.workspace.id', fields.workspaceId); + if (fields.userWorkspaceId) { + Sentry.setTag('twenty.user_workspace.id', fields.userWorkspaceId); + } + + Sentry.setContext('twenty', { + workspace_id: fields.workspaceId, + ...(fields.userWorkspaceId && { + user_workspace_id: fields.userWorkspaceId, + }), + }); +}; diff --git a/packages/twenty-server/src/instrument.ts b/packages/twenty-server/src/instrument.ts index 217d123139..1c09ae04b0 100644 --- a/packages/twenty-server/src/instrument.ts +++ b/packages/twenty-server/src/instrument.ts @@ -45,6 +45,29 @@ if (process.env.EXCEPTION_HANDLER_DRIVER === ExceptionHandlerDriver.SENTRY) { profilesSampleRate: 0.3, sendDefaultPii: true, debug: process.env.NODE_ENV === NodeEnvironment.DEVELOPMENT, + beforeSendSpan: (span) => { + const twentyContext = Sentry.getIsolationScope().getScopeData().contexts + ?.twenty as + | { + workspace_id?: string; + user_workspace_id?: string; + } + | undefined; + + if (!twentyContext?.workspace_id) { + return span; + } + + span.data = { + ...span.data, + 'twenty.workspace.id': twentyContext.workspace_id, + ...(twentyContext.user_workspace_id && { + 'twenty.user_workspace.id': twentyContext.user_workspace_id, + }), + }; + + return span; + }, }); }