[SIEM] Fix and consolidate handling of error responses in the client (elastic#59438) (elastic#59757)

* Convert our manual throwing of TypeError to a custom Error

Throwing a TypeError meant that our manual errors were indistinguishable
from, say, trying to invoke a method on undefined. This adds a custom
error, BadRequestError, that disambiguates that situation.

* Present API Error messages to the user

With Core's new HTTP client, an unsuccessful API call will raise an
error containing the body of the response it received. In the case of
SIEM endpoints, this will include a useful error message with
potentially more specificity than e.g. 'Internal Server Error'.

This adds a type predicate to check for such errors, and adds a handling
case in our errorToToaster handler.

If the error does not contain our SIEM-specific message, it will fall
through as normal and the general error.message will be displayed in the
toaster.

* Remove unnecessary use of throwIfNotOk in our client API calls

The new HTTP client raises an error on a 4xx or 5xx response, so there
should not be a case where throwIfNotOk is actually going to throw an
error.

The established pattern on the frontend is to catch errors at the call
site and handle them appropriately, so I'm mainly just verifying that
these are caught where they're used, now.

* Move errorToToaster and ToasterError to general location

These were living in ML since that's where they originated. However, we
have need of it (and already use it) elsewhere.

The basic pattern for error handling on the frontend is:
1) API call throws error
2) caller catches error and dispatches a toast

throwIfNotOk is meant to convert the error into a useful message in 1).
We currently use both errorToToaster and displayErrorToast to display
that in a toaster in 2)

Now that errorToToaster handles a few different types of errors, and
throwIfNotOk is going to be bypassed due to the new client behavior of
throwing on error, we're going to start consolidating on:

1) Api call throws error
2) caller catches error and passes it to errorToToaster

* Refactor Rules API functions to not use throwIfNotOk

* Ensures that all callers of these methods properly catch errors
* Updates error toasterification to use errorToToaster
* Simplifies tests now that we mainly just invoke the http client and
return the result.

throwIfNotOk is not being used in the majority of cases, as the client
raises an error and bypasses that call.

The few cases this might break are where we return a 200 but have errors
within the response. Whether throwIfNotOk handled this or not, I'll need
a simpler helper to accomplish the same behavior.

* Define a type for our BulkRule responses

These can be an array of errors OR rules; typing it as such forces
downstream to deal with both. enableRules was being handled correctly
with the bucketing helper, and TS has confirmed the rest are as well.

This obviates the need to raise from our API calls, as bulk errors are
recoverable and we want to both a) continue on with any successful rules
and b) handle the errors as necessary. This is highly dependent on the
caller and so we can't/shouldn't handle it here.

* Address case where bulk rules errors were not handled

I'm not sure that we're ever using this non-dispatch version, but it was
throwing a type error. Will bring it up in review.

* Remove more throwIfNotOk uses from API calls

These are unneeded as an error response will already throw an error to
be handled at the call site.

* Display an error toaster on newsfeed fetch failure

* Remove dead code

This was left over as a result of elastic#56261

* Remove throwIfNotOk from case API calls

Again, not needed because the client already throws.

* Update use_get_tags for NP

* Gets rid of throwIfNotOK usage
* uses core http fetch

* Remove throwIfNotOk from signals API

* Remove throwIfNotOk

This served the same purpose as errorToToaster, but in a less robust
way. All usages have been replaced, so now we say goodbye.

* Remove custom errors in favor of KibanaApiError and isApiError type predicate

There was no functional difference between these two code paths, and
removing these custom errors allowed us to delete a bunch of associated
code as well..

* Fix test failures

These were mainly related to my swapping any remaining fetch calls with
the core router as good kibana denizens should :salute:

* Replace use of core mocks with our simpler local ones

This is enough to get our tests to pass. We can't use the core mocks for
now since there are circular dependencies there, which breaks our build.

* add signal api unit tests

* privilege unit test api

* Add unit tests on the signals container

* Refactor signals API tests to use core mocks

* Simplifies our mocking verbosity by leveraging core mocks
* Simplifies test setup by isolating a reference to our fetch mock
* Abstracts response structure to pure helper functions

The try/catch tests had some false positives in that nothing would be
asserted if the code did not throw an error. These proved to be masking
a gap in coverage for our get/create signal index requests, which do not
leverage `throwIfNotOk` but instead rely on the fetch to throw an error;
once that behavior is verified we can update those tests to have our
fetchMock throw errors, and we should be all set.

* Simplify signals API tests now that the subjects do less

We no longer re-throw errors, or parse the response, we just return the
result of the client call. Simple!

* Simplify API functions to use implict returns

When possible. Also adds missing error-throwing documentation where
necessary.

* Revert "Display an error toaster on newsfeed fetch failure"

This reverts commit 6421322.

* Error property is readonly

* Pull uuid generation into default argument value

* Fix type predicate isApiError

Uses has to properly inspect our errorish object. Turns out we have a
'message' property, not an 'error' property.

* Fix test setup following modification of type predicate

We need a message (via new Error), a body.message, and a
body.status_code to satisfy isApiError.

Co-authored-by: Xavier Mouligneau <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Xavier Mouligneau <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>

Author: 3 people

x-pack/legacy/plugins/siem/public/components/ml/anomaly/use_anomalies_table_data.ts

@@ -10,8 +10,7 @@ import { InfluencerInput, Anomalies, CriteriaFields } from '../types';
 import { hasMlUserPermissions } from '../permissions/has_ml_user_permissions';
 import { MlCapabilitiesContext } from '../permissions/ml_capabilities_provider';
 import { useSiemJobs } from '../../ml_popover/hooks/use_siem_jobs';
-import { useStateToaster } from '../../toasters';
-import { errorToToaster } from '../api/error_to_toaster';
+import { useStateToaster, errorToToaster } from '../../toasters';
 
 import * as i18n from './translations';
 import { useTimeZone, useUiSetting$ } from '../../../lib/kibana';

x-pack/legacy/plugins/siem/public/components/ml/api/anomalies_table_data.ts

@@ -5,7 +5,6 @@
  */
 
 import { Anomalies, InfluencerInput, CriteriaFields } from '../types';
-import { throwIfNotOk } from '../../../hooks/api/api';
 import { KibanaServices } from '../../../lib/kibana';
 
 export interface Body {
@@ -22,17 +21,10 @@ export interface Body {
 }
 
 export const anomaliesTableData = async (body: Body, signal: AbortSignal): Promise<Anomalies> => {
-  const response = await KibanaServices.get().http.fetch<Anomalies>(
-    '/api/ml/results/anomalies_table_data',
-    {
-      method: 'POST',
-      body: JSON.stringify(body),
-      asResponse: true,
-      asSystemRequest: true,
-      signal,
-    }
-  );
-
-  await throwIfNotOk(response.response);
-  return response.body!;
+  return KibanaServices.get().http.fetch<Anomalies>('/api/ml/results/anomalies_table_data', {
+    method: 'POST',
+    body: JSON.stringify(body),
+    asSystemRequest: true,
+    signal,
+  });
 };

x-pack/legacy/plugins/siem/public/components/ml/api/error_to_toaster.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { has } from 'lodash/fp';
+
+import { MlError } from '../types';
+
+export interface MlStartJobError {
+  error: MlError;
+  started: boolean;
+}
+
+// use the "in operator" and regular type guards to do a narrow once this issue is fixed below:
+// https://github.com/microsoft/TypeScript/issues/21732
+// Otherwise for now, has will work ok even though it casts 'unknown' to 'any'
+export const isMlStartJobError = (value: unknown): value is MlStartJobError =>
+  has('error.msg', value) && has('error.response', value) && has('error.statusCode', value);

x-pack/legacy/plugins/siem/public/components/ml/api/errors.ts

@@ -5,7 +5,6 @@
  */
 
 import { InfluencerInput, MlCapabilities } from '../types';
-import { throwIfNotOk } from '../../../hooks/api/api';
 import { KibanaServices } from '../../../lib/kibana';
 
 export interface Body {
@@ -22,16 +21,9 @@ export interface Body {
 }
 
 export const getMlCapabilities = async (signal: AbortSignal): Promise<MlCapabilities> => {
-  const response = await KibanaServices.get().http.fetch<MlCapabilities>(
-    '/api/ml/ml_capabilities',
-    {
-      method: 'GET',
-      asResponse: true,
-      asSystemRequest: true,
-      signal,
-    }
-  );
-
-  await throwIfNotOk(response.response);
-  return response.body!;
+  return KibanaServices.get().http.fetch<MlCapabilities>('/api/ml/ml_capabilities', {
+    method: 'GET',
+    asSystemRequest: true,
+    signal,
+  });
 };

x-pack/legacy/plugins/siem/public/components/ml/api/get_ml_capabilities.ts

@@ -5,48 +5,21 @@
  */
 
 import fetchMock from 'fetch-mock';
+
+import { ToasterError } from '../../toasters';
+import { SetupMlResponse } from '../../ml_popover/types';
+import { isMlStartJobError } from './errors';
 import {
-  isMlStartJobError,
-  MessageBody,
-  parseJsonFromBody,
   throwIfErrorAttached,
   throwIfErrorAttachedToSetup,
-  ToasterErrors,
   tryParseResponse,
 } from './throw_if_not_ok';
-import { SetupMlResponse } from '../../components/ml_popover/types';
 
 describe('throw_if_not_ok', () => {
   afterEach(() => {
     fetchMock.reset();
   });
 
-  describe('#parseJsonFromBody', () => {
-    test('parses a json from the body correctly', async () => {
-      fetchMock.mock('http://example.com', {
-        status: 500,
-        body: {
-          error: 'some error',
-          statusCode: 500,
-          message: 'I am a custom message',
-        },
-      });
-      const response = await fetch('http://example.com');
-      const expected: MessageBody = {
-        error: 'some error',
-        statusCode: 500,
-        message: 'I am a custom message',
-      };
-      await expect(parseJsonFromBody(response)).resolves.toEqual(expected);
-    });
-
-    test('returns null if the body does not exist', async () => {
-      fetchMock.mock('http://example.com', { status: 500, body: 'some text' });
-      const response = await fetch('http://example.com');
-      await expect(parseJsonFromBody(response)).resolves.toEqual(null);
-    });
-  });
-
   describe('#tryParseResponse', () => {
     test('It formats a JSON object', () => {
       const parsed = tryParseResponse(JSON.stringify({ hello: 'how are you?' }));
@@ -119,7 +92,7 @@ describe('throw_if_not_ok', () => {
         },
       };
       expect(() => throwIfErrorAttached(json, ['some-id'])).toThrow(
-        new ToasterErrors(['some message'])
+        new ToasterError(['some message'])
       );
     });
 

x-pack/legacy/plugins/siem/public/hooks/api/throw_if_not_ok.test.ts renamed to x-pack/legacy/plugins/siem/public/components/ml/api/throw_if_not_ok.test.ts

@@ -4,32 +4,10 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { has } from 'lodash/fp';
-
-import * as i18n from '../../components/ml/api/translations';
-import { MlError } from '../../components/ml/types';
-import { SetupMlResponse } from '../../components/ml_popover/types';
-
-export { MessageBody, parseJsonFromBody } from '../../utils/api';
-
-export interface MlStartJobError {
-  error: MlError;
-  started: boolean;
-}
-
-export type ToasterErrorsType = Error & {
-  messages: string[];
-};
-
-export class ToasterErrors extends Error implements ToasterErrorsType {
-  public messages: string[];
-
-  constructor(messages: string[]) {
-    super(messages[0]);
-    this.name = 'ToasterErrors';
-    this.messages = messages;
-  }
-}
+import * as i18n from './translations';
+import { ToasterError } from '../../toasters';
+import { SetupMlResponse } from '../../ml_popover/types';
+import { isMlStartJobError } from './errors';
 
 export const tryParseResponse = (response: string): string => {
   try {
@@ -71,7 +49,7 @@ export const throwIfErrorAttachedToSetup = (
 
   const errors = [...jobErrors, ...dataFeedErrors];
   if (errors.length > 0) {
-    throw new ToasterErrors(errors);
+    throw new ToasterError(errors);
   }
 };
 
@@ -93,12 +71,6 @@ export const throwIfErrorAttached = (
     }
   }, []);
   if (errors.length > 0) {
-    throw new ToasterErrors(errors);
+    throw new ToasterError(errors);
   }
 };
-
-// use the "in operator" and regular type guards to do a narrow once this issue is fixed below:
-// https://github.com/microsoft/TypeScript/issues/21732
-// Otherwise for now, has will work ok even though it casts 'unknown' to 'any'
-export const isMlStartJobError = (value: unknown): value is MlStartJobError =>
-  has('error.msg', value) && has('error.response', value) && has('error.statusCode', value);

x-pack/legacy/plugins/siem/public/hooks/api/throw_if_not_ok.ts renamed to x-pack/legacy/plugins/siem/public/components/ml/api/throw_if_not_ok.ts

@@ -9,8 +9,7 @@ import React, { useState, useEffect } from 'react';
 import { MlCapabilities } from '../types';
 import { getMlCapabilities } from '../api/get_ml_capabilities';
 import { emptyMlCapabilities } from '../empty_ml_capabilities';
-import { errorToToaster } from '../api/error_to_toaster';
-import { useStateToaster } from '../../toasters';
+import { errorToToaster, useStateToaster } from '../../toasters';
 
 import * as i18n from './translations';