riot-web/test
Eric Eastwood 3572b36648
Fix room list being laggy while scrolling 🐌 (#7939)
Fix https://github.com/vector-im/element-web/issues/21262

Optimizations:

 1. Don't update the `style` (positioning) of hidden tooltips
 1. Don't add DOM elements to the page for hidden tooltips

> ## Performance problems broken down
>
>
> ### Hidden tooltips rendering on `scroll`
>
> You can see that the Tooltip render is attached to the `scroll` event  at [`src/components/views/elements/Tooltip.tsx#L78-L81`](31f0a37ca2/src/components/views/elements/Tooltip.tsx (L78-L81))
>
> The rendering calls [`src/components/views/elements/Tooltip.tsx#L101` -> `updatePosition`](36adba101c/src/components/views/elements/Tooltip.tsx (L101)) which ends up as an expensive "Recalculate Style" because it uses [`Element.getBoundingClientRect()`](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect). This happens many many times within a single `scroll` event. Probably once for each tooltip within the room list **even though no tooltips are event visible as I scroll**. I can see that we're just updating the `style` attribute for a bunch of `.mx_Tooltip_invisible` elements at the end of the document.
>
> Each one of the purple spans below the `scroll` span ends up as a call to `updatePosition`. And a `scroll` event takes 35ms to 60ms to complete which is way over the 16.6ms 60 FPS budget (on a powerful desktop PC), granted these times are with the performance profiling running. This is without the Passbolt extension explained below.
>
> And the room list contains about 141 rooms (`document.querySelectorAll('.mx_RoomTile').length`):
>
> ![](https://user-images.githubusercontent.com/558581/156273551-e744d3d6-93c6-4b07-bb12-6aad361f96a2.png)
>
>
>
> ### Passbolt Chrome browser extension exacerbates the problem
>
> In order to login to Passbolt, it requires a browser extension which defaults to mucking up all pages:
>
> <img src="https://user-images.githubusercontent.com/558581/156275644-bc26b1f5-5d99-4eae-b74b-c2028f2f1baf.png" width="300">
>
>
> The extension source seems to be available: https://github.com/passbolt/passbolt_browser_extension
>
> The Passbolt Chrome extension has a `MutationObserver` listening to all attribute and element changes to the whole `<body>` of the `document` so it can `findAndSetAuthenticationFields` (find form elements and autofill).
>
>
> [`passbolt/passbolt_styleguide` -> `src/react-web-integration/lib/InForm/InFormManager.js#L143`](1c5eddc910/src/react-web-integration/lib/InForm/InFormManager.js (L143))
> ```js
> this.mutationObserver.observe(document.body, { attributes: true, childList: true, subtree: true });
> ```
>
> This causes a bunch of `Forced reflow` because the Tooltip `updatePosition` is mutating the element `style` attribute and Passbolt `MutationObserver` callbacks are querying the whole DOM looking for form elements all in the same frame.
>
> Under the `scroll` event, all of the little spans are the `MutationObserver` -> `findAndSetAuthenticationFields`. With the Passbolt extension, scrolling is verrrrry crunchy and bad.
>
> ![](https://user-images.githubusercontent.com/558581/156144998-8cf7686f-3c7b-42f8-8d81-ff780bae0ab5.png)
>
>
> #### Workaround
>
> Instead of running Passbolt on all sites, we can enable the extension to only run on the domain for Passbolt instance itself. I'm guessing the Passbolt extension also does autofill stuff on sites but I always login manually to the Passbolt instance so this solution works for me �
>
> **Extensions** -> **Passbolt** -> **Details** -> Change **Site access** to `On specific sites` -> Enter in your Passbolt instance `https://passbolt.example.com/`
>
> ![](https://user-images.githubusercontent.com/558581/156275630-a53ef6a1-c058-4ac9-aa08-ae50b90e72c9.png)
>
> *-- https://github.com/vector-im/element-web/issues/21262*
2022-03-02 13:20:01 -06:00
..
accessibility Keybinding code unification #3 (#7850) 2022-02-23 09:12:04 +00:00
audio dont re-prepare voice messages (#7897) 2022-03-01 09:43:32 +01:00
autocomplete Auto-fix lint errors 2021-06-29 13:11:58 +01:00
components Fix room list being laggy while scrolling 🐌 (#7939) 2022-03-02 13:20:01 -06:00
editor Clean up some unit test logs (#7857) 2022-02-21 16:57:44 +00:00
end-to-end-tests Add support for redirecting to external pages after logout (#7905) 2022-03-01 11:06:17 -07:00
i18n
i18n-test fallback properly with pluralized strings (#7495) 2022-01-10 14:54:57 +01:00
img
notifications Update eslint plugin & fix silly indenting 2021-08-03 17:07:37 +01:00
settings/watchers Unit tests for getEffectiveTheme (#7051) 2021-10-29 09:11:55 +01:00
stores Mandate use of js-sdk/src/matrix import over js-sdk/src (#7933) 2022-03-01 20:42:05 +00:00
test-utils Mandate use of js-sdk/src/matrix import over js-sdk/src (#7933) 2022-03-01 20:42:05 +00:00
utils Mandate use of js-sdk/src/matrix import over js-sdk/src (#7933) 2022-03-01 20:42:05 +00:00
.eslintrc.js Migrate to `eslint-plugin-matrix-org` 2021-06-29 12:51:13 +01:00
CallHandler-test.ts Mandate use of js-sdk/src/matrix import over js-sdk/src (#7933) 2022-03-01 20:42:05 +00:00
DecryptionFailureTracker-test.js Mandate use of js-sdk/src/matrix import over js-sdk/src (#7933) 2022-03-01 20:42:05 +00:00
DeviceListener-test.ts Mandate use of js-sdk/src/matrix import over js-sdk/src (#7933) 2022-03-01 20:42:05 +00:00
KeyBindingsManager-test.ts Work towards unifying `KeyboardShortcuts` and `KeyBindingsDefaults` #2 (#7674) 2022-01-31 15:55:45 +00:00
Markdown-test.ts Refactor matrix-linkify module (#7279) 2021-12-03 14:00:56 +00:00
PosthogAnalytics-test.ts Fix spacing errors (#7484) 2022-01-10 12:57:20 +00:00
ScalarAuthClient-test.js Auto-fix lint errors 2021-06-29 13:11:58 +01:00
Terms-test.js Mandate use of js-sdk/src/matrix import over js-sdk/src (#7933) 2022-03-01 20:42:05 +00:00
TextForEvent-test.ts Mandate use of js-sdk/src/matrix import over js-sdk/src (#7933) 2022-03-01 20:42:05 +00:00
UserActivity-test.js Auto fix 2021-10-22 17:23:37 -05:00
createRoom-test.js Upgrade to jest 27 (#7699) 2022-02-02 13:02:17 +01:00
globalSetup.js Fix TimeZone to be UTC in Jest tests (#7082) 2021-11-04 10:39:49 +00:00
languageHandler-test.ts Add support for overriding strings in the app (#7886) 2022-03-01 11:53:09 -07:00
linkify-matrix-test.ts Upgrade linkifyjs to fix schemes as domain prefixes (#7628) 2022-01-25 17:37:54 +00:00
minimal-sdk.js Fix right panel data flow (#7811) 2022-02-16 11:19:28 +00:00
setupTests.js Check 'useSystemTheme' in quick settings theme switcher (#7809) 2022-02-24 10:01:06 +01:00
skinned-sdk.js Add configuration to disable relative date markers in timeline (#7405) 2021-12-21 10:08:22 +01:00