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.

Sign up for GitHub

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

Migrate Query page to React: Cancel query execution #4496

Merged
merged 1 commit into from
Dec 26, 2019
Merged

Migrate Query page to React: Cancel query execution #4496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions client/app/pages/queries/QuerySource.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,15 @@ function QuerySource(props) {
const parameters = useMemo(() => query.getParametersDefs(), [query]);
const [dirtyParameters, setDirtyParameters] = useState(query.getParameters().hasPendingValues());

const { queryResult, queryResultData, isQueryExecuting, executeQuery, executeAdhocQuery } = useQueryExecute(query);
const {
queryResult,
queryResultData,
isQueryExecuting,
isExecutionCancelling,
gabrieldutra marked this conversation as resolved.
Show resolved Hide resolved
executeQuery,
executeAdhocQuery,
cancelExecution,
} = useQueryExecute(query);

const editorRef = useRef(null);
const autocompleteAvailable = useMemo(() => {
Expand Down Expand Up @@ -454,7 +462,8 @@ function QuerySource(props) {
status={queryResultData.status}
updatedAt={queryResultData.updatedAt}
error={queryResultData.error}
onCancel={() => console.log("Query execution cancelled")}
isCancelling={isExecutionCancelling}
onCancel={cancelExecution}
/>
</div>
)}
Expand Down
20 changes: 13 additions & 7 deletions client/app/pages/queries/components/QueryExecutionStatus.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,22 @@ import Alert from "antd/lib/alert";
import Button from "antd/lib/button";
import { Timer } from "@/components/Timer";

export default function QueryExecutionStatus({ status, updatedAt, error, onCancel }) {
export default function QueryExecutionStatus({ status, updatedAt, error, isCancelling, onCancel }) {
const alertType = status === "failed" ? "error" : "info";
const showTimer = status !== "failed" && updatedAt;
const canCancel = includes(["waiting", "processing"], status);
let message = null;
const isCancelButtonAvailable = includes(["waiting", "processing"], status);
let message = isCancelling ? <React.Fragment>Cancelling&hellip;</React.Fragment> : null;

switch (status) {
case "waiting":
message = <React.Fragment>Query in queue&hellip;</React.Fragment>;
if (!isCancelling) {
message = <React.Fragment>Query in queue&hellip;</React.Fragment>;
}
break;
case "processing":
message = <React.Fragment>Executing query&hellip;</React.Fragment>;
if (!isCancelling) {
message = <React.Fragment>Executing query&hellip;</React.Fragment>;
}
break;
case "loading-result":
message = <React.Fragment>Loading results&hellip;</React.Fragment>;
Expand All @@ -40,8 +44,8 @@ export default function QueryExecutionStatus({ status, updatedAt, error, onCance
{message} {showTimer && <Timer from={updatedAt} />}
</div>
<div>
{canCancel && (
<Button type="primary" size="small" onClick={onCancel}>
{isCancelButtonAvailable && (
<Button type="primary" size="small" disabled={isCancelling} onClick={onCancel}>
Cancel
</Button>
)}
Expand All @@ -56,12 +60,14 @@ QueryExecutionStatus.propTypes = {
status: PropTypes.string,
updatedAt: PropTypes.any,
error: PropTypes.string,
isCancelling: PropTypes.bool,
onCancel: PropTypes.func,
};

QueryExecutionStatus.defaultProps = {
status: "waiting",
updatedAt: null,
error: null,
isCancelling: true,
onCancel: () => {},
};
29 changes: 25 additions & 4 deletions client/app/pages/queries/utils/useQueryExecute.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ export default function useQueryExecute(query) {
queryResultData.status,
]);

const [isExecutionCancelling, setIsExecutionCancelling] = useState(false);

const executeQuery = useCallback(() => {
recordEvent("execute", "query", query.id);
setQueryResult(query.getQueryResult(0));
Expand All @@ -36,12 +38,31 @@ export default function useQueryExecute(query) {
[query]
);

const cancelExecution = useCallback(() => {
if (queryResult) {
recordEvent("cancel_execute", "query", query.id);
queryResult.cancelExecution();
setIsExecutionCancelling(true);
}
}, [query, queryResult]);

useEffect(() => {
if (!isQueryExecuting && queryResult && queryResult.query_result.query === query.query) {
query.latest_query_data_id = queryResult.getId();
query.queryResult = queryResult;
if (!isQueryExecuting) {
setIsExecutionCancelling(false);
if (queryResult && queryResult.query_result.query === query.query) {
query.latest_query_data_id = queryResult.getId();
query.queryResult = queryResult;
}
}
}, [isQueryExecuting]); // eslint-disable-line react-hooks/exhaustive-deps

return { queryResult, queryResultData, isQueryExecuting, executeQuery, executeAdhocQuery };
return {
queryResult,
queryResultData,
isQueryExecuting,
isExecutionCancelling,
executeQuery,
executeAdhocQuery,
cancelExecution,
};
}