Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[e2e] Account page tests - wait for transaction table to be visible #3530

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

joel-jeremy
Copy link
Contributor

@joel-jeremy joel-jeremy commented Sep 29, 2024

Fix the flaky navigates back to start page by clicking on “no server” in an empty budget file test from onboarding.test.js

@actual-github-bot actual-github-bot bot changed the title Wait for transaction table to be visible [WIP] Wait for transaction table to be visible Sep 29, 2024
Copy link
Contributor

coderabbitai bot commented Sep 29, 2024

Walkthrough

The changes in this pull request involve updates to the onboarding process tests and the associated functionality in the configuration page. The test case in onboarding.test.js has been revised to verify the visibility of the transaction table after initiating a fresh start. Additionally, the startFresh method in configuration-page.js has been modified to return a new instance of the AccountPage, thus refining the control flow within the onboarding process.

Changes

Files Change Summary
packages/desktop-client/e2e/onboarding.test.js Modified the onboarding test to check the visibility of the transactionTable after calling startFresh().
packages/desktop-client/e2e/page-models/configuration-page.js Added import for AccountPage and updated startFresh method to return a new instance of AccountPage.

Possibly related PRs

  • 🧪 improve onboarding e2e test stability #3503: This PR focuses on improving the stability of end-to-end tests related to the onboarding process, which is directly relevant to the changes made in the main PR that modifies the onboarding test case.

Suggested labels

:sparkles: Merged

Suggested reviewers

  • MatissJanis
  • matt-fidd

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ea5389b and d19cb93.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3530.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • packages/desktop-client/e2e/onboarding.test.js (1 hunks)
  • packages/desktop-client/e2e/page-models/configuration-page.js (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/desktop-client/e2e/onboarding.test.js
  • packages/desktop-client/e2e/page-models/configuration-page.js

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Sep 29, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit d19cb93
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/66fa1cfc545f1800091ba7e7
😎 Deploy Preview https://deploy-preview-3530.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@joel-jeremy joel-jeremy changed the title [WIP] Wait for transaction table to be visible [e2e] Account page tests - wait for transaction table to be visible Sep 29, 2024
Copy link
Contributor

github-actions bot commented Sep 29, 2024

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
9 5.29 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/AppliedFilters.js 20.96 kB 0%
static/js/usePreviewTransactions.js 1.64 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 81.98 kB 0%
static/js/wide.js 225.27 kB 0%
static/js/ReportRouter.js 1.5 MB 0%
static/js/index.js 3.31 MB 0%

Copy link
Contributor

github-actions bot commented Sep 29, 2024

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
1 1.19 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.js 1.19 MB 0%

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
packages/desktop-client/e2e/page-models/configuration-page.js (2)

22-23: LGTM: Method updated to return AccountPage. Consider removing blank line.

The startFresh method has been appropriately updated to return a new AccountPage instance, which aligns with its purpose and improves the e2e test flow. This change is consistent with other methods in the class that return page objects.

Consider removing the blank line (line 22) before the return statement for consistency with other methods in the class:

 async startFresh() {
   await this.page.getByRole('button', { name: 'Start fresh' }).click();
-
   return new AccountPage(this.page);
 }

Action Required: Capture and utilize the returned AccountPage instance from startFresh in all relevant tests.

  • File: packages/desktop-client/e2e/onboarding.test.js

    • Test: creates a new empty budget file
      • Issue: Calls startFresh without capturing its return value.
      • Action: Assign the returned AccountPage instance to a variable and use it as needed within the test.
    const accountPage = await configurationPage.startFresh();
    // Add assertions or interactions using accountPage

Ensure all tests invoking startFresh handle the returned AccountPage instance appropriately to maintain test integrity and leverage the updated functionality.

🔗 Analysis chain

Line range hint 1-23: Verify impact on existing tests using startFresh method.

The changes to the ConfigurationPage class, particularly the startFresh method, improve its functionality and allow for a more seamless flow in e2e tests. These modifications are consistent with the existing code structure and patterns.

Please ensure that all existing tests using the startFresh method are updated to handle the new return value (AccountPage instance). Run the following script to identify potential areas that may need updates:

Review the results and update the relevant test files to properly utilize the returned AccountPage instance.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find usages of startFresh method that might need updating

# Search for startFresh method calls in test files
echo "Searching for startFresh method calls in test files:"
rg --type js "startFresh\(\)" packages/desktop-client/e2e/tests -C 2

# Search for startFresh method calls in other files (excluding the configuration-page.js)
echo "Searching for startFresh method calls in other files:"
rg --type js "startFresh\(\)" packages/desktop-client/e2e -g "!configuration-page.js" -C 2

Length of output: 1411

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 545c8d5 and ea5389b.

📒 Files selected for processing (2)
  • packages/desktop-client/e2e/onboarding.test.js (1 hunks)
  • packages/desktop-client/e2e/page-models/configuration-page.js (2 hunks)
🔇 Additional comments (2)
packages/desktop-client/e2e/page-models/configuration-page.js (1)

1-1: LGTM: Import statement added correctly.

The import statement for AccountPage has been added appropriately, following the existing import pattern. This import is necessary for the changes made to the startFresh method.

packages/desktop-client/e2e/onboarding.test.js (1)

96-98: Excellent addition to ensure UI readiness!

These changes effectively implement the PR objective of waiting for the transaction table to be visible. By assigning the result of startFresh() to accountPage and adding an expectation for the transaction table's visibility, the test now ensures that the UI is in the correct state before proceeding. This enhancement improves the test's reliability and aligns perfectly with the PR's goal.

@joel-jeremy joel-jeremy force-pushed the vrt-wait-for-transactiontable-to-be-visible branch from ea5389b to a0fabf3 Compare September 29, 2024 15:26
@joel-jeremy joel-jeremy force-pushed the vrt-wait-for-transactiontable-to-be-visible branch from b7a1e4f to d19cb93 Compare September 30, 2024 03:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants