allow for backward compatible errors

apache · Oct 25, 2023 · 2e91e0d · 2e91e0d
1 parent e2fe967
commit 2e91e0d
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 20 deletions.
diff --git a/superset-frontend/packages/superset-ui-core/src/models/Registry.ts b/superset-frontend/packages/superset-ui-core/src/models/Registry.ts
@@ -54,6 +54,7 @@ export type Listener = (keys: string[]) => void;
 export interface RegistryConfig {
   name?: string;
   overwritePolicy?: OverwritePolicy;
+  defaultValue?: any;
 }
 
 /**
@@ -88,13 +89,20 @@ export default class Registry<
 
   listeners: Set<Listener>;
 
+  defaultValue?: V;
+
   constructor(config: RegistryConfig = {}) {
-    const { name = '', overwritePolicy = OverwritePolicy.ALLOW } = config;
+    const {
+      name = '',
+      overwritePolicy = OverwritePolicy.ALLOW,
+      defaultValue,
+    } = config;
     this.name = name;
     this.overwritePolicy = overwritePolicy;
     this.items = {};
     this.promises = {};
     this.listeners = new Set();
+    this.defaultValue = defaultValue;
   }
 
   clear() {
@@ -174,7 +182,9 @@ export default class Registry<
 
       return item.value;
     }
-
+    if (this.defaultValue) {
+      return this.defaultValue;
+    }
     return undefined;
   }
 

diff --git a/superset-frontend/src/components/Datasource/DatasourceModal.tsx b/superset-frontend/src/components/Datasource/DatasourceModal.tsx
@@ -31,13 +31,11 @@ import {
 
 import Modal from 'src/components/Modal';
 import AsyncEsmComponent from 'src/components/AsyncEsmComponent';
-import {
-  genericSupersetError,
-  SupersetError,
-} from 'src/components/ErrorMessage/types';
+import { SupersetError } from 'src/components/ErrorMessage/types';
 import ErrorMessageWithStackTrace from 'src/components/ErrorMessage/ErrorMessageWithStackTrace';
 import withToasts from 'src/components/MessageToasts/withToasts';
 import { useSelector } from 'react-redux';
+import { getClientErrorObject } from 'src/utils/getClientErrorObject';
 
 const DatasourceEditor = AsyncEsmComponent(() => import('./DatasourceEditor'));
 
@@ -207,16 +205,24 @@ const DatasourceModal: FunctionComponent<DatasourceModalProps> = ({
       })
       .catch(response => {
         setIsSaving(false);
-        response.json().then((errorJson: { errors: SupersetError[] }) => {
+        getClientErrorObject(response).then(error => {
+          let errorResponse: SupersetError | undefined;
+          let errorText: string | undefined;
+          // sip-40 error response
+          if (error?.errors?.length) {
+            errorResponse = error.errors[0];
+          } else if (typeof error.error === 'string') {
+            // backward compatible with old error messages
+            errorText = error.error;
+          }
           modal.error({
             title: t('Error saving dataset'),
             okButtonProps: { danger: true, className: 'btn-danger' },
             content: (
               <ErrorMessageWithStackTrace
-                error={
-                  errorJson?.errors?.[0] || genericSupersetError(errorJson)
-                }
+                error={errorResponse}
                 source="crud"
+                fallback={errorText}
               />
             ),
           });

diff --git a/superset-frontend/src/components/ErrorMessage/getErrorMessageComponentRegistry.ts b/superset-frontend/src/components/ErrorMessage/getErrorMessageComponentRegistry.ts
@@ -16,9 +16,23 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { Registry, makeSingleton, OverwritePolicy } from '@superset-ui/core';
+import {
+  Registry,
+  makeSingleton,
+  OverwritePolicy,
+  ErrorTypeEnum,
+  ErrorLevel,
+} from '@superset-ui/core';
 import { ErrorMessageComponent } from './types';
 
+/* Generic error to be returned when the backend returns an error response that is not
+ * SIP-41 compliant. */
+const genericSupersetError = (extra: object) => ({
+  error_type: ErrorTypeEnum.GENERIC_BACKEND_ERROR,
+  extra,
+  level: 'error' as ErrorLevel,
+  message: 'An error occurred',
+});
 class ErrorMessageComponentRegistry extends Registry<
   ErrorMessageComponent,
   ErrorMessageComponent
@@ -27,6 +41,7 @@ class ErrorMessageComponentRegistry extends Registry<
     super({
       name: 'ErrorMessageComponent',
       overwritePolicy: OverwritePolicy.ALLOW,
+      defaultValue: genericSupersetError,
     });
   }
 }

diff --git a/superset-frontend/src/components/ErrorMessage/types.ts b/superset-frontend/src/components/ErrorMessage/types.ts
@@ -107,12 +107,3 @@ export type ErrorMessageComponentProps<ExtraType = Record<string, any> | null> =
 
 export type ErrorMessageComponent =
   React.ComponentType<ErrorMessageComponentProps>;
-
-/* Generic error to be returned when the backend returns an error response that is not
- * SIP-41 compliant. */
-export const genericSupersetError = (extra: object) => ({
-  error_type: ErrorTypeEnum.GENERIC_BACKEND_ERROR,
-  extra,
-  level: 'error' as ErrorLevel,
-  message: 'An error occurred',
-});