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

apps/condo/domains/billing/schema/BillingAccount.test.js

@@ -9,7 +9,6 @@ const {
     expectToThrowAuthenticationErrorToObjects,
     expectToThrowAccessDeniedErrorToObj,
     expectToThrowAccessDeniedErrorToObjects,
-    expectToThrowInternalError,
     expectToThrowGraphQLRequestError,
     expectToThrowValidationFailureError,
 } = require('@open-condo/keystone/test.utils')

apps/condo/domains/billing/schema/BillingProperty.test.js

@@ -9,7 +9,6 @@ const {
     expectToThrowAuthenticationErrorToObjects,
     expectToThrowAccessDeniedErrorToObj,
     expectToThrowAccessDeniedErrorToObjects,
-    expectToThrowInternalError,
     expectToThrowGraphQLRequestError,
 } = require('@open-condo/keystone/test.utils')
 const { makeClient } = require('@open-condo/keystone/test.utils')

apps/condo/domains/billing/schema/ValidateQRCodeService.js

@@ -143,6 +143,7 @@ const ValidateQRCodeService = new GQLCustomSchema('ValidateQRCodeService', {
                         `validate-QR-code-${ip}`,
                         BILLING_VALIDATE_QR_CODE_WINDOW,
                         MAX_CLIENT_VALIDATE_QR_CODE_BY_WINDOW,
+                        context,
                     )
                 }
 

apps/condo/domains/billing/schema/ValidateQRCodeService.test.js

@@ -415,18 +415,15 @@ describe('ValidateQRCodeService', () => {
 
             for await (const i of Array.from(Array(MAX_CLIENT_VALIDATE_QR_CODE_BY_WINDOW + 1).keys())) {
                 if (i === MAX_CLIENT_VALIDATE_QR_CODE_BY_WINDOW) {
-                    await catchErrorFrom(async () => {
-                        await validateQRCodeByTestClient(anonymousClient, { qrCode: qrCodeString })
-                    }, ({ errors }) => {
-                        expect(errors).toMatchObject([{
-                            path: ['result'],
-                            extensions: {
-                                code: 'BAD_USER_INPUT',
-                                type: 'TOO_MANY_REQUESTS',
-                                message: 'You have to wait {secondsRemaining} seconds to be able to send request again',
-                            },
-                        }])
-                    })
+                    await expectToThrowGQLError(
+                        async () => await validateQRCodeByTestClient(anonymousClient, { qrCode: qrCodeString }),
+                        {
+                            code: 'BAD_USER_INPUT',
+                            type: 'TOO_MANY_REQUESTS',
+                            message: 'You have to wait {secondsRemaining} seconds to be able to send request again',
+                        },
+                        'result'
+                    )
                 } else {
                     await validateQRCodeByTestClient(anonymousClient, { qrCode: qrCodeString })
                 }

apps/condo/domains/billing/utils/testSchema/index.js

@@ -858,7 +858,7 @@ async function validateQRCodeByTestClient (client, extraAttrs = {}) {
         ...extraAttrs,
     }
     const { data, errors } = await client.mutate(VALIDATE_QRCODE_MUTATION, { data: attrs })
-    throwIfError(data, errors)
+    throwIfError(data, errors, { query: VALIDATE_QRCODE_MUTATION, variables: { data: attrs } })
     return [data.result, attrs]
 }
 

apps/condo/domains/marketplace/schema/MarketCategory.test.js

@@ -2,7 +2,7 @@
 * @jest-environment node
 */
 
-const { makeLoggedInAdminClient, makeClient, expectValuesOfCommonFields, expectToThrowGQLError, expectToThrowInternalError } = require('@open-condo/keystone/test.utils')
+const { makeLoggedInAdminClient, makeClient, expectValuesOfCommonFields, expectToThrowGQLError } = require('@open-condo/keystone/test.utils')
 const {
     expectToThrowAuthenticationErrorToObj, expectToThrowAuthenticationErrorToObjects,
     expectToThrowAccessDeniedErrorToObj,

apps/condo/domains/miniapp/schema/B2BApp.js

@@ -121,10 +121,12 @@ const B2BApp = new GQLListSchema('B2BApp', {
             const newItem = { ...existingItem, ...resolvedData }
             if (newItem.isGlobal) {
                 if (!newItem.appUrl) {
+                    // TODO(pahaz): use GQLError
                     return addValidationError(GLOBAL_APP_NO_APP_URL_ERROR)
                 }
             } else {
                 if (newItem.features) {
+                    // TODO(pahaz): use GQLError
                     return addValidationError(NON_GLOBAL_APP_WITH_FEATURES_ERROR)
                 }
             }

apps/condo/domains/notification/schema/Message.test.js

@@ -200,7 +200,7 @@ describe('Message', () => {
 
             await expectToThrowInternalError(
                 async () => await createTestMessage(admin, { user: { connect: { id: user.user.id } }, uniqKey }),
-                DUPLICATE_CONSTRAINT_VIOLATION_ERROR_MESSAGE,
+                `${DUPLICATE_CONSTRAINT_VIOLATION_ERROR_MESSAGE} "message_unique_user_type_uniqKey"`,
             )
         })
 
@@ -214,7 +214,7 @@ describe('Message', () => {
 
             await expectToThrowInternalError(
                 async () => await createTestMessage(admin, { user: null, uniqKey }),
-                DUPLICATE_CONSTRAINT_VIOLATION_ERROR_MESSAGE,
+                `${DUPLICATE_CONSTRAINT_VIOLATION_ERROR_MESSAGE} "message_unique_type_uniqKey"`,
             )
         })
 
@@ -233,12 +233,12 @@ describe('Message', () => {
 
             await expectToThrowInternalError(
                 async () => await createTestMessage(admin, { user: { connect: { id: user.user.id } }, uniqKey }),
-                DUPLICATE_CONSTRAINT_VIOLATION_ERROR_MESSAGE,
+                `${DUPLICATE_CONSTRAINT_VIOLATION_ERROR_MESSAGE} "message_unique_user_type_uniqKey"`,
             )
 
             await expectToThrowInternalError(
                 async () => await createTestMessage(admin, { uniqKey }),
-                DUPLICATE_CONSTRAINT_VIOLATION_ERROR_MESSAGE,
+                `${DUPLICATE_CONSTRAINT_VIOLATION_ERROR_MESSAGE} "message_unique_type_uniqKey"`,
             )
         })
 

apps/condo/domains/user/constants/errors.js

@@ -67,6 +67,7 @@ const PASSWORD_CONSISTS_OF_SMALL_SET_OF_CHARACTERS = 'PASSWORD_CONSISTS_OF_SMALL
 
 const GQL_ERRORS = {
     TOO_MANY_REQUESTS: {
+        // TODO(pahaz): it' looks like a wrong code. Use TOO_MANY_REQUESTS
         code: 'BAD_USER_INPUT',
         type: TOO_MANY_REQUESTS,
         message: 'You have to wait {secondsRemaining} seconds to be able to send request again',
@@ -105,7 +106,7 @@ const GQL_ERRORS = {
         variable: ['data', 'password'],
         code: 'BAD_USER_INPUT',
         type: INVALID_PASSWORD_LENGTH,
-        message: `Password length must be between ${MIN_PASSWORD_LENGTH} and ${MAX_PASSWORD_LENGTH} characters`,
+        message: 'Password length must be between {min} and {max} characters',
         messageForUser: 'api.user.INVALID_PASSWORD_LENGTH',
         messageInterpolation: {
             min: MIN_PASSWORD_LENGTH,
@@ -137,7 +138,7 @@ const GQL_ERRORS = {
         variable: ['data', 'password'],
         code: 'BAD_USER_INPUT',
         type: PASSWORD_CONSISTS_OF_SMALL_SET_OF_CHARACTERS,
-        message: `Password must contain at least ${MIN_COUNT_OF_DIFFERENT_CHARACTERS_IN_PASSWORD} different characters`,
+        message: 'Password must contain at least {min} different characters',
         messageForUser: 'api.user.PASSWORD_CONSISTS_OF_SMALL_SET_OF_CHARACTERS',
         messageInterpolation: {
             min: MIN_COUNT_OF_DIFFERENT_CHARACTERS_IN_PASSWORD,

apps/condo/domains/user/schema/ChangePhoneNumberResidentUserService.test.js

@@ -3,7 +3,7 @@ const { faker } = require('@faker-js/faker')
 const {
     makeLoggedInAdminClient,
     makeClient,
-    expectToThrowInternalError,
+    expectToThrowGQLError,
     catchErrorFrom,
     expectToThrowAccessDeniedErrorToResult,
     expectToThrowAuthenticationErrorToResult,
@@ -22,7 +22,6 @@ const {
     changePhoneNumberResidentUserByTestClient,
 } = require('@condo/domains/user/utils/testSchema')
 
-
 describe('ChangePhoneNumberResidentUserService', () => {
     describe('Anonymous', () => {
         it('can not change phone with token', async () => {
@@ -72,9 +71,15 @@ describe('ChangePhoneNumberResidentUserService', () => {
                 const client = await makeClientWithResidentUser({ type: RESIDENT, isPhoneVerified: true })
                 await createTestUser(admin, { phone: phone, type: RESIDENT })
 
-                await expectToThrowInternalError(async () => {
-                    await changePhoneNumberResidentUserByTestClient(client, { token })
-                }, '[error] Update User internal error', 'result')
+                await expectToThrowGQLError(
+                    async () => await changePhoneNumberResidentUserByTestClient(client, { token }),
+                    {
+                        code: 'INTERNAL_ERROR',
+                        type: 'SUB_GQL_ERROR',
+                        message: '[error] Update User internal error',
+                    },
+                    'result',
+                )
             })
             it('can not change phone with expired token', async () => {
                 const admin = await makeLoggedInAdminClient()

packages/codegen/generate.server.utils.js

@@ -1,7 +1,7 @@
 const { pickBy, get, isEmpty, isObject } = require('lodash')
 
 const conf = require('@open-condo/config')
-const { GQLError } = require('@open-condo/keystone/errors')
+const { GQLError, GQLErrorCode } = require('@open-condo/keystone/errors')
 const { getById } = require('@open-condo/keystone/schema')
 
 const IS_DEBUG = conf.NODE_ENV === 'development'
@@ -26,8 +26,6 @@ function _throwIfError (context, errors, data, errorMessage, errorMapping) {
             console.error(errors)
         }
 
-        let error = new Error(errorMessage)
-
         /** NOTE(pahaz): you can use it like so:
          *
          *    const ERRORS = {
@@ -51,20 +49,22 @@ function _throwIfError (context, errors, data, errorMessage, errorMapping) {
          *    })
          *
          */
+        const fields = {
+            code: GQLErrorCode.INTERNAL_ERROR,
+            type: 'SUB_GQL_ERROR',
+            message: errorMessage,
+        }
         if (errorMapping && isObject(errorMapping)) {
             const message = _getAllErrorMessages(errors).join(' -- ')
             for (const key in errorMapping) {
                 if (message.includes(key)) {
-                    error = new GQLError(errorMapping[key], context)
+                    Object.assign(fields, errorMapping[key])
                     break
                 }
             }
         }
 
-        // NOTE(pahaz): we will see this nested result at the ApolloErrorFormatter
-        error.errors = errors
-        error.reqId = get(context, 'req.id')
-        throw error
+        throw new GQLError(fields, context, errors)
     }
     if (!data || typeof data !== 'object') {
         throw new Error('wrong query result')

packages/codegen/generate.test.utils.js

@@ -1,17 +1,25 @@
 const { faker } = require('@faker-js/faker')
 const { print } = require('graphql')
-const { get, isEmpty } = require('lodash')
+const { get, isEmpty, pick, map, toArray } = require('lodash')
 
 const { normalizeQuery } = require('@open-condo/keystone/logging/normalize')
 
 class TestClientResponseError extends Error {
     constructor (data, errors, context = {}) {
         super(`Test client caught GraphQL response with not empty errors body! ${_renderDeveloperFriendlyErrorMessage(data, errors, context)}`)
-        this.errors = errors
-        this.data = data
-        this.context = context
+        // NOTE(pahaz): we don't want to display all this fields during console.error
+        this._constructor = { data, errors, context }
         this.name = 'TestClientResponseError'
     }
+
+    get data () {
+        return this._constructor?.data
+    }
+
+    get errors () {
+        // NOTE(pahaz): we want to use only public error fields during the rests
+        return map(toArray(this._constructor?.errors), error => pick(error, ['message', 'name', 'locations', 'path', 'extensions']))
+    }
 }
 
 function throwIfError (data, errors, context = {}) {
@@ -77,6 +85,17 @@ function _renderDeveloperFriendlyErrorMessage (data, errors, context) {
         msg.push('ERRORS: no or empty')
     }
 
+    if (errors) {
+        msg.push('--stack--')
+        const length = errors.length
+        errors.forEach((error, index) => {
+            const prefix = (length === 1) ? '' : `STACK[${index + 1}/${length}]: `
+            const stack = error?.fullstack || error.stack
+            msg.push(prefix + stack)
+        })
+    }
+
+    msg.push('--end--\n')
     return msg.join('\n')
 }
 
@@ -126,7 +145,7 @@ function generateGQLTestUtils (gql) {
 
     async function createMany (client, attrsArray = [], { raw = false } = {}) {
         _checkClient(client)
-        const { data, errors } = await  client.mutate(gql.CREATE_OBJS_MUTATION, {
+        const { data, errors } = await client.mutate(gql.CREATE_OBJS_MUTATION, {
             data: [...attrsArray],
         })
         if (raw) return { data, errors }
@@ -147,7 +166,7 @@ function generateGQLTestUtils (gql) {
     async function updateMany (client, attrsArray = [], { raw = false } = {}) {
         _checkClient(client)
         const { data, errors } = await client.mutate(gql.UPDATE_OBJS_MUTATION, {
-            data: [ ...attrsArray ],
+            data: [...attrsArray],
         })
         if (raw) return { data, errors }
         throwIfError(data, errors, { query: gql.UPDATE_OBJS_MUTATION, variables: { data: [...attrsArray] } })