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

Fixed the flaky investigation cypress test #9091

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

nihal467
Copy link
Member

@nihal467 nihal467 commented Nov 12, 2024

Proposed Changes

  • Fixes #issue_number
  • Change 1
  • Change 2
  • More?

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • Bug Fixes
    • Updated the patient reference in the investigation test to ensure accurate testing with the correct patient data.

@nihal467 nihal467 requested a review from a team as a code owner November 12, 2024 07:29
@nihal467 nihal467 self-assigned this Nov 12, 2024
Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

The changes made in this pull request involve updating the patientName variable in the PatientInvestigation.cy.ts file from "Dummy Patient 12" to "Dummy Patient 14". This modification affects the patient referenced in a test case for creating an investigation, while the overall structure and logic of the test remain unchanged.

Changes

File Path Change Summary
cypress/e2e/patient_spec/PatientInvestigation.cy.ts Updated patientName from "Dummy Patient 12" to "Dummy Patient 14".

Possibly related PRs

Suggested labels

needs testing, needs review

Suggested reviewers

  • rithviknishad
  • shivankacker

Poem

🐰 In the land of tests, so bright and fair,
A patient’s name changed with utmost care.
From twelve to fourteen, a simple swap,
In Cypress we trust, our tests never stop!
Hops of joy for each line we write,
Ensuring our code is always just right! 🌟

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

cypress/e2e/patient_spec/PatientInvestigation.cy.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

Error: Failed to load parser '@typescript-eslint/parser' declared in '.eslintrc.json': Cannot find module '@typescript-eslint/parser'
Require stack:

  • /.eslintrc.json
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Function.resolve (node:internal/modules/helpers:145:19)
    at Object.resolve (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46)
    at ConfigArrayFactory._loadParser (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39)
    at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43)
    at _normalizeObjectConfigDataBody.next ()
    at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20)
    at _normalizeObjectConfigData.next ()
    at ConfigArrayFactory.loadInDirectory (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28)
    at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

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 Nov 12, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 491eb46
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/673303d62e2a8a000859959b
😎 Deploy Preview https://deploy-preview-9091--care-ohc.netlify.app
📱 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.

@nihal467 nihal467 changed the title Fixed the flaky investigation test Fixed the flaky investigation cypress test Nov 12, 2024
Copy link

Deploying care-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 491eb46
Status: ✅  Deploy successful!
Preview URL: https://1f48cfe7.care-fe.pages.dev
Branch Preview URL: https://flaky-investigation.care-fe.pages.dev

View logs

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: 1

🧹 Outside diff range and nitpick comments (1)
cypress/e2e/patient_spec/PatientInvestigation.cy.ts (1)

Line range hint 22-35: Test implementation is incomplete and may cause flakiness.

The test has several issues that could contribute to flakiness:

  1. Only verifies the error case
  2. Contains a TODO comment about temporary workflow
  3. Missing assertions for successful investigation creation

Consider completing the test implementation:

it("Create a investigation for a patient and verify its reflection", () => {
  patientPage.visitPatient(patientName);
  patientInvestigation.clickInvestigationTab();
  patientInvestigation.clickLogLabResults();
  
  // Select investigations
  patientInvestigation.selectInvestigationOption([
    "Haematology",
    "Urine Test",
  ]);
  
  // First verify error case
  cy.submitButton("Save Investigation");
  cy.verifyNotification("Please Enter at least one value");
  cy.closeNotification();
  
  // Then test the happy path
  patientInvestigation.enterTestResults({
    haematology: { value: "Normal", notes: "Test notes" },
    urineTest: { value: "Normal", notes: "Test notes" }
  });
  
  cy.submitButton("Save Investigation");
  cy.verifyNotification("Investigation saved successfully");
  
  // Verify investigation appears in the list
  patientInvestigation.verifyInvestigationExists({
    type: ["Haematology", "Urine Test"],
    status: "Completed"
  });
});
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between dc97a9c and 491eb46.

📒 Files selected for processing (1)
  • cypress/e2e/patient_spec/PatientInvestigation.cy.ts (1 hunks)
🔇 Additional comments (1)
cypress/e2e/patient_spec/PatientInvestigation.cy.ts (1)

Line range hint 15-21: Review state management approach.

The current state management using localStorage and filter clearing could lead to test interference:

  1. clearLocalStorage(/filters--.+/) suggests filtering state might affect the test
  2. No verification that the state is properly reset

Let's check for other tests that might interfere with this one:

Consider implementing more robust state isolation:

beforeEach(() => {
  cy.restoreLocalStorage();
  // Clear all application state, not just filters
  cy.window().then((win) => {
    win.localStorage.clear();
    win.sessionStorage.clear();
  });
  // Explicitly set required state
  cy.setInitialState({
    filters: {},
    // other required state
  });
  cy.awaitUrl("/patients");
});

@@ -7,7 +7,7 @@ describe("Patient Investigation Creation from Patient consultation page", () =>
const loginPage = new LoginPage();
const patientPage = new PatientPage();
const patientInvestigation = new PatientInvestigation();
const patientName = "Dummy Patient 12";
const patientName = "Dummy Patient 14";
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Changing patient name may not address the root cause of flakiness.

While updating the patient name might temporarily fix the issue, it suggests a deeper problem with test data management. The test appears to depend on pre-existing data without proper setup/teardown.

Consider implementing one of these approaches:

  1. Create test data during the test setup
  2. Use dynamic test data generation
  3. Implement proper cleanup to ensure test isolation

Example approach using test data creation:

before(() => {
  loginPage.loginAsDistrictAdmin();
  // Create test patient with known state
  cy.createTestPatient(patientName, {
    // Add required patient properties
  }).then(patient => {
    cy.saveLocalStorage();
  });
});

after(() => {
  // Cleanup test data
  cy.deleteTestPatient(patientName);
});

Copy link

cypress bot commented Nov 12, 2024

CARE    Run #3885

Run Properties:  status check passed Passed #3885  •  git commit 491eb46bd5: Fixed the flaky investigation test
Project CARE
Branch Review flaky-investigation
Run status status check passed Passed #3885
Run duration 04m 37s
Commit git commit 491eb46bd5: Fixed the flaky investigation test
Committer Mohammed Nihal
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 128
View all changes introduced in this branch ↗︎

@khavinshankar khavinshankar merged commit f0dc1de into develop Nov 12, 2024
64 checks passed
@khavinshankar khavinshankar deleted the flaky-investigation branch November 12, 2024 08:14
Copy link

@nihal467 @nihal467 Your efforts have helped advance digital healthcare and TeleICU systems. 🚀 Thank you for taking the time out to make CARE better. We hope you continue to innovate and contribute; your impact is immense! 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants