[lit-labs/compiler] rollup example and source map tests #4077

AndrewJakubowicz · 2023-08-08T20:07:31Z

Issue: #189
RFC: lit/rfcs#21
Full prototype PR: #3984

Why

The initial labs compiler public export is only a TypeScript transform. This makes it usable within multiple build tools that accept TypeScript transformers. E.g., within g3, @rollup/plugin-typescript, ttypescript, and maybe one day natively through TypeScript.

This PR adds an example rollup config for testing source maps. The example rollup config uses @rollup/plugin-typescript to compile the sourcemap test file. A new test has been added to ensure the resulting source maps correctly reference the authored example.

How

Add source-map which allows easy queries on a source map, and manually setup some source map tests.
Add a rollup.source_map_tests.js config which uses the compiler transform to compile a basic typescript file for source map testing.

Risk

This change has minimal risks as it doesn't add or change any logic in the compiler, it's a test only and example only change.

Why not run this transform on lit-html_tests?

Because labs/compiler uses TypeScript 5, while the rest of the monorepo uses TypeScript 4. This will also come in a followup, and can use the example rollup config here as inspiration.

Notes

I noticed in this change that the license does not remain at the top of the generated basic.js file. This will be addressed in a followup.

changeset-bot · 2023-08-08T20:07:34Z

🦋 Changeset detected

Latest commit: 5b1c2db

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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-08-08T20:07:48Z

📊 Tachometer Benchmark Results

Summary

nop-update

this-change, tip-of-tree, previous-release: unsure 🔍 -9% - +5% (-2.30ms - +1.12ms)
^{this-change vs tip-of-tree}

render

this-change: 98.76ms - 102.77ms
this-change, tip-of-tree, previous-release: unsure 🔍 -6% - +3% (-2.27ms - +1.25ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -3% - +2% (-1.63ms - +1.48ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: faster ✔ 0% - 6% (0.13ms - 3.89ms)
^{this-change vs tip-of-tree}

update

this-change: 1053.40ms - 1080.98ms
this-change, tip-of-tree, previous-release: unsure 🔍 -4% - +5% (-3.80ms - +4.83ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -4% - +1% (-5.93ms - +1.24ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -2% - +0% (-23.81ms - +0.85ms)
^{this-change vs tip-of-tree}

update-reflect

this-change: 1014.74ms - 1034.99ms
this-change, tip-of-tree, previous-release: unsure 🔍 -2% - +0% (-21.02ms - +2.90ms)
^{this-change vs tip-of-tree}

Results

this-change

Browser: chrome-headless 115.0.5790.110
Sample size: 50
Built by: Benchmarks #5174
Commit: 5b1c2db

render

Version	Avg time	vs
	98.76ms - 102.77ms	-

update

Version	Avg time	vs
	1053.40ms - 1080.98ms	-

update-reflect

Version	Avg time	vs
	1014.74ms - 1034.99ms	-

this-change, tip-of-tree, previous-release

Browser: chrome-headless 115.0.5790.110
Sample size: 30
Built by: Benchmarks #5174
Commit: 5b1c2db

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	38.28ms - 41.00ms	-	unsure 🔍 -6% - +3% -2.27ms - +1.25ms	unsure 🔍 -8% - +2% -3.10ms - +0.67ms
tip-of-tree tip-of-tree	39.04ms - 41.26ms	unsure 🔍 -3% - +6% -1.25ms - +2.27ms	-	unsure 🔍 -6% - +2% -2.42ms - +1.01ms
previous-release previous-release	39.55ms - 42.16ms	unsure 🔍 -2% - +8% -0.67ms - +3.10ms	unsure 🔍 -3% - +6% -1.01ms - +2.42ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	96.25ms - 101.65ms	-	unsure 🔍 -4% - +5% -3.80ms - +4.83ms	unsure 🔍 -2% - +7% -1.66ms - +6.36ms
tip-of-tree tip-of-tree	95.07ms - 101.80ms	unsure 🔍 -5% - +4% -4.83ms - +3.80ms	-	unsure 🔍 -3% - +7% -2.64ms - +6.32ms
previous-release previous-release	93.64ms - 99.56ms	unsure 🔍 -6% - +2% -6.36ms - +1.66ms	unsure 🔍 -6% - +3% -6.32ms - +2.64ms	-

nop-update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	22.41ms - 25.11ms	-	unsure 🔍 -9% - +5% -2.30ms - +1.12ms	unsure 🔍 -10% - +4% -2.52ms - +1.00ms
tip-of-tree tip-of-tree	23.30ms - 25.40ms	unsure 🔍 -5% - +10% -1.12ms - +2.30ms	-	unsure 🔍 -7% - +6% -1.71ms - +1.37ms
previous-release previous-release	23.39ms - 25.65ms	unsure 🔍 -4% - +11% -1.00ms - +2.52ms	unsure 🔍 -6% - +7% -1.37ms - +1.71ms	-

this-change, tip-of-tree, previous-release

Browser: chrome-headless 115.0.5790.110
Sample size: 50
Built by: Benchmarks #5174
Commit: 5b1c2db

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	62.99ms - 64.93ms	-	unsure 🔍 -3% - +2% -1.63ms - +1.48ms	unsure 🔍 -2% - +2% -1.60ms - +1.28ms
tip-of-tree tip-of-tree	62.82ms - 65.26ms	unsure 🔍 -2% - +3% -1.48ms - +1.63ms	-	unsure 🔍 -3% - +2% -1.70ms - +1.53ms
previous-release previous-release	63.06ms - 65.19ms	unsure 🔍 -2% - +3% -1.28ms - +1.60ms	unsure 🔍 -2% - +3% -1.53ms - +1.70ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	132.08ms - 136.81ms	-	unsure 🔍 -4% - +1% -5.93ms - +1.24ms	unsure 🔍 -3% - +2% -4.06ms - +2.73ms
tip-of-tree tip-of-tree	134.10ms - 139.49ms	unsure 🔍 -1% - +4% -1.24ms - +5.93ms	-	unsure 🔍 -1% - +4% -1.95ms - +5.32ms
previous-release previous-release	132.67ms - 137.55ms	unsure 🔍 -2% - +3% -2.73ms - +4.06ms	unsure 🔍 -4% - +1% -5.32ms - +1.95ms	-

this-change, tip-of-tree, previous-release

Browser: chrome-headless 115.0.5790.110
Sample size: 50
Built by: Benchmarks #5174
Commit: 5b1c2db

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	64.47ms - 66.81ms	-	faster ✔ 0% - 6% 0.13ms - 3.89ms	faster ✔ 0% - 5% 0.09ms - 3.48ms
tip-of-tree tip-of-tree	66.18ms - 69.12ms	slower ❌ 0% - 6% 0.13ms - 3.89ms	-	unsure 🔍 -3% - +3% -1.69ms - +2.14ms
previous-release previous-release	66.20ms - 68.65ms	slower ❌ 0% - 5% 0.09ms - 3.48ms	unsure 🔍 -3% - +2% -2.14ms - +1.69ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	1022.81ms - 1041.38ms	-	unsure 🔍 -2% - +0% -23.81ms - +0.85ms	unsure 🔍 -2% - +0% -18.89ms - +4.44ms
tip-of-tree tip-of-tree	1035.46ms - 1051.70ms	unsure 🔍 -0% - +2% -0.85ms - +23.81ms	-	unsure 🔍 -1% - +1% -6.51ms - +15.02ms
previous-release previous-release	1032.25ms - 1046.39ms	unsure 🔍 -0% - +2% -4.44ms - +18.89ms	unsure 🔍 -1% - +1% -15.02ms - +6.51ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	1027.68ms - 1043.86ms	-	unsure 🔍 -2% - +0% -21.02ms - +2.90ms	unsure 🔍 -2% - +0% -21.48ms - +2.88ms
tip-of-tree tip-of-tree	1036.02ms - 1053.64ms	unsure 🔍 -0% - +2% -2.90ms - +21.02ms	-	unsure 🔍 -1% - +1% -12.91ms - +12.43ms
previous-release previous-release	1035.96ms - 1054.17ms	unsure 🔍 -0% - +2% -2.88ms - +21.48ms	unsure 🔍 -1% - +1% -12.43ms - +12.91ms	-

_{tachometer-reporter-action v2 for Benchmarks}

packages/labs/compiler/rollup.source_map_tests.js

augustjk · 2023-08-08T23:17:20Z

packages/labs/compiler/src/test/source_map_test.ts

+};
+
+test('basic.ts', async () => {
+  const smc = await setupTest('basic.js.map');


probably not a big deal with a single file test like this but maybe it's worth putting this in a suiteSetup() and using suiteTeardown() to call smc.destroy()?

Great catch. This is a small test so I think I'm inclined to add the smc.destroy() directly to the end of the test.

I tried adding a test.after.each which cleans up the smc, but noted that if the destructor throws outside the test, we get a 0/1 tests passed with an exit code of 0 – which makes it look like everything worked. Went with simpler approach which doesn't have this strange issue.

since all the assertions are synchronous it's probably fine as is, though something about test code execution ordering makes me a bit uncomfortable.

how about something like this?
c516966

this seems to work on my end. is there an actual chance that .destroy() would fail? and should that then report as a test failure?
if so we can add try catch like this https://github.com/google/wireit/blob/df9c9e9d3dc4bd1c92933ef6d4e1919679390478/src/test/analysis.test.ts#L27-L34

packages/labs/compiler/src/test/source_map_test.ts

packages/labs/compiler/package.json

AndrewJakubowicz · 2023-08-09T20:54:38Z

Thank you for the excellent suggestions!

AndrewJakubowicz · 2023-08-09T21:12:04Z

I did some further investigating regarding the license falling below the imports in the generated source_map javascript file. That looks like a rollup/plugin-typescript behavior – as it occurs without the compiler transform.

I'll add a license golden (in a separate PR) to the test_files to show that the compiler transform doesn't do this by default.

augustjk

suggestion #4077 (comment) is optional.

excellent addition of rollup example and making sure generated source maps are accurate!

AndrewJakubowicz added 2 commits August 8, 2023 12:14

add rollup example and source map test

8e6217a

add empty changeset and ignore files

8a507e1

AndrewJakubowicz requested a review from kevinpschaaf as a code owner August 8, 2023 20:07

rename rollup build

35d1c0c

AndrewJakubowicz requested review from augustjk and rictic August 8, 2023 20:10

AndrewJakubowicz changed the title ~~[lit-labs/compiler] compiler rollup example and source map tests~~ [lit-labs/compiler] rollup example and source map tests Aug 8, 2023

augustjk reviewed Aug 8, 2023

View reviewed changes

augustjk reviewed Aug 9, 2023

View reviewed changes

packages/labs/compiler/package.json Outdated Show resolved Hide resolved

AndrewJakubowicz added 2 commits August 9, 2023 13:46

code review feedback

eabad7d

after changing gitignore, add staged other ignore files.

5b1c2db

AndrewJakubowicz requested a review from augustjk August 9, 2023 23:44

augustjk approved these changes Aug 10, 2023

View reviewed changes

rictic approved these changes Aug 10, 2023

View reviewed changes

AndrewJakubowicz merged commit 40879ce into main Aug 10, 2023

AndrewJakubowicz deleted the compiler-source-map-tests branch August 10, 2023 17:06

[lit-labs/compiler] rollup example and source map tests #4077

[lit-labs/compiler] rollup example and source map tests #4077

Uh oh!

Conversation

AndrewJakubowicz commented Aug 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why

How

Risk

Notes

Uh oh!

changeset-bot bot commented Aug 8, 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 Aug 8, 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

update-reflect

Uh oh!

Uh oh!

augustjk Aug 8, 2023

Choose a reason for hiding this comment

Uh oh!

AndrewJakubowicz Aug 9, 2023

Choose a reason for hiding this comment

Uh oh!

augustjk Aug 10, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AndrewJakubowicz commented Aug 9, 2023

Uh oh!

AndrewJakubowicz commented Aug 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

augustjk left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AndrewJakubowicz commented Aug 8, 2023 •

edited

Loading

changeset-bot bot commented Aug 8, 2023 •

edited

Loading

github-actions bot commented Aug 8, 2023 •

edited

Loading

AndrewJakubowicz commented Aug 9, 2023 •

edited

Loading