fix(server): convert 4xx status HttpError to UserFriendlyError (#10956)

packages/backend/server/src/__tests__/utils/blobs.ts

@@ -1,6 +1,7 @@
 import { type Blob } from '@prisma/client';
 
 import { TestingApp } from './testing-app';
+import { TEST_LOG_LEVEL } from './utils';
 
 export async function listBlobs(
   app: TestingApp,
@@ -73,5 +74,13 @@ export async function setBlob(
       `blob-${Math.random().toString(16).substring(2, 10)}.data`
     )
     .expect(200);
+
+  if (res.body.errors?.length) {
+    if (TEST_LOG_LEVEL !== 'fatal') {
+      // print the error stack when log level is not fatal, for better debugging
+      console.error('%o', res.body);
+    }
+    throw new Error(res.body.errors[0].message);
+  }
   return res.body.data.setBlob;
 }

packages/backend/server/src/__tests__/workspace/blobs.e2e.ts

@@ -169,3 +169,15 @@ test('should accept blob even storage out of quota if workspace has unlimited fe
   await t.notThrowsAsync(setBlob(app, workspace.id, buffer));
   await t.notThrowsAsync(setBlob(app, workspace.id, buffer));
 });
+
+test('should throw error when blob size large than max file size', async t => {
+  await app.signup();
+
+  const workspace = await createWorkspace(app);
+
+  const buffer = Buffer.from(new Uint8Array(1024 * 1024 * 11));
+  await t.throwsAsync(setBlob(app, workspace.id, buffer), {
+    message:
+      'HTTP request error, message: File truncated as it exceeds the 10485760 byte size limit.',
+  });
+});

packages/backend/server/src/base/error/def.ts

@@ -264,6 +264,11 @@ export const USER_FRIENDLY_ERRORS = {
     message: ({ code, message }) =>
       `GraphQL bad request, code: ${code}, ${message}`,
   },
+  http_request_error: {
+    type: 'bad_request',
+    args: { message: 'string' },
+    message: ({ message }) => `HTTP request error, message: ${message}`,
+  },
 
   // Input errors
   query_too_long: {

packages/backend/server/src/base/error/errors.gen.ts

@@ -45,6 +45,16 @@ export class GraphqlBadRequest extends UserFriendlyError {
   }
 }
 @ObjectType()
+class HttpRequestErrorDataType {
+  @Field() message!: string
+}
+
+export class HttpRequestError extends UserFriendlyError {
+  constructor(args: HttpRequestErrorDataType, message?: string | ((args: HttpRequestErrorDataType) => string)) {
+    super('bad_request', 'http_request_error', message, args);
+  }
+}
+@ObjectType()
 class QueryTooLongDataType {
   @Field() max!: number
 }
@@ -896,6 +906,7 @@ export enum ErrorNames {
   NOT_FOUND,
   BAD_REQUEST,
   GRAPHQL_BAD_REQUEST,
+  HTTP_REQUEST_ERROR,
   QUERY_TOO_LONG,
   VALIDATION_ERROR,
   USER_NOT_FOUND,
@@ -1011,5 +1022,5 @@ registerEnumType(ErrorNames, {
 export const ErrorDataUnionType = createUnionType({
   name: 'ErrorDataUnion',
   types: () =>
-    [GraphqlBadRequestDataType, QueryTooLongDataType, ValidationErrorDataType, WrongSignInCredentialsDataType, UnknownOauthProviderDataType, InvalidOauthCallbackCodeDataType, MissingOauthQueryParameterDataType, InvalidEmailDataType, InvalidPasswordLengthDataType, WorkspacePermissionNotFoundDataType, SpaceNotFoundDataType, MemberNotFoundInSpaceDataType, NotInSpaceDataType, AlreadyInSpaceDataType, SpaceAccessDeniedDataType, SpaceOwnerNotFoundDataType, SpaceShouldHaveOnlyOneOwnerDataType, DocNotFoundDataType, DocActionDeniedDataType, DocUpdateBlockedDataType, VersionRejectedDataType, InvalidHistoryTimestampDataType, DocHistoryNotFoundDataType, BlobNotFoundDataType, ExpectToGrantDocUserRolesDataType, ExpectToRevokeDocUserRolesDataType, ExpectToUpdateDocUserRoleDataType, UnsupportedSubscriptionPlanDataType, SubscriptionAlreadyExistsDataType, SubscriptionNotExistsDataType, SameSubscriptionRecurringDataType, SubscriptionPlanNotFoundDataType, CopilotDocNotFoundDataType, CopilotMessageNotFoundDataType, CopilotPromptNotFoundDataType, CopilotProviderSideErrorDataType, CopilotInvalidContextDataType, CopilotContextFileNotSupportedDataType, CopilotFailedToModifyContextDataType, CopilotFailedToMatchContextDataType, RuntimeConfigNotFoundDataType, InvalidRuntimeConfigTypeDataType, InvalidLicenseUpdateParamsDataType, WorkspaceMembersExceedLimitToDowngradeDataType, UnsupportedClientVersionDataType, MentionUserDocAccessDeniedDataType] as const,
+    [GraphqlBadRequestDataType, HttpRequestErrorDataType, QueryTooLongDataType, ValidationErrorDataType, WrongSignInCredentialsDataType, UnknownOauthProviderDataType, InvalidOauthCallbackCodeDataType, MissingOauthQueryParameterDataType, InvalidEmailDataType, InvalidPasswordLengthDataType, WorkspacePermissionNotFoundDataType, SpaceNotFoundDataType, MemberNotFoundInSpaceDataType, NotInSpaceDataType, AlreadyInSpaceDataType, SpaceAccessDeniedDataType, SpaceOwnerNotFoundDataType, SpaceShouldHaveOnlyOneOwnerDataType, DocNotFoundDataType, DocActionDeniedDataType, DocUpdateBlockedDataType, VersionRejectedDataType, InvalidHistoryTimestampDataType, DocHistoryNotFoundDataType, BlobNotFoundDataType, ExpectToGrantDocUserRolesDataType, ExpectToRevokeDocUserRolesDataType, ExpectToUpdateDocUserRoleDataType, UnsupportedSubscriptionPlanDataType, SubscriptionAlreadyExistsDataType, SubscriptionNotExistsDataType, SameSubscriptionRecurringDataType, SubscriptionPlanNotFoundDataType, CopilotDocNotFoundDataType, CopilotMessageNotFoundDataType, CopilotPromptNotFoundDataType, CopilotProviderSideErrorDataType, CopilotInvalidContextDataType, CopilotContextFileNotSupportedDataType, CopilotFailedToModifyContextDataType, CopilotFailedToMatchContextDataType, RuntimeConfigNotFoundDataType, InvalidRuntimeConfigTypeDataType, InvalidLicenseUpdateParamsDataType, WorkspaceMembersExceedLimitToDowngradeDataType, UnsupportedClientVersionDataType, MentionUserDocAccessDeniedDataType] as const,
 });

packages/backend/server/src/base/nestjs/exception.ts

@@ -11,12 +11,14 @@ import { ThrottlerException } from '@nestjs/throttler';
 import { BaseWsExceptionFilter } from '@nestjs/websockets';
 import { Response } from 'express';
 import { GraphQLError } from 'graphql';
+import { HttpError } from 'http-errors';
 import { of } from 'rxjs';
 import { Socket } from 'socket.io';
 import { ZodError } from 'zod';
 
 import {
   GraphqlBadRequest,
+  HttpRequestError,
   InternalServerError,
   NotFound,
   TooManyRequest,
@@ -57,6 +59,16 @@ export function mapAnyError(error: any): UserFriendlyError {
     return new ValidationError({
       errors: error.message,
     });
+  } else if (
+    error instanceof HttpError &&
+    error.status >= 400 &&
+    error.status < 500
+  ) {
+    const e = new HttpRequestError({
+      message: error.message,
+    });
+    e.status = error.status;
+    return e;
   } else {
     const e = new InternalServerError();
     e.cause = error;

packages/backend/server/src/schema.gql

@@ -376,7 +376,7 @@ type EditorType {
   name: String!
 }
 
-union ErrorDataUnion = AlreadyInSpaceDataType | BlobNotFoundDataType | CopilotContextFileNotSupportedDataType | CopilotDocNotFoundDataType | CopilotFailedToMatchContextDataType | CopilotFailedToModifyContextDataType | CopilotInvalidContextDataType | CopilotMessageNotFoundDataType | CopilotPromptNotFoundDataType | CopilotProviderSideErrorDataType | DocActionDeniedDataType | DocHistoryNotFoundDataType | DocNotFoundDataType | DocUpdateBlockedDataType | ExpectToGrantDocUserRolesDataType | ExpectToRevokeDocUserRolesDataType | ExpectToUpdateDocUserRoleDataType | GraphqlBadRequestDataType | InvalidEmailDataType | InvalidHistoryTimestampDataType | InvalidLicenseUpdateParamsDataType | InvalidOauthCallbackCodeDataType | InvalidPasswordLengthDataType | InvalidRuntimeConfigTypeDataType | MemberNotFoundInSpaceDataType | MentionUserDocAccessDeniedDataType | MissingOauthQueryParameterDataType | NotInSpaceDataType | QueryTooLongDataType | RuntimeConfigNotFoundDataType | SameSubscriptionRecurringDataType | SpaceAccessDeniedDataType | SpaceNotFoundDataType | SpaceOwnerNotFoundDataType | SpaceShouldHaveOnlyOneOwnerDataType | SubscriptionAlreadyExistsDataType | SubscriptionNotExistsDataType | SubscriptionPlanNotFoundDataType | UnknownOauthProviderDataType | UnsupportedClientVersionDataType | UnsupportedSubscriptionPlanDataType | ValidationErrorDataType | VersionRejectedDataType | WorkspaceMembersExceedLimitToDowngradeDataType | WorkspacePermissionNotFoundDataType | WrongSignInCredentialsDataType
+union ErrorDataUnion = AlreadyInSpaceDataType | BlobNotFoundDataType | CopilotContextFileNotSupportedDataType | CopilotDocNotFoundDataType | CopilotFailedToMatchContextDataType | CopilotFailedToModifyContextDataType | CopilotInvalidContextDataType | CopilotMessageNotFoundDataType | CopilotPromptNotFoundDataType | CopilotProviderSideErrorDataType | DocActionDeniedDataType | DocHistoryNotFoundDataType | DocNotFoundDataType | DocUpdateBlockedDataType | ExpectToGrantDocUserRolesDataType | ExpectToRevokeDocUserRolesDataType | ExpectToUpdateDocUserRoleDataType | GraphqlBadRequestDataType | HttpRequestErrorDataType | InvalidEmailDataType | InvalidHistoryTimestampDataType | InvalidLicenseUpdateParamsDataType | InvalidOauthCallbackCodeDataType | InvalidPasswordLengthDataType | InvalidRuntimeConfigTypeDataType | MemberNotFoundInSpaceDataType | MentionUserDocAccessDeniedDataType | MissingOauthQueryParameterDataType | NotInSpaceDataType | QueryTooLongDataType | RuntimeConfigNotFoundDataType | SameSubscriptionRecurringDataType | SpaceAccessDeniedDataType | SpaceNotFoundDataType | SpaceOwnerNotFoundDataType | SpaceShouldHaveOnlyOneOwnerDataType | SubscriptionAlreadyExistsDataType | SubscriptionNotExistsDataType | SubscriptionPlanNotFoundDataType | UnknownOauthProviderDataType | UnsupportedClientVersionDataType | UnsupportedSubscriptionPlanDataType | ValidationErrorDataType | VersionRejectedDataType | WorkspaceMembersExceedLimitToDowngradeDataType | WorkspacePermissionNotFoundDataType | WrongSignInCredentialsDataType
 
 enum ErrorNames {
   ACCESS_DENIED
@@ -429,6 +429,7 @@ enum ErrorNames {
   FAILED_TO_SAVE_UPDATES
   FAILED_TO_UPSERT_SNAPSHOT
   GRAPHQL_BAD_REQUEST
+  HTTP_REQUEST_ERROR
   INTERNAL_SERVER_ERROR
   INVALID_AUTH_STATE
   INVALID_CHECKOUT_PARAMETERS
@@ -554,6 +555,10 @@ type GraphqlBadRequestDataType {
   message: String!
 }
 
+type HttpRequestErrorDataType {
+  message: String!
+}
+
 input ImportUsersInput {
   users: [CreateUserInput!]!
 }