gristlabs_grist-core/test/nbrowser/GridViewNewColumnMenu.ts
George Gevoian fed697e676 (core) Tweak Add Column menu
Summary:
Tweaking behavior of the unreleased Add Column menu per feedback from
Anais and Dmitry.

Test Plan: WIP

Reviewers: jarek

Reviewed By: jarek

Differential Revision: https://phab.getgrist.com/D4089
2023-10-24 15:35:42 -04:00

373 lines
15 KiB
TypeScript

import {driver, Key, WebElement} from "mocha-webdriver";
import {DocCreationInfo} from "app/common/DocListAPI";
import {UserAPIImpl} from "app/common/UserAPI";
import {assert} from "chai";
import * as gu from "./gristUtils";
import {setupTestSuite} from "./testUtils";
describe('GridViewNewColumnMenu', function () {
if(process.env.GRIST_NEW_COLUMN_MENU) {
this.timeout('5m');
const cleanup = setupTestSuite();
//helpers
let session: gu.Session, doc: DocCreationInfo, apiImpl: UserAPIImpl;
before(async function () {
session = await gu.session().login();
await createEmptyDoc('ColumnMenu');
});
this.afterEach(async function () {
await closeAddColumnMenu();
});
describe('menu composition', function () {
it('simple columns, should have add column and shortcuts', async function () {
const menu = await openAddColumnIcon();
await hasAddNewColumMenu(menu);
await hasShortcuts(menu);
});
it('have lookup columns, should have add column, shortcuts and lookup section ', async function () {
const createReferenceTable = async () => {
await apiImpl.applyUserActions(doc.id, [
['AddTable', 'Reference', [
{id: "Name"},
{id: "Age"},
{id: "City"}]],
]);
await apiImpl.applyUserActions(doc.id, [
['AddRecord', 'Reference', null, {Name: "Bob", Age: 12, City: "New York"}],
['AddRecord', 'Reference', null, {Name: "Robert", Age: 34, City: "Łódź"}],
]);
};
const addReferenceColumnToManinTable = async () => {
//add reference column
await apiImpl.applyUserActions(doc.id, [
['AddColumn', 'Table1', 'Reference', {type: 'Ref:Reference'}],
]);
};
await createReferenceTable();
await addReferenceColumnToManinTable();
await gu.reloadDoc();
//open menu
const menu = await openAddColumnIcon();
// check if all three sections are present
await hasAddNewColumMenu(menu);
await hasShortcuts(menu);
await hasLookupMenu(menu, 'Reference');
//TODO - remove reference column somehow.
await apiImpl.applyUserActions(doc.id, [["RemoveColumn", "Table1", "Reference"]]);
await gu.reloadDoc();
});
});
describe('column creation', function () {
it('should show rename menu after new column click', async function () {
const menu = await openAddColumnIcon();
await menu.findWait('.test-new-columns-menu-add-new', 100).click();
await driver.findWait('.test-column-title-popup', 100, 'rename menu is not present');
await gu.undo();
});
it('should create new column', async function () {
const menu = await openAddColumnIcon();
await menu.findWait('.test-new-columns-menu-add-new', 100).click();
//discard rename menu
await driver.findWait('.test-column-title-close', 100).click();
//check if new column is present
const columns = await gu.getColumnNames();
assert.include(columns, 'D', 'new column is not present');
assert.lengthOf(columns, 4, 'wrong number of columns');
await gu.undo();
});
it('should support inserting before selected column', async function () {
await gu.openColumnMenu('A', 'Insert column to the left');
await driver.findWait(".test-new-columns-menu", 100);
await gu.sendKeys(Key.ENTER);
await gu.waitForServer();
await driver.findWait('.test-column-title-close', 100).click();
const columns = await gu.getColumnNames();
assert.deepEqual(columns, ['D', 'A', 'B', 'C']);
await gu.undo();
});
it('should support inserting after selected column', async function () {
await gu.openColumnMenu('A', 'Insert column to the right');
await driver.findWait(".test-new-columns-menu", 100);
await gu.sendKeys(Key.ENTER);
await gu.waitForServer();
await driver.findWait('.test-column-title-close', 100).click();
const columns = await gu.getColumnNames();
assert.deepEqual(columns, ['A', 'D', 'B', 'C']);
await gu.undo();
});
it('should support inserting after the last visible column', async function () {
await gu.openColumnMenu('C', 'Insert column to the right');
await driver.findWait(".test-new-columns-menu", 100);
await gu.sendKeys(Key.ENTER);
await gu.waitForServer();
await driver.findWait('.test-column-title-close', 100).click();
const columns = await gu.getColumnNames();
assert.deepEqual(columns, ['A', 'B', 'C', 'D']);
await gu.undo();
});
it('should skip showing menu when inserting with keyboard shortcuts', async function () {
await gu.sendKeys(Key.chord(Key.ALT, '='));
await gu.waitForServer();
assert.isFalse(await driver.find('.test-new-columns-menu').isPresent());
await gu.sendKeys(Key.ENTER);
let columns = await gu.getColumnNames();
assert.deepEqual(columns, ['A', 'B', 'C', 'D']);
await gu.sendKeys(Key.chord(Key.SHIFT, Key.ALT, '='));
await gu.waitForServer();
assert.isFalse(await driver.find('.test-new-columns-menu').isPresent());
await gu.sendKeys(Key.ENTER);
columns = await gu.getColumnNames();
assert.deepEqual(columns, ['A', 'B', 'C', 'E', 'D']);
await gu.undo(2);
});
});
describe('hidden columns', function () {
it('no hidden column in document, section should not be present', async function () {
const menu = await openAddColumnIcon();
const isHiddenSectionPresent = await menu.find(".new-columns-menu-hidden-columns").isPresent();
assert.isFalse(isHiddenSectionPresent, 'hidden section is present');
await closeAddColumnMenu();
});
describe('inline menu section', function () {
before(async function () {
await gu.addColumn('Add1');
await gu.addColumn('Add2');
await gu.addColumn('Add3');
});
it('1 to 5 hidden columns, section should be inline', async function () {
const checkSection = async (...columns: string[]) => {
const menu = await openAddColumnIcon();
await menu.findWait(".test-new-columns-menu-hidden-columns", 100,
'hidden section is not present');
for (const column of columns) {
const isColumnPresent = await menu.findContent('li', column).isPresent();
assert.isTrue(isColumnPresent, `column ${column} is not present`);
}
await closeAddColumnMenu();
};
await gu.openWidgetPanel();
await gu.moveToHidden('A');
await checkSection('A');
await gu.moveToHidden('B');
await gu.moveToHidden('C');
await gu.moveToHidden('Add1');
await gu.moveToHidden('Add2');
await checkSection('A', 'B', 'C', 'Add1', 'Add2');
await gu.undo(11);
});
it('inline button should show column at the end of the table', async function () {
});
});
describe('submenu section', function () {
it('more than 5 hidden columns, section should be in submenu', async function () {
});
it('submenu should be searchable', async function () {
});
it('submenu button should show column at the end of the table', async function () {
});
});
});
describe('lookups', function () {
before(async function () {
//save current state
});
after(async function () {
//restore current state
});
it('should show columns in menu with lookup', async function () {
});
it('should create formula column with data from selected column', async function () {
});
});
describe('shortcuts', function () {
describe('Timestamp', function () {
it('created at - should create new column with date triggered on create', function () {
});
it('modified at - should create new column with date triggered on change', function () {
});
});
describe('Authorship', function () {
it('created by - should create new column with author name triggered on create', function () {
});
it('modified by - should create new column with author name triggered on change', function () {
});
});
describe('Detect Duplicates in...', function () {
it('should show columns in a searchable sub-menu', async function () {
const menu = await openAddColumnIcon();
await menu.findWait('.test-new-columns-menu-shortcuts-duplicates', 100).mouseMove();
await gu.waitToPass(async () => {
assert.deepEqual(
await driver.findAll('.test-searchable-menu li', (el) => el.getText()),
['A', 'B', 'C']
);
}, 500);
await driver.find('.test-searchable-menu-input').click();
await gu.sendKeys('A');
await gu.waitToPass(async () => {
assert.deepEqual(
await driver.findAll('.test-searchable-menu li', (el) => el.getText()),
['A']
);
}, 250);
await gu.sendKeys('BC');
await gu.waitToPass(async () => {
assert.deepEqual(
await driver.findAll('.test-searchable-menu li', (el) => el.getText()),
[]
);
}, 250);
await gu.clearInput();
await gu.waitToPass(async () => {
assert.deepEqual(
await driver.findAll('.test-searchable-menu li', (el) => el.getText()),
['A', 'B', 'C']
);
}, 250);
});
it('should create new column that checks for duplicates in the specified column', async function () {
let menu = await openAddColumnIcon();
await menu.findWait('.test-new-columns-menu-shortcuts-duplicates', 100).mouseMove();
await driver.findContentWait('.test-searchable-menu li', 'A', 500).click();
await gu.waitForServer();
await gu.sendKeys(Key.ENTER);
// Just checking the formula looks plausible - correctness is best left to a python test.
assert.equal(
await driver.find('.test-formula-editor').getText(),
'$A != "" and $A is not None and len(Table1.lookupRecords(A=$A)) > 1'
);
await gu.sendKeys(Key.ESCAPE);
let columns = await gu.getColumnNames();
assert.deepEqual(columns, ['A', 'B', 'C', 'Duplicate in A']);
await gu.undo();
// Try it with list-based columns; the formula should look a little different.
for (const [label, type] of [['Choice', 'Choice List'], ['Ref', 'Reference List']]) {
await gu.addColumn(label, type);
menu = await openAddColumnIcon();
await menu.findWait('.test-new-columns-menu-shortcuts-duplicates', 100).mouseMove();
await driver.findContentWait('.test-searchable-menu li', label, 500).click();
await gu.waitForServer();
await gu.sendKeys(Key.ENTER);
assert.equal(
await driver.find('.test-formula-editor').getText(),
`any([len(Table1.lookupRecords(${label}=CONTAINS(x))) > 1 for x in $${label}])`
);
await gu.sendKeys(Key.ESCAPE);
columns = await gu.getColumnNames();
assert.deepEqual(columns, ['A', 'B', 'C', label, `Duplicate in ${label}`]);
await gu.undo(4);
}
});
});
describe('UUID', function () {
it('should create new column that generates a UUID on new record', async function () {
await gu.getCell(2, 1).click();
await gu.sendKeys('A', Key.ENTER);
await gu.waitForServer();
const menu = await openAddColumnIcon();
await menu.findWait('.test-new-columns-menu-shortcuts-uuid', 100).click();
await gu.waitForServer();
const cells1 = await gu.getVisibleGridCells({col: 'UUID', rowNums: [1, 2]});
assert.match(cells1[0], /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/);
assert.equal(cells1[1], '');
await gu.getCell(2, 2).click();
await gu.sendKeys('B', Key.ENTER);
await gu.waitForServer();
const cells2 = await gu.getVisibleGridCells({col: 'UUID', rowNums: [1, 2, 3]});
assert.match(cells2[0], /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/);
assert.match(cells2[1], /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/);
assert.equal(cells2[2], '');
assert.equal(cells1[0], cells2[0]);
await gu.undo(3);
});
});
});
async function createEmptyDoc(docName: string) {
session = await gu.session().login();
const docId = await session.tempNewDoc(cleanup, docName);
doc = {id: docId, title: docName};
apiImpl = session.createHomeApi();
}
async function openAddColumnIcon() {
const isMenuPresent = await driver.find(".test-new-columns-menu").isPresent();
if (!isMenuPresent) {
await driver.findWait(".mod-add-column", 100).click();
}
return driver.findWait(".test-new-columns-menu", 100);
}
async function closeAddColumnMenu() {
const isMenuPresent = await driver.find(".test-new-columns-menu").isPresent();
if (isMenuPresent) {
await driver.sendKeys(Key.ESCAPE);
assert.isFalse(await driver.wait(driver.find(".test-new-columns-menu").isPresent(), 100),
'menu is still present after close by escape');
}
}
const hasAddNewColumMenu = async (menu: WebElement) => {
await checkInMenu(menu, '.test-new-columns-menu-add-new', 'add new column menu is not present');
};
const checkInMenu = async (menu: WebElement, selector: string, message: string) => {
const element = await menu.findWait(selector, 100, message);
assert.exists(element, message);
return element;
};
const hasShortcuts = async (menu: WebElement) => {
await checkInMenu(menu, '.test-new-columns-menu-shortcuts', 'shortcuts section is not present');
await checkInMenu(menu, '.test-new-columns-menu-shortcuts-timestamp',
'timestamp shortcuts section is not present');
await checkInMenu(menu, '.test-new-columns-menu-shortcuts-author', 'authorship shortcuts section is not present');
};
const hasLookupMenu = async (menu: WebElement, tableName: string) => {
await checkInMenu(menu, '.test-new-columns-menu-lookups', 'lookup section is not present');
await checkInMenu(menu, `.test-new-columns-menu-lookups-${tableName}`,
`lookup section for ${tableName} is not present`);
};
}
});