From bf2e51f0b5f7c41ed5f6b39d1d466fca10838638 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Krassowski?=
 <5832902+krassowski@users.noreply.github.com>
Date: Wed, 13 Dec 2023 13:41:29 +0000
Subject: [PATCH] Backport PR #15524: Fix visual tests

* Try to make the test terminal snapshot more robust

by mock `tree . -L 2` command

* Workaround `test-` dirs issue by capturing `/data` instead of `/`

* Update Playwright Snapshots

* Run customization docs snapshots in serial

* Ignore all test files in galata tests

* Update Playwright Snapshots

* Disable concurrency in `build:examples` to fix flaky test

This was already use in `build:src`

* Ensure no flaky focus indicator on snapshot

(cherry picked from commit c26a0e7cced6eea64a7f0908a7cded8e4c8874fb)
---
 .licenserc.yaml                               |   1 +
 .../commandsList-documentation-linux.json     |   4 +-
 .../test/documentation/customization.test.ts  |   3 +
 .../test/documentation/data/tree_fixture.txt  |  37 ++++++
 galata/test/documentation/general.test.ts     | 110 ++---------------
 .../internationalization.test.ts              |   2 +
 galata/test/documentation/overview.test.ts    | 113 ++++++++++++++++++
 ...terface-jupyterlab-documentation-linux.png | Bin
 .../interface-tabs-documentation-linux.png    | Bin
 ...nterface-tabs-menu-documentation-linux.png | Bin
 package.json                                  |   2 +-
 packages/terminal/src/tokens.ts               |   2 +-
 12 files changed, 170 insertions(+), 104 deletions(-)
 create mode 100644 galata/test/documentation/data/tree_fixture.txt
 create mode 100644 galata/test/documentation/overview.test.ts
 rename galata/test/documentation/{general.test.ts-snapshots => overview.test.ts-snapshots}/interface-jupyterlab-documentation-linux.png (100%)
 rename galata/test/documentation/{general.test.ts-snapshots => overview.test.ts-snapshots}/interface-tabs-documentation-linux.png (100%)
 rename galata/test/documentation/{general.test.ts-snapshots => overview.test.ts-snapshots}/interface-tabs-menu-documentation-linux.png (100%)

diff --git a/.licenserc.yaml b/.licenserc.yaml
index 1d4c9c8a1712..c57530331f3c 100644
--- a/.licenserc.yaml
+++ b/.licenserc.yaml
@@ -32,6 +32,7 @@ header:
     - 'dev_mode/style.js'
     - 'examples/federated/example.cert'
     - 'galata/test/jupyterlab/notebooks/'
+    - 'galata/test/*/*/*.txt'
     - 'jupyterlab.desktop'
     - 'jupyterlab/staging'
     - 'packages/codemirror/test/foo.grammar'
diff --git a/galata/test/documentation/commands.test.ts-snapshots/commandsList-documentation-linux.json b/galata/test/documentation/commands.test.ts-snapshots/commandsList-documentation-linux.json
index d1dfea719fa0..7507c6685ac4 100644
--- a/galata/test/documentation/commands.test.ts-snapshots/commandsList-documentation-linux.json
+++ b/galata/test/documentation/commands.test.ts-snapshots/commandsList-documentation-linux.json
@@ -1915,9 +1915,7 @@
     "id": "notebook:toggle-all-cell-line-numbers",
     "label": "Show Line Numbers",
     "caption": "",
-    "shortcuts": [
-      "Shift L"
-    ]
+    "shortcuts": []
   },
   {
     "id": "notebook:toggle-autoclosing-brackets",
diff --git a/galata/test/documentation/customization.test.ts b/galata/test/documentation/customization.test.ts
index 4cd400f0789a..d0cb61e9c45d 100644
--- a/galata/test/documentation/customization.test.ts
+++ b/galata/test/documentation/customization.test.ts
@@ -10,6 +10,9 @@ test.use({
   viewport: { height: 720, width: 1280 }
 });
 
+// Use serial mode to avoid flaky screenshots
+test.describe.configure({ mode: 'serial' });
+
 test.describe('Default', () => {
   test('should use default layout', async ({ page }) => {
     await galata.Mock.freezeContentLastModified(page);
diff --git a/galata/test/documentation/data/tree_fixture.txt b/galata/test/documentation/data/tree_fixture.txt
new file mode 100644
index 000000000000..e4aac6cffe2a
--- /dev/null
+++ b/galata/test/documentation/data/tree_fixture.txt
@@ -0,0 +1,37 @@
+$ tree . -L 2
+.
+├── LICENSE
+├── README.md
+├── data
+│   ├── 1024px-Hubble_Interacting_Galaxy_AM_0500-620_(2008-04-24).jpg
+│   ├── Dockerfile
+│   ├── Museums_in_DC.geojson
+│   ├── README.md
+│   ├── bar.vl.json
+│   ├── iris.csv
+│   ├── japan_meterological_agency_201707211555.json
+│   └── zika_assembled_genomes.fasta
+├── jupyter_notebook_config.py
+├── narrative
+│   ├── QConAI.md
+│   ├── jupyterlab.md
+│   ├── markdown_python.md
+│   └── scipy2017.md
+├── notebooks
+│   ├── Cpp.ipynb
+│   ├── Data.ipynb
+│   ├── Fasta.ipynb
+│   ├── Julia.ipynb
+│   ├── Lorenz.ipynb
+│   ├── R.ipynb
+│   ├── audio
+│   ├── images
+│   └── lorenz.py
+├── slides
+│   ├── jupyterlab-slides.key
+│   ├── jupyterlab-slides.pdf
+│   └── jupyterlab-slides_scipy19.pdf
+├── talks.yml
+└── tasks.py
+
+6 directories, 27 files
diff --git a/galata/test/documentation/general.test.ts b/galata/test/documentation/general.test.ts
index 6687ef44dcee..395f2170ed61 100644
--- a/galata/test/documentation/general.test.ts
+++ b/galata/test/documentation/general.test.ts
@@ -2,6 +2,7 @@
 // Distributed under the terms of the Modified BSD License.
 
 import { expect, galata, test } from '@jupyterlab/galata';
+import path from 'path';
 import {
   generateArrow,
   positionMouse,
@@ -79,13 +80,6 @@ test.describe('General', () => {
     expect(await page.screenshot()).toMatchSnapshot('jupyterlab.png');
   });
 
-  test('Overview', async ({ page }) => {
-    await galata.Mock.freezeContentLastModified(page);
-    await openOverview(page);
-
-    expect(await page.screenshot()).toMatchSnapshot('interface_jupyterlab.png');
-  });
-
   test('Left Sidebar', async ({ page }) => {
     await galata.Mock.freezeContentLastModified(page);
     await page.goto();
@@ -98,6 +92,8 @@ test.describe('General', () => {
     await setSidebarWidth(page);
 
     await page.dblclick('[aria-label="File Browser Section"] >> text=data');
+    // Wait for the `data` folder to load to have something to blur
+    await page.waitForSelector('text=1024px');
 
     await page.evaluate(() => {
       (document.activeElement as HTMLElement).blur();
@@ -228,32 +224,6 @@ test.describe('General', () => {
     );
   });
 
-  test('Open tabs', async ({ page }) => {
-    await openOverview(page);
-
-    await page.click('[title="Running Terminals and Kernels"]');
-
-    await page
-      .locator(
-        '.jp-RunningSessions-item.jp-mod-kernel >> text="Python 3 (ipykernel)"'
-      )
-      .waitFor();
-    expect(
-      await page.screenshot({ clip: { y: 27, x: 0, width: 283, height: 400 } })
-    ).toMatchSnapshot('interface_tabs.png');
-  });
-
-  test('Tabs menu', async ({ page }) => {
-    await galata.Mock.freezeContentLastModified(page);
-    await openOverview(page);
-
-    await page.click('text="Tabs"');
-
-    expect(
-      await page.screenshot({ clip: { y: 0, x: 210, width: 700, height: 350 } })
-    ).toMatchSnapshot('interface_tabs_menu.png');
-  });
-
   test('File menu', async ({ page }) => {
     await page.goto();
     await page.addStyleTag({
@@ -532,8 +502,13 @@ test.describe('General', () => {
     );
   });
 
-  test('Terminals', async ({ page }) => {
+  test('Terminal layout', async ({ page, tmpPath }) => {
     await galata.Mock.freezeContentLastModified(page);
+    const fileName = 'tree_fixture.txt';
+    await page.contents.uploadFile(
+      path.resolve(__dirname, `./data/${fileName}`),
+      `${tmpPath}/${fileName}`
+    );
     await page.goto();
     await page.addStyleTag({
       content: `.jp-LabShell.jp-mod-devMode {
@@ -559,7 +534,7 @@ test.describe('General', () => {
 
     await page.keyboard.type('cd $JUPYTERLAB_GALATA_ROOT_DIR');
     await page.keyboard.press('Enter');
-    await page.keyboard.type('tree . -L 2');
+    await page.keyboard.type(`clear && cat ${tmpPath}/${fileName}`);
     await page.keyboard.press('Enter');
 
     // Wait for command answer
@@ -634,6 +609,7 @@ test.describe('General', () => {
 
     await setSidebarWidth(page);
 
+    await page.dblclick('[aria-label="File Browser Section"] >> text=data');
     await page.click('text=README.md', {
       button: 'right'
     });
@@ -710,67 +686,3 @@ test.describe('General', () => {
     });
   });
 });
-
-async function openOverview(page) {
-  await page.goto();
-  await page.addStyleTag({
-    content: `.jp-LabShell.jp-mod-devMode {
-      border-top: none;
-    }`
-  });
-
-  await setSidebarWidth(page);
-
-  // Open Data.ipynb
-  await page.dblclick('[aria-label="File Browser Section"] >> text=notebooks');
-  await page.dblclick('text=Data.ipynb');
-
-  // Back home
-  await page.click('.jp-BreadCrumbs-home svg');
-
-  // Open jupyterlab.md
-  await page.dblclick('[aria-label="File Browser Section"] >> text=narrative');
-  await page.click('text=jupyterlab.md', {
-    button: 'right'
-  });
-  await page.click('text=Open With');
-  await page.click('text=Markdown Preview');
-
-  // Back home
-  await page.click('.jp-BreadCrumbs-home svg');
-
-  // Open bar.vl.json
-  await page.dblclick('[aria-label="File Browser Section"] >> text=data');
-  await page.dblclick('text=bar.vl.json');
-  await page.dblclick(
-    'text=1024px-Hubble_Interacting_Galaxy_AM_0500-620_(2008-04-24).jpg'
-  );
-
-  // Move notebook panel
-  const notebookHandle = await page.$('div[role="main"] >> text=Data.ipynb');
-  await notebookHandle.click();
-  const notebookBBox = await notebookHandle.boundingBox();
-
-  await page.mouse.move(
-    notebookBBox.x + 0.5 * notebookBBox.width,
-    notebookBBox.y + 0.5 * notebookBBox.height
-  );
-  await page.mouse.down();
-  await page.mouse.move(notebookBBox.x + 0.5 * notebookBBox.width, 350);
-  await page.mouse.up();
-
-  // Move md panel
-  const mdHandle = await page.$('div[role="main"] >> text=jupyterlab.md');
-  await mdHandle.click();
-  const mdBBox = await mdHandle.boundingBox();
-  const panelHandle = await page.activity.getPanel();
-  const panelBBox = await panelHandle.boundingBox();
-
-  await page.mouse.move(
-    mdBBox.x + 0.5 * mdBBox.width,
-    mdBBox.y + 0.5 * mdBBox.height
-  );
-  await page.mouse.down();
-  await page.mouse.move(panelBBox.x + 0.5 * panelBBox.width, 200);
-  await page.mouse.up();
-}
diff --git a/galata/test/documentation/internationalization.test.ts b/galata/test/documentation/internationalization.test.ts
index 5b001631a745..9b85720a2b10 100644
--- a/galata/test/documentation/internationalization.test.ts
+++ b/galata/test/documentation/internationalization.test.ts
@@ -44,6 +44,8 @@ test.describe('Internationalization', () => {
     await galata.Mock.freezeContentLastModified(page);
     await page.goto();
 
+    await page.dblclick('[aria-label="File Browser Section"] >> text=data');
+
     await page.click('text=Settings');
     await page.click('.lm-Menu ul[role="menu"] >> text=Language');
     await page.click('#jp-mainmenu-settings-language >> text=Chinese');
diff --git a/galata/test/documentation/overview.test.ts b/galata/test/documentation/overview.test.ts
new file mode 100644
index 000000000000..a07e2a3c5077
--- /dev/null
+++ b/galata/test/documentation/overview.test.ts
@@ -0,0 +1,113 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import { expect, galata, test } from '@jupyterlab/galata';
+import { setSidebarWidth } from './utils';
+
+test.use({
+  autoGoto: false,
+  mockState: galata.DEFAULT_DOCUMENTATION_STATE,
+  viewport: { height: 720, width: 1280 }
+});
+
+// Use serial mode to avoid flaky screenshots
+test.describe.configure({ mode: 'serial' });
+
+test.describe('Overview', () => {
+  test('Overview', async ({ page }) => {
+    await galata.Mock.freezeContentLastModified(page);
+    await openOverview(page);
+
+    expect(await page.screenshot()).toMatchSnapshot('interface_jupyterlab.png');
+  });
+
+  test('Open tabs', async ({ page }) => {
+    await openOverview(page);
+
+    await page.click('[title="Running Terminals and Kernels"]');
+
+    await page
+      .locator(
+        '.jp-RunningSessions-item.jp-mod-kernel >> text="Python 3 (ipykernel)"'
+      )
+      .waitFor();
+    expect(
+      await page.screenshot({ clip: { y: 27, x: 0, width: 283, height: 400 } })
+    ).toMatchSnapshot('interface_tabs.png');
+  });
+
+  test('Tabs menu', async ({ page }) => {
+    await galata.Mock.freezeContentLastModified(page);
+    await openOverview(page);
+
+    await page.click('text="Tabs"');
+
+    expect(
+      await page.screenshot({ clip: { y: 0, x: 210, width: 700, height: 350 } })
+    ).toMatchSnapshot('interface_tabs_menu.png');
+  });
+});
+
+async function openOverview(page) {
+  await page.goto();
+  await page.addStyleTag({
+    content: `.jp-LabShell.jp-mod-devMode {
+      border-top: none;
+    }`
+  });
+
+  await setSidebarWidth(page);
+
+  // Open Data.ipynb
+  await page.dblclick('[aria-label="File Browser Section"] >> text=notebooks');
+  await page.dblclick('text=Data.ipynb');
+
+  // Back home
+  await page.click('.jp-BreadCrumbs-home svg');
+
+  // Open jupyterlab.md
+  await page.dblclick('[aria-label="File Browser Section"] >> text=narrative');
+  await page.click('text=jupyterlab.md', {
+    button: 'right'
+  });
+  await page.click('text=Open With');
+  await page.click('text=Markdown Preview');
+
+  // Back home
+  await page.click('.jp-BreadCrumbs-home svg');
+
+  // Open bar.vl.json
+  await page.dblclick('[aria-label="File Browser Section"] >> text=data');
+  await page.dblclick('text=bar.vl.json');
+  await page.dblclick(
+    'text=1024px-Hubble_Interacting_Galaxy_AM_0500-620_(2008-04-24).jpg'
+  );
+
+  // Move notebook panel
+  const notebookHandle = await page.$('div[role="main"] >> text=Data.ipynb');
+  await notebookHandle.click();
+  const notebookBBox = await notebookHandle.boundingBox();
+
+  await page.mouse.move(
+    notebookBBox.x + 0.5 * notebookBBox.width,
+    notebookBBox.y + 0.5 * notebookBBox.height
+  );
+  await page.mouse.down();
+  await page.mouse.move(notebookBBox.x + 0.5 * notebookBBox.width, 350);
+  await page.mouse.up();
+
+  // Move md panel
+  const mdHandle = await page.$('div[role="main"] >> text=jupyterlab.md');
+  await mdHandle.click();
+  const mdBBox = await mdHandle.boundingBox();
+  const panelHandle = await page.activity.getPanel();
+  const panelBBox = await panelHandle.boundingBox();
+
+  await page.mouse.move(
+    mdBBox.x + 0.5 * mdBBox.width,
+    mdBBox.y + 0.5 * mdBBox.height
+  );
+  await page.mouse.down();
+  await page.mouse.move(panelBBox.x + 0.5 * panelBBox.width, 200);
+  await page.mouse.up();
+}
diff --git a/galata/test/documentation/general.test.ts-snapshots/interface-jupyterlab-documentation-linux.png b/galata/test/documentation/overview.test.ts-snapshots/interface-jupyterlab-documentation-linux.png
similarity index 100%
rename from galata/test/documentation/general.test.ts-snapshots/interface-jupyterlab-documentation-linux.png
rename to galata/test/documentation/overview.test.ts-snapshots/interface-jupyterlab-documentation-linux.png
diff --git a/galata/test/documentation/general.test.ts-snapshots/interface-tabs-documentation-linux.png b/galata/test/documentation/overview.test.ts-snapshots/interface-tabs-documentation-linux.png
similarity index 100%
rename from galata/test/documentation/general.test.ts-snapshots/interface-tabs-documentation-linux.png
rename to galata/test/documentation/overview.test.ts-snapshots/interface-tabs-documentation-linux.png
diff --git a/galata/test/documentation/general.test.ts-snapshots/interface-tabs-menu-documentation-linux.png b/galata/test/documentation/overview.test.ts-snapshots/interface-tabs-menu-documentation-linux.png
similarity index 100%
rename from galata/test/documentation/general.test.ts-snapshots/interface-tabs-menu-documentation-linux.png
rename to galata/test/documentation/overview.test.ts-snapshots/interface-tabs-menu-documentation-linux.png
diff --git a/package.json b/package.json
index dfca9df864d4..71e7c4d69a0b 100644
--- a/package.json
+++ b/package.json
@@ -41,7 +41,7 @@
     "build:dev:prod:minimize": "npm run integrity && npm run build:all && cd dev_mode && npm run build:prod:minimize",
     "build:dev:prod:minimize:report": "npm run integrity && npm run build:all && cd dev_mode && npm run build:prod:minimize:report",
     "build:dev:prod:release": "npm run integrity && npm run build:all && cd dev_mode && npm run build:prod:release",
-    "build:examples": "lerna run build --scope \"@jupyterlab/example-*\"",
+    "build:examples": "lerna run build --scope \"@jupyterlab/example-*\" --concurrency 1",
     "build:galata": "cd galata && npm run build",
     "build:nbconvert:css": "cd packages/nbconvert-css && npm run build",
     "build:packages": "cd packages/metapackage && npm run build",
diff --git a/packages/terminal/src/tokens.ts b/packages/terminal/src/tokens.ts
index 3205448bb82a..14fd56c3f572 100644
--- a/packages/terminal/src/tokens.ts
+++ b/packages/terminal/src/tokens.ts
@@ -104,7 +104,7 @@ export namespace ITerminal {
     closeOnExit: boolean;
 
     /**
-     * Whether to blink the cursor.  Can only be set at startup.
+     * Whether to blink the cursor. Can only be set at startup.
      */
     cursorBlink: boolean;