Allowing defining potentially non existent components in the running keyword #2898
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If a component defined in running does not exist, the componentPath in updateComponent will be undefined. Added a check that skips the update if that is the case. Otherwise the dashboard will crash as it will try to perform operations on the undefined object that it cannot perform.
…-existent component in the running keyword.
aGitForEveryone
requested review from
alexcjohnson,
T4rk1n and
ndrezn
as code owners
T4rk1n
reviewed
Jun 21, 2024
| @@ -334,6 +334,11 @@ function updateComponent(component_id: any, props: any) { | |||
| return function (dispatch: any, getState: any) { | |||
| const paths = getState().paths; | |||
| const componentPath = getPath(paths, component_id); | |||
| if (typeof componentPath === 'undefined') { | |||
| // Can't find the component that was defined in the running keyword, | |||
| // Let's skip the component to prevent the dashboard from crashing. | |||
There was a problem hiding this comment.
I think it would be better to throw an error unless config.suppress_callback_exceptions=True. It is in state.config, could refactor line 335 to const {paths,config} = getState();
There was a problem hiding this comment.
I added a check for that and threw an error when suppress_callback_exceptions=False
…hrow error Non-existent running components will now only silently passed if surpress_callback_exceptions=True. Otherwise, an error will be thrown. Note: even if an error is thrown, the callback execution is not stopped. Only the side-update of the running component is ignored.
…g components and not suppressing callback exceptions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #2897
When using the running keyword in (regular) callbacks, the app crashes if a component is used that does not exist in the layout. Added a check to only continue with component update it the component was found in the dashboard. Full explanation in #2897.
Contributor Checklist
optionals
CHANGELOG.md