mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2025-02-25 18:55:31 -06:00
Significant changes to use ReactJS extensively.
1. Replace the current layout library wcDocker with ReactJS based rc-dock. #6479 2. Have close buttons on individual panel tabs instead of common. #2821 3. Changes in the context menu on panel tabs - Add close, close all and close others menu items. #5394 4. Allow closing all the tabs, including SQL and Properties. #4733 5. Changes in docking behaviour of different tabs based on user requests and remove lock layout menu. 6. Fix an issue where the scroll position of panels was not remembered on Firefox. #2986 7. Reset layout now will not require page refresh and is done spontaneously. 8. Use the zustand store for storing preferences instead of plain JS objects. This will help reflecting preferences immediately. 9. The above fix incorrect format (no indent) of SQL stored functions/procedures. #6720 10. New version check is moved to an async request now instead of app start to improve startup performance. 11. Remove jQuery and Bootstrap completely. 12. Replace jasmine and karma test runner with jest. Migrate all the JS test cases to jest. This will save time in writing and debugging JS tests. 13. Other important code improvements and cleanup.
This commit is contained in:
247
web/pgadmin/misc/properties/ObjectNodeProperties.jsx
Normal file
247
web/pgadmin/misc/properties/ObjectNodeProperties.jsx
Normal file
@@ -0,0 +1,247 @@
|
||||
/////////////////////////////////////////////////////////////
|
||||
//
|
||||
// pgAdmin 4 - PostgreSQL Tools
|
||||
//
|
||||
// Copyright (C) 2013 - 2023, The pgAdmin Development Team
|
||||
// This software is released under the PostgreSQL Licence
|
||||
//
|
||||
//////////////////////////////////////////////////////////////
|
||||
|
||||
import React, { useEffect, useMemo, useRef } from 'react';
|
||||
|
||||
import getApiInstance from 'sources/api_instance';
|
||||
import {getHelpUrl, getEPASHelpUrl} from 'pgadmin.help';
|
||||
import SchemaView from 'sources/SchemaView';
|
||||
import gettext from 'sources/gettext';
|
||||
import { generateNodeUrl } from '../../browser/static/js/node_ajax';
|
||||
import { usePgAdmin } from '../../static/js/BrowserComponent';
|
||||
import { LAYOUT_EVENTS, LayoutDockerContext } from '../../static/js/helpers/Layout';
|
||||
import usePreferences from '../../preferences/static/js/store';
|
||||
import PropTypes from 'prop-types';
|
||||
|
||||
export default function ObjectNodeProperties({panelId, node, treeNodeInfo, nodeData, actionType, formType, onEdit, onSave, onClose,
|
||||
isActive, isStale, setIsStale}) {
|
||||
const layoutDocker = React.useContext(LayoutDockerContext);
|
||||
const nodeType = nodeData?._type;
|
||||
const pgAdmin = usePgAdmin();
|
||||
let serverInfo = treeNodeInfo && ('server' in treeNodeInfo) &&
|
||||
pgAdmin.Browser.serverInfo && pgAdmin.Browser.serverInfo[treeNodeInfo.server._id];
|
||||
let inCatalog = treeNodeInfo && ('catalog' in treeNodeInfo);
|
||||
let urlBase = generateNodeUrl.call(node, treeNodeInfo, actionType, nodeData, false, node.url_jump_after_node);
|
||||
const api = getApiInstance();
|
||||
const url = (isNew)=>{
|
||||
return urlBase + (isNew ? '' : nodeData._id);
|
||||
};
|
||||
const isDirty = useRef(false); // usefull for warnings
|
||||
let warnOnCloseFlag = true;
|
||||
const confirmOnCloseReset = usePreferences().getPreferencesForModule('browser').confirm_on_properties_close;
|
||||
let updatedData = ['table', 'partition'].includes(nodeType) && !_.isEmpty(nodeData.rows_cnt) ? {rows_cnt: nodeData.rows_cnt} : undefined;
|
||||
|
||||
let onError = (err)=> {
|
||||
if(err.response){
|
||||
console.error('error resp', err.response);
|
||||
} else if(err.request){
|
||||
console.error('error req', err.request);
|
||||
} else if(err.message){
|
||||
console.error('error msg', err.message);
|
||||
}
|
||||
};
|
||||
|
||||
/* Called when dialog is opened in edit mode, promise required */
|
||||
let initData = ()=>new Promise((resolve, reject)=>{
|
||||
if(actionType === 'create') {
|
||||
resolve({});
|
||||
} else {
|
||||
// Do not call the API if tab is not active.
|
||||
if(!isActive && actionType == 'properties') {
|
||||
return;
|
||||
}
|
||||
api.get(url(false))
|
||||
.then((res)=>{
|
||||
resolve(res.data);
|
||||
})
|
||||
.catch((err)=>{
|
||||
pgAdmin.Browser.notifier.pgNotifier('error', err, '', function(msg) {
|
||||
if (msg == 'CRYPTKEY_SET') {
|
||||
return Promise.resolve(initData());
|
||||
} else if (msg == 'CRYPTKEY_NOT_SET') {
|
||||
reject(gettext('The master password is not set.'));
|
||||
}
|
||||
reject(err);
|
||||
});
|
||||
|
||||
})
|
||||
.then(()=>{
|
||||
// applies only for properties tab
|
||||
setIsStale?.(false);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
/* on save button callback, promise required */
|
||||
const onSaveClick = (isNew, data)=>new Promise((resolve, reject)=>{
|
||||
return api({
|
||||
url: url(isNew),
|
||||
method: isNew ? 'POST' : 'PUT',
|
||||
data: data,
|
||||
}).then((res)=>{
|
||||
/* Don't warn the user before closing dialog */
|
||||
warnOnCloseFlag = false;
|
||||
resolve(res.data);
|
||||
onSave?.(res.data);
|
||||
}).catch((err)=>{
|
||||
pgAdmin.Browser.notifier.pgNotifier('error-noalert', err, '', function(msg) {
|
||||
if (msg == 'CRYPTKEY_SET') {
|
||||
return Promise.resolve(onSaveClick(isNew, data));
|
||||
} else if (msg == 'CRYPTKEY_NOT_SET') {
|
||||
reject(gettext('The master password is not set.'));
|
||||
}
|
||||
reject(err);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
/* Called when switched to SQL tab, promise required */
|
||||
const getSQLValue = (isNew, changedData)=>{
|
||||
const msqlUrl = generateNodeUrl.call(node, treeNodeInfo, 'msql', nodeData, !isNew, node.url_jump_after_node);
|
||||
return new Promise((resolve, reject)=>{
|
||||
api({
|
||||
url: msqlUrl,
|
||||
method: 'GET',
|
||||
params: changedData,
|
||||
}).then((res)=>{
|
||||
resolve(res.data.data);
|
||||
}).catch((err)=>{
|
||||
onError(err);
|
||||
reject(err);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
/* Callback for help button */
|
||||
const onHelp = (isSqlHelp=false, isNew=false)=>{
|
||||
if(isSqlHelp) {
|
||||
let server = treeNodeInfo.server;
|
||||
let helpUrl = pgAdmin.Browser.utils.pg_help_path;
|
||||
let fullUrl = '';
|
||||
|
||||
if (server.server_type == 'ppas' && node.epasHelp) {
|
||||
fullUrl = getEPASHelpUrl(server.version);
|
||||
} else {
|
||||
if (node.sqlCreateHelp == '' && node.sqlAlterHelp != '') {
|
||||
fullUrl = getHelpUrl(helpUrl, node.sqlAlterHelp, server.version);
|
||||
} else if (node.sqlCreateHelp != '' && node.sqlAlterHelp == '') {
|
||||
fullUrl = getHelpUrl(helpUrl, node.sqlCreateHelp, server.version);
|
||||
} else {
|
||||
if (isNew) {
|
||||
fullUrl = getHelpUrl(helpUrl, node.sqlCreateHelp, server.version);
|
||||
} else {
|
||||
fullUrl = getHelpUrl(helpUrl, node.sqlAlterHelp, server.version);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
window.open(fullUrl, 'postgres_help');
|
||||
} else {
|
||||
window.open(node.dialogHelp, 'pgadmin_help');
|
||||
}
|
||||
};
|
||||
|
||||
/* A warning before closing the dialog with unsaved changes, based on preference */
|
||||
const warnBeforeChangesLost = (id)=>{
|
||||
if(panelId != id) {
|
||||
warnBeforeChangesLost();
|
||||
}
|
||||
if (warnOnCloseFlag && confirmOnCloseReset) {
|
||||
if(isDirty.current) {
|
||||
pgAdmin.Browser.notifier.confirm(
|
||||
gettext('Warning'),
|
||||
gettext('Changes will be lost. Are you sure you want to close the dialog?'),
|
||||
function() {
|
||||
onClose(true);
|
||||
},
|
||||
null
|
||||
);
|
||||
} else {
|
||||
onClose(true);
|
||||
}
|
||||
} else {
|
||||
onClose(true);
|
||||
}
|
||||
};
|
||||
|
||||
useEffect(()=>{
|
||||
if(formType == 'dialog') {
|
||||
/* Bind the close event and check if user should be warned */
|
||||
layoutDocker.eventBus.registerListener(LAYOUT_EVENTS.CLOSING, warnBeforeChangesLost);
|
||||
}
|
||||
return ()=>{
|
||||
layoutDocker.eventBus.deregisterListener(LAYOUT_EVENTS.CLOSING, warnBeforeChangesLost);
|
||||
};
|
||||
}, []);
|
||||
|
||||
/* All other useful details can go with this object */
|
||||
const viewHelperProps = {
|
||||
mode: actionType,
|
||||
serverInfo: serverInfo ? {
|
||||
type: serverInfo.server_type,
|
||||
version: serverInfo.version,
|
||||
}: undefined,
|
||||
inCatalog: inCatalog,
|
||||
};
|
||||
|
||||
let schema = node.getSchema.call(node, treeNodeInfo, nodeData);
|
||||
// Show/Hide security group for nodes under the catalog
|
||||
if('catalog' in treeNodeInfo
|
||||
&& formType !== 'tab') {
|
||||
schema.filterGroups = [gettext('Security')];
|
||||
}
|
||||
|
||||
const key = useMemo(()=>{
|
||||
if(!isActive && isStale || actionType != 'properties') {
|
||||
return nodeData?._id;
|
||||
} else if(isActive && isStale) {
|
||||
return nodeData?._id + '0';
|
||||
}
|
||||
return nodeData?._id + '1';
|
||||
}, [isActive, isStale, nodeData?._id]);
|
||||
|
||||
/* Fire at will, mount the DOM */
|
||||
return (
|
||||
<SchemaView
|
||||
key={key}
|
||||
formType={formType}
|
||||
getInitData={initData}
|
||||
updatedData={updatedData}
|
||||
schema={schema}
|
||||
viewHelperProps={viewHelperProps}
|
||||
onSave={onSaveClick}
|
||||
onClose={()=>onClose()}
|
||||
onHelp={onHelp}
|
||||
onEdit={onEdit}
|
||||
onDataChange={(dataChanged)=>{
|
||||
isDirty.current = dataChanged;
|
||||
}}
|
||||
confirmOnCloseReset={confirmOnCloseReset}
|
||||
hasSQL={node.hasSQL && (actionType === 'create' || actionType === 'edit')}
|
||||
getSQLValue={getSQLValue}
|
||||
disableSqlHelp={node.sqlAlterHelp == '' && node.sqlCreateHelp == '' && !node.epasHelp}
|
||||
disableDialogHelp={node.dialogHelp == undefined || node.dialogHelp == ''}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
ObjectNodeProperties.propTypes = {
|
||||
panelId: PropTypes.string,
|
||||
node: PropTypes.func,
|
||||
treeNodeInfo: PropTypes.object,
|
||||
nodeData: PropTypes.object,
|
||||
actionType: PropTypes.string,
|
||||
formType: PropTypes.string,
|
||||
onEdit: PropTypes.func,
|
||||
onSave: PropTypes.func,
|
||||
onClose: PropTypes.func,
|
||||
isActive: PropTypes.bool,
|
||||
isStale: PropTypes.bool,
|
||||
setIsStale: PropTypes.func,
|
||||
};
|
||||
Reference in New Issue
Block a user