[ssr-client] Move experimental hydrate modules by augustjk · Pull Request #3720 · lit/lit

augustjk · 2023-03-10T22:17:48Z

This PR can be reviewed commit by commit.

Copy experimental hydrate modules to ssr-client
Copies contents of experimental files to new location
Update to fix type errors after copying
As _$LH is being pulled from lit-html package, @internal marked properties became invisible.
Some of the @internal markings for classes and types that were never meant for public consumption were removed.
For others, like those in ChildPart and AttributePart, type assertions were added.
Update ssr-client package
Update package.json files, exports, wireit configs, rollup to add new entry and node build.
Add deprecation notes to original
I'm leaving the original contents there and marking deprecated, since trying to re-export from @lit-labs/ssr-client introduces a circular dependency as @lit-labs/ssr-client itself depends on lit-html.
experimental-hydrate-support.js is side-effectful so added a console.warn for deprecation warning.

To do: maybe in a separate PR, would be to update all our docs, examples, and integrations to use the new location.

Open to discussion: if we need to make any changes to these going forward, do we update both locations until we remove the originals from lit-html and lit-element (Lit3?) or just update the @lit-labs/ssr-client?

changeset-bot · 2023-03-10T22:17:51Z

🦋 Changeset detected

Latest commit: b992c5d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages

Name	Type
@lit-labs/eleventy-plugin-lit	Patch
@lit-labs/ssr-react	Patch
@lit-labs/testing	Patch
@lit-labs/nextjs	Patch
@lit-labs/ssr	Patch
@lit-labs/ssr-client	Minor
lit-element	Patch
lit-html	Patch
lit	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2023-03-10T22:18:17Z

📊 Tachometer Benchmark Results

Summary

nop-update

lit-html-kitchen-sink: unsure 🔍 -5% - +2% (-0.78ms - +0.35ms)
^{this-change vs tip-of-tree}

render

lit-element-list: 75.81ms - 79.03ms
lit-html-kitchen-sink: unsure 🔍 -4% - +8% (-1.46ms - +2.74ms)
^{this-change vs tip-of-tree}
lit-html-repeat: unsure 🔍 -2% - +11% (-0.22ms - +1.17ms)
^{this-change vs tip-of-tree}
lit-html-template-heavy: unsure 🔍 -3% - +1% (-1.78ms - +0.68ms)
^{this-change vs tip-of-tree}
reactive-element-list: unsure 🔍 -6% - +0% (-2.98ms - +0.04ms)
^{this-change vs tip-of-tree}

update

lit-element-list: 753.09ms - 762.46ms
lit-html-kitchen-sink: unsure 🔍 -3% - +4% (-2.44ms - +2.84ms)
^{this-change vs tip-of-tree}
lit-html-repeat: unsure 🔍 -9% - +10% (-27.32ms - +32.20ms)
^{this-change vs tip-of-tree}
lit-html-template-heavy: unsure 🔍 -2% - +1% (-2.44ms - +1.07ms)
^{this-change vs tip-of-tree}
reactive-element-list: unsure 🔍 -1% - +1% (-10.30ms - +8.95ms)
^{this-change vs tip-of-tree}

update-reflect

lit-element-list: 726.25ms - 734.48ms
reactive-element-list: unsure 🔍 -1% - +1% (-8.61ms - +6.62ms)
^{this-change vs tip-of-tree}

Results

lit-element-list

Browser: chrome-headless 111.0.5563.110
Sample size: 50
Built by: Benchmarks #4601
Commit: c617b3a

render

Version	Avg time	vs
	75.81ms - 79.03ms	-

update

Version	Avg time	vs
	753.09ms - 762.46ms	-

update-reflect

Version	Avg time	vs
	726.25ms - 734.48ms	-

lit-html-kitchen-sink

Browser: chrome-headless 111.0.5563.110
Sample size: 30
Built by: Benchmarks #4601
Commit: c617b3a

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	32.06ms - 35.04ms	-	unsure 🔍 -4% - +8% -1.46ms - +2.74ms	unsure 🔍 -7% - +6% -2.46ms - +1.92ms
tip-of-tree tip-of-tree	31.44ms - 34.38ms	unsure 🔍 -8% - +4% -2.74ms - +1.46ms	-	unsure 🔍 -9% - +4% -3.09ms - +1.26ms
previous-release previous-release	32.22ms - 35.43ms	unsure 🔍 -6% - +7% -1.92ms - +2.46ms	unsure 🔍 -4% - +9% -1.26ms - +3.09ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	78.79ms - 82.54ms	-	unsure 🔍 -3% - +4% -2.44ms - +2.84ms	unsure 🔍 -5% - +2% -3.81ms - +1.84ms
tip-of-tree tip-of-tree	78.61ms - 82.33ms	unsure 🔍 -4% - +3% -2.84ms - +2.44ms	-	unsure 🔍 -5% - +2% -3.99ms - +1.62ms
previous-release previous-release	79.55ms - 83.76ms	unsure 🔍 -2% - +5% -1.84ms - +3.81ms	unsure 🔍 -2% - +5% -1.62ms - +3.99ms	-

nop-update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	16.48ms - 17.31ms	-	unsure 🔍 -5% - +2% -0.78ms - +0.35ms	unsure 🔍 -3% - +4% -0.49ms - +0.65ms
tip-of-tree tip-of-tree	16.73ms - 17.49ms	unsure 🔍 -2% - +5% -0.35ms - +0.78ms	-	unsure 🔍 -1% - +5% -0.25ms - +0.83ms
previous-release previous-release	16.43ms - 17.20ms	unsure 🔍 -4% - +3% -0.65ms - +0.49ms	unsure 🔍 -5% - +1% -0.83ms - +0.25ms	-

lit-html-repeat

Browser: chrome-headless 111.0.5563.110
Sample size: 30
Built by: Benchmarks #4601
Commit: c617b3a

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	11.05ms - 12.07ms	-	unsure 🔍 -2% - +11% -0.22ms - +1.17ms	unsure 🔍 -5% - +7% -0.54ms - +0.85ms
tip-of-tree tip-of-tree	10.61ms - 11.56ms	unsure 🔍 -10% - +2% -1.17ms - +0.22ms	-	unsure 🔍 -9% - +3% -0.99ms - +0.35ms
previous-release previous-release	10.93ms - 11.88ms	unsure 🔍 -7% - +5% -0.85ms - +0.54ms	unsure 🔍 -3% - +9% -0.35ms - +0.99ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	295.47ms - 338.69ms	-	unsure 🔍 -9% - +10% -27.32ms - +32.20ms	unsure 🔍 -6% - +12% -17.25ms - +36.52ms
tip-of-tree tip-of-tree	294.18ms - 335.09ms	unsure 🔍 -10% - +9% -32.20ms - +27.32ms	-	unsure 🔍 -6% - +11% -18.77ms - +33.16ms
previous-release previous-release	291.45ms - 323.43ms	unsure 🔍 -11% - +5% -36.52ms - +17.25ms	unsure 🔍 -10% - +6% -33.16ms - +18.77ms	-

lit-html-template-heavy

Browser: chrome-headless 111.0.5563.110
Sample size: 50
Built by: Benchmarks #4601
Commit: c617b3a

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	54.45ms - 56.18ms	-	unsure 🔍 -3% - +1% -1.78ms - +0.68ms	unsure 🔍 -2% - +2% -1.14ms - +1.34ms
tip-of-tree tip-of-tree	54.99ms - 56.74ms	unsure 🔍 -1% - +3% -0.68ms - +1.78ms	-	unsure 🔍 -1% - +3% -0.60ms - +1.90ms
previous-release previous-release	54.33ms - 56.11ms	unsure 🔍 -2% - +2% -1.34ms - +1.14ms	unsure 🔍 -3% - +1% -1.90ms - +0.60ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	111.42ms - 113.20ms	-	unsure 🔍 -2% - +1% -2.44ms - +1.07ms	unsure 🔍 -2% - +1% -2.10ms - +0.73ms
tip-of-tree tip-of-tree	111.48ms - 114.50ms	unsure 🔍 -1% - +2% -1.07ms - +2.44ms	-	unsure 🔍 -2% - +2% -1.86ms - +1.87ms
previous-release previous-release	111.89ms - 114.09ms	unsure 🔍 -1% - +2% -0.73ms - +2.10ms	unsure 🔍 -2% - +2% -1.87ms - +1.86ms	-

reactive-element-list

Browser: chrome-headless 111.0.5563.110
Sample size: 50
Built by: Benchmarks #4601
Commit: c617b3a

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	49.64ms - 51.57ms	-	unsure 🔍 -6% - +0% -2.98ms - +0.04ms	unsure 🔍 -4% - +2% -1.79ms - +1.23ms
tip-of-tree tip-of-tree	50.91ms - 53.24ms	unsure 🔍 -0% - +6% -0.04ms - +2.98ms	-	unsure 🔍 -1% - +6% -0.46ms - +2.84ms
previous-release previous-release	49.71ms - 52.05ms	unsure 🔍 -2% - +4% -1.23ms - +1.79ms	unsure 🔍 -5% - +1% -2.84ms - +0.46ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	758.56ms - 771.41ms	-	unsure 🔍 -1% - +1% -10.30ms - +8.95ms	unsure 🔍 -1% - +1% -9.16ms - +8.28ms
tip-of-tree tip-of-tree	758.49ms - 772.83ms	unsure 🔍 -1% - +1% -8.95ms - +10.30ms	-	unsure 🔍 -1% - +1% -9.05ms - +9.52ms
previous-release previous-release	759.52ms - 771.32ms	unsure 🔍 -1% - +1% -8.28ms - +9.16ms	unsure 🔍 -1% - +1% -9.52ms - +9.05ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	750.91ms - 761.69ms	-	unsure 🔍 -1% - +1% -8.61ms - +6.62ms	unsure 🔍 -1% - +1% -9.95ms - +6.34ms
tip-of-tree tip-of-tree	751.91ms - 762.67ms	unsure 🔍 -1% - +1% -6.62ms - +8.61ms	-	unsure 🔍 -1% - +1% -8.95ms - +7.33ms
previous-release previous-release	751.99ms - 764.21ms	unsure 🔍 -1% - +1% -6.34ms - +9.95ms	unsure 🔍 -1% - +1% -7.33ms - +8.95ms	-

_{tachometer-reporter-action v2 for Benchmarks}

justinfagnani · 2023-03-27T21:59:05Z

I worry about leaving the existing files in place, even with deprecation warnings. Will versions always be kept in sync? Even if so, will people get version mismatches between lit-html and ssr, like they already have?

I'd be templated to say that since these files are "experimental", that users just need to upgrade to the new locations. This would be the one outward breaking change in 3.0, and I think we can live with that.

justinfagnani · 2023-03-27T21:59:45Z

@augustjk do you need to set the base branch to 3.0 now?

justinfagnani

Nice work!

This PR should contain the updates to refer to the files in their new proper location though:

~~Update the package.json, .gitignore, rollup.config.js of lit, lit-html, and lit-element to remove entries for the support files.~~
Update lit-element/src/test/node-import.ts to use new files locations
Update SSR demos to use new files locations
Update 11ty plugin README and demo
Update labs/nextjs
Update testing README

justinfagnani · 2023-03-28T01:24:08Z

+import type {PropertyValues} from '@lit/reactive-element';
+import {render, RenderOptions} from 'lit-html';
+import {hydrate} from 'lit-html/experimental-hydrate.js';
+import {HYDRATE_INTERNALS_ATTR_PREFIX} from '@lit-labs/ssr-dom-shim';


I wish I had caught this in the SSR-internals code review. I don't think the client packages should be depending on the shim package like this. I think we can define this attribute a bit like a protocol and just define it in multiple places so we don't need this dependency. At least I'd want to make a separate module for this in ssr-dom-shim.

Makse sense. Filed #3769

Can you just copy the value into here now so that this package doesn't need to depend on the ssr-dom-shim?

- Add more props to private-ssr-support - Make TemplateInstance._parts a stable prop - Add node build to rollup config - Export everything from hydrate-lit-html

augustjk · 2023-03-29T00:01:38Z

@justinfagnani Addressed the concerns.

Could you take a look at this commit in particular 8559720 ?

Trying to use the hydration modules from ssr-client package surfaced additional issues caused by it being outside so I had to make some changes.

Namely, I added more properties to lit-html/private-ssr-support.js and made TemplateInstance.prototype._parts into a stable part and renamed to _$parts.

justinfagnani · 2023-03-30T19:14:25Z

Namely, I added more properties to lit-html/private-ssr-support.js and made TemplateInstance.prototype._parts into a stable part and renamed to _$parts.

That probably had to be done anyway to support multiple hydrating versions of lit-html in a render tree.

justinfagnani

🎉

justinfagnani · 2023-03-30T19:18:57Z

+import type {PropertyValues} from '@lit/reactive-element';
+import {render, RenderOptions} from 'lit-html';
+import {hydrate} from 'lit-html/experimental-hydrate.js';
+import {HYDRATE_INTERNALS_ATTR_PREFIX} from '@lit-labs/ssr-dom-shim';


Can you just copy the value into here now so that this package doesn't need to depend on the ssr-dom-shim?

LasseRosenow · 2023-04-03T23:05:16Z

After this got merged I have this error now:

Error [ERR_MODULE_NOT_FOUND]: Cannot find module 'C:\Users\Lasse\Desktop\lit-ssr\node_modules\@lit-labs\ssr-client\node\index.js' imported from C:\Users\Lasse\Desktop\lit-ssr\node_modules\@lit-labs\ssr\lib\render-value.js

augustjk · 2023-04-03T23:52:21Z

@LasseRosenow thanks for the report. this should be fixed in the latest release of @lit-labs/ssr-client.

augustjk requested review from aomarks and kevinpschaaf March 10, 2023 22:17

augustjk requested a review from justinfagnani as a code owner March 10, 2023 22:17

augustjk added 5 commits March 27, 2023 14:53

Copy experimental hydrate modules to ssr-client

d06d66e

Update to fix type errors after copying

e31dc5c

Update ssr-client package

0d04bcc

Add deprecation notes to original

88559ff

Add changeset

e7cfe49

augustjk force-pushed the move-experimental-hydrate branch from 0922356 to e7cfe49 Compare March 27, 2023 21:53

augustjk mentioned this pull request Mar 27, 2023

[all] Remove experimental hydration modules #3765

Merged

justinfagnani requested changes Mar 28, 2023

View reviewed changes

augustjk added 4 commits March 28, 2023 16:13

Fixes to make hydration to work in ssr-client

8559720

- Add more props to private-ssr-support - Make TemplateInstance._parts a stable prop - Add node build to rollup config - Export everything from hydrate-lit-html

Update all usage of experimental hydrate

c1a6bbb

Add changeset

a440aad

Add console.warn on experimental-hydrate

dae2e5b

augustjk mentioned this pull request Mar 28, 2023

[labs/ssr-client] Don't depend on shim module for internals attr prefix #3769

Open

1 task

augustjk requested a review from justinfagnani March 29, 2023 00:01

justinfagnani approved these changes Mar 30, 2023

View reviewed changes

justinfagnani mentioned this pull request Mar 30, 2023

[all] Lit 3.0 prereleases #3774

Closed

10 tasks

Remove dependency on ssr-dom-shim

b992c5d

augustjk merged commit 575fb57 into main Apr 3, 2023

augustjk deleted the move-experimental-hydrate branch April 3, 2023 20:20

lit-robot mentioned this pull request Apr 3, 2023

Version Packages #3778

Merged

augustjk mentioned this pull request Apr 3, 2023

[labs/ssr-client] Fix for removing @types/web-ie11 dep #3779

Merged

augustjk mentioned this pull request Apr 3, 2023

[labs/ssr-client] Node build artifact not included in npm package #3780

Closed

augustjk mentioned this pull request May 12, 2023

[labs/ssr-client] Bump dependency for requisite version of lit-html #3899

Closed

1 task

thescientist13 mentioned this pull request Feb 28, 2024

feature/issue 1197 Lit v3 upgrade and SSR fixes and enhancements ProjectEvergreen/greenwood#1201

Merged

16 tasks

Uh oh!

Conversation

augustjk commented Mar 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Mar 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions Bot commented Mar 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Tachometer Benchmark Results

Summary

nop-update

render

update

update-reflect

Results

render

update

update-reflect

render

update

nop-update

render

update

render

update

render

update

update-reflect

Uh oh!

justinfagnani commented Mar 27, 2023

Uh oh!

justinfagnani commented Mar 27, 2023

Uh oh!

justinfagnani left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justinfagnani Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

augustjk Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

justinfagnani Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

augustjk commented Mar 29, 2023

Uh oh!

justinfagnani commented Mar 30, 2023

Uh oh!

justinfagnani left a comment

Choose a reason for hiding this comment

Uh oh!

justinfagnani Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

LasseRosenow commented Apr 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

augustjk commented Apr 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

augustjk commented Mar 10, 2023 •

edited

Loading

changeset-bot Bot commented Mar 10, 2023 •

edited

Loading

github-actions Bot commented Mar 10, 2023 •

edited

Loading

justinfagnani left a comment •

edited

Loading

LasseRosenow commented Apr 3, 2023 •

edited

Loading