upstream-gitea/tests/e2e/pr-diff-filter.test.ts

import {test, expect} from '@playwright/test';
import {apiCreateFiles, apiCreatePR, apiCreateRepo, apiCreateUser, apiUserHeaders, loginUser, randomString} from './utils.ts';

test('diff sidebar filtering', async ({page, request}) => {
  const user = `df-${randomString(8)}`;
  await apiCreateUser(request, user);
  const headers = apiUserHeaders(user);
  const repo = `e2e-difffilter-${randomString(8)}`;
  await apiCreateRepo(request, {name: repo, headers});

  await apiCreateFiles(request, user, repo, [
    {path: 'src/a.ts', content: 'a\n'},
    {path: 'src/b.ts', content: 'b\n'},
    {path: 'src/.eslintrc', content: 'e\n'}, // dotfiles count as "No extension"
    {path: 'styles/x.css', content: 'x\n'},
    {path: 'docs/intro.md', content: 'r\n'},
    {path: 'Makefile', content: 'm\n'},
  ], {branch: 'main', newBranch: 'feat', headers});
  const prIndex = await apiCreatePR(request, user, repo, 'feat', 'main', 'diff filter test', {headers});

  await loginUser(page, user);
  await page.goto(`/${user}/${repo}/pulls/${prIndex}/files`);

  const tree = page.locator('#diff-file-tree');
  const items = tree.locator('.item-file');
  const search = tree.getByRole('textbox');
  const filterTrigger = tree.getByRole('button', {name: 'Filter by file extension'});

  // every PR file is listed
  await expect(items).toHaveCount(6);

  // sidebar leaves the diff column the bulk of the viewport
  const boxesWidth = (await page.locator('#diff-file-boxes').boundingBox())!.width;
  const treeWidth = (await tree.boundingBox())!.width;
  expect(boxesWidth).toBeGreaterThan(treeWidth * 2);

  // search filters tree and file boxes
  await search.fill('a.ts');
  await expect(items).toHaveText([/a\.ts/]);
  await expect(page.locator('.diff-file-box[data-new-filename="src/a.ts"]')).toBeVisible();

  await tree.getByRole('button', {name: 'Clear filter'}).click();
  await expect(items).toHaveCount(6);

  // empty-result placeholder
  await search.fill('zzz-no-such-file');
  await expect(page.locator('#diff-no-matches')).toBeVisible();
  await search.fill('');

  // extensions sort alphabetically, then dotfiles, then files without extension
  await filterTrigger.click();
  const extItems = page.getByRole('menuitemcheckbox');
  await expect(extItems).toHaveText(['.css1', '.md1', '.ts2', 'Dotfiles1', 'No extension1', 'All extensions']);

  // deselecting .ts leaves the other extensions
  const allExtensions = page.getByRole('menuitemcheckbox', {name: 'All extensions'});
  await page.getByRole('menuitemcheckbox', {name: '.ts'}).click();
  await expect(items).toHaveCount(4);
  await expect(filterTrigger).toHaveClass(/\bindicator-dot\b/);
  await expect(allExtensions).toHaveAttribute('aria-checked', 'false');

  // "All extensions" cycles through select all, select none and back
  await allExtensions.click();
  await expect(allExtensions).toHaveAttribute('aria-checked', 'true');
  await expect(items).toHaveCount(6);

  await allExtensions.click();
  await expect(items).toHaveCount(0);

  await allExtensions.click();
  await expect(items).toHaveCount(6);
  await expect(filterTrigger).not.toHaveClass(/\bindicator-dot\b/);

  // the extension filter lives in the URL and survives a reload
  await page.getByRole('menuitemcheckbox', {name: '.ts'}).click();
  await expect(page).toHaveURL(/file-filters/);
  await page.reload();
  await expect(items).toHaveCount(4);
  await expect(filterTrigger).toHaveClass(/\bindicator-dot\b/);

  // hiding the file tree drops the filter
  await expect(page.locator('.diff-file-box[data-new-filename="src/a.ts"]')).toBeHidden();
  await filterTrigger.click();
  await page.locator('.diff-toggle-file-tree-button').click();
  await expect(tree).toBeHidden();
  await expect(page.locator('.diff-file-box[data-new-filename="src/a.ts"]')).toBeVisible();
});