Improve userFriendlyMessage devX (#16815)

Two challenges with error messages
- always provide a useful/meaningful error message for the end user
instead of the generic one. eg: show "Wrong password" and not "An error
occured"
- avoid technical details unless error regards a technical feature. eg:
show "An error occured" and not "Invalid post-hook payload."; but do
show "Invalid issuer URL." as it occurs while configuring SSO

What this PR does
- Make userFriendlyMessage mandatory for widely used
GraphqlQueryRunnerException and CommonQueryRunnerException, so that
developers are forced to ask themselves what the error message should
be, and as it contains very wide error codes (eg: "Bad request") which
should not be mapped to just one default message
- Keep userFriendlyMessage optional for service-specific exceptions (eg:
workflowStepExecutorException), but convert the error code to
userFriendlyMessage mapper to a switch case function with a typecheck
ensuring that all codes are mapped to a message. These default messages
are still overridable where they are thrown.

packages/twenty-server/src/engine/api/utils/build-cursor-composite-field-where-condition.utils.ts

@@ -11,6 +11,7 @@ import {
   type ObjectRecordOrderBy,
 } from 'src/engine/api/graphql/workspace-query-builder/interfaces/object-record.interface';
 
+import { STANDARD_ERROR_MESSAGE } from 'src/engine/api/common/common-query-runners/errors/standard-error-message.constant';
 import {
   GraphqlQueryRunnerException,
   GraphqlQueryRunnerExceptionCode,
@@ -46,6 +47,7 @@ export const buildCursorCompositeFieldWhereCondition = ({
     throw new GraphqlQueryRunnerException(
       `Composite type definition not found for type: ${fieldType}`,
       GraphqlQueryRunnerExceptionCode.INVALID_CURSOR,
+      { userFriendlyMessage: STANDARD_ERROR_MESSAGE },
     );
   }
 
@@ -112,6 +114,7 @@ export const buildCursorCompositeFieldWhereCondition = ({
         throw new GraphqlQueryRunnerException(
           'Invalid cursor',
           GraphqlQueryRunnerExceptionCode.INVALID_CURSOR,
+          { userFriendlyMessage: STANDARD_ERROR_MESSAGE },
         );
       }
 

packages/twenty-server/src/engine/api/utils/build-cursor-where-condition.utils.ts

@@ -7,6 +7,7 @@ import {
   type ObjectRecordOrderBy,
 } from 'src/engine/api/graphql/workspace-query-builder/interfaces/object-record.interface';
 
+import { STANDARD_ERROR_MESSAGE } from 'src/engine/api/common/common-query-runners/errors/standard-error-message.constant';
 import {
   GraphqlQueryRunnerException,
   GraphqlQueryRunnerExceptionCode,
@@ -59,6 +60,7 @@ export const buildCursorWhereCondition = ({
     throw new GraphqlQueryRunnerException(
       `Field metadata not found for key: ${cursorKey}`,
       GraphqlQueryRunnerExceptionCode.INVALID_CURSOR,
+      { userFriendlyMessage: STANDARD_ERROR_MESSAGE },
     );
   }
 
@@ -84,6 +86,7 @@ export const buildCursorWhereCondition = ({
     throw new GraphqlQueryRunnerException(
       'Invalid cursor',
       GraphqlQueryRunnerExceptionCode.INVALID_CURSOR,
+      { userFriendlyMessage: STANDARD_ERROR_MESSAGE },
     );
   }
 

packages/twenty-server/src/engine/api/utils/validate-and-get-order-by.utils.ts

@@ -8,6 +8,7 @@ import { isDefined } from 'twenty-shared/utils';
 
 import { type ObjectRecordOrderBy } from 'src/engine/api/graphql/workspace-query-builder/interfaces/object-record.interface';
 
+import { STANDARD_ERROR_MESSAGE } from 'src/engine/api/common/common-query-runners/errors/standard-error-message.constant';
 import {
   GraphqlQueryRunnerException,
   GraphqlQueryRunnerExceptionCode,
@@ -51,6 +52,7 @@ export const validateAndGetOrderByForScalarField = (
     throw new GraphqlQueryRunnerException(
       'Invalid cursor',
       GraphqlQueryRunnerExceptionCode.INVALID_CURSOR,
+      { userFriendlyMessage: STANDARD_ERROR_MESSAGE },
     );
   }
 
@@ -58,6 +60,7 @@ export const validateAndGetOrderByForScalarField = (
     throw new GraphqlQueryRunnerException(
       'Expected non-composite field order by',
       GraphqlQueryRunnerExceptionCode.INVALID_CURSOR,
+      { userFriendlyMessage: STANDARD_ERROR_MESSAGE },
     );
   }
 
@@ -74,6 +77,7 @@ export const validateAndGetOrderByForCompositeField = (
     throw new GraphqlQueryRunnerException(
       'Invalid cursor',
       GraphqlQueryRunnerExceptionCode.INVALID_CURSOR,
+      { userFriendlyMessage: STANDARD_ERROR_MESSAGE },
     );
   }
 
@@ -81,6 +85,7 @@ export const validateAndGetOrderByForCompositeField = (
     throw new GraphqlQueryRunnerException(
       'Expected composite field order by',
       GraphqlQueryRunnerExceptionCode.INVALID_CURSOR,
+      { userFriendlyMessage: STANDARD_ERROR_MESSAGE },
     );
   }