forgejo/tests/e2e/modal.test.e2e.ts
Beowulf 28e0af23fa
Some checks are pending
/ release (push) Waiting to run
testing-integration / test-unit (push) Waiting to run
testing-integration / test-sqlite (push) Waiting to run
testing-integration / test-mariadb (v10.6) (push) Waiting to run
testing-integration / test-mariadb (v11.8) (push) Waiting to run
testing / backend-checks (push) Waiting to run
testing / frontend-checks (push) Waiting to run
testing / test-unit (push) Blocked by required conditions
testing / test-e2e (push) Blocked by required conditions
testing / test-remote-cacher (redis) (push) Blocked by required conditions
testing / test-remote-cacher (valkey) (push) Blocked by required conditions
testing / test-remote-cacher (garnet) (push) Blocked by required conditions
testing / test-remote-cacher (redict) (push) Blocked by required conditions
testing / test-mysql (push) Blocked by required conditions
testing / test-pgsql (push) Blocked by required conditions
testing / test-sqlite (push) Blocked by required conditions
testing / security-check (push) Blocked by required conditions
feat(ui): replace Monaco with CodeMirror (#10559)
- Replace the [Monaco Editor](https://microsoft.github.io/monaco-editor/)
with [CodeMirror 6](https://codemirror.net/). This editor is used to
facilitate the 'Add file' and 'Edit file' functionality.
- Rationale:
  - Monaco editor is a great and powerful editor, however for Forgejo's
  purpose it acts more like a small IDE than a code editor and is doing
  too much. In my limited user research the usage of editing files via
  the web UI is largely for small changes that does not need the
  features that Monaco editor provides.
  - Monaco editor has no mobile support, Codemirror is very usable on mobile.
  - Monaco editor pulls in large dependencies (for language support) and
  by replacing it with Codemirror the amount of time that webpack needs
  to build the frontend is reduced by 50% (~30s -> ~15s).
  - The binary of Forgejo (build with `bindata` tag) is reduced by 2MiB.
  - Codemirror is much more lightweight and should be more usable on
  less powerful hardware, most notably the lazy loading is much faster
  as codemirror uses less javascript.
  - Because Codemirror is modular it is much easier to change the
  behavior of the code editor if we wish to.
- Drawbacks:
  - Codemirror is quite modular and as seen in `package.json` and in
  `codeeditor.ts` we have to supply a lot more of its features to have
  feature parity with Monaco editor.
  - Monaco editor has great integrated language support (features that
  an lsp would provide), Codemirror only has such language support to an
  extend.
  - Monaco editor has its famous command palette (known by many as its
  also available in VSCode), this is not available in code mirror.
- Good to note:
  - All features that was added on top of the monaco editor (such as
  dynamically changing language  support depending on the filename)
  still works and the theme is based on the VSCode colors which largely
  resembles the monaco editor.
  - The code editor is still lazy-loaded (this is painfully clear by
  reading how imports are passed around in `codeeditor.ts`).
  - This change was privately tested by a few people, a few bugs were
  found (and fixed) but no major drawbacks were noted for their usage of
  the web editor.
  - There's a "search" button in the top bar, so that search can be used
  on mobile. It is otherwise only accessible via
  <kbd>Ctrl</kbd>+<kbd>f</kbd>.

Co-authored-by: Beowulf <beowulf@beocode.eu>

Co-authored-by: Gusted <postmaster@gusted.xyz>
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10559
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Reviewed-by: 0ko <0ko@noreply.codeberg.org>
Co-committed-by: Beowulf <beowulf@beocode.eu>
2026-01-04 23:52:33 +01:00

105 lines
3.5 KiB
TypeScript

// Copyright 2025 The Forgejo Authors. All rights reserved.
// SPDX-License-Identifier: GPL-3.0-or-later
// @watch start
// templates/devtest/modal.tmpl
// templates/repo/editor/edit.tmpl
// templates/repo/editor/patch.tmpl
// web_src/js/features/repo-editor.js
// web_src/css/modules/dialog.ts
// web_src/css/modules/dialog.css
// @watch end
import {expect} from '@playwright/test';
import {dynamic_id, test} from './utils_e2e.ts';
import {screenshot} from './shared/screenshots.ts';
test.use({user: 'user2'});
test('Dialog modal', async ({page}) => {
let response = await page.goto('/user2/repo1/_new/master', {waitUntil: 'domcontentloaded'});
expect(response?.status()).toBe(200);
const filename = `${dynamic_id()}.md`;
await page.getByPlaceholder('Name your file…').fill(filename);
await page.locator('.cm-content').click();
await page.keyboard.type('Hi, nice to meet you. Can I talk about ');
await page.locator('.quick-pull-choice input[value="direct"]').click();
await page.getByRole('button', {name: 'Commit changes'}).click();
response = await page.goto(`/user2/repo1/_edit/master/${filename}`, {waitUntil: 'domcontentloaded'});
expect(response?.status()).toBe(200);
await page.locator('.cm-content').click();
await page.keyboard.press('ControlOrMeta+A');
await page.keyboard.press('Backspace');
await page.locator('#commit-button').click();
await screenshot(page);
await expect(page.locator('#edit-empty-content-modal')).toBeVisible();
await page.locator('#edit-empty-content-modal .cancel').click();
await expect(page.locator('#edit-empty-content-modal')).toBeHidden();
await page.locator('#commit-button').click();
await page.locator('#edit-empty-content-modal .ok').click();
await expect(page).toHaveURL(`/user2/repo1/src/branch/master/${filename}`);
});
test('Dialog modal: width', async ({page, isMobile}) => {
// This test doesn't need JS and runs a little faster without it
await page.goto('/devtest/modal');
// Open modal with short content
const shortModal = page.locator('#short-modal');
await expect(shortModal).toBeHidden();
await page.locator('button[data-modal="#short-modal"]').click();
await expect(shortModal).toBeVisible();
// Check it's width
let width = Math.round((await shortModal.boundingBox()).width);
if (isMobile) {
// Bound by viewport width
expect(width).toBeLessThan(400);
} else {
// Bound by min-width
expect(width).toBe(400);
}
// Open modal with medium sized content
await shortModal.locator('button.cancel').click();
const mediumModal = page.locator('#medium-modal');
await expect(mediumModal).toBeHidden();
await page.locator('button[data-modal="#medium-modal"]').click();
await expect(mediumModal).toBeVisible();
// Check it's width
width = Math.round((await mediumModal.boundingBox()).width);
if (isMobile) {
// Bound by viewport width
expect(width).toBeLessThan(400);
} else {
// Not bound by min-width or max-width
expect(width).toBeLessThan(800);
expect(width).toBeGreaterThan(400);
}
// Open modal with long content
await mediumModal.locator('button.cancel').click();
const longModal = page.locator('#long-modal');
await expect(longModal).toBeHidden();
await page.locator('button[data-modal="#long-modal"]').click();
await expect(longModal).toBeVisible();
// Check it's width
width = Math.round((await longModal.boundingBox()).width);
if (isMobile) {
// Bound by viewport width
expect(width).toBeLessThan(400);
} else {
// Bound by max-width
expect(width).toBe(800);
}
});