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

FIO-9649: update componentMatches fn to not omit layout components; add tests #218

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

brendanbond
Copy link
Contributor

@brendanbond brendanbond commented Jan 30, 2025

Link to Jira Ticket

https://formio.atlassian.net/browse/FIO-9649

Description

This issue surfaced with a regression in the resourcefields component shim used by the Save Submission action.

Previously, I could call getComponent('keyToLayoutComponent' from a nested component instance (e.g. in the Developer Portal application's resourcefields component shim, which calls that function to get a Panel component). However, with the introduction of the new pathing regime, this broke because we omit layout components by checking the component JSON for the input property.

This PR updates that change to allow for layout components to be retrieved using getComponent using just their key.

Breaking Changes / Backwards Compatibility

n/a

Dependencies

n/a

How has this PR been tested?

Automated test added

Checklist:

  • I have completed the above PR template
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • My changes include tests that prove my fix is effective (or that my feature works as intended)
  • New and existing unit/integration tests pass locally with my changes
  • Any dependent changes have corresponding PRs that are listed above

@@ -695,7 +695,7 @@ export function matchComponent(component: Component, query: any, paths?: Compone
export function getComponent(
components: Component[],
path: any,
includeAll: any = false,
includeAll: any = true,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since there is evidence (described in the PR description) that we should expect getComponent to include layout components, I've changed this default parameter.

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

Successfully merging this pull request may close these issues.

1 participant