Skip to content

Fixed an issue where query tool should not prompt for unsaved changes when there are no changes. #8127 #8210

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
adityatoshniwal merged 1 commit into from
Dec 5, 2024
Merged

Fixed an issue where query tool should not prompt for unsaved changes when there are no changes. #8127 #8210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion web/pgadmin/static/js/components/ReactCodeMirror/CustomEditorView.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ function getAutocompLoading({ bottom, left }, dom) {
export default class CustomEditorView extends EditorView {
constructor(...args) {
super(...args);
// Set the initial and clean state for the document and EOL(end of line).
this._cleanDoc = this.state.doc;
this._cleanDocEOL = this.getEOL();
}

getValue(tillCursor=false, useLineSep=false) {
Expand Down Expand Up @@ -268,10 +270,12 @@ export default class CustomEditorView extends EditorView {

markClean() {
this._cleanDoc = this.state.doc;
this._cleanDocEOL = this.getEOL(); // Update the initial EOL value.
}

isDirty() {
return !this._cleanDoc.eq(this.state.doc);
// Return true if either the document content or the EOL(end of line) has changed.
return !this._cleanDoc.eq(this.state.doc) || this._cleanDocEOL !== this.getEOL();
}

fireDOMEvent(event) {
Expand Down Expand Up @@ -340,4 +344,11 @@ export default class CustomEditorView extends EditorView {
effects: eolCompartment.reconfigure(eol.of(val))
});
}

// Use to detect EOL type.
detectEOL(content) {
const lineSep = content.includes('\r\n') ? '\r\n' : '\n';
this.setEOL(lineSep);
return lineSep == '\r\n' ? 'crlf' : 'lf';
}
}
2 changes: 1 addition & 1 deletion web/pgadmin/tools/sqleditor/static/js/components/QueryToolComponent.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ export default function QueryToolComponent({params, pgWindow, pgAdmin, selectedN
{
maximizable: true,
tabs: [
LayoutDocker.getPanel({id: PANELS.QUERY, title: gettext('Query'), content: <Query onTextSelect={(text) => setSelectedText(text)} handleEndOfLineChange={handleEndOfLineChange}/>}),
LayoutDocker.getPanel({id: PANELS.QUERY, title: gettext('Query'), content: <Query onTextSelect={(text) => setSelectedText(text)} setQtStatePartial={setQtStatePartial}/>}),
LayoutDocker.getPanel({id: PANELS.HISTORY, title: gettext('Query History'), content: <QueryHistory />,
cached: undefined}),
],
Expand Down
20 changes: 11 additions & 9 deletions web/pgadmin/tools/sqleditor/static/js/components/sections/Query.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import React, {useContext, useCallback, useEffect, useMemo } from 'react';
import { format } from 'sql-formatter';
import { QueryToolContext, QueryToolEventsContext } from '../QueryToolComponent';
import CodeMirror from '../../../../../../static/js/components/ReactCodeMirror';
import {OS_EOL, PANELS, QUERY_TOOL_EVENTS} from '../QueryToolConstants';
import { PANELS, QUERY_TOOL_EVENTS} from '../QueryToolConstants';
import url_for from 'sources/url_for';
import { LayoutDockerContext, LAYOUT_EVENTS } from '../../../../../../static/js/helpers/Layout';
import ConfirmSaveContent from '../../../../../../static/js/Dialogs/ConfirmSaveContent';
Expand Down Expand Up @@ -56,7 +56,7 @@ async function registerAutocomplete(editor, api, transId) {
});
}

export default function Query({onTextSelect, handleEndOfLineChange}) {
export default function Query({onTextSelect, setQtStatePartial}) {
const editor = React.useRef();
const eventBus = useContext(QueryToolEventsContext);
const queryToolCtx = useContext(QueryToolContext);
Expand Down Expand Up @@ -187,12 +187,13 @@ export default function Query({onTextSelect, handleEndOfLineChange}) {
editor.current.setValue(res.data);
//Check the file content for Trojan Source
checkTrojanSource(res.data);
editor.current.markClean();
eventBus.fireEvent(QUERY_TOOL_EVENTS.LOAD_FILE_DONE, fileName, true);
const lineSep = res.data.includes('\r\n') ? 'crlf' : 'lf';
if (lineSep !== OS_EOL){
handleEndOfLineChange(lineSep);
}
// Detect line separator from content and editor's EOL.
const lineSep = editor.current?.detectEOL(res.data);
// Update the EOL if it differs from the current editor EOL
setQtStatePartial({ eol: lineSep });
// Mark the editor content as clean
editor.current?.markClean();
}).catch((err)=>{
eventBus.fireEvent(QUERY_TOOL_EVENTS.LOAD_FILE_DONE, null, false);
pgAdmin.Browser.notifier.error(parseApiError(err));
Expand Down Expand Up @@ -292,8 +293,9 @@ export default function Query({onTextSelect, handleEndOfLineChange}) {
});

eventBus.registerListener(QUERY_TOOL_EVENTS.CHANGE_EOL, (lineSep)=>{
// Set the new EOL character in the editor.
editor.current?.setEOL(lineSep);
eventBus.fireEvent(QUERY_TOOL_EVENTS.QUERY_CHANGED, true);
eventBus.fireEvent(QUERY_TOOL_EVENTS.QUERY_CHANGED, editor.current?.isDirty());
});

eventBus.registerListener(QUERY_TOOL_EVENTS.EDITOR_TOGGLE_CASE, ()=>{
Expand Down Expand Up @@ -526,5 +528,5 @@ export default function Query({onTextSelect, handleEndOfLineChange}) {

Query.propTypes = {
onTextSelect: PropTypes.func,
handleEndOfLineChange: PropTypes.func
setQtStatePartial: PropTypes.func
};
Loading