test: lw-12256 add tests for debugging switch (#1730)

ljagiela · web-flow · commit 9984e61090af · 2025-02-21T17:10:03.000+01:00
* test: lw-12256 add tests for debugging switch

* test: update test steps
diff --git a/packages/e2e-tests/src/assert/consoleAssert.ts b/packages/e2e-tests/src/assert/consoleAssert.ts
@@ -7,5 +7,15 @@ class ConsoleAssert {
     const errors: ConsoleLogEntry[] = logs.filter((log) => log.level === 'error');
     expect(errors).is.empty;
   };
+
+  assertLogsAreCollected = async (shouldBeCollected: boolean) => {
+    await browser.pause(1000); // some delay to let logs populate
+    const logs: ConsoleLogEntry[] = await consoleManager.getLogs();
+    if (shouldBeCollected) {
+      expect(logs.length).to.be.greaterThan(10);
+    } else {
+      expect(logs).is.empty;
+    }
+  };
 }
 export default new ConsoleAssert();
diff --git a/packages/e2e-tests/src/assert/settings/SettingsPageAssert.ts b/packages/e2e-tests/src/assert/settings/SettingsPageAssert.ts
@@ -41,9 +41,11 @@ class SettingsPageAssert {
     expect(await SettingsPage.showRecoveryPhraseLink.getTitleText()).to.equal(
       await t('browserView.settings.security.showPassphrase.title')
     );
-    expect(await SettingsPage.generatePaperWallet.getTitleText()).to.equal(
-      await t('browserView.settings.generatePaperWallet.title')
-    );
+    if (!popupView) {
+      expect(await SettingsPage.generatePaperWallet.getTitleText()).to.equal(
+        await t('browserView.settings.generatePaperWallet.title')
+      );
+    }
     // TODO: temporarily disabled due to LW-2907
     // expect(await SettingsPage.passphraseVerificationLink.getTitleText()).to.equal(
     //   await t('browserView.settings.security.passphrasePeriodicVerification.title')
@@ -101,9 +103,11 @@ class SettingsPageAssert {
     expect(await SettingsPage.showRecoveryPhraseLink.getDescriptionText()).to.equal(
       await t('browserView.settings.security.showPassphrase.description')
     );
-    expect(await SettingsPage.generatePaperWallet.getDescriptionText()).to.equal(
-      await t('browserView.settings.generatePaperWallet.description')
-    );
+    if (!popupView) {
+      expect(await SettingsPage.generatePaperWallet.getDescriptionText()).to.equal(
+        await t('browserView.settings.generatePaperWallet.description')
+      );
+    }
     // TODO: temporarily disabled due to LW-2907
     // expect(await SettingsPage.passphraseVerificationLink.getDescriptionText()).to.equal(
     //   await t('browserView.settings.security.passphrasePeriodicVerification.description')
diff --git a/packages/e2e-tests/src/features/ForgotPassword.feature b/packages/e2e-tests/src/features/ForgotPassword.feature
@@ -121,4 +121,4 @@ Feature: Forgot password
     Then header menu displays "TestAutomationWallet" as a wallet name
     When I close header menu
     And I navigate to Settings extended page
-    Then Analytics toggle is enabled: false
+    Then Analytics toggle is not enabled
diff --git a/packages/e2e-tests/src/features/OnboardingCreateWallet.part2.feature b/packages/e2e-tests/src/features/OnboardingCreateWallet.part2.feature
@@ -45,7 +45,7 @@ Feature: Onboarding - Create wallet
     And I see LW homepage
     And "N_8J@bne87A" password is not in snapshot
     And I open settings from header menu
-    Then Analytics toggle is enabled: true
+    Then Analytics toggle is enabled
     When I open settings from header menu
     And I click on Remove wallet button
     And I click "Remove wallet" button on "Remove wallet" modal
@@ -57,7 +57,7 @@ Feature: Onboarding - Create wallet
     When I click "Enter wallet" button
     And I see LW homepage
     And I open settings from header menu
-    Then Analytics toggle is enabled: false
+    Then Analytics toggle is not enabled
 
   @LW-2627
   Scenario: Create Wallet - autofill words
diff --git a/packages/e2e-tests/src/features/OnboardingRestoreWallet.part1.feature b/packages/e2e-tests/src/features/OnboardingRestoreWallet.part1.feature
@@ -68,7 +68,7 @@ Feature: Onboarding - Restore wallet
     Then I see LW homepage
     When I confirm multi-address discovery modal
     And I open settings from header menu
-    Then Analytics toggle is enabled: true
+    Then Analytics toggle is enabled
     When I open settings from header menu
     And I click on Remove wallet button
     And I click "Remove wallet" button on "Remove wallet" modal
@@ -79,7 +79,7 @@ Feature: Onboarding - Restore wallet
     Then I see LW homepage
     When I confirm multi-address discovery modal
     And I open settings from header menu
-    Then Analytics toggle is enabled: false
+    Then Analytics toggle is not enabled
 
   @LW-2628
   Scenario: Restore Wallet - autofill words
diff --git a/packages/e2e-tests/src/features/SettingsPageExtended.part2.feature b/packages/e2e-tests/src/features/SettingsPageExtended.part2.feature
@@ -17,7 +17,7 @@ Feature: General Settings - Extended Browser View
     And I click on "FAQs" setting
     Then FAQ page is displayed
 
-  @LW-3058 @Mainnet @Testnet
+  @LW-3058 @LW-12253 @Mainnet @Testnet
   Scenario Outline: Extended view - Settings - <option_name> option displayed
     When I open settings from header menu
     Then I see <option_name> option with proper description and toggle
@@ -209,6 +209,18 @@ Feature: General Settings - Extended Browser View
     When I close "Custom submit API" drawer
     Then "Custom submit API" is marked as disabled on Settings page
 
+  @LW-12255 @Mainnet @Testnet
+  Scenario Outline: Extended view - Settings - Debugging option enables verbose logging in console
+    Given I enable console logs collection
+    When I open settings from header menu
+    And Debugging toggle <debugging_enabled> enabled
+    And I navigate to NFTs extended page
+    Then I verify that logs <logs_collected> collected
+    Examples:
+      | debugging_enabled | logs_collected |
+      | is not            | are not        |
+      | is                | are            |
+
   # this test should be executed as the last one in this suite
   @LW-2521 @LW-9113 @Mainnet @Testnet
   Scenario: Extended View - Remove wallet and confirm
diff --git a/packages/e2e-tests/src/features/SettingsPagePopup.part2.feature b/packages/e2e-tests/src/features/SettingsPagePopup.part2.feature
@@ -104,7 +104,7 @@ Feature: General Settings - Popup View
     Then Side drawer "Show 24-word passphrase" is displayed
     And Password field is empty
 
-  @LW-3061 @Mainnet @Testnet
+  @LW-3061 @LW-12252 @Mainnet @Testnet
   Scenario Outline: Popup view - Settings -  <option_name> option displayed
     When I open settings from header menu
     Then I see <option_name> option with proper description and toggle
@@ -151,6 +151,18 @@ Feature: General Settings - Popup View
     When I close "Custom submit API" drawer
     Then "Custom submit API" is marked as disabled on Settings page
 
+  @LW-12254 @Mainnet @Testnet
+  Scenario Outline: Popup view - Settings - Debugging option enables verbose logging in console
+    Given I enable console logs collection
+    When I open settings from header menu
+    And Debugging toggle <debugging_enabled> enabled
+    And I navigate to NFTs popup page
+    Then I verify that logs <logs_collected> collected
+    Examples:
+      | debugging_enabled | logs_collected |
+      | is not            | are not        |
+      | is                | are            |
+
     # this test should be executed as the last one in this suite
   @LW-2708 @Mainnet @Testnet
   Scenario: Popup View - Remove wallet and confirm
diff --git a/packages/e2e-tests/src/features/analytics/AnalyticsSettingsExtended.feature b/packages/e2e-tests/src/features/analytics/AnalyticsSettingsExtended.feature
@@ -148,11 +148,11 @@ Feature: Analytics - Settings - Extended View
   Scenario: Analytics - Extended View - Settings - Analytics
     When I open settings from header menu
     And I set up request interception for posthog analytics request(s)
-    And Analytics toggle is enabled: true
-    And Analytics toggle is enabled: false
+    And Analytics toggle is enabled
+    And Analytics toggle is not enabled
     Then I validate latest analytics single event "settings | analytics | skip | click"
     Then I validate that 1 analytics event(s) have been sent
-    And Analytics toggle is enabled: true
+    And Analytics toggle is enabled
 
   @LW-8790
   Scenario: Analytics - Extended View - Settings - Theme switch
diff --git a/packages/e2e-tests/src/features/analytics/AnalyticsSettingsPopup.feature b/packages/e2e-tests/src/features/analytics/AnalyticsSettingsPopup.feature
@@ -163,11 +163,11 @@ Feature: Analytics - Settings - Popup View
     Given I am on Tokens popup page
     When I open settings from header menu
     And I set up request interception for posthog analytics request(s)
-    And Analytics toggle is enabled: true
-    And Analytics toggle is enabled: false
+    And Analytics toggle is enabled
+    And Analytics toggle is not enabled
     Then I validate latest analytics single event "settings | analytics | skip | click"
     Then I validate that 1 analytics event(s) have been sent
-    And Analytics toggle is enabled: true
+    And Analytics toggle is enabled
 
   @LW-8786
   Scenario: Analytics - Popup View - Settings - Theme switch
diff --git a/packages/e2e-tests/src/features/analytics/AnalyticsToggleSettingsExtended.feature b/packages/e2e-tests/src/features/analytics/AnalyticsToggleSettingsExtended.feature
@@ -7,11 +7,11 @@ Feature: Analytics - Settings Toggle - Extended View
   @LW-8312
   Scenario Outline: Analytics - Extended view - Settings - Analytics option enabled: <is_enabled> and Posthog events sent
     When I open settings from header menu
-    And Analytics toggle is enabled: <toggle_enabled>
+    And Analytics toggle <toggle_enabled> enabled
     Given I set up request interception for posthog analytics request(s)
     And I am on NFTs extended page
     And I validate that <number_of_events> analytics event(s) have been sent
     Examples:
       | toggle_enabled | number_of_events |
-      | true           | 1                |
-      | false          | 0                |
+      | is             | 1                |
+      | is not         | 0                |
diff --git a/packages/e2e-tests/src/features/analytics/AnalyticsToggleSettingsPopup.feature b/packages/e2e-tests/src/features/analytics/AnalyticsToggleSettingsPopup.feature
@@ -7,11 +7,11 @@ Feature: Analytics - Settings Toggle - Popup View
   @LW-8314
   Scenario Outline: Analytics - Popup view - Settings - Analytics option enabled: <is_enabled> and Posthog events sent
     When I open settings from header menu
-    And Analytics toggle is enabled: <toggle_enabled>
+    And Analytics toggle <toggle_enabled> enabled
     Given I set up request interception for posthog analytics request(s)
     And I am on NFTs popup page
     And I validate that <number_of_events> analytics event(s) have been sent
     Examples:
       | toggle_enabled | number_of_events |
-      | true           | 1                |
-      | false          | 0                |
+      | is             | 1                |
+      | is not         | 0                |
diff --git a/packages/e2e-tests/src/pageobject/settingsExtendedPageObject.ts b/packages/e2e-tests/src/pageobject/settingsExtendedPageObject.ts
@@ -11,6 +11,8 @@ import { expect } from 'chai';
 import MainLoader from '../elements/MainLoader';
 import MenuHeader from '../elements/menuHeader';
 
+const toggleEnabledAttribute = 'aria-checked';
+
 class SettingsExtendedPageObject {
   clickOnAbout = async () => {
     await SettingsPage.aboutLink.element.click();
@@ -75,11 +77,16 @@ class SettingsExtendedPageObject {
     }
   };
 
-  toggleAnalytics = async (isEnabled: 'true' | 'false') => {
-    (await SettingsPage.analyticsSwitch.getAttribute('aria-checked')) !== isEnabled &&
+  toggleAnalytics = async (isEnabled: boolean) => {
+    (await SettingsPage.analyticsSwitch.getAttribute(toggleEnabledAttribute)) !== String(isEnabled) &&
       (await SettingsPage.analyticsSwitch.click());
   };
 
+  toggleDebugging = async (isEnabled: boolean) => {
+    (await SettingsPage.debuggingSwitch.getAttribute(toggleEnabledAttribute)) !== String(isEnabled) &&
+      (await SettingsPage.debuggingSwitch.click());
+  };
+
   // eslint-disable-next-line complexity
   clickSettingsItem = async (elementName: string): Promise<void> => {
     await browser.pause(500);
diff --git a/packages/e2e-tests/src/steps/commonSteps.ts b/packages/e2e-tests/src/steps/commonSteps.ts
@@ -378,6 +378,10 @@ Then(/^I verify there are no errors in console logs$/, async () => {
   await consoleAssert.assertNoErrorsInConsole();
 });
 
+Then(/^I verify that logs (are|are not) collected$/, async (logsCollected: 'are' | 'are not') => {
+  await consoleAssert.assertLogsAreCollected(logsCollected === 'are');
+});
+
 Then(/^I wait (\d*) milliseconds$/, async (delay: 1000) => {
   await browser.pause(delay);
 });
diff --git a/packages/e2e-tests/src/steps/settingsSteps.ts b/packages/e2e-tests/src/steps/settingsSteps.ts
@@ -201,9 +201,14 @@ Then(
   }
 );
 
-When(/Analytics toggle is enabled: (true|false)/, async (isEnabled: 'true' | 'false') => {
-  await settingsExtendedPageObject.toggleAnalytics(isEnabled);
-});
+When(
+  /^(Analytics|Debugging) toggle (is|is not) enabled$/,
+  async (option: 'Analytics' | 'Debugging', isEnabled: 'is' | 'is not') => {
+    option === 'Analytics'
+      ? await settingsExtendedPageObject.toggleAnalytics(isEnabled === 'is')
+      : await settingsExtendedPageObject.toggleDebugging(isEnabled === 'is');
+  }
+);
 
 Then(/^Side drawer "Show 24-word passphrase" is displayed$/, async () => {
   await passphraseDrawerAssert.assertSeeDrawerTitle(
