Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Rollups] Improve Rollup Job Wizard error handling #25092

Merged
merged 8 commits into from
Nov 5, 2018
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion x-pack/plugins/rollup/public/crud_app/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import PropTypes from 'prop-types';
import { Switch, Route, Redirect } from 'react-router-dom';

import { CRUD_APP_BASE_PATH } from './constants';
import { registerRouter } from './services';
import { registerRouter, setUserHasLeftApp } from './services';
import { JobList, JobCreate } from './sections';

export class App extends Component {
Expand All @@ -33,6 +33,11 @@ export class App extends Component {
registerRouter(router);
}

componentWillUnmount() {
// Set internal flag so we can prevent reacting to route changes internally.
setUserHasLeftApp(true);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to implement this so that navigating to the fatal error screen didn't affect our routing logic.

}

render() {
return (
<div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,9 @@ export class JobCreateUi extends Component {

// This error isn't an HTTP error, so let the fatal error screen tell the user something
// unexpected happened.
fatalError(error, 'Rollup Job Wizard index pattern validation');
fatalError(error, i18n.translate('xpack.rollupJobs.create.errors.indexPatternValidationFatalErrorTitle', {
defaultMessage: 'Rollup Job Wizard index pattern validation',
}));
});
}, 300);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,34 @@ export class JobListUi extends Component {
);
}

renderError(error) {
// We can safely depend upon the shape of this error coming from Angular $http, because we
// handle unexpected error shapes in the API action.
const {
statusCode,
error: errorString,
} = error.data;

const { intl } = this.props;
const title = intl.formatMessage({
id: 'xpack.rollupJobs.jobList.loadingErrorTitle',
defaultMessage: 'Error loading rollup jobs',
});
return (
<Fragment>
{this.getHeaderSection()}
<EuiSpacer size="m" />
<EuiCallOut
title={title}
color="danger"
iconType="alert"
>
{statusCode} {errorString}
</EuiCallOut>
</Fragment>
);
}

renderEmpty() {
return (
<EuiEmptyPrompt
Expand Down Expand Up @@ -224,8 +252,13 @@ export class JobListUi extends Component {
const { isLoading, jobs, jobLoadError } = this.props;

let content;
if (jobLoadError && jobLoadError.status === 403) {
content = this.renderNoPermission();

if (jobLoadError) {
if (jobLoadError.status === 403) {
content = this.renderNoPermission();
} else {
content = this.renderError(jobLoadError);
}
} else if (!isLoading && !jobs.length) {
content = this.renderEmpty();
} else {
Expand Down
42 changes: 42 additions & 0 deletions x-pack/plugins/rollup/public/crud_app/services/api_errors.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
* 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 { fatalError, toastNotifications } from 'ui/notify';

function createToast(error, errorTitle) {
jen-huang marked this conversation as resolved.
Show resolved Hide resolved
// Expect an error in the shape provided by Angular's $http service.
if (error && error.data) {
const { error: errorString, statusCode, message } = error.data;
return {
title: errorTitle,
text: `${statusCode}: ${errorString}. ${message}`,
};
}
}

export function showApiWarning(error, errorTitle) {
const toast = createToast(error, errorTitle);

if (toast) {
return toastNotifications.addWarning(toast);
}

// This error isn't an HTTP error, so let the fatal error screen tell the user something
// unexpected happened.
return fatalError(error, errorTitle);
}

export function showApiError(error, errorTitle) {
const toast = createToast(error, errorTitle);

if (toast) {
return toastNotifications.addDanger(toast);
}

// This error isn't an HTTP error, so let the fatal error screen tell the user something
// unexpected happened.
fatalError(error, errorTitle);
}
5 changes: 5 additions & 0 deletions x-pack/plugins/rollup/public/crud_app/services/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ export {
validateIndexPattern,
} from './api';

export {
showApiError,
showApiWarning,
} from './api_errors';

export {
cronExpressionToParts,
cronPartsToExpression,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { toastNotifications } from 'ui/notify';
import { i18n } from '@kbn/i18n';

import {
startJobs as sendStartJobsRequest,
stopJobs as sendStopJobsRequest,
createNoticeableDelay,
showApiError,
} from '../../services';

import {
Expand All @@ -31,7 +33,9 @@ export const startJobs = (jobIds) => async (dispatch) => {
type: UPDATE_JOB_FAILURE,
});

return toastNotifications.addDanger(error.data.message);
return showApiError(error, i18n.translate('xpack.rollupJobs.startJobsAction.errorTitle', {
defaultMessage: 'Error starting rollup jobs',
}));
}

dispatch({
Expand All @@ -53,7 +57,9 @@ export const stopJobs = (jobIds) => async (dispatch) => {
type: UPDATE_JOB_FAILURE,
});

return toastNotifications.addDanger(error.data.message);
return showApiError(error, i18n.translate('xpack.rollupJobs.stopJobsAction.errorTitle', {
defaultMessage: 'Error stopping rollup jobs',
}));
}

dispatch({
Expand Down
47 changes: 31 additions & 16 deletions x-pack/plugins/rollup/public/crud_app/store/actions/create_job.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { i18n } from '@kbn/i18n';
import { fatalError } from 'ui/notify';

import { CRUD_APP_BASE_PATH } from '../../constants';
import {
createJob as sendCreateJobRequest,
Expand Down Expand Up @@ -33,34 +36,46 @@ export const createJob = (jobConfig) => async (dispatch) => {
new Promise(resolve => setTimeout(resolve, 500)),
]);
} catch (error) {
const { statusCode, data } = error;
if (error) {
const { statusCode, data } = error;

// Some errors have statusCode directly available but some are under a data property.
switch (statusCode || data.statusCode) {
case 409:
dispatch({
type: CREATE_JOB_FAILURE,
payload: {
error: {
message: `A job with ID '${jobConfig.id}' already exists.`,
// Expect an error in the shape provided by Angular's $http service.
if (data) {
// Some errors have statusCode directly available but some are under a data property.
if ((statusCode || (data && data.statusCode)) === 409) {
jen-huang marked this conversation as resolved.
Show resolved Hide resolved
return dispatch({
type: CREATE_JOB_FAILURE,
payload: {
error: {
message: i18n.translate('xpack.rollupJobs.createAction.jobIdAlreadyExistsErrorMessage', {
defaultMessage: `A job with ID '{jobConfigId}' already exists.`,
values: { jobConfigId: jobConfig.id },
}),
},
},
},
});
break;
});
}

default:
dispatch({
return dispatch({
type: CREATE_JOB_FAILURE,
payload: {
error: {
message: `Request failed with a ${statusCode} error. ${data.message}`,
message: i18n.translate('xpack.rollupJobs.createAction.failedDefaultErrorMessage', {
defaultMessage: 'Request failed with a {statusCode} error. {message}',
values: { statusCode, message: data.message },
}),
cause: data.cause,
},
},
});
}
}

return;
// This error isn't an HTTP error, so let the fatal error screen tell the user something
// unexpected happened.
return fatalError(error, i18n.translate('xpack.rollupJobs.createAction.errorTitle', {
defaultMessage: 'Error creating rollup job',
}));
}

dispatch({
Expand Down
21 changes: 17 additions & 4 deletions x-pack/plugins/rollup/public/crud_app/store/actions/delete_jobs.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { i18n } from '@kbn/i18n';
import { toastNotifications } from 'ui/notify';

import { deleteJobs as sendDeleteJobsRequest, createNoticeableDelay } from '../../services';
import {
deleteJobs as sendDeleteJobsRequest,
createNoticeableDelay,
showApiError,
} from '../../services';
import { getDetailPanelJob } from '../selectors';

import {
Expand All @@ -30,13 +35,21 @@ export const deleteJobs = (jobIds) => async (dispatch, getState) => {
type: UPDATE_JOB_FAILURE,
});

return toastNotifications.addDanger(error.data.message);
return showApiError(error, i18n.translate('xpack.rollupJobs.deleteAction.errorTitle', {
defaultMessage: 'Error deleting rollup jobs',
}));
}

if (jobIds.length === 1) {
toastNotifications.addSuccess(`Rollup job '${jobIds[0]}' was deleted`);
toastNotifications.addSuccess(i18n.translate('xpack.rollupJobs.deleteAction.successSingleNotificationTitle', {
defaultMessage: `Rollup job '{jobId}' was deleted`,
values: { jobId: jobIds[0] },
}));
} else {
toastNotifications.addSuccess(`${jobIds.length} rollup jobs were deleted`);
toastNotifications.addSuccess(i18n.translate('xpack.rollupJobs.deleteAction.successMultipleNotificationTitle', {
defaultMessage: '{count} rollup jobs were deleted',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to handle pluralization?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessary, since this branch of the logic only handles multiple jobs.

values: { count: jobIds.length },
}));
}

// If we've just deleted a job we were looking at, we need to close the panel.
Expand Down
13 changes: 10 additions & 3 deletions x-pack/plugins/rollup/public/crud_app/store/actions/load_jobs.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { toastNotifications } from 'ui/notify';
import { loadJobs as sendLoadJobsRequest, deserializeJobs } from '../../services';
import { i18n } from '@kbn/i18n';

import {
loadJobs as sendLoadJobsRequest,
deserializeJobs,
showApiError,
} from '../../services';
import {
LOAD_JOBS_START,
LOAD_JOBS_SUCCESS,
Expand All @@ -26,7 +31,9 @@ export const loadJobs = () => async (dispatch) => {
payload: { error }
});

return toastNotifications.addDanger(error.data.message);
return showApiError(error, i18n.translate('xpack.rollupJobs.loadAction.errorTitle', {
defaultMessage: 'Error loading rollup jobs',
}));
}

dispatch({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { toastNotifications } from 'ui/notify';
import { loadJobs as sendLoadJobsRequest, deserializeJobs } from '../../services';
import { i18n } from '@kbn/i18n';

import {
loadJobs as sendLoadJobsRequest,
deserializeJobs,
showApiWarning,
} from '../../services';
import {
REFRESH_JOBS_SUCCESS,
} from '../action_types';
Expand All @@ -15,7 +20,9 @@ export const refreshJobs = () => async (dispatch) => {
try {
jobs = await sendLoadJobsRequest();
} catch (error) {
return toastNotifications.addWarning(error.data.message);
return showApiWarning(error, i18n.translate('xpack.rollupJobs.refreshAction.errorTitle', {
defaultMessage: 'Error refreshing rollup jobs',
}));
}

dispatch({
Expand Down