Integration tests

.github/workflows/build.yml

@@ -76,6 +76,64 @@ jobs:
         path: packages/jupyterlab-${{ matrix.extension }}-chat/dist/jupyterlab_${{ matrix.extension }}_chat*
         if-no-files-found: error
 
+  integration-tests:
+    name: ${{ matrix.extension }} integration tests
+    needs: build_extensions
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        extension: [collaborative, ws]
+
+    env:
+      PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Base Setup
+      uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+    - name: Download extension package
+      uses: actions/download-artifact@v3
+      with:
+        name: jupyterlab_${{ matrix.extension }}_chat-artifacts
+
+    - name: Install the extension
+      run: |
+        set -eux
+        python -m pip install "jupyterlab>=4.0.0,<5" jupyterlab_${{ matrix.extension }}_chat*.whl
+    - name: Install dependencies
+      working-directory: packages/jupyterlab-${{ matrix.extension }}-chat/ui-tests
+      env:
+        YARN_ENABLE_IMMUTABLE_INSTALLS: 0
+        PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+      run: jlpm install
+
+    - name: Set up browser cache
+      uses: actions/cache@v3
+      with:
+        path: |
+          ${{ github.workspace }}/pw-browsers
+        key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}
+
+    - name: Install browser
+      run: jlpm playwright install chromium
+      working-directory: packages/jupyterlab-${{ matrix.extension }}-chat/ui-tests
+
+    - name: Execute integration tests
+      working-directory: packages/jupyterlab-${{ matrix.extension }}-chat/ui-tests
+      run: |
+        jlpm playwright test
+    - name: Upload Playwright Test report
+      if: always()
+      uses: actions/upload-artifact@v3
+      with:
+        name: jupyterlab_${{ matrix.extension }}_chat-playwright-tests
+        path: |
+          packages/jupyterlab-${{ matrix.extension }}-chat/ui-tests/test-results
+          packages/jupyterlab-${{ matrix.extension }}-chat/ui-tests/playwright-report
+
   check_links:
     name: Check Links
     runs-on: ubuntu-latest

.gitignore

@@ -8,6 +8,7 @@ node_modules/
 .ipynb_checkpoints
 *.tsbuildinfo
 jupyter_chat/labextension
+.jupyter_ystore.db
 # Version file is handled by hatchling
 jupyter_chat/_version.py
 

packages/jupyterlab-collaborative-chat/schema/commands.json

@@ -14,7 +14,7 @@
               "items": [
                 {
                   "command": "collaborative-chat:create",
-                  "rank": 10
+                  "rank": 50
                 }
               ]
             }

packages/jupyterlab-collaborative-chat/src/index.ts

@@ -152,7 +152,7 @@ export const chatCreation: JupyterFrontEndPlugin<void> = {
             await InputDialog.getText({
               label: 'Name',
               placeholder: 'untitled',
-              title: 'Name of the chat'
+              title: 'Create a new chat'
             })
           ).value;
         }
@@ -170,9 +170,13 @@ export const chatCreation: JupyterFrontEndPlugin<void> = {
         }
 
         let fileExist = true;
-        await drive.get(filepath, { content: false }).catch(() => {
+        if (filepath) {
+          await drive.get(filepath, { content: false }).catch(() => {
+            fileExist = false;
+          });
+        } else {
           fileExist = false;
-        });
+        }
 
         // Create a new file if it does not exists
         if (!fileExist) {
@@ -193,9 +197,9 @@ export const chatCreation: JupyterFrontEndPlugin<void> = {
             );
             return '';
           }
-
           filepath = model.path;
         }
+
         return commands.execute(CommandIDs.openChat, { filepath });
       }
     });
@@ -210,7 +214,7 @@ export const chatCreation: JupyterFrontEndPlugin<void> = {
       label: 'Open a chat',
       execute: async args => {
         let filepath: string | null = (args.filepath as string) ?? null;
-        if (!filepath) {
+        if (filepath === null) {
           filepath = (
             await InputDialog.getText({
               label: 'File path',

packages/jupyterlab-collaborative-chat/ui-tests/jupyter_server_test_config.py

@@ -11,5 +11,7 @@
 
 configure_jupyter_server(c)
 
+c.FileContentsManager.delete_to_trash = False
+
 # Uncomment to set server log level to debug level
 # c.ServerApp.log_level = "DEBUG"

packages/jupyterlab-collaborative-chat/ui-tests/tests/jupyterlab_collaborative_chat.spec.ts

@@ -3,27 +3,129 @@
  * Distributed under the terms of the Modified BSD License.
  */
 
-import { expect, test } from '@jupyterlab/galata';
+import { IJupyterLabPageFixture, expect, test } from '@jupyterlab/galata';
 
-/**
- * Don't load JupyterLab webpage before running the tests.
- * This is required to ensure we capture all log messages.
- */
-test.use({ autoGoto: false });
+async function fillModal(
+  page: IJupyterLabPageFixture,
+  text = '',
+  button: 'Ok' | 'Cancel' = 'Ok'
+) {
+  const dialog = page.getByRole('dialog');
+  await dialog.getByRole('textbox').pressSequentially(text);
+  await dialog.getByRole('button').filter({ hasText: button }).click();
+}
+
+test.describe('#commandPalette', () => {
+  const name = 'my-chat';
+
+  test.beforeEach(async ({ page }) => {
+    await page.keyboard.press('Control+Shift+c');
+  });
+
+  test.afterEach(async ({ page }) => {
+    for (let filename of ['untitled.chat', `${name}.chat`]) {
+      if (await page.filebrowser.contents.fileExists(filename)) {
+        await page.filebrowser.contents.deleteFile(filename);
+      }
+    }
+  });
 
-test('should emit an activation console message', async ({ page }) => {
-  const logs: string[] = [];
+  test('should have 2 commands in palette', async ({ page }) => {
+    await expect(
+      page.locator(
+        '#modal-command-palette li[data-command^="collaborative-chat"]'
+      )
+    ).toHaveCount(2);
+  });
+
+  test('should create a chat with name from command palette', async ({
+    page
+  }) => {
+    await page
+      .locator(
+        '#modal-command-palette li[data-command="collaborative-chat:create"]'
+      )
+      .click();
+    await fillModal(page, name);
+    await page.waitForCondition(
+      async () => await page.filebrowser.contents.fileExists(`${name}.chat`)
+    );
+    await expect(page.activity.getTabLocator(`${name}.chat`)).toBeVisible();
+  });
 
-  page.on('console', message => {
-    logs.push(message.text());
+  test('should create an untitled chat from command palette', async ({
+    page
+  }) => {
+    await page
+      .locator(
+        '#modal-command-palette li[data-command="collaborative-chat:create"]'
+      )
+      .click();
+    await fillModal(page);
+    await page.waitForCondition(
+      async () => await page.filebrowser.contents.fileExists('untitled.chat')
+    );
+    await expect(page.activity.getTabLocator('untitled.chat')).toBeVisible();
   });
 
-  await page.goto();
+  test('should not create a chat if modal is cancelled', async ({ page }) => {
+    await page
+      .locator(
+        '#modal-command-palette li[data-command="collaborative-chat:create"]'
+      )
+      .click();
+    await fillModal(page, '', 'Cancel');
+    const tab = page.getByRole('main').getByRole('tab');
+    await expect(tab).toHaveCount(1);
+  });
+
+  test('should open an existing chat', async ({ page }) => {
+    // Create a chat file
+    await page.filebrowser.contents.uploadContent('{}', 'text', `${name}.chat`);
 
-  expect(
-    logs.filter(
-      s =>
-        s === 'JupyterLab extension jupyterlab-collaborative-chat is activated!'
-    )
-  ).toHaveLength(1);
+    // open it from command palette
+    await page
+      .locator(
+        '#modal-command-palette li[data-command="collaborative-chat:open"]'
+      )
+      .click();
+    await fillModal(page, `${name}.chat`);
+    await expect(page.activity.getTabLocator(`${name}.chat`)).toBeVisible();
+  });
+});
+
+test.describe('#menuNew', () => {
+  test('should have an entry in main menu -> new', async ({ page }) => {
+    const menu = await page.menu.open('File>New');
+    expect(await menu?.screenshot()).toMatchSnapshot('menu-new.png');
+  });
+
+  test('should open modal create from the menu', async ({ page }) => {
+    await page.menu.clickMenuItem('File>New>Chat');
+    await expect(page.locator('dialog .jp-Dialog-header')).toHaveText(
+      'Create a new chat'
+    );
+  });
+});
+
+test.describe('#launcher', () => {
+  test('should have a launcher item in section', async ({ page }) => {
+    // Chat section
+    await expect(
+      page.locator('.jp-Launcher-sectionTitle:text("Chat")')
+    ).toHaveCount(1);
+
+    // Chat tile
+    const tile = page
+      .locator('.jp-LauncherCard[data-category="Chat"]')
+      .getByTitle('Create a chat');
+    expect(await tile.screenshot()).toMatchSnapshot('launcher-tile.png');
+  });
+
+  test('should open modal create from the launcher', async ({ page }) => {
+    await page.locator('.jp-LauncherCard').getByTitle('Create a chat').click();
+    await expect(page.locator('dialog .jp-Dialog-header')).toHaveText(
+      'Create a new chat'
+    );
+  });
 });