fix(webui): Improve Presto search metadata handling: (#1280)

- Defer query done status until all data is delivered.
- Quantize Presto search signal as required for CLP.
- Reset the number of results to zero when submitting a new query.

Author: davemarco

components/webui/client/src/pages/SearchPage/SearchControls/Presto/presto-search-requests.ts

@@ -8,7 +8,7 @@ import {
     clearQueryResults,
     submitQuery,
 } from "../../../../api/presto-search";
-import useSearchStore from "../../SearchState";
+import useSearchStore, {SEARCH_STATE_DEFAULT} from "../../SearchState";
 import {SEARCH_UI_STATE} from "../../SearchState/typings";
 
 
@@ -43,7 +43,13 @@ const handlePrestoClearResults = () => {
  * @param payload
  */
 const handlePrestoQuerySubmit = (payload: PrestoQueryJobCreation) => {
-    const {updateSearchJobId, updateSearchUiState, searchUiState} = useSearchStore.getState();
+    const {
+        updateNumSearchResultsTable,
+        updateNumSearchResultsMetadata,
+        updateSearchJobId,
+        updateSearchUiState,
+        searchUiState,
+    } = useSearchStore.getState();
 
     // User should NOT be able to submit a new query while an existing query is in progress.
     if (
@@ -58,6 +64,8 @@ const handlePrestoQuerySubmit = (payload: PrestoQueryJobCreation) => {
 
     handlePrestoClearResults();
 
+    updateNumSearchResultsTable(SEARCH_STATE_DEFAULT.numSearchResultsTable);
+    updateNumSearchResultsMetadata(SEARCH_STATE_DEFAULT.numSearchResultsMetadata);
     updateSearchUiState(SEARCH_UI_STATE.QUERY_ID_PENDING);
 
     submitQuery(payload)

components/webui/client/src/pages/SearchPage/SearchControls/search-requests.ts

@@ -95,6 +95,7 @@ const handleQuerySubmit = (payload: QueryJobCreation) => {
 
     store.updateNumSearchResultsTable(SEARCH_STATE_DEFAULT.numSearchResultsTable);
     store.updateNumSearchResultsTimeline(SEARCH_STATE_DEFAULT.numSearchResultsTimeline);
+    store.updateNumSearchResultsMetadata(SEARCH_STATE_DEFAULT.numSearchResultsMetadata);
     store.updateSearchUiState(SEARCH_UI_STATE.QUERY_ID_PENDING);
 
     submitQuery(payload)

components/webui/client/src/pages/SearchPage/SearchState/useUpdateStateWithMetadata.ts

@@ -38,7 +38,7 @@ const useUpdateStateWithMetadata = () => {
 
         switch (resultsMetadata.lastSignal) {
             case SEARCH_SIGNAL.RESP_DONE:
-            case PRESTO_SEARCH_SIGNAL.FINISHED:
+            case PRESTO_SEARCH_SIGNAL.DONE:
                 updateSearchUiState(SEARCH_UI_STATE.DONE);
                 break;
             case PRESTO_SEARCH_SIGNAL.FAILED:

components/webui/common/src/metadata.ts

@@ -23,16 +23,8 @@ enum SEARCH_SIGNAL {
  * Presto search-related signals.
  */
 enum PRESTO_SEARCH_SIGNAL {
-    WAITING_FOR_PREREQUISITES = "WAITING_FOR_PREREQUISITES",
-    QUEUED = "QUEUED",
-    WAITING_FOR_RESOURCES = "WAITING_FOR_RESOURCES",
-    DISPATCHING = "DISPATCHING",
-    PLANNING = "PLANNING",
-    STARTING = "STARTING",
-    RUNNING = "RUNNING",
-    FINISHING = "FINISHING",
-    FINISHED = "FINISHED",
-    CANCELED = "CANCELED",
+    QUERYING = "QUERYING",
+    DONE = "DONE",
     FAILED = "FAILED",
 }
 

components/webui/server/src/routes/api/presto-search/index.ts

@@ -150,8 +150,6 @@ const plugin: FastifyPluginAsyncTypebox = async (fastify) => {
                         },
                         query: queryString,
                         state: (_, queryId, stats) => {
-                            // Type cast `presto-client` string literal type to our enum type.
-                            const newState = stats.state as PRESTO_SEARCH_SIGNAL;
                             request.log.info({
                                 searchJobId: queryId,
                                 state: stats.state,
@@ -163,24 +161,30 @@ const plugin: FastifyPluginAsyncTypebox = async (fastify) => {
                                     _id: queryId,
                                     errorMsg: null,
                                     errorName: null,
-                                    lastSignal: newState,
+                                    lastSignal: PRESTO_SEARCH_SIGNAL.QUERYING,
                                     queryEngine: CLP_QUERY_ENGINES.PRESTO,
                                 }).catch((err: unknown) => {
                                     request.log.error(err, "Failed to insert Presto metadata");
                                 });
                                 isResolved = true;
                                 resolve(queryId);
-                            } else {
-                                // Update metadata on subsequent calls
-                                searchResultsMetadataCollection.updateOne(
-                                    {_id: queryId},
-                                    {$set: {lastSignal: newState}}
-                                ).catch((err: unknown) => {
-                                    request.log.error(err, "Failed to update Presto metadata");
-                                });
                             }
                         },
                         success: () => {
+                            if (false === isResolved) {
+                                request.log.error(
+                                    "Presto query finished before searchJobId was resolved; "
+                                );
+
+                                return;
+                            }
+                            searchResultsMetadataCollection.updateOne(
+                                {_id: searchJobId},
+                                {$set: {lastSignal: PRESTO_SEARCH_SIGNAL.DONE}}
+                            ).catch((err: unknown) => {
+                                request.log.error(err, "Failed to update Presto metadata");
+                            });
+
                             request.log.info("Presto search succeeded");
                         },
                         timeout: null,