Skip to content

Use the shared validation wait in the EHR test #48

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.

Sign up for GitHub

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

Merged
labkey-martyp merged 2 commits into from
Sep 17, 2026
Merged

Use the shared validation wait in the EHR test #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
baa4569
Use the shared data entry validation wait
labkey-martyp Sep 15, 2026
06d207b
Re-validate a stale error summary before submitting a form
labkey-martyp Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 1 addition & 58 deletions nbri_ehr/test/src/org.labkey.test/tests.nbri_ehr/NBRI_EHRTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,6 @@ public class NBRI_EHRTest extends AbstractGenericEHRTest implements PostgresOnly
// cannot change what the snapshot reports.
private static final String[] LOCATION_ANIMALS = {"LOC0001"};

// Longest buffer DataEntryErrorPanel puts between a validation event and repainting the error summary
private static final int ERROR_PANEL_REPAINT_BUFFER = 1500;

// protocol.investigatorId looks up ehr.investigators rather than the user table, so a protocol shows an
// investigator only when a row there carries its id.
private static final String INVES_LAST_NAME = "Marsh";
Expand Down Expand Up @@ -2623,58 +2620,6 @@ private void waitForFormError(String message)
waitFor(() -> isTextPresent(message), "Form did not report: " + message, WAIT_FOR_JAVASCRIPT);
}

/**
* Waits for a validation message to clear, re-running server-side validation once if it does not. A value can be
* accepted at the field while the form's error summary still lists it, which the form itself handles by pointing
* the user at More Actions -> Re-Validate.
*/
private void waitForValidationToClear(String message)
{
if (waitForValidationToSettleWithout(message))
return;

log("Form kept reporting '" + message + "', re-validating");
revalidateForm();
if (!waitForValidationToSettleWithout(message))
Assert.fail("Form kept reporting after re-validating: " + message);
}

/**
* Waits for the form to go quiet without reporting the given message. DataEntryErrorPanel repaints on a buffered
* event rather than when the validation response lands, so the summary trails the form's actual state by up to a
* second: a message can read as absent before validation has reported it, and read as present after the value
* that raised it was accepted. Neither is worth acting on, so require no validation in flight and the message
* absent, then re-check after the repaint window to confirm the absence survives it.
*/
private boolean waitForValidationToSettleWithout(String message)
{
return waitFor(() -> {
if (getValidationRequestsInFlight() > 0 || isTextPresent(message))
return false;

sleep(ERROR_PANEL_REPAINT_BUFFER);
return getValidationRequestsInFlight() == 0 && !isTextPresent(message);
}, WAIT_FOR_JAVASCRIPT);
}

// Server validations the form is still waiting on. StoreCollection counts these itself; the form has no
// rendered "validating" state to watch instead.
private int getValidationRequestsInFlight()
{
Object inFlight = executeScript("var panel = Ext4.ComponentQuery.query('ehr-dataentrypanel')[0];" +
"return panel && panel.storeCollection ? panel.storeCollection.validationRequestsInFlight : 0;");

return inFlight == null ? 0 : ((Number) inFlight).intValue();
}

// More Actions -> Re-Validate: re-runs server-side validation on every record in the form
private void revalidateForm()
{
WebElement moreActions = _helper.getDataEntryButton("More Actions").findElement(getDriver());
scrollIntoView(moreActions);
_ext4Helper.clickExt4MenuButton(false, moreActions, false, "Re-Validate");
}

/**
* Reads a date field for one animal through the API rather than off a grid, so assertions compare stored values
* instead of formatted display text, and normalizes to the day: event dates are entered with the time stripped,
Expand Down Expand Up @@ -2767,9 +2712,7 @@ private void submitForm(String buttonText, String windowTitle)

private void submitForm(String buttonText, String windowTitle, boolean expectNavigation)
{
//Give time for errors to disappear after validation
Locator.tagContainingText("div", "The form has the following errors and warnings:")
.waitForElementToDisappear(longWait());
waitForFormValidationToClear();
Locator submitFinalBtn = Locator.linkWithText(buttonText);
shortWait().until(ExpectedConditions.elementToBeClickable(submitFinalBtn));
Window<?> msgWindow;
Expand Down