nocodb/scripts/playwright/pages/Base.ts

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

type ResponseSelector = (json: any) => boolean;

export default abstract class BasePage {
  readonly rootPage: Page;

  abstract get(args?: any): Locator;

  constructor(rootPage: Page) {
    this.rootPage = rootPage;
  }

  async toastWait({ message }: { message: string }) {
    // todo: text of toaster shows old one in the test assertion
    await this.rootPage
      .locator(".ant-message .ant-message-notice-content", { hasText: message })
      .last()
      .textContent()
      .then((text) => expect(text).toContain(message));

    // await this.rootPage
    //   .locator(".ant-message .ant-message-notice-content", { hasText: message })
    //   .last()
    //   .waitFor({ state: "detached" });
  }

  async waitForResponse({
    uiAction,
    httpMethodsToMatch = [],
    requestUrlPathToMatch,
    responseJsonMatcher,
  }: {
    uiAction: Promise<any>;
    requestUrlPathToMatch: string;
    httpMethodsToMatch?: string[];
    responseJsonMatcher?: ResponseSelector;
  }) {
    await Promise.all([
      this.rootPage.waitForResponse(async (res) => {
        let isResJsonMatched = true;
        if(responseJsonMatcher){
          try {
            isResJsonMatched = responseJsonMatcher(await res.json());
          } catch (e) {
            return false;
          }
        }

        return (
          res.request().url().includes(requestUrlPathToMatch) &&
          httpMethodsToMatch.includes(res.request().method()) &&
          isResJsonMatched
          );
      }),
      uiAction,
    ]);
  }

  async attachFile({filePickUIAction, filePath}:{ filePickUIAction: Promise<any>, filePath: string}) {
    const [fileChooser] = await Promise.all([
      // It is important to call waitForEvent before click to set up waiting.
      this.rootPage.waitForEvent('filechooser'),
      // Opens the file chooser.
      filePickUIAction,
    ]);
    await fileChooser.setFiles(filePath);
  }

  async downloadAndGetFile({downloadUIAction}:{ downloadUIAction: Promise<any>,}) {
    const [ download ] = await Promise.all([
      // It is important to call waitForEvent before click to set up waiting.
      this.rootPage.waitForEvent('download'),
      // Triggers the download.
      downloadUIAction,
    ]);
    // wait for download to complete
    if(await download.failure()) {
      throw new Error('Download failed');
    }
    
    const file = await download.createReadStream();
    const data = await new Promise((resolve, reject) => {
      let data = '';
      file?.on('data', chunk => data += chunk);
      file?.on('end', () => resolve(data));
      file?.on('error', reject);
    });
    return data as any;
  }
}