documentation/known-bugs.md

   1 # Known Bugs
   2
   3 Given that VimFx operates outside the bounds of what Mozilla supports, there
   4 are some things that VimFx doesn't play along with well. This page lists
   5 problems that affect VimFx when run on versions of Firefox we support
   6 (latest *Release* and *ESR* versions).
   7
   8 ## Responsive Design Mode
   9
  10 **Affected**: Firefox <= 78
  11 **Workaround**: `devtools.responsive.browserUI.enabled;true`
  12
  13 Launching the (old) Responsive Design Mode breaks VimFx for this tab. The only
  14 way to recover is to copy-paste the URL into a new tab.
  15
  16 The [new RDM] does not have this bug; it can be enabled by switching
  17 `devtools.responsive.browserUI.enabled` to `true` in `about:config` in Firefox
  18 78 ESR. There is no workaround for Firefox 68 ESR.
  19
  20 [new RDM]: https://mail.mozilla.org/pipermail/firefox-dev/2020-March/007397.html
  21
  22 ## Fission
  23
  24 **Affected**: some Nightly users, future versions
  25 **Workaround**: `fission.autostart;false`
  26
  27 With [Fission] enabled, VimFx can't inspect out-of-process iframes.
  28
  29 Fission, sometimes called *Site Isolation*, is not (yet) turned on by default,
  30 but can be disabled by switching `fission.autostart` to `false` in
  31 `about:config`. With Fission, VimFx cannot place hint markers or determine
  32 whether an editable element is active in iframes from a different domain to the
  33 top document. We will instead enter insert mode whenever such an iframe is
  34 active (so input elements are usable; hit Escape or click outside the iframe to
  35 let VimFx re-gain control).
  36
  37 <!-- Mozilla are doing a/b testing on around 5% of Nightly 83+ installations,
  38 where they enable Fission.
  39 https://bugzilla.mozilla.org/show_bug.cgi?id=1660366 -->
  40
  41 <!-- For full OOP-iframe support it is way too early.
  42 As of May 2020, not even Firefox' DevTools support it, let alone other Vim
  43 like (web)extensions. Further, I suspect that to avoid a huge rewrite of how
  44 VimFx handles element discovery and interaction, we'd need cross-process-DOM
  45 APIs that just don't exist right now. -->
  46
  47 [Fission]: https://wiki.mozilla.org/Project_Fission
  48
  49 ## VimFx behaves broken after installation
  50
  51 **Affected**: all supported versions
  52 **Solution**: restart browser
  53
  54 For some as-of-yet undetermined reason, the addon sometimes breaks after
  55 installation (or upgrade)<!-- possibly Gecko internals changed and the
  56 BootstrapLoader is failing -->. Fastest way to restart Firefox is pressing
  57 `<c-s-j>` to open the browser console, then `<c-a-r>` to restart.