feat: handle 406 error message COMPASS-7189 (#4819)

* feat: handle 406 error message COMPASS-7189

* refactor: clean up

* test: match to error type

Author: alenakhineika

packages/atlas-service/src/main.spec.ts

@@ -412,6 +412,7 @@ describe('AtlasServiceMain', function () {
           json() {
             return Promise.resolve({
               errorCode: 'ExampleCode',
+              error: 500,
               detail: 'tortillas',
             });
           },

packages/atlas-service/src/main.ts

@@ -2,6 +2,7 @@ import { ipcMain, shell, app } from 'electron';
 import { URL, URLSearchParams } from 'url';
 import { createHash } from 'crypto';
 import type { AuthFlowType, MongoDBOIDCPlugin } from '@mongodb-js/oidc-plugin';
+import type { AtlasServiceError } from './renderer';
 import {
   createMongoDBOIDCPlugin,
   hookLoggerToMongoLogWriter as oidcPluginHookLoggerToMongoLogWriter,
@@ -46,8 +47,10 @@ const redirectRequestHandler = oidcServerRequestHandler.bind(null, {
 /**
  * https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/#errors
  */
-function isServerError(err: any): err is { errorCode: string; detail: string } {
-  return Boolean(err.errorCode && err.detail);
+function isServerError(
+  err: any
+): err is { error: number; errorCode: string; detail: string } {
+  return Boolean(err.error && err.errorCode && err.detail);
 }
 
 function throwIfNetworkTrafficDisabled() {
@@ -76,9 +79,10 @@ export async function throwIfNotOk(
   } catch (err) {
     // no-op, use the default status and statusText in the message.
   }
+
   const err = new Error(serverErrorMessage);
   err.name = serverErrorName;
-  (err as any).statusCode = res.status;
+  (err as AtlasServiceError).statusCode = res.status;
   throw err;
 }
 

packages/atlas-service/src/renderer.ts

@@ -151,7 +151,7 @@ export type {
   AtlasUserConfig,
   IntrospectInfo,
   Token,
-  AtlasServiceNetworkError,
+  AtlasServiceError,
   AIQuery,
   AIAggregation,
 } from './util';

packages/atlas-service/src/util.ts

@@ -142,4 +142,4 @@ export function validateAIQueryResponse(
   }
 }
 
-export type AtlasServiceNetworkError = Error & { statusCode: number };
+export type AtlasServiceError = Error & { statusCode: number };

packages/compass-aggregations/src/modules/pipeline-builder/pipeline-ai.ts

@@ -11,7 +11,7 @@ import { isAction } from '../../utils/is-action';
 import type { PipelineParserError } from './pipeline-parser/utils';
 import type Stage from './stage';
 import { updatePipelinePreview } from './builder-helpers';
-import type { AtlasServiceNetworkError } from '@mongodb-js/atlas-service/renderer';
+import type { AtlasServiceError } from '@mongodb-js/atlas-service/renderer';
 
 const { log, mongoLogId, track } = createLoggerAndTelemetry('AI-PIPELINE-UI');
 
@@ -243,13 +243,13 @@ export const runAIPipelineGeneration = (
       }
       trackAndLogFailed({
         editor_view_type,
-        errorCode: (err as AtlasServiceNetworkError).statusCode,
-        errorMessage: (err as AtlasServiceNetworkError).message,
+        errorCode: (err as AtlasServiceError).statusCode,
+        errorMessage: (err as AtlasServiceError).message,
         errorName: 'request_error',
       });
       // We're going to reset input state with this error, show the error in the
       // toast instead
-      if ((err as AtlasServiceNetworkError).statusCode === 401) {
+      if ((err as AtlasServiceError).statusCode === 401) {
         openToast('ai-unauthorized', {
           variant: 'important',
           title: 'Network Error',
@@ -259,8 +259,8 @@ export const runAIPipelineGeneration = (
       }
       dispatch({
         type: AIPipelineActionTypes.AIPipelineFailed,
-        errorMessage: (err as AtlasServiceNetworkError).message,
-        networkErrorCode: (err as AtlasServiceNetworkError).statusCode ?? -1,
+        errorMessage: (err as AtlasServiceError).message,
+        networkErrorCode: (err as AtlasServiceError).statusCode ?? -1,
       });
       return;
     } finally {
@@ -286,7 +286,7 @@ export const runAIPipelineGeneration = (
     } catch (err) {
       trackAndLogFailed({
         editor_view_type,
-        errorCode: (err as AtlasServiceNetworkError).statusCode,
+        errorCode: (err as AtlasServiceError).statusCode,
         errorMessage: (err as Error).message,
         errorName: 'empty_pipeline_error',
       });

packages/compass-query-bar/src/stores/ai-query-reducer.ts

@@ -13,7 +13,7 @@ import {
 import type { QueryFormFields } from '../constants/query-properties';
 import { DEFAULT_FIELD_VALUES } from '../constants/query-bar-store';
 import { openToast } from '@mongodb-js/compass-components';
-import type { AtlasServiceNetworkError } from '@mongodb-js/atlas-service/renderer';
+import type { AtlasServiceError } from '@mongodb-js/atlas-service/renderer';
 
 const { log, mongoLogId, track } = createLoggerAndTelemetry('AI-QUERY-UI');
 
@@ -204,12 +204,12 @@ export const runAIQuery = (
       }
       trackAndLogFailed({
         errorName: 'request_error',
-        errorCode: (err as AtlasServiceNetworkError).statusCode,
-        errorMessage: (err as AtlasServiceNetworkError).message,
+        errorCode: (err as AtlasServiceError).statusCode,
+        errorMessage: (err as AtlasServiceError).message,
       });
       // We're going to reset input state with this error, show the error in the
       // toast instead
-      if ((err as AtlasServiceNetworkError).statusCode === 401) {
+      if ((err as AtlasServiceError).statusCode === 401) {
         openToast('ai-unauthorized', {
           variant: 'important',
           title: 'Network Error',
@@ -219,8 +219,8 @@ export const runAIQuery = (
       }
       dispatch({
         type: AIQueryActionTypes.AIQueryFailed,
-        errorMessage: (err as AtlasServiceNetworkError).message,
-        networkErrorCode: (err as AtlasServiceNetworkError).statusCode ?? -1,
+        errorMessage: (err as AtlasServiceError).message,
+        networkErrorCode: (err as AtlasServiceError).statusCode ?? -1,
       });
       return;
     } finally {
@@ -246,7 +246,7 @@ export const runAIQuery = (
     } catch (err: any) {
       trackAndLogFailed({
         errorName: 'could_not_parse_fields',
-        errorCode: (err as AtlasServiceNetworkError).statusCode,
+        errorCode: (err as AtlasServiceError).statusCode,
         errorMessage: err?.message,
       });
       dispatch({