enso/app/gui2/e2e/componentBrowser.spec.ts

import { test, type Page } from '@playwright/test'
import os from 'os'
import * as actions from './actions'
import { expect } from './customExpect'
import * as locate from './locate'

const CONTROL_KEY = os.platform() === 'darwin' ? 'Meta' : 'Control'
const ACCEPT_SUGGESTION_SHORTCUT = `${CONTROL_KEY}+Enter`

async function deselectAllNodes(page: Page) {
  await page.keyboard.press('Escape')
  await expect(page.locator('.GraphNode.selected')).toHaveCount(0)
}

async function expectAndCancelBrowser(page: Page, expectedInput: string) {
  const nodeCount = await locate.graphNode(page).count()
  await expect(locate.componentBrowser(page)).toExist()
  await expect(locate.componentBrowserEntry(page)).toExist()
  await expect(locate.componentBrowserInput(page).locator('input')).toHaveValue(expectedInput)
  await expect(locate.componentBrowserInput(page).locator('input')).toBeInViewport()
  await page.keyboard.press('Escape')
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  await expect(locate.graphNode(page)).toHaveCount(nodeCount)
}

test('Different ways of opening Component Browser', async ({ page }) => {
  await actions.goToGraph(page)

  // Without source node

  // (+) button
  await locate.addNewNodeButton(page).click()
  await expectAndCancelBrowser(page, '')
  // Enter key
  await locate.graphEditor(page).press('Enter')
  await expectAndCancelBrowser(page, '')

  // With source node

  // (+) button
  await locate.graphNodeByBinding(page, 'final').click()
  await locate.addNewNodeButton(page).click()
  await expectAndCancelBrowser(page, 'final.')
  // Enter key
  await locate.graphNodeByBinding(page, 'final').click()
  await locate.graphEditor(page).press('Enter')
  await expectAndCancelBrowser(page, 'final.')
  // Dragging out an edge
  const outputPort = await locate.outputPortCoordinates(locate.graphNodeByBinding(page, 'final'))
  await page.mouse.click(outputPort.x, outputPort.y)
  await page.mouse.click(100, 500)
  await expectAndCancelBrowser(page, 'final.')
  // Double-clicking port
  // TODO[ao] Without timeout, even the first click would be treated as double due to previous
  // event. Probably we need a better way to simulate double clicks.
  await page.waitForTimeout(600)
  await page.mouse.click(outputPort.x, outputPort.y)
  await page.mouse.click(outputPort.x, outputPort.y)
  await expectAndCancelBrowser(page, 'final.')
})

test('Opening Component Browser with small plus buttons', async ({ page }) => {
  await actions.goToGraph(page)

  // Small (+) button shown when node is hovered
  await page.keyboard.press('Escape')
  await page.mouse.move(100, 80)
  await expect(locate.smallPlusButton(page)).not.toBeVisible()
  await locate.graphNodeIcon(locate.graphNodeByBinding(page, 'aggregated')).hover()
  await expect(locate.smallPlusButton(page)).toBeVisible()
  await locate.smallPlusButton(page).click()
  await expectAndCancelBrowser(page, 'aggregated.')

  // Small (+) button shown when node is sole selection
  await page.keyboard.press('Escape')
  await expect(locate.smallPlusButton(page)).not.toBeVisible()
  await locate.graphNodeByBinding(page, 'aggregated').click()
  await expect(locate.smallPlusButton(page)).toBeVisible()
  await locate.smallPlusButton(page).click()
  await expectAndCancelBrowser(page, 'aggregated.')
})

test('Graph Editor pans to Component Browser', async ({ page }) => {
  await actions.goToGraph(page)

  // Select node, pan out of view of it, press Enter; should pan to show node and CB
  await locate.graphNodeByBinding(page, 'final').click()
  await page.mouse.move(100, 80)
  await page.mouse.down({ button: 'middle' })
  await page.mouse.move(100, 700)
  await page.mouse.up({ button: 'middle' })
  await expect(locate.graphNodeByBinding(page, 'final')).not.toBeInViewport()
  await locate.graphEditor(page).press('Enter')
  await expect(locate.graphNodeByBinding(page, 'final')).toBeInViewport()
  await expectAndCancelBrowser(page, 'final.')

  // Dragging out an edge to the bottom of the viewport; when the CB pans into view, some nodes are out of view.
  await page.mouse.move(100, 1100)
  await page.mouse.down({ button: 'middle' })
  await page.mouse.move(100, 80)
  await page.mouse.up({ button: 'middle' })
  await expect(locate.graphNodeByBinding(page, 'five')).toBeInViewport()
  const outputPort = await locate.outputPortCoordinates(locate.graphNodeByBinding(page, 'final'))
  await page.mouse.click(outputPort.x, outputPort.y)
  await page.mouse.click(100, 1550)
  await expect(locate.graphNodeByBinding(page, 'five')).not.toBeInViewport()
  await expectAndCancelBrowser(page, 'final.')
})

test('Accepting suggestion', async ({ page }) => {
  // Clicking enry
  await actions.goToGraph(page)
  await locate.addNewNodeButton(page).click()
  let nodeCount = await locate.graphNode(page).count()
  await locate.componentBrowserEntry(page).nth(1).click()
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  await expect(locate.graphNode(page)).toHaveCount(nodeCount + 1)
  await expect(locate.graphNode(page).last().locator('.WidgetToken')).toHaveText([
    'Data',
    '.',
    'read_text',
  ])
  await expect(locate.graphNode(page).last()).toBeSelected()

  // Clicking at highlighted entry
  nodeCount = await locate.graphNode(page).count()
  await deselectAllNodes(page)
  await locate.addNewNodeButton(page).click()
  await locate.componentBrowserSelectedEntry(page).first().click()
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  await expect(locate.graphNode(page)).toHaveCount(nodeCount + 1)
  await expect(locate.graphNode(page).last().locator('.WidgetToken')).toHaveText([
    'Data',
    '.',
    'read',
  ])
  await expect(locate.graphNode(page).last()).toBeSelected()

  // Accepting with Enter
  nodeCount = await locate.graphNode(page).count()
  await deselectAllNodes(page)
  await locate.addNewNodeButton(page).click()
  await page.keyboard.press('Enter')
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  await expect(locate.graphNode(page)).toHaveCount(nodeCount + 1)
  await expect(locate.graphNode(page).last().locator('.WidgetToken')).toHaveText([
    'Data',
    '.',
    'read',
  ])
  await expect(locate.graphNode(page).last()).toBeSelected()
})

test('Accepting any written input', async ({ page }) => {
  await actions.goToGraph(page)
  await locate.addNewNodeButton(page).click()
  const nodeCount = await locate.graphNode(page).count()
  await locate.componentBrowserInput(page).locator('input').fill('re')
  await page.keyboard.press(ACCEPT_SUGGESTION_SHORTCUT)
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  await expect(locate.graphNode(page)).toHaveCount(nodeCount + 1)
  await expect(locate.graphNode(page).last().locator('.WidgetToken')).toHaveText('re')
})

test('Filling input with suggestions', async ({ page }) => {
  await actions.goToGraph(page)
  await locate.addNewNodeButton(page).click()

  // Entering module
  await locate.componentBrowserEntryByLabel(page, 'Standard.Base.Data').click()
  await expect(locate.componentBrowser(page)).toExist()
  await expect(locate.componentBrowserInput(page).locator('input')).toHaveValue(
    'Standard.Base.Data.',
  )

  // Applying suggestion
  await page.keyboard.press('Tab')
  await expect(locate.componentBrowser(page)).toExist()
  await expect(locate.componentBrowserInput(page).locator('input')).toHaveValue(
    'Standard.Base.Data.read ',
  )
})

test('Filtering list', async ({ page }) => {
  await actions.goToGraph(page)
  await locate.addNewNodeButton(page).click()
  await locate.componentBrowserInput(page).locator('input').fill('re_te')
  const segments = locate.componentBrowserEntry(page).locator('.component-label-segment')
  await expect(segments).toHaveText(['Data.', 're', 'ad', '_te', 'xt'])
  const highlighted = locate.componentBrowserEntry(page).locator('.component-label-segment.match')
  await expect(highlighted).toHaveText(['re', '_te'])
})

test('Editing existing nodes', async ({ page }) => {
  await actions.goToGraph(page)
  const node = locate.graphNodeByBinding(page, 'data')
  const ADDED_PATH = '"/home/enso/Input.txt"'

  // Start node editing
  await locate.graphNodeIcon(node).click({ modifiers: [CONTROL_KEY] })
  await expect(locate.componentBrowser(page)).toBeVisible()
  const input = locate.componentBrowserInput(page).locator('input')
  await expect(input).toHaveValue('Data.read')

  // Add argument and accept
  await page.keyboard.press('End')
  await input.pressSequentially(` ${ADDED_PATH}`)
  await expect(input).toHaveValue(`Data.read ${ADDED_PATH}`)
  await page.keyboard.press('Enter')
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  await expect(node.locator('.WidgetToken')).toHaveText(['Data', '.', 'read', '"', '"'])
  await expect(node.locator('.WidgetText input')).toHaveValue(ADDED_PATH.replaceAll('"', ''))

  // Edit again, using "edit" button
  await locate.graphNodeIcon(node).click()
  await node.getByTestId('edit-button').click()
  await expect(locate.componentBrowser(page)).toBeVisible()
  await expect(input).toHaveValue(`Data.read ${ADDED_PATH}`)
  for (let i = 0; i < ADDED_PATH.length; ++i) await page.keyboard.press('Backspace')
  await expect(input).toHaveValue('Data.read ')
  await page.keyboard.press('Enter')
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  await expect(node.locator('.WidgetToken')).toHaveText(['Data', '.', 'read'])
  await expect(node.locator('.WidgetText')).not.toBeVisible()
})

test('Visualization preview: type-based visualization selection', async ({ page }) => {
  await actions.goToGraph(page)
  const nodeCount = await locate.graphNode(page).count()
  await locate.addNewNodeButton(page).click()
  await expect(locate.componentBrowser(page)).toExist()
  await expect(locate.componentBrowserEntry(page)).toExist()
  const input = locate.componentBrowserInput(page).locator('input')
  await input.fill('4')
  await expect(input).toHaveValue('4')
  await expect(locate.jsonVisualization(page)).toExist()
  await input.fill('Table.ne')
  await expect(input).toHaveValue('Table.ne')
  // The table visualization is not currently working with `executeExpression` (#9194), but we can test that the JSON
  // visualization is no longer selected.
  await expect(locate.jsonVisualization(page)).not.toBeVisible()
  await page.keyboard.press('Escape')
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  await expect(locate.graphNode(page)).toHaveCount(nodeCount)
})

test('Visualization preview: user visualization selection', async ({ page }) => {
  await actions.goToGraph(page)
  const nodeCount = await locate.graphNode(page).count()
  await locate.addNewNodeButton(page).click()
  await expect(locate.componentBrowser(page)).toExist()
  await expect(locate.componentBrowserEntry(page)).toExist()
  const input = locate.componentBrowserInput(page).locator('input')
  await input.fill('4')
  await expect(input).toHaveValue('4')
  await expect(locate.jsonVisualization(page)).toExist()
  await locate.showVisualizationSelectorButton(page).click()
  await page.getByRole('button', { name: 'Table' }).click()
  // The table visualization is not currently working with `executeExpression` (#9194), but we can test that the JSON
  // visualization is no longer selected.
  await expect(locate.jsonVisualization(page)).not.toBeVisible()
  await page.keyboard.press('Escape')
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  await expect(locate.graphNode(page)).toHaveCount(nodeCount)
})

test('Component browser handling of overridden record-mode', async ({ page }) => {
  await actions.goToGraph(page)
  const node = locate.graphNodeByBinding(page, 'data')
  const ADDED_PATH = '"/home/enso/Input.txt"'
  const recordModeToggle = node.getByTestId('overrideRecordingButton')
  const recordModeIndicator = node.getByTestId('recordingOverriddenButton')

  // Enable record mode for the node.
  await locate.graphNodeIcon(node).hover()
  await expect(recordModeToggle).not.toHaveClass(/recording-overridden/)
  await recordModeToggle.click()
  // TODO[ao]: The simple move near top-left corner not always works i.e. not always
  //  `pointerleave` event is emitted. Investigated in https://github.com/enso-org/enso/issues/9478
  //  once fixed, remember to change the second `await page.mouse.move(700, 1200, { steps: 20 })`
  //  line below.
  await page.mouse.move(700, 1200, { steps: 20 })
  await expect(recordModeIndicator).toBeVisible()
  await locate.graphNodeIcon(node).hover()
  await expect(recordModeToggle).toHaveClass(/recording-overridden/)
  // Ensure editing in the component browser doesn't display the override expression.
  await locate.graphNodeIcon(node).click({ modifiers: [CONTROL_KEY] })
  await expect(locate.componentBrowser(page)).toBeVisible()
  const input = locate.componentBrowserInput(page).locator('input')
  await expect(input).toHaveValue('Data.read')
  // Ensure committing an edit doesn't change the override state.
  await page.keyboard.press('End')
  await input.pressSequentially(` ${ADDED_PATH}`)
  await page.keyboard.press('Enter')
  await expect(locate.componentBrowser(page)).not.toBeVisible()
  // See TODO above.
  await page.mouse.move(700, 1200, { steps: 20 })
  await expect(recordModeIndicator).toBeVisible()
  // Ensure after editing the node, editing still doesn't display the override expression.
  await locate.graphNodeIcon(node).click({ modifiers: [CONTROL_KEY] })
  await expect(locate.componentBrowser(page)).toBeVisible()
  await expect(input).toHaveValue(`Data.read ${ADDED_PATH}`)
})

test('AI prompt', async ({ page }) => {
  await actions.goToGraph(page)

  const node = locate.graphNodeByBinding(page, 'data')
  await node.click()
  await expect(node).toBeSelected()
  await locate.graphEditor(page).press('Enter')
  await expect(locate.componentBrowser(page)).toBeVisible()

  await page.keyboard.insertText('AI:convert to table')
  await page.keyboard.press('Enter')
  await expect(locate.componentBrowserInput(page).locator('input')).toHaveValue('data.to_table')
})