[WIP] Dashboard: add input error tracking #985

proy30 · 2025-06-10T00:45:38Z

This PR provides the user guidance on which inputs are invalid. Additionally, the PR refactors the current logic to track such errors.

Changes:

A new dynamic notification banner in the Inputs toolbar which will display the count of input errors the user has. Hovering over the banner will tell the user exactly which inputs are incorrect along with the error message.
A new class, SimulationValidation in validation.py, is created to encapsulate all logic for determining whether the simulation can run based on current input errors.
The primary method in the class, update, takes the input section header as an argument.
- This allows the method to check only the relevant section for errors.
Add a JS function to suppress resizeWarning error.
- Does not affect the dashboard functionality.
Remove unhelpful (and unneeded) comments in generalFunctions.py
Fix variable naming in shared.py
- A variable referring to csr inputs was incorrectly labeled under space charge

Demo:

chrome_u8cxvRN2ps.mp4

Merge after #981

Copilot

Pull Request Overview

This PR adds dynamic input error tracking to the dashboard, introduces a centralized SimulationValidation class to manage error state per section, and suppresses unnecessary ResizeObserver console errors.

Add an error banner in the Inputs toolbar showing total and detailed input errors.
Introduce SimulationValidation to replace piecemeal validation updates with a section-based update API.
Suppress redundant ResizeObserver loop errors in custom.js.

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/python/impactx/dashboard/Toolbar/sim_history/custom.js	Suppress ResizeObserver errors by overriding `console.error`.
src/python/impactx/dashboard/Toolbar/controls.py	Add `error_notification` banner and include it in the toolbar.
src/python/impactx/dashboard/Input/validation.py	Create `SimulationValidation` to track and cache per-section errors.
src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeMain.py	Swap `DashboardValidation.update_*` calls for `SimulationValidation.update`.
src/python/impactx/dashboard/Input/shared.py	Update imports and use `SimulationValidation.update` in shared utilities.
src/python/impactx/dashboard/Input/latticeConfiguration/variable_handler.py	Replace `DashboardValidation` calls; incorrectly calls `update_simulation_validation_status`.
src/python/impactx/dashboard/Input/latticeConfiguration/latticeMain.py	Replace validation triggers with `SimulationValidation.update`.
src/python/impactx/dashboard/Input/inputParameters/inputMain.py	Remove old validation hook but omit new `SimulationValidation.update` call.
src/python/impactx/dashboard/Input/generalFunctions.py	Remove unneeded comments and extend `get_default` with robust fallback.
src/python/impactx/dashboard/Input/distributionParameters/distributionMain.py	Hook distribution parameter changes into `SimulationValidation.update`.
src/python/impactx/dashboard/Input/init.py	Export `SimulationValidation` alongside `DashboardValidation`.

Comments suppressed due to low confidence (3)

src/python/impactx/dashboard/Input/validation.py:173

The if n_cell_error block is mis-indented outside the loop, so only the last direction is ever checked. Move the if and its append logic inside the for block.

        for direction in ["x", "y", "z"]:

src/python/impactx/dashboard/Input/inputParameters/inputMain.py:44

You removed the validation hook but did not add a SimulationValidation.update("Input Parameters") call. Without it, changes here won’t update the input-error state.

        if state.space_charge not in current_sc_list:

src/python/impactx/dashboard/Input/validation.py:158

[nitpick] New validation logic in SimulationValidation and the toolbar banner lack unit tests. Consider adding tests for update behavior and InputToolbar.error_notification rendering.

class SimulationValidation:

src/python/impactx/dashboard/Toolbar/sim_history/custom.js

src/python/impactx/dashboard/Input/latticeConfiguration/variable_handler.py

src/python/impactx/dashboard/Input/generalFunctions.py

proy30 · 2025-06-13T17:22:30Z

src/python/impactx/dashboard/Input/inputParameters/inputMain.py

        current_sc_list = ui_props.get("space_charge_list", [])
        if state.space_charge not in current_sc_list:
            state.space_charge = current_sc_list[0]
-        DashboardValidation.update_simulation_validation_status()


It is fine to not have to update the simulation with tracking_mode because tracking_mode is a dropdown and will always have a valid input.

src/python/impactx/dashboard/Input/__init__.py

src/python/impactx/dashboard/Input/validation.py

src/python/impactx/dashboard/Toolbar/input.py

break into multiple smaller functions

docstring, type hint, error messages

docstring/simplify

because the input of state.kin_energy_unit is coming from a dropdown, its input is a string. if it goes through the shared.py state change '@state.change(*INPUT_DEFAULTS)', then it will be validated as a string. Because it has no error messages (technically because the state.kin_energy_unit default is 'MeV' and would be a valid python identifier), it will be converted to a numeric value. however the 'convert_to_numeric' method will set the value to 'None' if it can't be turned into a default type of int or float. this will set the state.kin_energy_unit to 'None' and the dashboard will not launch. The solution to this is not have any dropdown inputs go through @state.change(*INPUT_DEFAULTS) because every dropdown will have a valid set of inputs by default.

which also fixes distribution validaiton

The current default for lattice name is 'None', a string. We change that to a python literal None now. But because that is the case the name parameter for the lattice element will be empty. So we need to make sure in the dashboard test we provide a name for the element so that there are no inputs errors before running a simulation

for more information, see https://pre-commit.ci

…imeoutError

for more information, see https://pre-commit.ci

doesnt affect dashbaord visually or functionally this resizeObserver error message appears whenever hovering over a tooltip that takes the entire width of the page, or if we hover over the tooltip showing input errors. not exactly sure why and this is just a suppression 'bandaid'

…g errors correctly track n_cell and blocking factor completely refactor refactor fixup create SimulationValidation class this is where the logic of checking for input errors is now stored update main function name shorten because the class name helps with identifying call correct function for variables add type hints simplify update 'get_default' [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci update var name for disabling sim

place in a new folder 'Input/validation'

the set_js_input is going to reach the 'exception' case if I place an invalid error. If I am intentionally trying to set an error, such as if I am testing the dashboard validation with an error input, I need it to fail on the dashboard end only.

sets all inputs to an error state, checks to make sure that the # of input errors is accurate, then reset different parts of the dashboard and continuously check the number of errors.

it always returned true

create '_apply_state_updates'

for more information, see https://pre-commit.ci

proy30 requested a review from Copilot June 10, 2025 01:02

Copilot AI reviewed Jun 10, 2025

View reviewed changes

src/python/impactx/dashboard/Toolbar/sim_history/custom.js Show resolved Hide resolved

src/python/impactx/dashboard/Input/latticeConfiguration/variable_handler.py Outdated Show resolved Hide resolved

src/python/impactx/dashboard/Input/generalFunctions.py Outdated Show resolved Hide resolved

proy30 commented Jun 13, 2025

View reviewed changes

ax3l added the component: dashboard our browser based trame dashboard label Jun 23, 2025

proy30 force-pushed the dashboard/add_input_errors_tracker branch 2 times, most recently from 68527e7 to a270010 Compare June 26, 2025 17:41

proy30 force-pushed the dashboard/add_input_errors_tracker branch from d03f1b5 to caa96bf Compare July 17, 2025 02:26

github-advanced-security bot found potential problems Jul 17, 2025

View reviewed changes

src/python/impactx/dashboard/Input/__init__.py Fixed Show fixed Hide fixed

src/python/impactx/dashboard/Input/validation.py Fixed Show fixed Hide fixed

proy30 force-pushed the dashboard/add_input_errors_tracker branch from e3e1f41 to f269f1a Compare July 18, 2025 00:16

github-advanced-security bot found potential problems Jul 18, 2025

View reviewed changes

src/python/impactx/dashboard/Toolbar/input.py Fixed Show fixed Hide fixed

proy30 force-pushed the dashboard/add_input_errors_tracker branch from f269f1a to a5db113 Compare July 18, 2025 00:23

proy30 added 19 commits August 7, 2025 17:37

update validate_against's arguments

77ab6aa

refactor validate_against

5a8683b

break into multiple smaller functions

refactor validation logic in shared.py

ee66353

simplify n_cell and blocking_factor validation

f151450

simplify shared.py with usingnon-hardcoded defaults

cd22d2b

cleanup

4e33c1a

docstring, type hint, error messages

prob_relative validation cleanup

d3b7306

update type hint

17e28f5

cleanup

82f42ba

docstring/simplify

move validation function to validation.py

729f29c

simplify lattice validation

62876a1

fix from rebase

6e1a6a7

cleanup

d3907f7

rename INPUT_DEFAULTS -> STATE_INPUTS

7c54bbe

fix convert_to_numeric

b7f364f

which also fixes distribution validaiton

fix lattice validation and remove print statement

35af17e

remove: duplicate import

ae32305

remove comment

c894043

proy30 and others added 23 commits August 7, 2025 17:38

[pre-commit.ci] auto fixes from pre-commit.com hooks

1ef752f

for more information, see https://pre-commit.ci

rename validate_input to validate

6012d8f

print what was shown in the terminal page if 'assert_state' reached t…

392d7c8

…imeoutError

update update_distribution_parameter arguments

41b5fef

[pre-commit.ci] auto fixes from pre-commit.com hooks

1c2fa57

for more information, see https://pre-commit.ci

add the temp fix to default_types

182199b

add error tracking

8def38e

add GeneralFunctions import in 'Input/__init__.py'

ab78f0f

split up inputs validation and errors tracking validation

4ae7fbe

place in a new folder 'Input/validation'

update class names

8115e00

add 'test_validation.py

8d8dc67

sets all inputs to an error state, checks to make sure that the # of input errors is accurate, then reset different parts of the dashboard and continuously check the number of errors.

add space charge for match state_name

6e512b9

fix condition in shared.py

9ec76fb

it always returned true

simplify/cleanup/fix

6e2aaf7

update ErrorsTracker class docstring

5fdbdd9

remove redundant function

614a145

squash into one big commit

0db14f3

create '_apply_state_updates'

fix

f15ea4b

Merge branch 'development' into dashboard/add_input_errors_tracker

4ca3e8c

proy30 force-pushed the dashboard/add_input_errors_tracker branch from a5db113 to 4ca3e8c Compare September 19, 2025 17:38

proy30 and others added 6 commits September 21, 2025 20:18

Merge branch 'development' into dashboard/add_input_errors_tracker

1f2b1e4

cleanup/fixerrors

201434b

[pre-commit.ci] auto fixes from pre-commit.com hooks

5767bc6

for more information, see https://pre-commit.ci

cleanup

433857e

fix tests

e9c7cc7

[pre-commit.ci] auto fixes from pre-commit.com hooks

178757d

for more information, see https://pre-commit.ci

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[WIP] Dashboard: add input error tracking #985

[WIP] Dashboard: add input error tracking #985

Uh oh!

proy30 commented Jun 10, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

proy30 Jun 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

[WIP] Dashboard: add input error tracking #985

Are you sure you want to change the base?

[WIP] Dashboard: add input error tracking #985

Uh oh!

Conversation

proy30 commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

proy30 Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

proy30 commented Jun 10, 2025 •

edited

Loading