Merge pull request #1174 from serlo/1143-api-sentry-logs-sometimes-do…

…nt-help-at-debugging

feat: Add type and payload to sentry logging

__tests__/examples/data-sources/how-to-create-a-mutation.ts

@@ -102,6 +102,8 @@ describe('How to create a mutation in a data source: update the content of an ar
             // the right values.
             return (await res.json()) as unknown
           },
+
+          type: 'ExampleMutation',
         }),
       },
     }

__tests__/examples/data-sources/how-to-create-a-query.ts

@@ -111,6 +111,9 @@ describe('How to create a query in a data source: Fetching the content of an art
 
             // Add an example payload which is used in tests
             examplePayload: { id: 1 },
+
+            // Add a name for sentry logs
+            type: 'ExampleQuery',
           },
           // In the actual code you will pass the `environment` variable here
           createTestEnvironment(),

__tests__/internals/sentry.ts

@@ -29,6 +29,8 @@ test('invalid values from data sources are reported', async () => {
     errorContext: {
       invalidCurrentValue: invalidValue,
       key: 'de.serlo.org/api/uuid/42',
+      type: 'UuidQuery',
+      payload: { id: 42 },
     },
   })
 })

packages/server/src/internals/data-source-helper/common.ts

@@ -8,6 +8,8 @@ export class InvalidCurrentValueError extends Error {
       invalidCurrentValue: unknown
       decoder: string
       validationErrors: string[]
+      type?: string
+      payload: unknown
       key?: string
     },
   ) {

packages/server/src/internals/data-source-helper/mutation.ts

@@ -23,6 +23,8 @@ export function createMutation<P, R>(spec: MutationSpec<P, R>): Mutation<P, R> {
         invalidCurrentValue: result,
         decoder: spec.decoder.name,
         validationErrors: reporter.report(decodedResult),
+        type: spec.type,
+        payload,
       })
     }
   }
@@ -54,6 +56,8 @@ interface MutationSpec<Payload, Result> {
    * executed and the result of the mutation matches the decoder.
    */
   updateCache?: (payload: Payload, newValue: Result) => AsyncOrSync<void>
+
+  type: string
 }
 
 /**

packages/server/src/internals/data-source-helper/query.ts

@@ -67,6 +67,8 @@ export function createQuery<P, R>(
         invalidCurrentValue: value,
         decoder: decoder.name,
         validationErrors: reporter.report(decoded),
+        payload,
+        type: spec.type,
         key,
       })
     }
@@ -164,6 +166,8 @@ export interface QuerySpec<Payload, Result> {
   getPayload: (key: string) => O.Option<Payload>
 
   examplePayload: Payload
+
+  type: string
 }
 
 /**

packages/server/src/internals/data-source-helper/request.ts

@@ -18,6 +18,8 @@ interface RequestSpec<Payload, Result> {
    * Function which does the actual query operation.
    */
   getCurrentValue: (payload: Payload) => Promise<unknown>
+
+  type: string
 }
 
 /**
@@ -46,6 +48,8 @@ export function createRequest<P, R>(spec: RequestSpec<P, R>): Request<P, R> {
       throw new InvalidCurrentValueError({
         invalidCurrentValue: result,
         decoder: spec.decoder.name,
+        payload,
+        type: spec.type,
         validationErrors: reporter.report(decodedResult),
       })
     }

packages/server/src/internals/server/kratos-middleware.ts

@@ -13,6 +13,7 @@ import { DatabaseLayer } from '~/model'
 const basePath = '/kratos'
 
 const createLegacyUser = createRequest({
+  type: 'UserCreateMutation',
   decoder: DatabaseLayer.getDecoderFor('UserCreateMutation'),
   async getCurrentValue(payload: DatabaseLayer.Payload<'UserCreateMutation'>) {
     return DatabaseLayer.makeRequest('UserCreateMutation', payload)

packages/server/src/model/chat.ts

@@ -8,6 +8,7 @@ import { Environment } from '~/internals/environment'
 export function createChatModel({ environment }: { environment: Environment }) {
   const getUsersInfo = createQuery(
     {
+      type: 'community.serlo.org/get-users-info',
       decoder: t.strict({ success: t.boolean }),
       enableSwr: true,
       staleAfter: { minutes: 30 },
@@ -33,6 +34,7 @@ export function createChatModel({ environment }: { environment: Environment }) {
   )
 
   const deleteUser = createMutation({
+    type: 'community.serlo.org/delete-user',
     decoder: t.union([
       t.strict({ success: t.literal(true) }),
       t.strict({ success: t.literal(false), errorType: t.string }),

packages/server/src/model/google-spreadsheet-api.ts

@@ -43,6 +43,7 @@ export function createGoogleSpreadsheetApiModel({
 }) {
   const getValues = createQuery<Arguments, E.Either<ErrorEvent, CellValues>>(
     {
+      type: 'google-spreadsheets-api',
       enableSwr: true,
       getCurrentValue: async (args) => {
         const { spreadsheetId, range } = args

packages/server/src/model/kratos.ts

@@ -14,6 +14,7 @@ export function createKratosModel({
 }) {
   const getUserLanguage = createQuery(
     {
+      type: 'kratos.serlo.org/get-user-language',
       decoder: t.union([InstanceDecoder, t.null]),
       enableSwr: true,
       staleAfter: { days: 30 },
@@ -49,6 +50,7 @@ export function createKratosModel({
 
   const getLastLogin = createQuery(
     {
+      type: 'kratos.serlo.org/get-last-login',
       decoder: t.union([t.string, t.null]),
       enableSwr: true,
       staleAfter: { days: 1 },

packages/server/src/model/mailchimp.ts

@@ -4,6 +4,7 @@ import { createMutation } from '~/internals/data-source-helper'
 
 export function createMailchimpModel() {
   const deleteEmailPermanently = createMutation({
+    type: 'mailchimp/delete-user',
     decoder: t.union([
       t.strict({ success: t.literal(true) }),
       t.strict({ success: t.literal(false), mailchimpResponse: t.unknown }),