Memory leak in Shortcuts class #2631

melenudo · 2024-02-21T19:07:21Z

Editor.js Version

v2.29.0

Issue description

Hi!

I've found a memory leak in the Shortcuts class. When you remove the shortcut for an element you don't check if the element's shortcuts are empty and left the element in the registeredShortcuts map (with an empty array):

editor.js/src/components/utils/shortcuts.ts

Line 89 in b619946

this.registeredShortcuts.set(element, shortcuts.filter(el => el !== shortcut));

If you create a new EditorJS and destroys it, you will see a bunch of detached elements referenced by registeredShortcuts map.

Steps to reproduce:

You can reproduce the issue with this simple html:

<html>
  <body>
    <button id="remove">Remove</button>
    <div id="editor" style="min-width: 700px"></div>
    <script src="https://cdn.jsdelivr.net/npm/@editorjs/editorjs@latest"></script>
    <script>
      let editor = new EditorJS({
        holder: 'editor',
      });

      function remove() {
        document.querySelector('#editor').remove();
        editor.isReady.then(() => {
          editor.destroy();
          editor = undefined;
        });
      }
      document.querySelector('#remove').addEventListener('click', remove);
    </script>
  </body>
</html>

Press "Remove" button and take a snapshot in Chrome dev tools. You will see detached HTMLDivElement's referenced by registeredShortcuts:

If you remove the element from the map when the shortcuts array is empty, the problem disappears:

const newShortcuts = shortcuts.filter(el => el !== shortcut);

newShortcuts.length===0?
  this.registeredShortcuts.delete(element):
  this.registeredShortcuts.set(element, newShortcuts);

The text was updated successfully, but these errors were encountered:

neSpecc added the good first issue label Mar 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Memory leak in Shortcuts class #2631

Memory leak in Shortcuts class #2631

melenudo commented Feb 21, 2024 •

edited

Memory leak in Shortcuts class #2631

Memory leak in Shortcuts class #2631

Comments

melenudo commented Feb 21, 2024 • edited

melenudo commented Feb 21, 2024 •

edited