pgadmin4/web/regression/javascript/schema_ui_files/foreign_key.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

203 lines
5.7 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 BaseUISchema from '../../../pgadmin/static/js/SchemaView/base_schema.ui';
import _ from 'lodash';
import * as nodeAjax from '../../../pgadmin/browser/static/js/node_ajax';
import { getNodeForeignKeySchema } from '../../../pgadmin/browser/server_groups/servers/databases/schemas/tables/constraints/foreign_key/static/js/foreign_key.ui';
import TableSchema from '../../../pgadmin/browser/server_groups/servers/databases/schemas/tables/static/js/table.ui';
import {addNewDatagridRow, genericBeforeEach, getCreateView, getEditView, getPropertiesView} from '../genericFunctions';
class SchemaInColl extends BaseUISchema {
constructor(schemaObj) {
super();
this.schemaObj = schemaObj;
}
get baseFields() {
return [{
id: 'collection', label: '', type: 'collection',
schema: this.schemaObj,
editable: false,
canAdd: true, canEdit: false, canDelete: true, hasRole: true,
columns : ['name', 'columns','references_table_name'],
}];
}
}
function getFieldDepChange(schema, id) {
return _.find(schema.fields, (f)=>f.id==id)?.depChange;
}
describe('ForeignKeySchema', ()=>{
let schemaObj;
let getInitData = ()=>Promise.resolve({});
beforeAll(()=>{
jest.spyOn(nodeAjax, 'getNodeAjaxOptions').mockReturnValue(Promise.resolve([]));
jest.spyOn(nodeAjax, 'getNodeListByName').mockReturnValue(Promise.resolve([]));
schemaObj = getNodeForeignKeySchema({}, {}, {Nodes: {table: {}}});
});
beforeEach(()=>{
genericBeforeEach();
});
it('create', async ()=>{
await getCreateView(schemaObj);
});
it('edit', async ()=>{
await getEditView(schemaObj, getInitData);
});
it('properties', async ()=>{
await getPropertiesView(schemaObj, getInitData);
});
it('create collection', async ()=>{
let schemaCollObj = new SchemaInColl(schemaObj);
const {ctrl, user} = await getCreateView(schemaCollObj);
/* Make sure you hit every corner */
await addNewDatagridRow(user, ctrl);
});
it('changeColumnOptions', ()=>{
jest.spyOn(schemaObj.fkHeaderSchema, 'changeColumnOptions');
let columns = [{label: 'label', value: 'value'}];
schemaObj.changeColumnOptions(columns);
expect(schemaObj.fkHeaderSchema.changeColumnOptions).toHaveBeenCalledWith(columns);
});
describe('ForeignKeyHeaderSchema', ()=>{
it('getNewData', ()=>{
schemaObj.fkHeaderSchema.refTables = [
{label: 'tab1', value: 140391},
{label: 'tab2', value: 180191},
];
expect(schemaObj.fkHeaderSchema.getNewData({
local_column: 'lid',
referenced: 'rid',
references: 140391,
})).toEqual({
local_column: 'lid',
referenced: 'rid',
references: 140391,
references_table_name: 'tab1',
});
});
});
it('depChange', ()=>{
let state = {columns: [{local_column: 'id'}]};
let actionObj = {
path: ['name'],
oldState: {
name: 'fkname',
}
};
state.autoindex = true;
state.name = 'fkname';
expect(getFieldDepChange(schemaObj, 'autoindex')(state, null, null, actionObj)).toEqual({
coveringindex: 'fki_fkname'
});
state.name = 'fknamenew';
state.coveringindex = 'fki_fkname';
actionObj.oldState.name = 'fkname';
expect(getFieldDepChange(schemaObj, 'autoindex')(state, null, null, actionObj)).toEqual({
coveringindex: 'fki_fknamenew'
});
state.autoindex = false;
expect(getFieldDepChange(schemaObj, 'autoindex')(state, null, null, actionObj)).toEqual({
coveringindex: ''
});
state.hasindex = true;
expect(getFieldDepChange(schemaObj, 'autoindex')(state, null, null, actionObj)).toEqual({});
state.oid = 140391;
expect(getFieldDepChange(schemaObj, 'autoindex')(state, null, null, actionObj)).toEqual({});
state.oid = null;
schemaObj.top = new TableSchema({}, null);
expect(getFieldDepChange(schemaObj, 'autoindex')(state, null, null, actionObj)).toEqual({
autoindex: false,
coveringindex: '',
});
state.name = '';
expect(getFieldDepChange(schemaObj, 'comment')(state)).toEqual({
comment: '',
});
expect(getFieldDepChange(schemaObj, 'columns')(state, ['columns', 0], null, {
type: SCHEMA_STATE_ACTIONS.DELETE_ROW,
oldState: {
columns: [
{name: 'id'}
],
},
path: ['columns'],
value: 0,
})).toEqual({
columns: [],
});
expect(getFieldDepChange(schemaObj, 'columns')(state, ['columns', 0], {
columns: [
{name: 'id123'}
],
}, {
type: SCHEMA_STATE_ACTIONS.SET_VALUE,
oldState: {
columns: [
{name: 'id'}
],
},
path: ['columns', 0, 'name'],
value: 'id123',
})).toEqual({
columns: [{local_column: 'id123'}],
});
});
it('columns formatter', ()=>{
let formatter = _.find(schemaObj.fields, (f)=>f.id=='columns').cell().controlProps.formatter;
expect(formatter.fromRaw([{
local_column: 'lid',
referenced: 'rid',
}])).toBe('(lid) -> (rid)');
expect(formatter.fromRaw([])).toBe('');
});
it('validate', ()=>{
let state = {};
let setError = jest.fn();
state.columns = ['id'];
state.autoindex = true;
schemaObj.validate(state, setError);
expect(setError).toHaveBeenCalledWith('coveringindex', 'Please specify covering index name.');
state.coveringindex = 'asdas';
expect(schemaObj.validate(state, setError)).toBe(false);
});
});