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

fix(j-s): slow down the execution of js playwright tests #17438

Merged
merged 8 commits into from
Jan 9, 2025

Conversation

thorhildurt
Copy link
Member

@thorhildurt thorhildurt commented Jan 8, 2025

Debug and research flakiness in our E2E tests

What

  • Run the judicial system E2E tests slower and experiment if it will reduce flakiness
    • To begin with, we add 1s between every action (click, type, etc.) using the slowMo option. Locally the tests now take 515s or ~8.5m to execute.
    • Research trace available here

Why

  • There is some flakiness in our E2E tests when we are running them during deployment.
  • Due to flakiness, we have to run the E2E 5-6 times until most tests have past during some of our executions

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • Tests

    • Added a slow motion configuration for end-to-end tests in the judicial system to improve test visibility.
    • Introduced a comment regarding a feature flag affecting test implementation.
  • Chores

    • Added a new constant to conditionally handle routing based on case type.

@thorhildurt thorhildurt self-assigned this Jan 8, 2025
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

Walkthrough

The pull request introduces a comment regarding a feature flag affecting end-to-end tests in the Processing component of the judicial system. It defines a new constant, isTrafficViolationCaseCheck, to determine if the current case is a traffic violation or if a feature flag for multiple indictment subtypes is enabled, influencing routing behavior. Additionally, a new use object with a slowMo property is added to the Playwright test configuration for the judicial system project to enhance test visibility.

Changes

File Change Summary
apps/judicial-system/web/src/routes/Prosecutor/Indictments/Processing/Processing.tsx Added comment about feature flag and new constant isTrafficViolationCaseCheck for conditional case routing
apps/system-e2e/src/playwright.config.ts Introduced use.launchOptions.slowMo with a value of 200ms for the judicial-system project tests

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • unakb

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 98ec5b3 and 40f3d4f.

📒 Files selected for processing (1)
  • apps/system-e2e/src/playwright.config.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/system-e2e/src/playwright.config.ts

Finishing Touches

  • 📝 Generate Docstrings

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

@thorhildurt thorhildurt changed the title J s/e2e debugging fix(j-s): slow down the execution of js playwright tests Jan 8, 2025
…nd.is into j-s/e2e-debugging

# Conflicts:
#	apps/judicial-system/web/src/routes/Prosecutor/Indictments/Processing/Processing.tsx
@thorhildurt thorhildurt marked this pull request as ready for review January 8, 2025 10:44
@thorhildurt thorhildurt requested review from a team as code owners January 8, 2025 10:44
Copy link

codecov bot commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.68%. Comparing base (4777f05) to head (ecb87ad).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17438      +/-   ##
==========================================
+ Coverage   35.66%   35.68%   +0.01%     
==========================================
  Files        6941     6940       -1     
  Lines      149145   149044     -101     
  Branches    42650    42597      -53     
==========================================
- Hits        53193    53179      -14     
+ Misses      95952    95865      -87     
Flag Coverage Δ
judicial-system-web 27.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...s/Prosecutor/Indictments/Processing/Processing.tsx 0.00% <ø> (ø)

... and 29 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4777f05...ecb87ad. Read the comment docs.

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

🧹 Nitpick comments (3)
apps/system-e2e/src/playwright.config.ts (1)

73-78: Consider investigating root causes of flakiness.

While adding slowMo can help stabilize flaky tests, it significantly increases test execution time (now ~8.5 minutes). Consider:

  1. Using Playwright's built-in auto-waiting mechanisms
  2. Adding explicit waits only where needed
  3. Investigating race conditions or timing issues
       use: {
-        /* Slows down execution in ms */
-        launchOptions: {
-          slowMo: 1000,
-        },
+        /* Wait until element is visible and actionable */
+        actionTimeout: 30 * 1000,
+        navigationTimeout: 30 * 1000,
       },
apps/judicial-system/web/src/routes/Prosecutor/Indictments/Processing/Processing.tsx (2)

80-80: Document the feature flag's impact on E2E tests.

Instead of a TODO comment, document the specific conditions under which the E2E tests fail and how to handle them.

-  // TODO: currently for e2e tests, this is failing locally due to this feature flag
+  // Note: E2E tests may fail locally when Feature.MULTIPLE_INDICTMENT_SUBTYPES is disabled.
+  // To fix: Enable the feature flag in your local environment or use the isTrafficViolationCase check.

81-83: Consider extracting the feature check into a custom hook.

The constant combines multiple conditions that determine routing behavior. Consider moving this logic into a custom hook for better reusability and testability.

+  const useIsTrafficViolationCase = (workingCase: Case) => {
+    const { features } = useContext(FeatureContext)
+    return features.includes(Feature.MULTIPLE_INDICTMENT_SUBTYPES) ||
+      isTrafficViolationCase(workingCase)
+  }

-  const isTrafficViolationCaseCheck =
-    features.includes(Feature.MULTIPLE_INDICTMENT_SUBTYPES) ||
-    isTrafficViolationCase(workingCase)
+  const isTrafficViolationCaseCheck = useIsTrafficViolationCase(workingCase)
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27bed66 and 98ec5b3.

📒 Files selected for processing (2)
  • apps/judicial-system/web/src/routes/Prosecutor/Indictments/Processing/Processing.tsx (1 hunks)
  • apps/system-e2e/src/playwright.config.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/system-e2e/src/playwright.config.ts (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
apps/judicial-system/web/src/routes/Prosecutor/Indictments/Processing/Processing.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
📓 Learnings (1)
apps/judicial-system/web/src/routes/Prosecutor/Indictments/Processing/Processing.tsx (4)
Learnt from: gudjong
PR: island-is/island.is#15421
File: apps/judicial-system/web/src/routes/Prosecutor/Indictments/Processing/Processing.tsx:55-61
Timestamp: 2024-11-12T15:15:11.835Z
Learning: The `updateCase` method in the `apps/judicial-system/web/src/routes/Prosecutor/Indictments/Processing/Processing.tsx` file has its own error handling, and additional error handling in the `initialize` function is not necessary.
Learnt from: oddsson
PR: island-is/island.is#17192
File: apps/judicial-system/web/src/routes/Prosecutor/Indictments/Indictment/IndictmentCount.tsx:579-587
Timestamp: 2024-12-17T20:28:47.549Z
Learning: In the `IndictmentCount.tsx` file of the `apps/judicial-system/web` project, constraints on the vehicle registration number are planned to be removed. Avoid suggesting changes related to vehicle registration number validation for now.
Learnt from: oddsson
PR: island-is/island.is#16731
File: apps/judicial-system/web/src/routes/Shared/IndictmentOverview/IndictmentOverview.tsx:172-186
Timestamp: 2024-11-12T15:15:20.157Z
Learning: In `IndictmentOverview.tsx`, since the defendants data does not change, using `useMemo` to memoize the filtering logic is unnecessary.
Learnt from: unakb
PR: island-is/island.is#15378
File: apps/judicial-system/web/src/routes/Court/Indictments/Summary/Summary.tsx:86-100
Timestamp: 2024-11-12T15:15:11.835Z
Learning: User unakb prefers explicit case handling in switch statements for key functionalities like `getRulingDecisionTagColor` to ensure clarity and avoid assumptions that a case was overlooked.

@datadog-island-is
Copy link

datadog-island-is bot commented Jan 8, 2025

Datadog Report

Branch report: j-s/e2e-debugging
Commit report: bd7328b
Test service: judicial-system-web

✅ 0 Failed, 336 Passed, 0 Skipped, 1m 10.84s Total Time
➡️ Test Sessions change in coverage: 1 no change

Copy link
Member

@unakb unakb left a comment

Choose a reason for hiding this comment

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

Nice, let's see what this tells us, will get us moving in the right direction hopefully to eliminating the flakiness 🙏

Copy link
Member

@AndesKrrrrrrrrrrr AndesKrrrrrrrrrrr left a comment

Choose a reason for hiding this comment

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

e2e config LGTM 👍

@thorhildurt thorhildurt added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Jan 9, 2025
@kodiakhq kodiakhq bot merged commit a850954 into main Jan 9, 2025
28 of 29 checks passed
@kodiakhq kodiakhq bot deleted the j-s/e2e-debugging branch January 9, 2025 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants