Skip to content

fixes edit mode callback bug in Saved Object Panels #420

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

Merged
ps48 merged 4 commits into from
Apr 27, 2023
Merged

fixes edit mode callback bug in Saved Object Panels #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
626bdb4
fix for SOpanels editMode
ps48 Apr 25, 2023
c898850
rename edit button data-test-subj
ps48 Apr 25, 2023
f7aefe7
Merge branch '2.7' into edit_check
ps48 Apr 25, 2023
ae348c5
Merge branch '2.7' into edit_check
ps48 Apr 25, 2023
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
31 changes: 9 additions & 22 deletions public/components/custom_panels/custom_panel_view_so.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,14 @@ import { PanelGridSO } from './panel_modules/panel_grid/panel_grid_so';
import { VisaulizationFlyoutSO } from './panel_modules/visualization_flyout/visualization_flyout_so';
import {
clonePanel,
createPanel,
deletePanels,
fetchPanel,
newPanelTemplate,
selectPanel,
setPanel,
setPanelEt,
setPanelId,
setPanelSt,
updatePanel,
} from './redux/panel_slice';
import PPLService from '../../services/requests/ppl';
import DSLService from '../../services/requests/dsl';

/*
* "CustomPanelsView" module used to render an Observability Dashboard
Expand Down Expand Up @@ -277,20 +274,10 @@ export const CustomPanelViewSO = (props: CustomPanelViewProps) => {
};

// toggle between panel edit mode

const startEdit = () => {
setIsEditing(true);
};

const applyEdits = useCallback(() => {
dispatch(updatePanel(panel));
setIsEditing(false);
setEditActionType('save');
}, [panel]);

const cancelEdit = () => {
dispatch(fetchPanel(panelId));
setIsEditing(false);
const editPanel = (editType: string) => {
setIsEditing(!isEditing);
if (editType === 'cancel') dispatch(fetchPanel(panelId));
setEditActionType(editType);
};

const closeFlyout = () => {
Expand Down Expand Up @@ -406,14 +393,14 @@ export const CustomPanelViewSO = (props: CustomPanelViewProps) => {
data-test-subj="cancelPanelButton"
iconType="cross"
color="danger"
onClick={cancelEdit}
onClick={() => editPanel('cancel')}
>
Cancel
</EuiButton>
);

const saveButton = (
<EuiButton data-test-subj="savePanelButton" iconType="save" onClick={applyEdits}>
<EuiButton data-test-subj="savePanelButton" iconType="save" onClick={() => editPanel('save')}>
Save
</EuiButton>
);
Expand All @@ -422,7 +409,7 @@ export const CustomPanelViewSO = (props: CustomPanelViewProps) => {
<EuiButton
data-test-subj="editPanelButton"
iconType="pencil"
onClick={startEdit}
onClick={() => editPanel('edit')}
disabled={editDisabled}
>
Edit
Expand Down
19 changes: 8 additions & 11 deletions public/components/custom_panels/panel_modules/panel_grid/panel_grid_so.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,17 +153,14 @@ export const PanelGridSO = (props: PanelGridProps) => {
};

// Save Visualization Layouts when not in edit mode anymore (after users saves the panel)
const saveVisualizationLayouts = useCallback(
async (panelID: string, visualizationParams: any) => {
const newVisualizations = updateLayout(panel.visualizations, visualizationParams);
const updateRes = await coreRefs.savedObjectsClient?.update('observability-panel', panelID, {
...panel,
visualizations: newVisualizations,
});
setPanelVisualizations(updateRes?.attributes?.visualizations || []);
},
[panel]
);
const saveVisualizationLayouts = async (panelID: string, visualizationParams: any) => {
Copy link
Copy Markdown
Collaborator

@derek-ho derek-ho Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what exactly is this change doing/what bug?

Copy link
Copy Markdown
Member Author

@ps48 ps48 Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Saving after edit in SOPanels still has drag/drop control on visualizations
  • Resize and drag visualization workflow post edit and save doesn't work in SOpanels, when a user hits the edit followed by save button, before response is made by the callback.

const newVisualizations = updateLayout(panel.visualizations, visualizationParams);
const updateRes = await coreRefs.savedObjectsClient?.update('observability-panel', panelID, {
...panel,
visualizations: newVisualizations,
});
setPanelVisualizations(updateRes?.attributes?.visualizations || []);
};

// Update layout whenever user edit gets completed
useEffect(() => {
Expand Down
37 changes: 3 additions & 34 deletions ...c/components/custom_panels/panel_modules/visualization_flyout/visualization_flyout_so.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,13 @@ import { useDispatch, useSelector } from 'react-redux';
import { CoreStart } from '../../../../../../../src/core/public';
import { SAVED_VISUALIZATION } from '../../../../../common/constants/explorer';
import {
PplResponse,
PPLResponse,
SavedVisualizationType,
VisualizationType,
VizContainerError,
} from '../../../../../common/types/custom_panels';
import { uiSettingsService } from '../../../../../common/utils';

import PPLService from '../../../../services/requests/ppl';
import { SavedObjectsActions } from '../../../../services/saved_objects/saved_object_client/saved_objects_actions';
import { ObservabilitySavedVisualization } from '../../../../services/saved_objects/saved_object_client/types';
Expand Down Expand Up @@ -121,7 +122,7 @@ export const VisaulizationFlyoutSO = ({
const [newVisualizationTimeField, setNewVisualizationTimeField] = useState('');
const [previewMetaData, setPreviewMetaData] = useState<SavedVisualizationType>();
const [pplQuery, setPPLQuery] = useState('');
const [previewData, setPreviewData] = useState<PplResponse>({} as PplResponse);
const [previewData, setPreviewData] = useState<PPLResponse>({} as PPLResponse);
const [previewArea, setPreviewArea] = useState(<></>);
const [previewLoading, setPreviewLoading] = useState(false);
const [isPreviewError, setIsPreviewError] = useState({} as VizContainerError);
Expand Down Expand Up @@ -182,43 +183,11 @@ export const VisaulizationFlyoutSO = ({
if (!isInputValid()) return;

if (isFlyoutReplacement) {
// http
// .post(`${CUSTOM_PANELS_API_PREFIX}/visualizations/replace`, {
// body: JSON.stringify({
// panelId,
// savedVisualizationId: selectValue,
// oldVisualizationId: replaceVisualizationId,
// }),
// })
// .then(async (res) => {
// setPanelVisualizations(res.visualizations);
// setToast(`Visualization ${newVisualizationTitle} successfully added!`, 'success');
Copy link
Copy Markdown
Contributor

@pjfitzgibbons pjfitzgibbons Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that the updated Toast is merged, these setToast should be re-instated wherever we see them in PRs.

Copy link
Copy Markdown
Member Author

@ps48 ps48 Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pjfitzgibbons does your code re-instate the toast? If so we should get this once it is merged

Copy link
Copy Markdown
Member Author

@ps48 ps48 Apr 25, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, the toast reinstatement should go here: #415

// })
// .catch((err) => {
// setToast(`Error in adding ${newVisualizationTitle} visualization to the panel`, 'danger');
Comment thread
ps48 marked this conversation as resolved.
// console.error(err);
// });
dispatch(replaceVizInPanel(panel, replaceVisualizationId, selectValue));
} else {
const visualizationsWithNewPanel = addVisualizationPanel({
savedVisualizationId: selectValue,
});

// http
// .post(`${CUSTOM_PANELS_API_PREFIX}/visualizations`, {
// body: JSON.stringify({
// panelId,
// savedVisualizationId: selectValue,
// }),
// })
// .then(async (res) => {
// setPanelVisualizations(res.visualizations);
// setToast(`Visualization ${newVisualizationTitle} successfully added!`, 'success');
Comment thread
ps48 marked this conversation as resolved.
// })
// .catch((err) => {
// setToast(`Error in adding ${newVisualizationTitle} visualization to the panel`, 'danger');
Comment thread
ps48 marked this conversation as resolved.
// console.error(err);
// });
}
closeFlyout();
};
Expand Down