From b1e76a70369d91729be625682b41e1617093814b Mon Sep 17 00:00:00 2001
From: Josh Hunt <joshhunt@users.noreply.github.com>
Date: Fri, 7 Jul 2023 14:46:53 +0100
Subject: [PATCH] Dashboards: Keep save drawer open for unhandled errors
 (#70434)

* user essentials mob! :trident:

* user essentials mob! :trident:

lastFile:public/app/features/dashboard/components/SaveDashboard/SaveDashboardDrawer.tsx

* user essentials mob! :trident:

lastFile:public/app/features/dashboard/components/SaveDashboard/SaveDashboardDrawer.tsx

* user essentials mob! :trident:

lastFile:public/app/features/dashboard/components/SaveDashboard/useDashboardSave.tsx

* rename isHandledError fn

* fix prettier

---------

Co-authored-by: Joao Silva <joao.silva@grafana.com>
Co-authored-by: Laura Benz <laura.benz@grafana.com>
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
---
 .../SaveDashboard/SaveDashboardDrawer.tsx     | 21 +++++++++----------
 .../SaveDashboard/SaveDashboardErrorProxy.tsx |  4 ++--
 .../forms/SaveDashboardAsForm.test.tsx        |  1 +
 .../forms/SaveDashboardAsForm.tsx             | 13 +++++++++---
 .../forms/SaveDashboardForm.test.tsx          |  3 +++
 .../SaveDashboard/forms/SaveDashboardForm.tsx |  6 ++++--
 .../forms/SaveProvisionedDashboardForm.tsx    |  2 +-
 .../components/SaveDashboard/types.ts         |  1 +
 8 files changed, 32 insertions(+), 19 deletions(-)

diff --git a/public/app/features/dashboard/components/SaveDashboard/SaveDashboardDrawer.tsx b/public/app/features/dashboard/components/SaveDashboard/SaveDashboardDrawer.tsx
index 18a2c6157fb..56abc04a20d 100644
--- a/public/app/features/dashboard/components/SaveDashboard/SaveDashboardDrawer.tsx
+++ b/public/app/features/dashboard/components/SaveDashboard/SaveDashboardDrawer.tsx
@@ -2,14 +2,14 @@ import React, { useMemo, useState } from 'react';
 import { useAsync } from 'react-use';
 
 import { config, isFetchError } from '@grafana/runtime';
-import { Drawer, Spinner, Tab, TabsBar } from '@grafana/ui';
+import { Drawer, Tab, TabsBar } from '@grafana/ui';
 import { backendSrv } from 'app/core/services/backend_srv';
 
 import { jsonDiff } from '../VersionHistory/utils';
 
 import DashboardValidation from './DashboardValidation';
 import { SaveDashboardDiff } from './SaveDashboardDiff';
-import { SaveDashboardErrorProxy } from './SaveDashboardErrorProxy';
+import { proxyHandlesError, SaveDashboardErrorProxy } from './SaveDashboardErrorProxy';
 import { SaveDashboardAsForm } from './forms/SaveDashboardAsForm';
 import { SaveDashboardForm } from './forms/SaveDashboardForm';
 import { SaveProvisionedDashboardForm } from './forms/SaveProvisionedDashboardForm';
@@ -72,18 +72,11 @@ export const SaveDashboardDrawer = ({ dashboard, onDismiss, onSaveSuccess, isCop
       return <SaveDashboardDiff diff={data.diff} oldValue={previous.value} newValue={data.clone} />;
     }
 
-    if (state.loading) {
-      return (
-        <div>
-          <Spinner />
-        </div>
-      );
-    }
-
     if (isNew || isCopy) {
       return (
         <SaveDashboardAsForm
           dashboard={dashboard}
+          isLoading={state.loading}
           onCancel={onDismiss}
           onSuccess={onSuccess}
           onSubmit={onDashboardSave}
@@ -99,6 +92,7 @@ export const SaveDashboardDrawer = ({ dashboard, onDismiss, onSaveSuccess, isCop
     return (
       <SaveDashboardForm
         dashboard={dashboard}
+        isLoading={state.loading}
         saveModel={data}
         onCancel={onDismiss}
         onSuccess={onSuccess}
@@ -109,7 +103,12 @@ export const SaveDashboardDrawer = ({ dashboard, onDismiss, onSaveSuccess, isCop
     );
   };
 
-  if (state.error && isFetchError(state.error) && !state.error.isHandled) {
+  if (
+    state.error &&
+    isFetchError(state.error) &&
+    !state.error.isHandled &&
+    proxyHandlesError(state.error.data.status)
+  ) {
     return (
       <SaveDashboardErrorProxy
         error={state.error}
diff --git a/public/app/features/dashboard/components/SaveDashboard/SaveDashboardErrorProxy.tsx b/public/app/features/dashboard/components/SaveDashboard/SaveDashboardErrorProxy.tsx
index 9f9addf0a94..21af0812755 100644
--- a/public/app/features/dashboard/components/SaveDashboard/SaveDashboardErrorProxy.tsx
+++ b/public/app/features/dashboard/components/SaveDashboard/SaveDashboardErrorProxy.tsx
@@ -28,7 +28,7 @@ export const SaveDashboardErrorProxy = ({
   const { onDashboardSave } = useDashboardSave(dashboard);
 
   useEffect(() => {
-    if (error.data && isHandledError(error.data.status)) {
+    if (error.data && proxyHandlesError(error.data.status)) {
       error.isHandled = true;
     }
   }, [error]);
@@ -109,7 +109,7 @@ const ConfirmPluginDashboardSaveModal = ({ onDismiss, dashboard }: SaveDashboard
   );
 };
 
-const isHandledError = (errorStatus: string) => {
+export const proxyHandlesError = (errorStatus: string) => {
   switch (errorStatus) {
     case 'version-mismatch':
     case 'name-exists':
diff --git a/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardAsForm.test.tsx b/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardAsForm.test.tsx
index 8def9b180e1..665251f5c2c 100644
--- a/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardAsForm.test.tsx
+++ b/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardAsForm.test.tsx
@@ -37,6 +37,7 @@ const renderAndSubmitForm = async (
 ) => {
   render(
     <SaveDashboardAsForm
+      isLoading={false}
       dashboard={dashboard as DashboardModel}
       onCancel={() => {}}
       onSuccess={() => {}}
diff --git a/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardAsForm.tsx b/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardAsForm.tsx
index 2c07960bc98..ed78b95e3ff 100644
--- a/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardAsForm.tsx
+++ b/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardAsForm.tsx
@@ -40,7 +40,14 @@ export interface SaveDashboardAsFormProps extends SaveDashboardFormProps {
   isNew?: boolean;
 }
 
-export const SaveDashboardAsForm = ({ dashboard, isNew, onSubmit, onCancel, onSuccess }: SaveDashboardAsFormProps) => {
+export const SaveDashboardAsForm = ({
+  dashboard,
+  isLoading,
+  isNew,
+  onSubmit,
+  onCancel,
+  onSuccess,
+}: SaveDashboardAsFormProps) => {
   const defaultValues: SaveDashboardAsFormDTO = {
     title: isNew ? dashboard.title : `${dashboard.title} Copy`,
     $folder: {
@@ -129,8 +136,8 @@ export const SaveDashboardAsForm = ({ dashboard, isNew, onSubmit, onCancel, onSu
             <Button type="button" variant="secondary" onClick={onCancel} fill="outline">
               Cancel
             </Button>
-            <Button type="submit" aria-label="Save dashboard button">
-              Save
+            <Button disabled={isLoading} type="submit" aria-label="Save dashboard button">
+              {isLoading ? 'Saving...' : 'Save'}
             </Button>
           </HorizontalGroup>
         </>
diff --git a/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardForm.test.tsx b/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardForm.test.tsx
index 0988e2e7356..bcbad4676d7 100644
--- a/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardForm.test.tsx
+++ b/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardForm.test.tsx
@@ -34,6 +34,7 @@ const prepareDashboardMock = (
 const renderAndSubmitForm = async (dashboard: DashboardModel, submitSpy: jest.Mock) => {
   render(
     <SaveDashboardForm
+      isLoading={false}
       dashboard={dashboard}
       onCancel={() => {}}
       onSuccess={() => {}}
@@ -62,6 +63,7 @@ describe('SaveDashboardAsForm', () => {
     it('renders switches when variables or timerange', () => {
       render(
         <SaveDashboardForm
+          isLoading={false}
           dashboard={prepareDashboardMock(true, true, jest.fn(), jest.fn())}
           onCancel={() => {}}
           onSuccess={() => {}}
@@ -124,6 +126,7 @@ describe('SaveDashboardAsForm', () => {
     it('renders saved message draft if it was filled before', () => {
       render(
         <SaveDashboardForm
+          isLoading={false}
           dashboard={createDashboardModelFixture()}
           onCancel={() => {}}
           onSuccess={() => {}}
diff --git a/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardForm.tsx b/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardForm.tsx
index f0b41b2337b..76d8c9fe2bd 100644
--- a/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardForm.tsx
+++ b/public/app/features/dashboard/components/SaveDashboard/forms/SaveDashboardForm.tsx
@@ -13,6 +13,7 @@ interface FormDTO {
 
 export type SaveProps = {
   dashboard: DashboardModel; // original
+  isLoading: boolean;
   saveModel: SaveDashboardData; // already cloned
   onCancel: () => void;
   onSuccess: () => void;
@@ -23,6 +24,7 @@ export type SaveProps = {
 
 export const SaveDashboardForm = ({
   dashboard,
+  isLoading,
   saveModel,
   options,
   onSubmit,
@@ -108,11 +110,11 @@ export const SaveDashboardForm = ({
               </Button>
               <Button
                 type="submit"
-                disabled={!saveModel.hasChanges}
+                disabled={!saveModel.hasChanges || isLoading}
                 icon={saving ? 'fa fa-spinner' : undefined}
                 aria-label={selectors.pages.SaveDashboardModal.save}
               >
-                Save
+                {isLoading ? 'Saving...' : 'Save'}
               </Button>
               {!saveModel.hasChanges && <div>No changes to save</div>}
             </Stack>
diff --git a/public/app/features/dashboard/components/SaveDashboard/forms/SaveProvisionedDashboardForm.tsx b/public/app/features/dashboard/components/SaveDashboard/forms/SaveProvisionedDashboardForm.tsx
index d62bee8c9a2..984d5b46683 100644
--- a/public/app/features/dashboard/components/SaveDashboard/forms/SaveProvisionedDashboardForm.tsx
+++ b/public/app/features/dashboard/components/SaveDashboard/forms/SaveProvisionedDashboardForm.tsx
@@ -7,7 +7,7 @@ import { Button, ClipboardButton, HorizontalGroup, TextArea } from '@grafana/ui'
 
 import { SaveDashboardFormProps } from '../types';
 
-export const SaveProvisionedDashboardForm = ({ dashboard, onCancel }: SaveDashboardFormProps) => {
+export const SaveProvisionedDashboardForm = ({ dashboard, onCancel }: Omit<SaveDashboardFormProps, 'isLoading'>) => {
   const [dashboardJSON, setDashboardJson] = useState(() => {
     const clone = dashboard.getSaveModelClone();
     delete clone.id;
diff --git a/public/app/features/dashboard/components/SaveDashboard/types.ts b/public/app/features/dashboard/components/SaveDashboard/types.ts
index 9f0dcd447c0..1e757c0bad0 100644
--- a/public/app/features/dashboard/components/SaveDashboard/types.ts
+++ b/public/app/features/dashboard/components/SaveDashboard/types.ts
@@ -26,6 +26,7 @@ export interface SaveDashboardCommand {
 
 export interface SaveDashboardFormProps {
   dashboard: DashboardModel;
+  isLoading: boolean;
   onCancel: () => void;
   onSuccess: () => void;
   onSubmit?: (clone: DashboardModel, options: SaveDashboardOptions, dashboard: DashboardModel) => Promise<any>;