Skip to content

Commit

Permalink
prefer attribute selector for selecting element ids (#191632)
Browse files Browse the repository at this point in the history
## Summary

This PR fixes an error that was discovered ahead of the react 18
upgrade(#138222).

Why are we concerned about this? Whilst `useId` isn't directly used in
our codebase, it is utilized by EUI's `useGeneratedHtmlId` hook, see
https://github.com/elastic/eui/blob/v95.8.0/packages/eui/src/services/accessibility/html_id_generator.ts#L73-L74,
the useId hook returns a string that is bounded by colons; if passed to
`document.querySelector` as an ID selector, they would cause errors (see
facebook/react#26839). As a result, instances
where these IDs are being used with `querySelector` have been modified
to instead use an attribute selector equivalent to the corresponding ID
selector.

<!-- ### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
-->

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
  • Loading branch information
eokoneyo and elasticmachine committed Sep 5, 2024
1 parent c07e946 commit 8627a57
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ describe('UserProfilesPopover', () => {
closePopover={[MockFunction]}
display="inline-block"
hasArrow={true}
initialFocus="#searchInput_generated-id"
initialFocus="[id=\\"searchInput_generated-id\\"]"
isOpen={false}
ownFocus={true}
panelPaddingSize="none"
Expand Down Expand Up @@ -140,7 +140,7 @@ describe('UserProfilesPopover', () => {
/>
);

expect(wrapper.find('EuiPopover').prop('initialFocus')).toBe('#searchInput_generated-id');
expect(wrapper.find('EuiPopover').prop('initialFocus')).toBe('[id="searchInput_generated-id"]');
expect(wrapper.find('UserProfilesSelectable').prop('searchInputId')).toBe(
'searchInput_generated-id'
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export const UserProfilesPopover = <Option extends UserProfileWithAvatar | null>
});

return (
<EuiPopover panelPaddingSize="none" initialFocus={`#${searchInputId}`} {...popoverProps}>
<EuiPopover panelPaddingSize="none" initialFocus={`[id="${searchInputId}"]`} {...popoverProps}>
<EuiContextMenuPanel title={title}>
<UserProfilesSelectable {...selectableProps} searchInputId={searchInputId} />
</EuiContextMenuPanel>
Expand Down
6 changes: 3 additions & 3 deletions packages/shared-ux/modal/tabbed/src/tabbed_modal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,13 @@ const TabbedModalInner: FC<ITabbedModalInner> = ({
const { tabs, state, dispatch } =
useModalContext<Array<IModalTabDeclaration<Record<string, any>>>>();
const { selectedTabId, defaultSelectedTabId } = state.meta;
const tabbedModalHTMLId = useGeneratedHtmlId();
const tabbedModalHeadingHTMLId = useGeneratedHtmlId();
const tabbedModalHTMLId = useGeneratedHtmlId({ prefix: 'tabbedModal' });
const tabbedModalHeadingHTMLId = useGeneratedHtmlId({ prefix: 'tabbedModal' });
const defaultTabCoordinates = useRef(new Map<string, Pick<DOMRect, 'top'>>());
const [translateYValue, setTranslateYValue] = useState(0);

const onTabContentRender = useCallback(() => {
const tabbedModal = document.querySelector(`#${tabbedModalHTMLId}`) as HTMLDivElement;
const tabbedModal = document.querySelector(`[id="${tabbedModalHTMLId}"]`) as HTMLDivElement;

if (!defaultTabCoordinates.current.get(defaultSelectedTabId)) {
// on initial render the modal animates into it's final position
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ export function ChangeDataView({
isOpen={isPopoverOpen}
closePopover={() => setPopoverIsOpen(false)}
panelPaddingSize="none"
initialFocus={`#${searchListInputId}`}
initialFocus={`[id="${searchListInputId}"]`}
display="block"
buffer={8}
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export function NormalizationMenu(props: Props) {
return (
<EuiPopover
anchorPosition="downRight"
initialFocus={`#${baselineScaleFactorInputId}`}
initialFocus={`[id="${baselineScaleFactorInputId}"]`}
button={
<EuiFormControlLayout
onClick={() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export const FilterByAssigneesPopover: FC<FilterByAssigneesPopoverProps> = memo(
<EuiFilterGroup>
<EuiPopover
panelPaddingSize="none"
initialFocus={`#${searchInputId}`}
initialFocus={`[id="${searchInputId}"]`}
button={button}
isOpen={isPopoverOpen}
panelStyle={{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ export const Assignees: FC<AssigneesProps> = memo(
return (
<EuiPopover
panelPaddingSize="none"
initialFocus={`#${searchInputId}`}
initialFocus={`[id="${searchInputId}"]`}
button={
<UpdateAssigneesButton
togglePopover={togglePopover}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export const ArgumentFileSelector = memo<
isOpen={state.isPopoverOpen}
closePopover={handleClosePopover}
anchorPosition="upCenter"
initialFocus={`#${filePickerUUID}`}
initialFocus={`[id="${filePickerUUID}"]`}
button={
<EuiFlexGroup responsive={false} alignItems="center" gutterSize="none">
<EuiFlexItem grow={false} className="eui-textTruncate" onClick={handleOpenPopover}>
Expand Down

0 comments on commit 8627a57

Please sign in to comment.