feat(condo): DOMA-10226 add full stacked gql error traces

.env.example

@@ -48,6 +48,6 @@ TELEGRAM_EMPLOYEE_BOT_TOKEN=telegram-token
 DISABLE_CAPTCHA=true
 USE_LOCAL_FEATURE_FLAGS=true
 NOTIFICATION__SEND_ALL_MESSAGES_TO_CONSOLE=true
-NOTIFICATION__DISABLE_LOGGING=true
+NOTIFICATION__DISABLE_LOGGING=false
 TESTS_LOG_REQUEST_RESPONSE=true
 WORKER_CONCURRENCY=50

.github/workflows/_nodejs.condo.core.tests.yml

@@ -61,7 +61,7 @@ jobs:
         uses: actions/upload-artifact@v4
         if: failure()
         with:
-          name: logs
+          name: logs-${{ inputs.domain_name }}-${{ env.GITHUB_RUN_ID }}-${{ env.GITHUB_RUN_NUMBER }}
           path: |
             ./test_logs/*
             *.log

apps/address-service/domains/address/schema/Address.test.js

@@ -16,6 +16,7 @@ const {
     expectToThrowAuthenticationErrorToObjects,
     expectToThrowAccessDeniedErrorToObj,
     expectToThrowAccessDeniedErrorToObjects,
+    expectToThrowValidationFailureError,
 } = require('@open-condo/keystone/test.utils')
 
 const { OVERRIDING_ROOT } = require('@address-service/domains/address/constants')
@@ -201,7 +202,7 @@ describe('Address', () => {
 
     describe('Overriding', () => {
         test('throw an error if no field to override', async () => {
-            await catchErrorFrom(
+            await expectToThrowValidationFailureError(
                 async () => {
                     await createTestAddress(
                         adminClient,
@@ -211,23 +212,12 @@ describe('Address', () => {
                         },
                     )
                 },
-                (caught) => {
-                    expect(caught).toEqual(expect.objectContaining({
-                        errors: [expect.objectContaining({
-                            name: 'ValidationFailureError',
-                            path: ['obj'],
-                            data: expect.objectContaining({
-                                messages: ['meta.data does not contains "nonExistingField" field'],
-                            }),
-                        })],
-                        data: { obj: null },
-                    }))
-                },
+                'meta.data does not contains "nonExistingField" field',
             )
         })
 
         test('throw an error if try to override with the same value', async () => {
-            await catchErrorFrom(
+            await expectToThrowValidationFailureError(
                 async () => {
                     await createTestAddress(
                         adminClient,
@@ -237,23 +227,12 @@ describe('Address', () => {
                         },
                     )
                 },
-                (caught) => {
-                    expect(caught).toEqual(expect.objectContaining({
-                        errors: [expect.objectContaining({
-                            name: 'ValidationFailureError',
-                            path: ['obj'],
-                            data: expect.objectContaining({
-                                messages: ['You trying to override field meta.data.someField with the same value'],
-                            }),
-                        })],
-                        data: { obj: null },
-                    }))
-                },
+                'You trying to override field meta.data.someField with the same value',
             )
         })
 
         test('throw an error if try to override with array', async () => {
-            await catchErrorFrom(
+            await expectToThrowValidationFailureError(
                 async () => {
                     await createTestAddress(
                         adminClient,
@@ -263,23 +242,12 @@ describe('Address', () => {
                         },
                     )
                 },
-                (caught) => {
-                    expect(caught).toEqual(expect.objectContaining({
-                        errors: [expect.objectContaining({
-                            name: 'ValidationFailureError',
-                            path: ['obj'],
-                            data: expect.objectContaining({
-                                messages: ['The "overrides" field must be an object'],
-                            }),
-                        })],
-                        data: { obj: null },
-                    }))
-                },
+                'The "overrides" field must be an object',
             )
         })
 
         test('throw an error if try to override with string', async () => {
-            await catchErrorFrom(
+            await expectToThrowValidationFailureError(
                 async () => {
                     await createTestAddress(
                         adminClient,
@@ -289,23 +257,12 @@ describe('Address', () => {
                         },
                     )
                 },
-                (caught) => {
-                    expect(caught).toEqual(expect.objectContaining({
-                        errors: [expect.objectContaining({
-                            name: 'ValidationFailureError',
-                            path: ['obj'],
-                            data: expect.objectContaining({
-                                messages: ['The "overrides" field must be an object'],
-                            }),
-                        })],
-                        data: { obj: null },
-                    }))
-                },
+                'The "overrides" field must be an object',
             )
         })
 
         test('throw an error if try to override with number', async () => {
-            await catchErrorFrom(
+            await expectToThrowValidationFailureError(
                 async () => {
                     await createTestAddress(
                         adminClient,
@@ -315,18 +272,7 @@ describe('Address', () => {
                         },
                     )
                 },
-                (caught) => {
-                    expect(caught).toEqual(expect.objectContaining({
-                        errors: [expect.objectContaining({
-                            name: 'ValidationFailureError',
-                            path: ['obj'],
-                            data: expect.objectContaining({
-                                messages: ['The "overrides" field must be an object'],
-                            }),
-                        })],
-                        data: { obj: null },
-                    }))
-                },
+                'The "overrides" field must be an object',
             )
         })
 
@@ -342,6 +288,7 @@ describe('Address', () => {
                     )
                 },
                 (caught) => {
+                    // TODO(pahaz): DOMA-10348 refactor and use `expectToThrowValidationFailureError`
                     expect(caught).toEqual(expect.objectContaining({
                         errors: [expect.objectContaining({
                             name: 'ValidationFailureError',

apps/condo/domains/acquiring/routes/paymentLinkRouter.js

@@ -245,6 +245,7 @@ class PaymentLinkRouter {
             ip,
             PAYMENT_LINK_WINDOW_SIZE,
             MAX_PAYMENT_LINK_REQUEST_BY_WINDOW,
+            { req },
         )
     }
 

apps/condo/domains/acquiring/schema/CalculateFeeForReceiptService.js

@@ -38,11 +38,12 @@ const ERRORS = {
 
 const redisGuard = new RedisGuard()
 
-const checkLimits = async (userId) => {
+const checkLimits = async (userId, context) => {
     await redisGuard.checkCustomLimitCounters(
         `calculate_fee_for_receipt:user:${userId}`,
         RESIDENT_CALCULATE_FEE_FOR_RECEIPT_WINDOW_IN_SEC,
         MAX_RESIDENT_CALCULATE_FEE_FOR_RECEIPT_WINDOW_IN_SEC_CALLS_BY_WINDOW_SEC,
+        context,
     )
 }
 

apps/condo/domains/acquiring/schema/CalculateFeeForReceiptService.test.js

@@ -5,7 +5,7 @@
 const { faker } = require('@faker-js/faker')
 const Big = require('big.js')
 
-const { expectToThrowGQLError, catchErrorFrom } = require('@open-condo/keystone/test.utils')
+const { expectToThrowGQLError, expectToThrowGQLErrorToResult } = require('@open-condo/keystone/test.utils')
 
 const { GQL_ERRORS: { PAYMENT_AMOUNT_LESS_THAN_MINIMUM } } = require('@condo/domains/acquiring/constants/errors')
 const { calculateFeeForReceiptByTestClient } = require('@condo/domains/acquiring/utils/testSchema')
@@ -19,8 +19,8 @@ describe('CalculateFeeForReceiptService', () => {
         await utils.init()
         await utils.updateAcquiringIntegration({
             explicitFeeDistributionSchema: [
-                { 'recipient':'acquiring', 'percent':'1.0' },
-                { 'recipient':'service', 'percent':'0.2' },
+                { 'recipient': 'acquiring', 'percent': '1.0' },
+                { 'recipient': 'service', 'percent': '0.2' },
             ],
         })
     })
@@ -38,7 +38,7 @@ describe('CalculateFeeForReceiptService', () => {
         test('Check calculations for implicit fees', async () => {
             const [[receipt]] = await utils.createReceipts()
             await utils.updateAcquiringContext({
-                implicitFeeDistributionSchema: [{ 'recipient':'organization', 'percent':'1.2' }],
+                implicitFeeDistributionSchema: [{ 'recipient': 'organization', 'percent': '1.2' }],
             })
             const amount = '300'
             const [result] = await calculateFeeForReceiptByTestClient(utils.clients.resident, { receipt: { id: receipt.id }, amount })
@@ -51,20 +51,17 @@ describe('CalculateFeeForReceiptService', () => {
         test('Receipt must exist', async () => {
             const missingReceiptId = faker.datatype.uuid()
             const amount = '300'
-            await catchErrorFrom(async () => {
+            await expectToThrowGQLErrorToResult(async () => {
                 await calculateFeeForReceiptByTestClient(utils.clients.resident, { receipt: { id: missingReceiptId }, amount })
-            }, ({ errors }) => {
-                expect(errors).toMatchObject([{
-                    message: `Cannot find specified BillingReceipt with id ${missingReceiptId}`,
-                    path: ['result'],
-                    extensions: {
-                        query: 'calculateFeeForReceipt',
-                        variable: ['data', 'receipt', 'id'],
-                        code: 'BAD_USER_INPUT',
-                        type: 'CANNOT_FIND_ALL_BILLING_RECEIPTS',
-                        message: 'Cannot find specified BillingReceipt with id {missingReceiptId}',
-                    },
-                }])
+            }, {
+                query: 'calculateFeeForReceipt',
+                variable: ['data', 'receipt', 'id'],
+                code: 'BAD_USER_INPUT',
+                type: 'CANNOT_FIND_ALL_BILLING_RECEIPTS',
+                message: 'Cannot find specified BillingReceipt with id {missingReceiptId}',
+                messageInterpolation: {
+                    missingReceiptId,
+                },
             })
         })
     })

apps/condo/domains/acquiring/schema/CreatePaymentByLinkService.test.js

@@ -8,7 +8,7 @@ const dayjs = require('dayjs')
 
 const {
     makeLoggedInAdminClient, makeClient, expectToThrowAuthenticationErrorToResult, catchErrorFrom,
-    expectToThrowAccessDeniedErrorToResult,
+    expectToThrowAccessDeniedErrorToResult, expectToThrowGQLErrorToResult,
 } = require('@open-condo/keystone/test.utils')
 
 const { CONTEXT_FINISHED_STATUS } = require('@condo/domains/acquiring/constants/context')
@@ -431,26 +431,13 @@ describe('CreatePaymentByLinkService', () => {
 
         const payload = { qrCode }
 
-        await catchErrorFrom(async () => {
+        await expectToThrowGQLErrorToResult(async () => {
             await createPaymentByLinkByTestClient(user, payload)
-        }, (error) => {
-            const { errors } = error
-            expect(errors).toEqual([
-                expect.objectContaining({
-                    message: '[error] Unable to validateQRCode',
-                    originalError: expect.objectContaining({
-                        errors: [expect.objectContaining({
-                            name: 'GQLError',
-                            message: 'Provided bank account is not in the system',
-                            extensions: expect.objectContaining({
-                                mutation: 'validateQRCode',
-                                code: 'BAD_USER_INPUT',
-                                message: 'Provided bank account is not in the system',
-                            }),
-                        })],
-                    }),
-                }),
-            ])
+        }, {
+            mutation: 'validateQRCode',
+            code: 'BAD_USER_INPUT',
+            type: 'WRONG_FORMAT',
+            message: 'Provided bank account is not in the system',
         })
 
     })
@@ -522,6 +509,7 @@ describe('CreatePaymentByLinkService', () => {
                 advancedAt: dayjs().toISOString(),
             })
 
+            // TODO(pahaz): DOMA-10368 use expectToThrowGQLErrorToResult
             await catchErrorFrom(async () => {
                 await createPaymentByLinkByTestClient(admin, { qrCode })
             }, (error) => {
@@ -570,6 +558,7 @@ describe('CreatePaymentByLinkService', () => {
                 advancedAt: dayjs().toISOString(),
             })
 
+            // TODO(pahaz): DOMA-10368 use expectToThrowGQLErrorToResult
             await catchErrorFrom(async () => {
                 await createPaymentByLinkByTestClient(admin, { qrCode })
             }, (error) => {
@@ -618,6 +607,7 @@ describe('CreatePaymentByLinkService', () => {
                 advancedAt: dayjs().toISOString(),
             })
 
+            // TODO(pahaz): DOMA-10368 use expectToThrowGQLErrorToResult
             await catchErrorFrom(async () => {
                 await createPaymentByLinkByTestClient(admin, { qrCode })
             }, (error) => {
@@ -682,6 +672,7 @@ describe('CreatePaymentByLinkService', () => {
                 advancedAt: dayjs().toISOString(),
             })
 
+            // TODO(pahaz): DOMA-10368 use expectToThrowGQLErrorToResult
             await catchErrorFrom(async () => {
                 await createPaymentByLinkByTestClient(admin, { qrCode })
             }, (error) => {

apps/condo/domains/acquiring/schema/ExportPaymentsService.js

@@ -40,7 +40,8 @@ const ERRORS = {
         code: BAD_USER_INPUT,
         type: WRONG_FORMAT,
         message: 'Invalid format of "sender" field value. {details}',
-        correctExample: '{ dv: 1, fingerprint: \'example-fingerprint-alphanumeric-value\'}',
+        correctExample: '{ "dv": 1, "fingerprint": "uniq-device-or-container-id" }',
+        messageInterpolation: { details: 'Please, check the example for details' },
     },
     NOTHING_TO_EXPORT: {
         // TODO(pahaz): mutation! cahnge

apps/condo/domains/acquiring/schema/GeneratePaymentLinkService.js

@@ -63,7 +63,8 @@ const ERRORS = {
         code: BAD_USER_INPUT,
         type: WRONG_FORMAT,
         message: 'Invalid format of "sender" field value. {details}',
-        correctExample: '{ dv: 1, fingerprint: \'example-fingerprint-alphanumeric-value\'}',
+        correctExample: '{ "dv": 1, "fingerprint": "uniq-device-or-container-id" }',
+        messageInterpolation: { details: 'Please, check the example for details' },
     },
     ACQUIRING_INTEGRATION_CONTEXT_IS_DELETED: {
         mutation: 'generatePaymentLink',