testing-library/svelte-testing-library

Happy-DOM on svelte5 branch causes PrettyFormatPluginError when rendering 1 line

sureshjoshi opened this issue · 11 comments

sureshjoshi commented

I made a brief comment on #284 - but I thought I could add a partial reproduction step. I wasn't able to cause this on main - so I don't know if it's related to svelte5, or the fact that the happy-dom commits haven't been merged. Either way, it took me hours to dig in and debug this - so hopefully this will help anyone else running down this path.

On the svelte5 branch, I created a mostly empty Svelte component:

<!-- EmptyComp.svelte -->
<h1>Hello world!</h1>

and I modified the debug.test.js to point to this:

import { describe, test } from 'vitest'
import { render } from '..'
import EmptyComp from './fixtures/EmptyComp.svelte'

describe('debug', () => {
  test('pretty prints the container', () => {
    const { debug } = render(EmptyComp)
    debug()
  })
})

Running test using jsdom, and there are no problems - passes.

Installing the latest happy-dom and running test returns this PrettyFormatPluginError.

PrettyFormatPluginError: Cannot read properties of null (reading 'toLowerCase')
 ❯ Object.serialize node_modules/.pnpm/@testing-library+dom@9.3.4/node_modules/@testing-library/dom/dist/@testing-library/dom.esm.js:107:77

 ❯ printPlugin node_modules/.pnpm/pretty-format@27.5.1/node_modules/pretty-format/build/index.js:330:16
 ❯ printer node_modules/.pnpm/pretty-format@27.5.1/node_modules/pretty-format/build/index.js:379:12
 ❯ node_modules/.pnpm/@testing-library+dom@9.3.4/node_modules/@testing-library/dom/dist/@testing-library/dom.esm.js:43:79
 ❯ printChildren node_modules/.pnpm/@testing-library+dom@9.3.4/node_modules/@testing-library/dom/dist/@testing-library/dom.esm.js:42:89
 ❯ Object.serialize node_modules/.pnpm/@testing-library+dom@9.3.4/node_modules/@testing-library/dom/dist/@testing-library/dom.esm.js:114:75
 ❯ printPlugin node_modules/.pnpm/pretty-format@27.5.1/node_modules/pretty-format/build/index.js:330:16
 ❯ printer node_modules/.pnpm/pretty-format@27.5.1/node_modules/pretty-format/build/index.js:379:12
 ❯ node_modules/.pnpm/@testing-library+dom@9.3.4/node_modules/@testing-library/dom/dist/@testing-library/dom.esm.js:43:79

What's weird is that, if there are 2 HTML lines in the component, the error goes away 🤦🏽

<!-- EmptyComp.svelte -->
<h1>Hello world!</h1>
<h1>Hello world!</h1>
sureshjoshi commented

Upon some searching last night (and just now), I found this ticket about happy-dom tests failing with > 2 components in a file.

sveltejs/svelte#10358

Based on the content of that ticket, I'm now thinking this is more a svelte bug? But it passes in JSDom, so would that make it a happy-dom bug?

Anyways, opening for posterity, and with the hope someone smarter than me can enlighten me 😄

mcous commented

Thanks for the heads up @sureshjoshi, this is weird! I agree, I don't think it's a bug with anything we're doing here. For now, I've put up a newer Svelte 5 branch - #321 - so we can at least see this failure in our CI matrix

  • 👍1
sureshjoshi commented

Yeah, feels like a Svelte issue - but it's good to track in the hopes that it'll get fixed in one of these Svelte Next's

mcous commented

This issue is suspiciously similar to #343. In the case of that issue, I was actually able to identify the causes in the Svelte and Happy DOM codebases. I'm still struggling to find a cause for this issue here, but due to some interaction between these two libraries, Element's are getting created (or updated) with their tagName property set to null

  • 👍1
mcous commented

Alright, pretty sure I've found found the cause:

  • Svelte 5 makes various DOM operation calls through Node.prototype and Element.prototype for performance, including cloneNode
  • Because of the way Happy DOM uses classes and inheritance, this doesn't work at all

Given the Svelte code in question works happily in the browser, I think this is a Happy DOM bug. But to my eyes, it also looks like a large architectural change to fix on the Happy DOM side, which is pretty unfortunate

sureshjoshi commented

Wow... Okay, well... That's something for sure. Thanks for the investigation! I guess it's JSDom for me for the near-future

mcous commented

Just kidding, the happy-dom maintainers are on top of their stuff! happy-dom@14.7.1 has been released and it resolves the issue. Our happy-dom test suite is now passing on Svelte 5

sureshjoshi commented

Hooray! I didn't even have enough time to pn install before they fixed it :)

  • 😄1
github-actions commented

🎉 This issue has been resolved in version 4.2.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

mcous commented

@yanick another one bites the dust! Not sure why semantic release didn't catch this one, but this issue has been resolved upstream and can be closed

yanick commented

W00t!