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

229 lines
7.3 KiB
JavaScript

/////////////////////////////////////////////////////////////
//
// pgAdmin 4 - PostgreSQL Tools
//
// Copyright (C) 2013 - 2024, The pgAdmin Development Team
// This software is released under the PostgreSQL Licence
//
//////////////////////////////////////////////////////////////
import * as nodeAjax from '../../../pgadmin/browser/static/js/node_ajax';
import BaseUISchema from '../../../pgadmin/static/js/SchemaView/base_schema.ui';
import IndexSchema from '../../../pgadmin/browser/server_groups/servers/databases/schemas/tables/indexes/static/js/index.ui';
import {addNewDatagridRow, genericBeforeEach, getCreateView, getEditView, getPropertiesView} from '../genericFunctions';
class SchemaInColl extends BaseUISchema {
constructor(indexSchemaObj) {
super();
this.indexSchemaObj = indexSchemaObj;
}
get baseFields() {
return [{
id: 'collection', label: '', type: 'collection',
schema: this.indexSchemaObj,
editable: false,
canAdd: true, canEdit: false, canDelete: true, hasRole: true,
columns : ['name', 'consrc'],
}];
}
}
function getFieldDepChange(schema, id) {
return _.find(schema.fields, (f) => f.id==id)?.depChange;
}
describe('IndexSchema', () => {
let indexSchemaObj;
let getInitData = () => Promise.resolve({});
beforeAll(() => {
jest.spyOn(nodeAjax, 'getNodeAjaxOptions').mockReturnValue(Promise.resolve([]));
jest.spyOn(nodeAjax, 'getNodeListByName').mockReturnValue(Promise.resolve([]));
indexSchemaObj = new IndexSchema(
{
tablespaceList: () => [],
amnameList : () => [{label:'abc', value:'abc'}],
columnList: () => [{label:'abc', value:'abc'}],
collationList: () => [{label:'abc', value:'abc'}],
opClassList: () => [{label:'abc', value:'abc'}]
},
{
node_info: {'server': { 'version': 110000} }
},
{
amname: 'btree'
}
);
});
beforeEach(() => {
genericBeforeEach();
});
it('create', async () => {
await getCreateView(indexSchemaObj);
});
it('edit', async () => {
await getEditView(indexSchemaObj, getInitData);
});
it('properties', async () => {
await getPropertiesView(indexSchemaObj, getInitData);
});
it('create collection', async () => {
let schemaCollObj = new SchemaInColl(indexSchemaObj);
let {ctrl, user} = await getCreateView(schemaCollObj);
/* Make sure you hit every corner */
/* Make sure you hit every corner */
await addNewDatagridRow(user, ctrl);
});
it('changeColumnOptions', () => {
jest.spyOn(indexSchemaObj.indexHeaderSchema, 'changeColumnOptions');
let columns = [{label: 'label', value: 'value'}];
indexSchemaObj.changeColumnOptions(columns);
expect(indexSchemaObj.indexHeaderSchema.changeColumnOptions).toHaveBeenCalledWith(columns);
});
describe('IndexColHeaderSchema', () => {
it('getNewData', () => {
indexSchemaObj.indexHeaderSchema.columnOptions = [
{label: 'id', value: 'id'},
{label: 'name', value: 'name'}
];
jest.spyOn(indexSchemaObj.indexColumnSchema, 'getNewData');
indexSchemaObj.indexHeaderSchema.getNewData({
is_exp: false,
colname: 'id',
expression: null,
});
expect(indexSchemaObj.indexColumnSchema.getNewData).toHaveBeenCalledWith({
is_exp: false,
colname: 'id',
});
indexSchemaObj.indexHeaderSchema.getNewData({
is_exp: true,
colname: null,
expression: 'abc',
});
expect(indexSchemaObj.indexColumnSchema.getNewData).toHaveBeenCalledWith({
is_exp: true,
colname: 'abc',
});
});
});
describe('IndexColumnSchema', () => {
it('column schema colname editable', () => {
indexSchemaObj.indexColumnSchema.top = {
sessData: { amname: 'btree' }
};
let cell = _.find(indexSchemaObj.indexColumnSchema.fields, (f) => f.id=='op_class').cell;
cell();
});
it('column schema sort_order depChange', () => {
let topState = { amname: 'btree' };
let depChange = _.find(indexSchemaObj.indexColumnSchema.fields, (f) => f.id=='sort_order').depChange;
let state = { sort_order: true };
depChange(state, {}, topState, { oldState: { sort_order: false } });
state.sort_order = false;
topState.amname = 'abc';
depChange(state, {}, topState, { oldState: { sort_order: false } });
expect(state.is_sort_nulls_applicable).toBe(false);
});
it('column schema sort_order editable', () => {
indexSchemaObj.indexColumnSchema.top = {
sessData: { amname: 'btree' }
};
let state = {};
jest.spyOn(indexSchemaObj.indexColumnSchema, 'inSchemaWithModelCheck').mockReturnValue(true);
let editable = _.find(indexSchemaObj.indexColumnSchema.fields, (f) => f.id=='sort_order').editable;
let status = editable(state);
expect(status).toBe(false);
jest.spyOn(indexSchemaObj.indexColumnSchema, 'inSchemaWithModelCheck').mockReturnValue(false);
status = editable(state);
expect(status).toBe(true);
indexSchemaObj.indexColumnSchema.top.sessData.amname = 'abc';
status = editable(state);
expect(status).toBe(false);
});
it('column schema nulls editable', () => {
indexSchemaObj.indexColumnSchema.top = {
sessData: { amname: 'btree' }
};
let state = {};
jest.spyOn(indexSchemaObj.indexColumnSchema, 'inSchemaWithModelCheck').mockReturnValue(true);
let editable = _.find(indexSchemaObj.indexColumnSchema.fields, (f) => f.id=='nulls').editable;
let status = editable(state);
expect(status).toBe(false);
jest.spyOn(indexSchemaObj.indexColumnSchema, 'inSchemaWithModelCheck').mockReturnValue(false);
status = editable(state);
expect(status).toBe(true);
indexSchemaObj.indexColumnSchema.top.sessData.amname = 'abc';
status = editable(state);
expect(status).toBe(false);
});
it('column schema setOpClassTypes', () => {
indexSchemaObj.indexColumnSchema.top = {
sessData: { amname: 'btree' }
};
let options = [];
indexSchemaObj.indexColumnSchema.op_class_types = [];
let status = indexSchemaObj.indexColumnSchema.setOpClassTypes(options);
expect(status).toEqual([]);
indexSchemaObj.indexColumnSchema.op_class_types = [];
options.push({label: '', value: ''});
indexSchemaObj.indexColumnSchema.setOpClassTypes(options);
expect(indexSchemaObj.indexColumnSchema.op_class_types.length).toBe(1);
});
});
it('depChange', () => {
let state = {};
expect(getFieldDepChange(indexSchemaObj, 'description')(state)).toEqual({
comment: '',
});
});
it('columns formatter', () => {
let formatter = _.find(indexSchemaObj.fields, (f) => f.id=='columns').cell().controlProps.formatter;
expect(formatter.fromRaw([{
colname: 'lid',
},{
colname: 'rid',
}])).toBe('lid, rid');
expect(formatter.fromRaw([])).toBe('');
});
it('validate', () => {
let state = { columns: [] };
let setError = jest.fn();
indexSchemaObj.validate(state, setError);
expect(setError).toHaveBeenCalledWith('columns', 'You must specify at least one column/expression.');
state.columns.push({});
let status = indexSchemaObj.validate(state, setError);
expect(status).toBe(null);
});
});