pgadmin4/web/regression/javascript/schema_ui_files/table.ui.spec.js
Ashesh Vashi e9af0c3226
Improved the extendability of the SchemaView and DataGridView. (#7876)
Restructured these modules for ease of maintenance and apply the single
responsibility principle (wherever applicable).

* SchemaView

 - Split the code based on the functionality and responsibility.
 - Introduced a new View 'InlineView' instead of using the
   'nextInline' configuration of the fields to have a better, and
   manageable view.
 - Using the separate class 'SchemaState' for managing the data and
   states of the SchemaView (separated from the 'useSchemaState'
   custom hook).
 - Introduced three new custom hooks 'useFieldValue',
   'useFieldOptions', 'useFieldError' for the individual control to
   use for each Schema Field.
 - Don't pass value as the parameter props, and let the
   'useFieldValue' and other custom hooks to decide, whether to
   rerender the control itself or the whole dialog/view. (single
   responsibility principle)
 - Introduced a new data store with a subscription facility.
 - Moving the field metadata (option) evaluation to a separate place
   for better management, and each option can be defined for a
   particular kind of field (for example - collection, row, cell,
   general, etc).
 - Allow to provide custom control for all kind of Schema field.

* DataGridView

 - Same as SchemaView, split the DataGridView call into smaller,
   manageable chunks. (For example - grid, row, mappedCell, etc).
 - Use context based approach for providing the row and table data
   instead of passing them as parameters to every component
   separately.
 - Have a facility to extend this feature separately in future.
   (for example - selectable cell, column grouping, etc.)
 - Separated the features like deletable, editable, reorder,
   expandable etc. cells using the above feature support.
 - Added ability to provide the CustomHeader, and CustomRow through the
   Schema field, which will extend the ability to customize better.
 - Removed the 'DataGridViewWithHeaderForm' as it has been achieved
   through providing 'CustomHeader', and also introduced
   'DataGridFormHeader' (a custom header) to achieve the same feature
   as 'DataGridViewWithHeaderForm'.
2024-09-09 14:27:31 +05:30

313 lines
9.4 KiB
JavaScript

/////////////////////////////////////////////////////////////
//
// pgAdmin 4 - PostgreSQL Tools
//
// Copyright (C) 2013 - 2024, The pgAdmin Development Team
// This software is released under the PostgreSQL Licence
//
//////////////////////////////////////////////////////////////
import { SCHEMA_STATE_ACTIONS } from '../../../pgadmin/static/js/SchemaView';
import _ from 'lodash';
import { getNodeTableSchema, LikeSchema } from '../../../pgadmin/browser/server_groups/servers/databases/schemas/tables/static/js/table.ui';
import * as nodeAjax from '../../../pgadmin/browser/static/js/node_ajax';
import {genericBeforeEach, getCreateView, getEditView, getPropertiesView} from '../genericFunctions';
import pgAdmin from '../fake_pgadmin';
function getFieldDepChange(schema, id) {
return _.find(schema.fields, (f)=>f.id==id)?.depChange;
}
describe('TableSchema', () => {
const createTableSchemaObject = () => getNodeTableSchema({
server: {
_id: 1,
},
schema: {
_label: 'public',
}
}, {}, {
Nodes: {table: {}},
serverInfo: {
1: {
user: {
name: 'Postgres',
}
}
}
});
let schemaObj = createTableSchemaObject();
let getInitData = ()=>Promise.resolve({});
beforeAll(() => {
jest.spyOn(nodeAjax, 'getNodeAjaxOptions').mockReturnValue(Promise.resolve([]));
jest.spyOn(nodeAjax, 'getNodeListByName').mockReturnValue(Promise.resolve([]));
});
beforeEach(() => {
genericBeforeEach();
});
it('create', async () => {
await getCreateView(createTableSchemaObject());
});
it('edit', async () => {
await getEditView(createTableSchemaObject(), getInitData);
});
it('properties', async () => {
await getPropertiesView(createTableSchemaObject(), getInitData);
});
it('getTableOid', () => {
schemaObj.inheritedTableList = [
{label: 'tab1', tid: 140391},
{label: 'tab2', tid: 180191}
];
expect(schemaObj.getTableOid('tab2')).toBe(180191);
});
it('canEditDeleteRowColumns', () => {
expect(schemaObj.canEditDeleteRowColumns({inheritedfrom: 1234})).toBe(false);
expect(schemaObj.canEditDeleteRowColumns({inheritedfrom: null})).toBe(true);
});
it('LikeSchema typname change', () => {
let likeSchemaObj = new LikeSchema([]);
/* Dummy */
likeSchemaObj.top = new LikeSchema([]);
let depResp = getFieldDepChange(likeSchemaObj, 'like_relation')({typname: 'type1'}, ['typname']);
expect(depResp).toEqual({
like_relation: null,
like_default_value: false,
like_constraints: false,
like_indexes: false,
like_storage: false,
like_comments: false,
like_compression: false,
like_generated: false,
like_identity: false,
like_statistics: false
});
});
describe('typname change', () => {
let confirmSpy;
let deferredDepChange;
let oftypeColumns = [
{name: 'id'}
];
beforeEach(() => {
jest.spyOn(schemaObj, 'changeColumnOptions');
jest.spyOn(schemaObj, 'getTableOid').mockReturnValue(140391);
confirmSpy = jest.spyOn(pgAdmin.Browser.notifier, 'confirm');
deferredDepChange = _.find(schemaObj.fields, (f)=>f.id=='typname')?.deferredDepChange;
schemaObj.ofTypeTables = [
{label: 'type1', oftype_columns: oftypeColumns}
];
});
let onDepChangeAction = (depChange, done)=> {
expect(depChange()).toEqual({
columns: oftypeColumns,
primary_key: [],
foreign_key: [],
exclude_constraint: [],
unique_constraint: [],
partition_keys: [],
partitions: [],
});
expect(schemaObj.changeColumnOptions).toHaveBeenCalledWith(oftypeColumns);
done();
};
it('initial selection with OK', (done)=>{
let state = {typname: 'type1'};
let deferredPromise = deferredDepChange(state, null, null, {
oldState: {
typname: null,
},
});
deferredPromise.then((depChange)=>{
onDepChangeAction(depChange, done);
});
/* Press OK */
confirmSpy.mock.calls[0][2]();
});
it('initial selection with Cancel', (done)=>{
confirmSpy.mockClear();
let state = {typname: 'type1'};
let deferredPromise = deferredDepChange(state, null, null, {
oldState: {
typname: null,
},
});
deferredPromise.then((depChange)=>{
expect(depChange()).toEqual({
typname: null,
});
done();
});
/* Press Cancel */
confirmSpy.mock.calls[0][3]();
});
it('later selection', (done)=>{
let state = {typname: 'type1'};
let deferredPromise = deferredDepChange(state, null, null, {
oldState: {
typname: 'typeold',
},
});
deferredPromise.then((depChange)=>{
onDepChangeAction(depChange, done);
});
});
it('empty', (done)=>{
let state = {typname: null};
let deferredPromise = deferredDepChange(state, null, null, {
oldState: {
typname: null,
},
});
deferredPromise.then((depChange)=>{
expect(depChange()).toBeUndefined();
done();
});
});
});
describe('coll_inherits change', () => {
let deferredDepChange;
let inheritCol = {name: 'id'};
let onRemoveAction = (depChange, state, done)=> {
let finalCols = [{name: 'desc'}];
expect(depChange(state)).toEqual({
adding_inherit_cols: false,
columns: finalCols,
});
expect(schemaObj.changeColumnOptions).toHaveBeenCalledWith(finalCols);
done();
};
beforeEach(() => {
jest.spyOn(schemaObj, 'changeColumnOptions');
jest.spyOn(schemaObj, 'getTableOid').mockReturnValue(140391);
jest.spyOn(schemaObj, 'getColumns').mockReturnValue(Promise.resolve([inheritCol]));
deferredDepChange = _.find(schemaObj.fields, (f)=>f.id=='coll_inherits')?.deferredDepChange;
});
it('add first selection', (done)=>{
let state = {columns: [], coll_inherits: ['table1']};
let newCol = schemaObj.columnsSchema.getNewData(inheritCol);
let deferredPromise = deferredDepChange(state, null, null, {
oldState: {
coll_inherits: [],
},
});
deferredPromise.then((depChange)=>{
let finalCols = [newCol];
expect(depChange(state)).toEqual({
adding_inherit_cols: false,
columns: finalCols,
});
expect(schemaObj.changeColumnOptions).toHaveBeenCalledWith(finalCols);
done();
});
});
it('add more', (done)=>{
let newCol = schemaObj.columnsSchema.getNewData(inheritCol);
let state = {columns: [newCol], coll_inherits: ['table1', 'table2']};
let deferredPromise = deferredDepChange(state, null, null, {
oldState: {
coll_inherits: ['table1'],
},
});
deferredPromise.then((depChange)=>{
let finalCols = [newCol];
expect(depChange(state)).toEqual({
adding_inherit_cols: false,
columns: [newCol],
});
expect(schemaObj.changeColumnOptions).toHaveBeenCalledWith(finalCols);
done();
});
});
it('remove one table', (done)=>{
inheritCol.inheritedid = 140391;
let newCol = schemaObj.columnsSchema.getNewData(inheritCol);
let state = {columns: [{name: 'desc'}, newCol], coll_inherits: ['table1']};
let deferredPromise = deferredDepChange(state, null, null, {
oldState: {
coll_inherits: ['table1', 'table2'],
},
});
deferredPromise.then((depChange)=>{
onRemoveAction(depChange, state, done);
});
});
it('remove all', (done)=>{
inheritCol.inheritedid = 140391;
let newCol = schemaObj.columnsSchema.getNewData(inheritCol);
let state = {columns: [{name: 'desc'}, newCol], coll_inherits: []};
let deferredPromise = deferredDepChange(state, null, null, {
oldState: {
coll_inherits: ['table1'],
},
});
deferredPromise.then((depChange)=>{
onRemoveAction(depChange, state, done);
});
});
});
it('depChange', () => {
jest.spyOn(schemaObj, 'getTableOid').mockReturnValue(140391);
let state = {};
state.is_partitioned = true;
state.coll_inherits = ['table1'];
expect(getFieldDepChange(schemaObj, 'coll_inherits')(state, ['is_partitioned'], null, {
type: SCHEMA_STATE_ACTIONS.SET_VALUE,
path: ['is_partitioned'],
})).toEqual({
coll_inherits: [],
});
jest.spyOn(schemaObj, 'getServerVersion').mockReturnValue(100000);
schemaObj.constraintsObj.top = schemaObj;
expect(getFieldDepChange(schemaObj.constraintsObj, 'primary_key')({is_partitioned: true})).toEqual({
primary_key: []
});
expect(getFieldDepChange(schemaObj.constraintsObj, 'foreign_key')({is_partitioned: true})).toEqual({
foreign_key: []
});
expect(getFieldDepChange(schemaObj.constraintsObj, 'unique_constraint')({is_partitioned: true})).toEqual({
unique_constraint: []
});
expect(getFieldDepChange(schemaObj.constraintsObj, 'exclude_constraint')({is_partitioned: true})).toEqual({
exclude_constraint: []
});
});
it('validate', () => {
let state = {is_partitioned: true};
let setError = jest.fn();
schemaObj.validate(state, setError);
expect(setError).toHaveBeenCalledWith('partition_keys', 'Please specify at least one key for partitioned table.');
state.partition_keys = [{key: 'id'}];
expect(schemaObj.validate(state, setError)).toBe(false);
});
});