extended-page-object.ts

extended-page-object.ts

// ./objects/base/page-object-base.ts
export interface IComponentObject {
  [key: string]: any;
  isRendered(): Promise<any>;
}

export abstract class PageObjectBase {
  // the root element for the page, for example: dashboard-page
  element: string;
  // all registered features and UI components (instances of Component Object)
  // example: this.features = [new BankAccount(), new Navigation()]
  features: IComponentObject[];
  // url for the page
  url: string;
  // used runtime to add Promises to waitUntilRendered
  // possible use case: need to fetch/post data before kicking of tests
  pageRenderRequirements: (() => Promise<any>)[] = [];

  verifyRenderRequirements() {
    if (this.features.length === 0 && this.pageRenderRequirements.length === 0) {
      return Promise.reject(`${this.element} has no registered features or page render requirements`);
    }
  }

  async waitUntilRendered(options = { skipComponents: [] }): Promise<any> {
    try {
      // skipComponent can runtime exclude components
      const skipComponents = options.skipComponents;
      await this.verifyRenderRequirements();

      const promises = [
        ...this.pageRenderRequirements,
        ...this.features
          .filter(feature => !skipComponents.includes(feature.componentName))
          .map(feature => feature.render),
      ];

      return Promise.all(promises);
    } catch (e) {
      return Promise.reject(e);
    }
  }
}