Merge pull request #175 from Progi1984/boFeatureFlagPage

Migrate `@pages/BO/advancedParameters/featureFlag` from Core

Author: Progi1984

src/index.ts

@@ -209,6 +209,7 @@ export {default as boDesignEmailThemesPreviewPage} from '@pages/BO/design/emailT
 export {default as boDesignPositionsPage} from '@pages/BO/design/positions';
 export {default as boDesignPositionsHookModulePage} from '@pages/BO/design/positions/hookModule';
 export {default as boEmailPage} from '@pages/BO/advancedParameters/email';
+export {default as boFeatureFlagPage} from '@pages/BO/advancedParameters/featureFlag';
 export {default as boInformationPage} from '@pages/BO/advancedParameters/information';
 export {default as boLanguagesPage} from '@pages/BO/international/languages';
 export {default as boLanguagesCreatePage} from '@pages/BO/international/languages/create';

src/interfaces/BO/advancedParameters/featureFlag.ts

@@ -0,0 +1,9 @@
+import {type BOBasePagePageInterface} from '@interfaces/BO';
+import {type Page} from '@playwright/test';
+
+export interface BOFeatureFlagInterface extends BOBasePagePageInterface {
+  readonly featureFlagAdminAPI: string;
+  readonly pageTitle: string;
+
+  setFeatureFlag(page: Page, featureFlag: string, toEnable?: boolean): Promise<string>;
+}

src/pages/BO/advancedParameters/featureFlag.ts

@@ -0,0 +1,9 @@
+import {type BOFeatureFlagInterface} from '@interfaces/BO/advancedParameters/featureFlag';
+
+/* eslint-disable global-require, @typescript-eslint/no-var-requires */
+function requirePage(): BOFeatureFlagInterface {
+  return require('@versions/develop/pages/BO/advancedParameters/featureFlag');
+}
+/* eslint-enable global-require, @typescript-eslint/no-var-requires */
+
+export default requirePage();

src/versions/develop/pages/BO/advancedParameters/featureFlag.ts

@@ -0,0 +1,85 @@
+import {type BOFeatureFlagInterface} from '@interfaces/BO/advancedParameters/featureFlag';
+import BOBasePage from '@pages/BO/BOBasePage';
+import {type Page} from '@playwright/test';
+
+/**
+ * Feature flag page, contains functions that can be used on the page
+ * @class
+ * @extends BOBasePage
+ */
+class BOFeatureFlag extends BOBasePage implements BOFeatureFlagInterface {
+  public readonly pageTitle: string;
+
+  public readonly featureFlagAdminAPI: string;
+
+  private readonly featureFlagSwitchButton: (status: string, feature: string, toggle: number) => string;
+
+  private readonly submitButton: (status: string) => string;
+
+  private readonly alertSuccess: string;
+
+  private readonly modalSubmitFeatureFlag: string;
+
+  private readonly enableExperimentalFeatureButton: string;
+
+  /**
+   * @constructs
+   * Setting up texts and selectors to use on import page
+   */
+  constructor() {
+    super();
+
+    this.pageTitle = `New & experimental features • ${global.INSTALL.SHOP_NAME}`;
+    this.successfulUpdateMessage = 'Update successful';
+
+    // Feature Flag
+    this.featureFlagAdminAPI = 'admin_api';
+    // Selectors
+    this.featureFlagSwitchButton = (status: string, feature: string, toggle: number) => `#feature_flag_${
+      status}_feature_flags_${feature}_enabled_${toggle}`;
+    this.submitButton = (status: string) => `#feature_flag_${status}_submit`;
+    this.alertSuccess = 'div.alert.alert-success[role="alert"]';
+    this.modalSubmitFeatureFlag = '#modal-confirm-submit-feature-flag';
+    this.enableExperimentalFeatureButton = `${this.modalSubmitFeatureFlag} button.btn-confirm-submit`;
+  }
+
+  /**
+   * Enable/Disable feature flag
+   * @param page {Page} Browser tab
+   * @param featureFlag {string}
+   * @param toEnable {boolean} True if we need to enable new product page
+   * @returns {Promise<string>}
+   */
+  async setFeatureFlag(page: Page, featureFlag: string, toEnable: boolean = true): Promise<string> {
+    let isStable: boolean;
+
+    switch (featureFlag) {
+      case this.featureFlagAdminAPI:
+        isStable = false;
+        break;
+      default:
+        throw new Error(`The feature flag ${featureFlag} is not defined`);
+    }
+
+    const selector: string = this.featureFlagSwitchButton(isStable ? 'stable' : 'beta', featureFlag, toEnable ? 1 : 0);
+
+    const isChecked = await this.isChecked(page, selector);
+
+    if (isChecked) {
+      // Return the successful message to simulate all went good (no need to change the value here)
+      return this.successfulUpdateMessage;
+    }
+
+    await this.setChecked(page, selector);
+    await this.waitForSelectorAndClick(page, this.submitButton(isStable ? 'stable' : 'beta'));
+    // The confirmation modal is only displayed for experimental/beta feature flags
+    if (toEnable && !isStable) {
+      await this.waitForVisibleSelector(page, this.modalSubmitFeatureFlag);
+      await this.clickAndWaitForLoadState(page, this.enableExperimentalFeatureButton);
+    }
+
+    return this.getTextContent(page, this.alertSuccess, true);
+  }
+}
+
+module.exports = new BOFeatureFlag();