utils-common.ts

import fs from 'fs';
import path from 'path';

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

import theme_customization from '../../../../../backend/impress/configuration/theme/default.json';
import { version as packageJsonVersion } from '../../package.json';

export type BrowserName = 'chromium' | 'firefox' | 'webkit';
export const BROWSERS: BrowserName[] = ['chromium', 'webkit', 'firefox'];

export const CONFIG = {
  AI_BOT: {
    name: 'Docs AI',
    color: '#8bc6ff',
  },
  AI_FEATURE_ENABLED: false,
  AI_FEATURE_BLOCKNOTE_ENABLED: false,
  AI_FEATURE_LEGACY_ENABLED: true,
  API_USERS_SEARCH_QUERY_MIN_LENGTH: 3,
  COLLABORATION_WS_INACTIVITY_TIMEOUT: 15,
  COLLABORATION_WS_URL: process.env.COLLABORATION_WS_URL,
  COLLABORATION_WS_NOT_CONNECTED_READ_ONLY: true,
  CONVERSION_UPLOAD_ENABLED: true,
  CONVERSION_FILE_EXTENSIONS_ALLOWED: ['.docx', '.md'],
  CONVERSION_FILE_MAX_SIZE: 20971520,
  ENVIRONMENT: 'development',
  FRONTEND_EMBED_BLOCK_ENABLED: true,
  FRONTEND_EMBED_BLOCK_ALLOWED_ORIGINS: {
    '*': 'allow-scripts allow-same-origin allow-popups allow-popups-to-escape-sandbox allow-forms',
  },
  FRONTEND_CSS_URL: null,
  FRONTEND_JS_URL: null,
  FRONTEND_HOMEPAGE_FEATURE_ENABLED: true,
  FRONTEND_SILENT_LOGIN_ENABLED: false,
  FRONTEND_THEME: null,
  MEDIA_BASE_URL: process.env.MEDIA_BASE_URL,
  LANGUAGES: [
    ['en-us', 'English'],
    ['fr-fr', 'Français'],
    ['de-de', 'Deutsch'],
    ['nl-nl', 'Nederlands'],
    ['es-es', 'Español'],
  ],
  LANGUAGE_CODE: 'en-us',
  POSTHOG_HOST: 'https://eu.i.posthog.com',
  POSTHOG_KEY: null,
  REACTIONS_MAX_PER_COMMENT: 15,
  RELEASE_VERSION: packageJsonVersion,
  SENTRY_DSN: null,
  TRASHBIN_CUTOFF_DAYS: 30,
  theme_customization,
} as const;

export const overrideConfig = async (
  page: Page,
  newConfig: { [_K in keyof typeof CONFIG]?: unknown },
) =>
  await page.route(/.*\/api\/v1.0\/config\/.*/, async (route) => {
    const request = route.request();
    if (request.method().includes('GET')) {
      await route.fulfill({
        json: {
          ...CONFIG,
          ...newConfig,
        },
      });
    } else {
      await route.continue();
    }
  });

export const getCurrentConfig = async (page: Page) => {
  const responsePromise = page.waitForResponse(
    (response) =>
      response.url().includes('/config/') && response.status() === 200,
  );

  await page.goto('/');

  const response = await responsePromise;
  expect(response.ok()).toBeTruthy();

  return (await response.json()) as typeof CONFIG;
};

export const getOtherBrowserName = (browserName: BrowserName) => {
  const otherBrowserName = BROWSERS.find((b) => b !== browserName);
  if (!otherBrowserName) {
    throw new Error('No alternative browser found');
  }
  return otherBrowserName;
};

export const randomName = (name: string, browserName: string, length: number) =>
  Array.from({ length }, (_el, index) => {
    return `${browserName}-${Math.floor(Math.random() * 10000)}-${index}-${name}`;
  });

export const openHeaderMenu = async (page: Page) => {
  const toggleButton = page.getByTestId('floating-bar-toggle-left-panel');
  await expect(toggleButton).toBeVisible();

  const isExpanded =
    (await toggleButton.getAttribute('aria-expanded')) === 'true';
  if (!isExpanded) {
    await toggleButton.click();
  }
};

export const closeHeaderMenu = async (page: Page, isMobile = false) => {
  if (isMobile) {
    const closeButton = page.getByRole('button', { name: 'Close left panel' });
    await expect(closeButton).toBeVisible();
    await closeButton.click();

    return;
  }

  const toggleButton = page.getByTestId('floating-bar-toggle-left-panel');
  await expect(toggleButton).toBeVisible();

  const isExpanded =
    (await toggleButton.getAttribute('aria-expanded')) === 'true';
  if (isExpanded) {
    await toggleButton.click();
  }
};

export const createDoc = async (
  page: Page,
  docName: string,
  browserName: string,
  length = 1,
  isMobile = false,
) => {
  const randomDocs = randomName(docName, browserName, length);

  for (let i = 0; i < randomDocs.length; i++) {
    if (isMobile) {
      await openHeaderMenu(page);
    }

    const responsePromiseCreateDoc = page.waitForResponse(
      (response) =>
        response.url().includes('/api/v1.0/documents/') &&
        response.status() === 201 &&
        response.request().method() === 'POST',
    );

    await page
      .getByRole('link', {
        name: 'New',
        exact: true,
      })
      .click();

    await page.waitForURL('**/docs/**', {
      timeout: 10000,
      waitUntil: 'networkidle',
    });

    const responseCreateDoc = await responsePromiseCreateDoc;
    expect(responseCreateDoc.ok()).toBeTruthy();
    const { id: docId } = (await responseCreateDoc.json()) as { id: string };

    const responsePromiseUpdateDoc = page.waitForResponse(
      (response) =>
        response.url().includes(`/api/v1.0/documents/${docId}`) &&
        response.status() === 200 &&
        response.request().method() === 'PATCH',
    );

    const input = page.getByLabel('Document title');
    await expect(input).toBeVisible({
      timeout: 10000,
    });
    await expect(input).toHaveText('', {
      timeout: 10000,
    });

    await input.fill(randomDocs[i]);
    void input.blur();

    const responseUpdateDoc = await responsePromiseUpdateDoc;
    expect(responseUpdateDoc.ok()).toBeTruthy();
  }

  return randomDocs;
};

export const verifyDocName = async (page: Page, docName: string) => {
  const card = page.getByLabel(
    'It is the card information about the document.',
  );
  await expect(card).toBeVisible({
    timeout: 10000,
  });

  await expect(card).toHaveText(new RegExp(docName), {
    timeout: 10000,
  });
};

export const getGridRow = async (page: Page, title: string) => {
  const docsGrid = page.getByTestId('docs-grid');
  await expect(docsGrid).toBeVisible();
  await expect(page.getByTestId('grid-loader')).toBeHidden();

  const rows = docsGrid.getByRole('listitem');

  const row = rows
    .filter({
      hasText: title,
    })
    .first();

  await expect(row).toBeVisible();

  return row;
};

interface GoToGridDocOptions {
  nthRow?: number;
  title?: string;
}
export const goToGridDoc = async (
  page: Page,
  { nthRow = 1, title }: GoToGridDocOptions = {},
) => {
  if (
    await page.getByRole('button', { name: 'Back to homepage' }).isVisible()
  ) {
    await page.getByRole('button', { name: 'Back to homepage' }).click();
  }

  const docsGrid = page.getByTestId('docs-grid');
  await expect(docsGrid).toBeVisible();
  await expect(page.getByTestId('grid-loader')).toBeHidden();

  const rows = docsGrid.getByRole('listitem');

  const row = title
    ? rows.filter({
        hasText: title,
      })
    : rows.nth(nthRow);

  await expect(row).toBeVisible();

  const docTitleContent = row.getByTestId('doc-title').first();
  const docTitle = await docTitleContent.textContent();
  expect(docTitle).toBeDefined();

  await row.getByRole('link').first().click();

  return docTitle as string;
};

export const updateDocTitle = async (page: Page, title: string) => {
  const input = page.getByRole('textbox', { name: 'Document title' });
  await expect(input).toHaveText('');
  await expect(input).toBeVisible();
  await input.fill(title, {
    force: true,
  });
  await input.blur();
  await verifyDocName(page, title);
};

export const waitForResponseCreateDoc = (page: Page) => {
  return page.waitForResponse(
    (response) =>
      response.url().includes('/documents/') &&
      response.url().includes('/children/') &&
      response.request().method() === 'POST',
  );
};

/**
 * Navigates back to the homepage, waits for the PATCH /content/ request
 * triggered by the route change to complete, then navigates back to the doc.
 *
 * Use this instead of goToGridDoc when the test must assert on content that
 * was just written in the editor, to avoid a race condition where the GET
 * request fired on doc mount returns stale data because the server has not
 * yet processed the PATCH.
 */
export const saveContent = async (page: Page, title: string) => {
  const savePromise = page.waitForResponse(
    (response) =>
      response.url().includes('/content/') &&
      response.request().method() === 'PATCH',
  );

  await page.getByRole('button', { name: 'Back to homepage' }).click();
  await expect(page.getByTestId('docs-grid')).toBeVisible();
  await expect(page.getByTestId('grid-loader')).toBeHidden();

  await savePromise;

  await goToGridDoc(page, { title });
};

export const mockedDocument = async (page: Page, data: object) => {
  // document/[ID]/ or document/[ID]/tree/ routes
  let uuid: string | undefined;
  await page.route(/.*\/documents\/[^/]+\/(?:$|tree\/.*)/, async (route) => {
    const request = route.request();
    if (request.method().includes('GET') && !request.url().includes('page=')) {
      uuid = request.url().match(/\/documents\/([^/]+)\//)?.[1];
      const { abilities, ...doc } = data as unknown as {
        abilities?: Record<string, unknown>;
      };
      await route.fulfill({
        json: {
          id: uuid,
          title: 'Mocked document',
          path: '000000',
          abilities: {
            destroy: false, // Means not owner
            link_configuration: false,
            versions_destroy: false,
            versions_list: true,
            versions_retrieve: true,
            accesses_manage: false, // Means not admin
            update: false,
            partial_update: false, // Means not editor
            retrieve: true,
            link_select_options: {
              public: ['reader', 'editor'],
              authenticated: ['reader', 'editor'],
              restricted: null,
            },
            ...abilities,
          },
          link_reach: 'restricted',
          computed_link_reach: 'restricted',
          computed_link_role: 'reader',
          ancestors_link_reach: null,
          ancestors_link_role: null,
          created_at: '2021-09-01T09:00:00Z',
          user_role: 'owner',
          ...doc,
        },
      });
    } else {
      await route.continue();
    }
  });

  await page.route(/.*\/documents\/[^/]+\/content\/$/, async (route) => {
    const request = route.request();
    if (request.method().includes('GET')) {
      await route.fulfill({
        body: '',
      });
    } else {
      await route.continue();
    }
  });

  return uuid;
};

export const mockedListDocs = async (page: Page, data: object[] = []) => {
  await page.route(/\**\/documents\/\**/, async (route) => {
    const request = route.request();
    if (request.method().includes('GET') && request.url().includes('page=')) {
      await route.fulfill({
        json: {
          count: data.length,
          next: null,
          previous: null,
          results: data,
        },
      });
    }
  });
};

// language helper
export const TestLanguage = {
  English: {
    label: 'English',
    expectedLocale: ['en-us'],
  },
  French: {
    label: 'Français',
    expectedLocale: ['fr-fr'],
  },
  German: {
    label: 'Deutsch',
    expectedLocale: ['de-de'],
  },
  Swedish: {
    label: 'Svenska',
    expectedLocale: ['sv-se'],
  },
} as const;

type TestLanguageKey = keyof typeof TestLanguage;
type TestLanguageValue = (typeof TestLanguage)[TestLanguageKey];

export async function waitForLanguageSwitch(
  page: Page,
  lang: TestLanguageValue,
  labelUserMenu = 'User menu',
  withMocking = true,
) {
  await page.route(/\**\/api\/v1.0\/users\/\**/, async (route, request) => {
    if (request.method().includes('PATCH') && withMocking) {
      await route.fulfill({
        json: {
          language: lang.expectedLocale[0],
        },
      });
    } else {
      await route.continue();
    }
  });

  await page.getByLabel(labelUserMenu).click();
  const languagePicker = page.getByRole('button', { name: /Language/ });
  const isAlreadyTargetLanguage = await languagePicker
    .innerText()
    .then((text) => text.toLowerCase().includes(lang.label.toLowerCase()));

  if (isAlreadyTargetLanguage) {
    await page.keyboard.press('Escape');
    return;
  }

  await languagePicker.click();

  await page.getByRole('menuitem', { name: lang.label }).click();
  await page.keyboard.press('Escape');
}

export const clickInEditorShareButton = async (page: Page) => {
  await page
    .getByTestId('floating-bar')
    .getByRole('button', { name: 'Share' })
    .click();
};

export const clickInEditorMenu = async (page: Page, textButton: string) => {
  await page
    .getByTestId('floating-bar')
    .getByRole('button', { name: 'Open the document options' })
    .click();
  await page.getByRole('menuitem', { name: textButton }).click();
};

export const clickInGridMenu = async (
  page: Page,
  row: Locator,
  textButton: string,
) => {
  await row
    .getByRole('button', { name: /Open the menu of actions for the document/ })
    .click();
  await page.getByRole('menuitem', { name: textButton }).click();
};

export const writeReport = async (
  testInfo: TestInfo,
  filename: string,
  attachName: string,
  buffer: Buffer,
  contentType: string,
) => {
  const REPORT_DIRNAME = 'extra-report';
  const REPORT_NAME = 'test-results';
  const outDir = testInfo
    ? path.join(testInfo.outputDir, REPORT_DIRNAME, path.parse(filename).name)
    : path.join(
        process.cwd(),
        REPORT_NAME,
        REPORT_DIRNAME,
        path.parse(filename).name,
      );

  fs.mkdirSync(outDir, { recursive: true });
  const pathToFile = path.join(outDir, filename);
  fs.writeFileSync(pathToFile, buffer);
  await testInfo.attach(attachName, {
    path: pathToFile,
    contentType: contentType,
  });
};