notesnook/apps/web/__e2e__/models/base-view.model.ts

/*
This file is part of the Notesnook project (https://notesnook.com/)

Copyright (C) 2023 Streetwriters (Private) Limited

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

import { Locator, Page } from "@playwright/test";
import { getTestId } from "../utils";
import { iterateList } from "./utils";
import { ContextMenuModel } from "./context-menu.model";
import { SortOptions } from "./types";

export class BaseViewModel {
  protected readonly page: Page;
  protected readonly list: Locator;
  private readonly listPlaceholder: Locator;
  private readonly sortByButton: Locator;

  constructor(page: Page, pageId: string, listType: string) {
    this.page = page;
    this.list = page.locator(`#${pageId} >> ${getTestId(`${listType}-list`)}`);
    this.listPlaceholder = page.locator(
      `#${pageId} >> ${getTestId("list-placeholder")}`
    );

    this.sortByButton = this.page.locator(
      // TODO:
      getTestId(`${pageId === "notebook" ? "notes" : pageId}-sort-button`)
    );
  }

  async findGroup(groupName: string) {
    const locator = this.list.locator(
      `${getTestId(`virtuoso-item-list`)} >> ${getTestId("group-header")}`
    );

    for await (const item of iterateList(locator)) {
      if ((await item.locator(getTestId("title")).textContent()) === groupName)
        return item;
    }
    return undefined;
  }

  protected async *iterateItems() {
    await this.waitForList();
    const locator = this.list.locator(
      `${getTestId(`virtuoso-item-list`)} >> ${getTestId("list-item")}`
    );

    for await (const _item of iterateList(locator)) {
      const id = await _item.getAttribute("id");
      if (!id) return;

      yield this.list.locator(`#${id}`);
    }
    return undefined;
  }

  async waitForItem(title: string) {
    await this.list.locator(getTestId("title"), { hasText: title }).waitFor();
  }

  async waitForList() {
    try {
      await this.listPlaceholder.waitFor({ timeout: 1000 });
    } catch {
      await this.list.waitFor();
    }
  }

  async focus() {
    const items = this.list.locator(
      `${getTestId(`virtuoso-item-list`)} >> ${getTestId("list-item")}`
    );
    await items.nth(0).click();
    await items.nth(0).click();
  }

  // async selectAll() {
  //   await this.press("Control+a");
  // }

  // async selectNext() {
  //   await this.press("ArrowDown");
  // }

  async press(key: string) {
    const itemList = this.list.locator(getTestId(`virtuoso-item-list`));
    await itemList.press(key);
    await this.page.waitForTimeout(300);
  }

  async sort(sort: SortOptions) {
    const contextMenu: ContextMenuModel = new ContextMenuModel(this.page);

    if (sort.groupBy) {
      await contextMenu.open(this.sortByButton, "left");
      await contextMenu.clickOnItem("groupBy");
      if (!(await contextMenu.hasItem(sort.groupBy))) {
        await contextMenu.close();
        return false;
      }
      await contextMenu.clickOnItem(sort.groupBy);
    }

    await contextMenu.open(this.sortByButton, "left");
    await contextMenu.clickOnItem("sortDirection");
    if (!(await contextMenu.hasItem(sort.orderBy))) {
      await contextMenu.close();
      return false;
    }
    await contextMenu.clickOnItem(sort.orderBy);

    await contextMenu.open(this.sortByButton, "left");
    await contextMenu.clickOnItem("sortBy");
    if (!(await contextMenu.hasItem(sort.sortBy))) {
      await contextMenu.close();
      return false;
    }
    await contextMenu.clickOnItem(sort.sortBy);

    return true;
  }

  async isEmpty() {
    const items = this.list.locator(
      `${getTestId(`virtuoso-item-list`)} >> ${getTestId("list-item")}`
    );
    const totalItems = await items.count();
    return totalItems <= 0;
  }
}