docs/src/frontend/apps/e2e/__tests__/app-impress/doc-header.spec.ts

import { expect, test } from '@playwright/test';

import {
  createDoc,
  getGridRow,
  goToGridDoc,
  mockedDocument,
  verifyDocName,
} from './utils-common';
import { mockedAccesses, mockedInvitations } from './utils-share';
import { createRootSubPage } from './utils-sub-pages';

test.beforeEach(async ({ page }) => {
  await page.goto('/');
});

test.describe('Doc Header', () => {
  test('it checks the element are correctly displayed', async ({
    page,
    browserName,
  }) => {
    await createDoc(page, 'doc-update', browserName, 1);

    const card = page.getByLabel(
      'It is the card information about the document.',
    );

    const docTitle = card.getByRole('textbox', { name: 'Document title' });
    await expect(docTitle).toBeVisible();

    await page.getByRole('button', { name: 'Share' }).click();

    await page.getByTestId('doc-visibility').click();

    await page
      .getByRole('menuitem', {
        name: 'Public',
      })
      .click();

    await page.getByRole('button', { name: 'close' }).first().click();

    await expect(card.getByText('Public document')).toBeVisible();

    await expect(card.getByText('Owner ·')).toBeVisible();
    await expect(page.getByRole('button', { name: 'Share' })).toBeVisible();
    await expect(
      page.getByRole('button', { name: 'Export the document' }),
    ).toBeVisible();
    await expect(
      page.getByRole('button', { name: 'Open the document options' }),
    ).toBeVisible();
  });

  test('it updates the title doc', async ({ page, browserName }) => {
    await createDoc(page, 'doc-update', browserName, 1);
    const docTitle = page.getByRole('textbox', { name: 'Document title' });
    await expect(docTitle).toBeVisible();
    await docTitle.fill('Hello World');
    await docTitle.blur();
    await verifyDocName(page, 'Hello World');
  });

  test('it updates the title doc adding a leading emoji', async ({
    page,
    browserName,
  }) => {
    await createDoc(page, 'doc-update', browserName, 1);
    const docTitle = page.getByRole('textbox', { name: 'Document title' });
    await expect(docTitle).toBeVisible();
    await docTitle.fill('👍 Hello Emoji World');
    await docTitle.blur();
    await verifyDocName(page, '👍 Hello Emoji World');

    // Check the tree
    const docTree = page.getByTestId('doc-tree');
    await expect(docTree.getByText('Hello Emoji World')).toBeVisible();
    await expect(docTree.getByLabel('Document emoji icon')).toBeVisible();
    await expect(docTree.getByLabel('Simple document icon')).toBeHidden();

    await page.getByTestId('home-button').click();

    // Check the documents grid
    const gridRow = await getGridRow(page, 'Hello Emoji World');
    await expect(gridRow.getByLabel('Document emoji icon')).toBeVisible();
    await expect(gridRow.getByLabel('Simple document icon')).toBeHidden();
  });

  test('it deletes the doc', async ({ page, browserName }) => {
    const [randomDoc] = await createDoc(page, 'doc-delete', browserName, 1);

    await page.getByLabel('Open the document options').click();
    await page.getByLabel('Delete document').click();

    await expect(
      page.getByRole('heading', { name: 'Delete a doc' }),
    ).toBeVisible();

    await expect(page.getByText(`This document and any sub-`)).toBeVisible();

    await page
      .getByRole('button', {
        name: 'Delete document',
      })
      .click();

    await expect(
      page.getByText('The document has been deleted.'),
    ).toBeVisible();

    await expect(page.getByRole('button', { name: 'New do' })).toBeVisible();

    const row = page
      .getByLabel('Datagrid of the documents page 1')
      .getByRole('table')
      .getByRole('row')
      .filter({
        hasText: randomDoc,
      });

    expect(await row.count()).toBe(0);
  });

  test('it checks the options available if administrator', async ({ page }) => {
    await mockedDocument(page, {
      abilities: {
        accesses_manage: true, // Means admin
        accesses_view: true,
        destroy: false, // Means not owner
        link_configuration: true,
        versions_destroy: true,
        versions_list: true,
        versions_retrieve: true,
        update: true,
        partial_update: true,
        retrieve: true,
      },
    });

    await mockedInvitations(page);
    await mockedAccesses(page);

    await goToGridDoc(page);

    await expect(
      page.getByRole('button', { name: 'Export the document' }),
    ).toBeVisible();

    await page.getByLabel('Open the document options').click();

    await expect(page.getByLabel('Delete document')).toBeDisabled();

    // Click somewhere else to close the options
    await page.click('body', { position: { x: 0, y: 0 } });

    await page.getByRole('button', { name: 'Share' }).click();

    const shareModal = page.getByRole('dialog', {
      name: 'Share modal content',
    });
    await expect(shareModal).toBeVisible();
    await expect(page.getByText('Share the document')).toBeVisible();

    const invitationCard = shareModal.getByLabel('List invitation card');
    await expect(invitationCard).toBeVisible();
    await expect(
      invitationCard.getByText('test.test@invitation.test').first(),
    ).toBeVisible();
    const invitationRole = invitationCard.getByLabel('doc-role-dropdown');
    await expect(invitationRole).toBeVisible();

    await invitationRole.click();

    await page.getByRole('menuitem', { name: 'Remove access' }).click();
    await expect(invitationCard).toBeHidden();

    const memberCard = shareModal.getByLabel('List members card');
    const roles = memberCard.getByLabel('doc-role-dropdown');
    await expect(memberCard).toBeVisible();
    await expect(
      memberCard.getByText('test.test@accesses.test').first(),
    ).toBeVisible();
    await expect(roles).toBeVisible();

    await roles.click();
    await expect(
      page.getByRole('menuitem', { name: 'Remove access' }),
    ).toBeEnabled();
  });

  test('it checks the options available if editor', async ({ page }) => {
    await mockedDocument(page, {
      abilities: {
        accesses_manage: false, // Means not admin
        accesses_view: true,
        destroy: false, // Means not owner
        link_configuration: false,
        versions_destroy: true,
        versions_list: true,
        versions_retrieve: true,
        update: true,
        partial_update: true, // Means editor
        retrieve: true,
      },
    });

    await mockedInvitations(page, {
      abilities: {
        destroy: false,
        update: false,
        partial_update: false,
        retrieve: true,
      },
    });
    await mockedAccesses(page);

    await goToGridDoc(page);

    await expect(
      page.getByRole('button', { name: 'Export the document' }),
    ).toBeVisible();
    await page.getByLabel('Open the document options').click();

    await expect(page.getByLabel('Delete document')).toBeDisabled();

    // Click somewhere else to close the options
    await page.click('body', { position: { x: 0, y: 0 } });

    await page.getByRole('button', { name: 'Share' }).click();

    const shareModal = page.getByRole('dialog', {
      name: 'Share modal content',
    });
    await expect(shareModal).toBeVisible();
    await expect(page.getByText('Share the document')).toBeVisible();

    await expect(page.getByPlaceholder('Type a name or email')).toBeHidden();

    const invitationCard = shareModal.getByLabel('List invitation card');
    await expect(invitationCard).toBeVisible();
    await expect(
      invitationCard.getByText('test.test@invitation.test').first(),
    ).toBeVisible();
    await expect(invitationCard.getByLabel('Document role text')).toBeVisible();
    await expect(
      invitationCard.getByRole('button', { name: 'more_horiz' }),
    ).toBeHidden();

    const memberCard = shareModal.getByLabel('List members card');
    await expect(memberCard.getByText('test.test@accesses.test')).toBeVisible();
    await expect(memberCard.getByLabel('Document role text')).toBeVisible();
    await expect(
      memberCard.getByRole('button', { name: 'more_horiz' }),
    ).toBeHidden();
  });

  test('it checks the options available if reader', async ({ page }) => {
    await mockedDocument(page, {
      abilities: {
        accesses_manage: false, // Means not admin
        accesses_view: true,
        destroy: false, // Means not owner
        link_configuration: false,
        versions_destroy: false,
        versions_list: true,
        versions_retrieve: true,
        update: false,
        partial_update: false, // Means not editor
        retrieve: true,
      },
    });

    await mockedInvitations(page, {
      abilities: {
        destroy: false,
        update: false,
        partial_update: false,
        retrieve: true,
      },
    });
    await mockedAccesses(page);

    await goToGridDoc(page);

    await expect(
      page.getByRole('button', { name: 'Export the document' }),
    ).toBeVisible();
    await page.getByLabel('Open the document options').click();

    await expect(page.getByLabel('Delete document')).toBeDisabled();

    // Click somewhere else to close the options
    await page.click('body', { position: { x: 0, y: 0 } });

    await page.getByRole('button', { name: 'Share' }).click();

    const shareModal = page.getByLabel('Share modal');
    await expect(page.getByText('Share the document')).toBeVisible();

    await expect(page.getByPlaceholder('Type a name or email')).toBeHidden();

    const invitationCard = shareModal.getByLabel('List invitation card');
    await expect(invitationCard).toBeVisible();
    await expect(
      invitationCard.getByText('test.test@invitation.test').first(),
    ).toBeVisible();
    await expect(invitationCard.getByLabel('Document role text')).toBeVisible();
    await expect(
      invitationCard.getByRole('button', { name: 'more_horiz' }),
    ).toBeHidden();

    const memberCard = shareModal.getByLabel('List members card');
    await expect(memberCard.getByText('test.test@accesses.test')).toBeVisible();
    await expect(memberCard.getByLabel('Document role text')).toBeVisible();
    await expect(
      memberCard.getByRole('button', { name: 'more_horiz' }),
    ).toBeHidden();
  });

  test('It checks the copy as Markdown button', async ({
    page,
    browserName,
  }) => {
    test.skip(
      browserName === 'webkit',
      'navigator.clipboard is not working with webkit and playwright',
    );

    // create page and navigate to it
    await page
      .getByRole('button', {
        name: 'New doc',
      })
      .click();

    // Add dummy content to the doc
    const editor = page.locator('.ProseMirror');
    const docFirstBlock = editor.locator('.bn-block-content').first();
    await docFirstBlock.click();
    await page.keyboard.type('# Hello World', { delay: 100 });
    const docFirstBlockContent = docFirstBlock.locator('h1');
    await expect(docFirstBlockContent).toHaveText('Hello World');

    // Copy content to clipboard
    await page.getByLabel('Open the document options').click();
    await page.getByLabel('Copy as Markdown').click();
    await expect(page.getByText('Copied to clipboard')).toBeVisible();

    // Test that clipboard is in Markdown format
    const handle = await page.evaluateHandle(() =>
      navigator.clipboard.readText(),
    );
    const clipboardContent = await handle.jsonValue();
    expect(clipboardContent.trim()).toBe('# Hello World');
  });

  test('It checks the copy as HTML button', async ({ page, browserName }) => {
    test.skip(
      browserName === 'webkit',
      'navigator.clipboard is not working with webkit and playwright',
    );

    // create page and navigate to it
    await page
      .getByRole('button', {
        name: 'New doc',
      })
      .click();

    // Add dummy content to the doc
    const editor = page.locator('.ProseMirror');
    const docFirstBlock = editor.locator('.bn-block-content').first();
    await docFirstBlock.click();
    await page.keyboard.type('# Hello World', { delay: 100 });
    const docFirstBlockContent = docFirstBlock.locator('h1');
    await expect(docFirstBlockContent).toHaveText('Hello World');

    // Copy content to clipboard
    await page.getByLabel('Open the document options').click();
    await page.getByLabel('Copy as HTML').click();
    await expect(page.getByText('Copied to clipboard')).toBeVisible();

    // Test that clipboard is in HTML format
    const handle = await page.evaluateHandle(() =>
      navigator.clipboard.readText(),
    );
    const clipboardContent = await handle.jsonValue();
    expect(clipboardContent.trim()).toBe(`<h1>Hello World</h1><p></p>`);
  });

  test('it checks the copy link button', async ({ page, browserName }) => {
    test.skip(
      browserName === 'webkit',
      'navigator.clipboard is not working with webkit and playwright',
    );
    await mockedDocument(page, {
      abilities: {
        destroy: false, // Means owner
        link_configuration: true,
        versions_destroy: true,
        versions_list: true,
        versions_retrieve: true,
        accesses_manage: false,
        accesses_view: false,
        update: true,
        partial_update: true,
        retrieve: true,
      },
    });

    await goToGridDoc(page);

    const shareButton = page.getByRole('button', {
      name: 'Share',
      exact: true,
    });
    await expect(shareButton).toBeVisible();

    await shareButton.click();
    await page.getByRole('button', { name: 'Copy link' }).click();
    await expect(page.getByText('Link Copied !')).toBeVisible();

    const handle = await page.evaluateHandle(() =>
      navigator.clipboard.readText(),
    );
    const clipboardContent = await handle.jsonValue();

    const origin = await page.evaluate(() => window.location.origin);
    expect(clipboardContent.trim()).toMatch(
      `${origin}/docs/mocked-document-id/`,
    );
  });

  test('it pins a document', async ({ page, browserName }) => {
    const [docTitle] = await createDoc(page, `Pin doc`, browserName);

    await page.getByLabel('Open the document options').click();

    // Pin
    await page.getByText('push_pin').click();
    await page
      .getByRole('button', { name: 'Open the document options' })
      .click();
    await expect(page.getByText('Unpin')).toBeVisible();

    await page.goto('/');

    const row = await getGridRow(page, docTitle);

    // Check is pinned
    await expect(row.locator('[data-testid^="doc-pinned-"]')).toBeVisible();
    const leftPanelFavorites = page.getByTestId('left-panel-favorites');
    await expect(leftPanelFavorites.getByText(docTitle)).toBeVisible();

    await row.getByText(docTitle).click();
    await page.getByLabel('Open the document options').click();

    // Unpin
    await page.getByText('Unpin').click();
    await page.getByLabel('Open the document options').click();
    await expect(page.getByText('push_pin')).toBeVisible();

    await page.goto('/');

    // Check is unpinned
    await expect(row.locator('[data-testid^="doc-pinned-"]')).toBeHidden();
    await expect(leftPanelFavorites.getByText(docTitle)).toBeHidden();
  });

  test('it duplicates a document', async ({ page, browserName }) => {
    const [docTitle] = await createDoc(page, `Duplicate doc`, browserName);

    const editor = page.locator('.ProseMirror');
    await editor.click();
    await editor.fill('Hello Duplicated World');

    await page.getByLabel('Open the document options').click();

    await page.getByRole('menuitem', { name: 'Duplicate' }).click();
    await expect(
      page.getByText('Document duplicated successfully!'),
    ).toBeVisible();

    const duplicateTitle = 'Copy of ' + docTitle;
    await verifyDocName(page, duplicateTitle);

    await page.goto('/');

    const row = await getGridRow(page, duplicateTitle);

    await expect(row.getByText(duplicateTitle)).toBeVisible();

    await row.getByText(`more_horiz`).click();
    await page.getByRole('menuitem', { name: 'Duplicate' }).click();
    const duplicateDuplicateTitle = 'Copy of ' + duplicateTitle;
    await page.getByText(duplicateDuplicateTitle).click();
    await expect(page.getByText('Hello Duplicated World')).toBeVisible();
  });

  test('it duplicates a child document', async ({ page, browserName }) => {
    await createDoc(page, `Duplicate doc`, browserName);

    const { name: childTitle } = await createRootSubPage(
      page,
      browserName,
      'Duplicate doc - child',
    );

    const editor = page.locator('.ProseMirror');
    await editor.click();
    await editor.fill('Hello Duplicated World');

    const duplicateTitle = 'Copy of ' + childTitle;
    const docTree = page.getByTestId('doc-tree');

    const child = docTree
      .getByRole('treeitem')
      .locator('.--docs-sub-page-item')
      .filter({
        hasText: childTitle,
      });
    await child.hover();
    await child.getByText(`more_horiz`).click();

    await page.getByRole('menuitem', { name: 'Duplicate' }).click();

    await verifyDocName(page, duplicateTitle);

    await expect(
      page.getByTestId('doc-tree').getByText(duplicateTitle),
    ).toBeVisible();
  });
});

test.describe('Documents Header mobile', () => {
  test.use({ viewport: { width: 500, height: 1200 } });

  test.beforeEach(async ({ page }) => {
    await page.goto('/');
  });

  test('it checks the copy link button is displayed', async ({ page }) => {
    await mockedDocument(page, {
      abilities: {
        destroy: false,
        link_configuration: true,
        versions_destroy: true,
        versions_list: true,
        versions_retrieve: true,
        accesses_manage: false,
        accesses_view: false,
        update: true,
        partial_update: true,
        retrieve: true,
      },
    });

    await goToGridDoc(page);

    await expect(page.getByRole('button', { name: 'Copy link' })).toBeHidden();
    await page.getByLabel('Open the document options').click();
    await expect(
      page.getByRole('menuitem', { name: 'Copy link' }),
    ).toBeVisible();
    await page.getByLabel('Share').click();
    await expect(page.getByRole('button', { name: 'Copy link' })).toBeVisible();
  });

  test('it checks the close button on Share modal', async ({ page }) => {
    await mockedDocument(page, {
      abilities: {
        destroy: true, // Means owner
        link_configuration: true,
        versions_destroy: true,
        versions_list: true,
        versions_retrieve: true,
        accesses_manage: true,
        accesses_view: true,
        update: true,
        partial_update: true,
        retrieve: true,
      },
    });

    await goToGridDoc(page);

    await page.getByLabel('Open the document options').click();
    await page.getByLabel('Share').click();

    const shareModal = page.getByRole('dialog', {
      name: 'Share modal content',
    });
    await expect(shareModal).toBeVisible();
    await page.getByRole('button', { name: 'close' }).click();
    await expect(page.getByLabel('Share modal')).toBeHidden();
  });
});