[ML] Improving client side error handling #76743

jgowdyelastic · 2020-09-04T08:01:53Z

Fixes error reporting on the client side introduced by #74965 which caused changes to the error objects returned from kibana.

Updates extractErrorProperties to extract the error properties from the new error formats.
Removes older getErrorMessage function for converting the error to a string. Copies it to the transforms plugin where it is still used and was originally being imported from the ML plugin.
Removes mlMessageBarService, and replaces it with a similar function getToastNotificationService which uses the dependency cache for getting ToastsStart to retain backwards compatibility with all existing mlMessageBarService uses.
Adds the ability to override the error stack in MLRequestFailure. This allows for the correct error message to be displayed when clicking the See full error button in the toast.
Previously it would show the client side JS stack, which was unrelated to the actual error.

Before:

After:

Removes updateJob, validateJob and updateDatafeed from job service as they are unnecessary and caused two error toasts to appear.
Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
This was checked for breaking API changes and was labeled appropriately

jgowdyelastic · 2020-09-07T11:57:10Z

@elasticmachine merge upstream

elasticmachine · 2020-09-07T15:08:52Z

Pinging @elastic/ml-ui (:ml)

jgowdyelastic · 2020-09-08T07:30:22Z

@elasticmachine merge upstream

qn895 · 2020-09-09T14:48:16Z

x-pack/plugins/ml/public/application/jobs/new_job/pages/components/summary_step/summary.tsx

+      const { displayErrorToast } = toastNotificationServiceProvider(notifications.toasts);
+      displayErrorToast(
+        error,
+        i18n.translate('xpack.ml.newJob.wizard.summaryStep.createJobError', {


Not sure we meant for the same i18n id here but if we are using the same block for both places I wonder if we should consolidate them in one function.

these ids have always been the same, which surprises me, but i guess it doesn't complain if the ids are the same and the text is the same.
I'll remove the duplication.

Removed in 9027b2a

qn895 · 2020-09-09T15:17:24Z

x-pack/plugins/ml/public/application/util/ml_error.ts

  // takes an Error object and and optional response object
-  // if error is falsy (null) the response object will be used
-  // notify will show the full expandable stack trace of the response if a response object is used and no error is passed in.
+
  constructor(error: any, resp: any) {


I wonder if we can be more explicit here with the error: any since if error obj is required and if .message is undefined, the error message shown to the user will be blank.

Updated in 430dbdb
I've also broken the error processing file into multiple files and moved the MLRequestFailure into common and changed it so it is no longer a subclass of KbnError, as it didn't gain us anything and meant it had to live in public.

qn895 · 2020-09-09T15:38:20Z

Gave this a quick test. I modified the names of the jobIds to test the delete operations and for some reasons it's showing success messages even though the jobs weren't deleted.

        if (datafeedResp.acknowledged) {
          try {
            await forceDeleteJob(`${jobId}_INVALID`);
            results[jobId] = { deleted: true };
          } catch (error) {...}

For starting invalid datafeed, I wonder if we should get rid of this 0 jobs started successfully. Perhaps out of scope of this PR.

jgowdyelastic · 2020-09-09T15:51:49Z

Gave this a quick test. I modified the names of the jobIds to test the delete operations and for some reasons it's showing success messages even though the jobs weren't deleted.

This is the same behaviour as master. The problem is that the jobs aren't really deleted at the point that the request returns. Instead they are deleted in tasks that happen later. We only get an acknowledgement that the delete request has gone through.
The success text could be updated here to something that reflects the real state of the deletion.
Similar to your other comment about the started success, I'd suggest these changes should be done in a follow up review of the success toasts.

qn895 · 2020-09-09T16:02:34Z

Changes LGTM 💯

alvarezmelissa87 · 2020-09-09T16:47:42Z

x-pack/plugins/ml/public/application/data_frame_analytics/common/use_results_view_config.ts

@@ -83,12 +83,12 @@ export const useResultsViewConfig = (jobId: string) => {
              setIsLoadingJobConfig(false);
            }
          } catch (e) {
-            setJobCapsServiceErrorMessage(getErrorMessage(e));
+            setJobCapsServiceErrorMessage(extractErrorMessage(e));


Noticed while testing this section that errors never get into this block when the error occurs in initializeFromIndexPattern since that function catches any error and logs it and does not propagate it. This means the results view table just fails silently and is empty. Maybe outside the scope of this PR but would be good to talk about whether the errors should be propagated somehow to code calling the service.

Once the error is propagated it does show up correctly so extractErrorMessage appears to be extracting things correctly. 👍

yes the errors probably should be propagated. initializeFromIndexPattern is called a few places and it's only here that we're expecting to catch anything.
I agree that it's outside of the scope of this PR, but definitely worth revisiting.

alvarezmelissa87

Gave this a local test and LGTM ⚡

peteharverson · 2020-09-10T15:03:18Z

Just found this one message which isn't displaying the reason for the error.

Test case is to use the Advanced Anomaly Detection wizard, and add two categorization detectors, with per-partition categorization enabled, but then pick a different partition field for each detector:

jgowdyelastic · 2020-09-10T16:30:20Z

Just found this one message which isn't displaying the reason for the error.

Fixed in 8875cfa

peteharverson

LGTM

jgowdyelastic · 2020-09-10T21:34:47Z

@elasticmachine merge upstream

kibanamachine · 2020-09-10T23:13:30Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: bfa4804

Build metrics

@kbn/optimizer bundle module count

id	value	diff	baseline
transform	459	+1	458

async chunks size

id	value	diff	baseline
ml	8.0MB	+207.0B	8.0MB
transform	759.6KB	+273.0B	759.3KB
total		+480.0B

page load bundle size

id	value	diff	baseline
ml	844.8KB	-2.9KB	847.8KB

distributable file count

id	value	diff	baseline
default	45526	+4	45522

History

💔 Build #73788 failed 8875cfa
💚 Build #73527 succeeded e9848af
💔 Build #73433 failed 430dbdb
💔 Build #73414 failed 9027b2a
💔 Build #73393 failed 912c224

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

* [ML] Improving client side error handling * adding stacktrace to request errors * copying error parsing to transforms * update snapshot * fixing jest tests * adding test and removing debug log output * updating translations * rewriting error extracting code * fixing tests * removing message bar service * removing test code * updating translations * combining job creation error handling * refactoring error files * updating test * fixing bug in DFA deletion * improving mml warning Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* [ML] Improving client side error handling * adding stacktrace to request errors * copying error parsing to transforms * update snapshot * fixing jest tests * adding test and removing debug log output * updating translations * rewriting error extracting code * fixing tests * removing message bar service * removing test code * updating translations * combining job creation error handling * refactoring error files * updating test * fixing bug in DFA deletion * improving mml warning Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

…s-for-710 * 'master' of github.com:elastic/kibana: (65 commits) Separate url forwarding logic and legacy services (elastic#76892) Bump yargs-parser to v13.1.2+ (elastic#77009) [Ingest Manager] Shared Fleet agent policy action (elastic#76013) [Search] Re-add support for aborting when a connection is closed (elastic#76470) [Search] Remove long-running query pop-up (elastic#75385) [Monitoring] Fix UI error when alerting is not available (elastic#77179) do not log plugin id format warning in dist mode (elastic#77134) [ML] Improving client side error handling (elastic#76743) [Alerting][Connectors] Refactor IBM Resilient: Generic Implementation (phase one) (elastic#74357) [Docs] some basic searchsource api docs (elastic#77038) add cGroupOverrides to the legacy config (elastic#77180) Change saved object bulkUpdate to work across multiple namespaces (elastic#75478) [Security Solution][Resolver] Replace Selectable popover with badges (elastic#76997) Removing ml-state index from archive (elastic#77143) [Security Solution] Add unit tests for histograms (elastic#77081) [Lens] Filters aggregation (elastic#75635) [Enterprise Search] Update WS Overview logic to use new config data (elastic#77122) Cleanup type output before building new types (elastic#77211) [Security Solution] Use safe type in resolver backend (elastic#76969) Use proper lodash syntax (elastic#77105) ... # Conflicts: # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/node_allocation.tsx

jgowdyelastic added 3 commits September 4, 2020 09:00

[ML] Improving client side error handling

122df10

adding stacktrace to request errors

a100bca

Merge branch 'master' into improving-client-side-error-handling

83b5778

elasticmachine and others added 6 commits September 7, 2020 05:57

Merge branch 'master' into improving-client-side-error-handling

3625106

copying error parsing to transforms

25f6f68

update snapshot

5a105eb

fixing jest tests

88c5a23

adding test and removing debug log output

339be76

updating translations

7ff0187

jgowdyelastic marked this pull request as ready for review September 7, 2020 15:07

jgowdyelastic requested a review from a team as a code owner September 7, 2020 15:07

jgowdyelastic requested review from peteharverson, walterra, darnautov, qn895 and alvarezmelissa87 September 7, 2020 15:08

jgowdyelastic self-assigned this Sep 7, 2020

jgowdyelastic added :ml release_note:enhancement review v7.10.0 v8.0.0 labels Sep 7, 2020

jgowdyelastic removed request for walterra and darnautov September 8, 2020 09:30

jgowdyelastic added 3 commits September 8, 2020 21:08

rewriting error extracting code

ede532b

fixing tests

fe55673

removing message bar service

734d9d2

jgowdyelastic added 3 commits September 9, 2020 14:45

removing test code

4447901

updating translations

912c224

Merge branch 'master' into improving-client-side-error-handling

1f4ab4d

qn895 reviewed Sep 9, 2020

View reviewed changes

combining job creation error handling

9027b2a

qn895 reviewed Sep 9, 2020

View reviewed changes

refactoring error files

430dbdb

qn895 approved these changes Sep 9, 2020

View reviewed changes

alvarezmelissa87 reviewed Sep 9, 2020

View reviewed changes

alvarezmelissa87 approved these changes Sep 9, 2020

View reviewed changes

jgowdyelastic added 2 commits September 9, 2020 20:58

updating test

d6d57b8

fixing bug in DFA deletion

e9848af

improving mml warning

8875cfa

peteharverson approved these changes Sep 10, 2020

View reviewed changes

Merge branch 'master' into improving-client-side-error-handling

bfa4804

jgowdyelastic merged commit ea8086b into elastic:master Sep 11, 2020

jgowdyelastic deleted the improving-client-side-error-handling branch September 11, 2020 07:53

jgowdyelastic mentioned this pull request Sep 11, 2020

[7.x] [ML] Improving client side error handling (#76743) #77265

Merged

peteharverson mentioned this pull request Oct 8, 2020

[ML] Improve error handling in Jobs list from failed requests #24394

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Improving client side error handling #76743

[ML] Improving client side error handling #76743

jgowdyelastic commented Sep 4, 2020 •

edited

Loading

jgowdyelastic commented Sep 7, 2020

elasticmachine commented Sep 7, 2020

jgowdyelastic commented Sep 8, 2020

qn895 Sep 9, 2020

jgowdyelastic Sep 9, 2020

jgowdyelastic Sep 9, 2020

qn895 Sep 9, 2020

jgowdyelastic Sep 9, 2020

qn895 commented Sep 9, 2020

jgowdyelastic commented Sep 9, 2020

qn895 commented Sep 9, 2020

alvarezmelissa87 Sep 9, 2020 •

edited

Loading

jgowdyelastic Sep 9, 2020

alvarezmelissa87 left a comment

peteharverson commented Sep 10, 2020

jgowdyelastic commented Sep 10, 2020

peteharverson left a comment

jgowdyelastic commented Sep 10, 2020

kibanamachine commented Sep 10, 2020

[ML] Improving client side error handling #76743

[ML] Improving client side error handling #76743

Conversation

jgowdyelastic commented Sep 4, 2020 • edited Loading

jgowdyelastic commented Sep 7, 2020

elasticmachine commented Sep 7, 2020

jgowdyelastic commented Sep 8, 2020

qn895 Sep 9, 2020

Choose a reason for hiding this comment

jgowdyelastic Sep 9, 2020

Choose a reason for hiding this comment

jgowdyelastic Sep 9, 2020

Choose a reason for hiding this comment

qn895 Sep 9, 2020

Choose a reason for hiding this comment

jgowdyelastic Sep 9, 2020

Choose a reason for hiding this comment

qn895 commented Sep 9, 2020

jgowdyelastic commented Sep 9, 2020

qn895 commented Sep 9, 2020

alvarezmelissa87 Sep 9, 2020 • edited Loading

Choose a reason for hiding this comment

jgowdyelastic Sep 9, 2020

Choose a reason for hiding this comment

alvarezmelissa87 left a comment

Choose a reason for hiding this comment

peteharverson commented Sep 10, 2020

jgowdyelastic commented Sep 10, 2020

peteharverson left a comment

Choose a reason for hiding this comment

jgowdyelastic commented Sep 10, 2020

kibanamachine commented Sep 10, 2020

💚 Build Succeeded

Build metrics

@kbn/optimizer bundle module count

async chunks size

page load bundle size

distributable file count

History

jgowdyelastic commented Sep 4, 2020 •

edited

Loading

alvarezmelissa87 Sep 9, 2020 •

edited

Loading