chore(sqllab): Remove validation result from state (#24082)

2026-04-24 10:35:01 +00:00 · 2023-06-08 12:53:16 -07:00
parent 7e626c04cb
commit c4242a3657
11 changed files with 457 additions and 195 deletions
--- a/superset-frontend/src/SqlLab/components/AceEditorWrapper/useAnnotations.ts
+++ b/superset-frontend/src/SqlLab/components/AceEditorWrapper/useAnnotations.ts
@@ -0,0 +1,83 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { useSelector } from 'react-redux';
+
+import { SqlLabRootState } from 'src/SqlLab/types';
+import COMMON_ERR_MESSAGES from 'src/utils/errorMessages';
+import { VALIDATION_DEBOUNCE_MS } from 'src/SqlLab/constants';
+import {
+  FetchValidationQueryParams,
+  useQueryValidationsQuery,
+} from 'src/hooks/apiResources';
+import { useDebounceValue } from 'src/hooks/useDebounceValue';
+import { ClientErrorObject } from 'src/utils/getClientErrorObject';
+import { t } from '@superset-ui/core';
+
+export function useAnnotations(params: FetchValidationQueryParams) {
+  const { sql, dbId, schema, templateParams } = params;
+  const debouncedSql = useDebounceValue(sql, VALIDATION_DEBOUNCE_MS);
+  const hasValidator = useSelector<SqlLabRootState>(({ sqlLab, common }) =>
+    // Check whether or not we can validate the current query based on whether
+    // or not the backend has a validator configured for it.
+    Boolean(
+      common?.conf?.SQL_VALIDATORS_BY_ENGINE?.[
+        sqlLab?.databases?.[dbId || '']?.backend
+      ],
+    ),
+  );
+  return useQueryValidationsQuery(
+    {
+      dbId,
+      schema,
+      sql: debouncedSql,
+      templateParams,
+    },
+    {
+      skip: !(hasValidator && dbId && sql),
+      selectFromResult: ({ isLoading, isError, error, data }) => {
+        const errorObj = (error ?? {}) as ClientErrorObject;
+        let message =
+          errorObj?.error || errorObj?.statusText || t('Unknown error');
+        if (message.includes('CSRF token')) {
+          message = t(COMMON_ERR_MESSAGES.SESSION_TIMED_OUT);
+        }
+        return {
+          data:
+            !isLoading && data?.length
+              ? data.map(err => ({
+                  type: 'error',
+                  row: (err.line_number || 0) - 1,
+                  column: (err.start_column || 0) - 1,
+                  text: err.message,
+                }))
+              : isError
+              ? [
+                  {
+                    type: 'error',
+                    row: 0,
+                    column: 0,
+                    text: `The server failed to validate your query.\n${message}`,
+                  },
+                ]
+              : [],
+        };
+      },
+    },
+  );
+}