Skip to content

Commit

Permalink
Notebook: Escaping code completion pop-up disables cell edit mode
Browse files Browse the repository at this point in the history
  • Loading branch information
dhuebner committed Oct 16, 2024
1 parent 8bff722 commit 0c9b790
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/playwright.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ jobs:
path: |
examples/playwright/test-results/
examples/playwright/playwright-report/
retention-days: 2
retention-days: 7
33 changes: 33 additions & 0 deletions examples/playwright/src/tests/theia-notebook-editor.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,39 @@ test.describe('Theia Notebook Cell interaction', () => {
expect(await cell.executionCount()).toBe('3');
});

test('Check arrow up and down works', async () => {
const cell = await firstCell(editor);
await editor.addCodeCell();
const secondCell = (await editor.cells())[1];
// second cell is selected after creation
expect(await secondCell.isSelected()).toBe(true);
// select cell above
await editor.page.keyboard.type('second cell');
await secondCell.editor.page.keyboard.press('ArrowUp');
expect(await cell.isSelected()).toBe(true);

// select cell below
await cell.app.page.keyboard.press('ArrowDown');
expect(await secondCell.isSelected()).toBe(true);
});

test('Check arrow-up/arrow-down/escape with code completion', async () => {
const cell = await firstCell(editor);
await editor.addCodeCell();
await cell.addEditorText('print("Test code completion")\n');

await editor.page.keyboard.press('Control+Space'); // call CC (suggestWidgetVisible=true)
await editor.page.keyboard.press('Escape'); // close CC
// check the same cell still selected and not lose the edit mode
expect(await cell.editor.isFocused()).toBe(true);

await editor.page.keyboard.press('Control+Space'); // call CC (suggestWidgetVisible=true)
await editor.page.keyboard.press('ArrowDown'); // select next entry in CC list
await editor.page.keyboard.press('Enter'); // apply completion
// check the same cell still selected and not the second one due to 'ArrowDown' being pressed
expect(await cell.isSelected()).toBe(true);

});
});

async function firstCell(editor: TheiaNotebookEditor): Promise<TheiaNotebookCell> {
Expand Down
13 changes: 13 additions & 0 deletions examples/playwright/src/theia-monaco-editor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,19 @@ export class TheiaMonacoEditor extends TheiaPageObject {
await this.page.keyboard.type(text);
}

/**
* @returns `true` if the editor is focused, `false` otherwise.
*/
async isFocused(): Promise<boolean> {
const viewElement = await this.viewElement();
const monacoEditor = await viewElement?.$('div.monaco-editor');
if (!monacoEditor) {
throw new Error('Couldn\'t retrieve monaco editor element.');
}
const editorClass = await monacoEditor.getAttribute('class');
return editorClass?.includes('focused') ?? false;
}

protected replaceEditorSymbolsWithSpace(content: string): string | Promise<string | undefined> {
// [ ] &nbsp; => \u00a0 -- NO-BREAK SPACE
// [·] &middot; => \u00b7 -- MIDDLE DOT
Expand Down
8 changes: 8 additions & 0 deletions examples/playwright/src/theia-notebook-cell.ts
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,14 @@ export class TheiaNotebookCell extends TheiaPageObject {
return text?.substring(1, text.length - 1);
}

/**
* @returns `true` if the cell is selected (blue vertical line), `false` otherwise.
*/
async isSelected(): Promise<boolean> {
const markerClass = await this.locator.locator('div.theia-notebook-cell-marker').getAttribute('class');
return markerClass?.includes('theia-notebook-cell-marker-selected') ?? false;
}

/**
* @returns The output text of the cell.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ export class NotebookCellActionContribution implements MenuContribution, Command
{
command: NotebookCellCommands.STOP_EDIT_COMMAND.id,
keybinding: 'esc',
when: `editorTextFocus && ${NOTEBOOK_EDITOR_FOCUSED}`,
when: `editorTextFocus && ${NOTEBOOK_EDITOR_FOCUSED} && !suggestWidgetVisible`,
},
{
command: NotebookCellCommands.EXECUTE_SINGLE_CELL_COMMAND.id,
Expand Down

0 comments on commit 0c9b790

Please sign in to comment.