Graduate @lit-labs/task out to @lit/task by rictic · Pull Request #4170 · lit/lit

rictic · 2023-09-01T15:53:40Z

No description provided.

changeset-bot · 2023-09-01T15:53:43Z

🦋 Changeset detected

Latest commit: 3188ff7

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

This PR includes changesets to release 2 packages

Name	Type
@lit/task	Major
@lit-labs/task	Minor

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-09-01T15:53:56Z

📊 Tachometer Benchmark Results

Summary

nop-update

this-change, tip-of-tree, previous-release: unsure 🔍 -7% - +14% (-1.43ms - +2.78ms)
^{this-change vs tip-of-tree}

render

this-change: 77.90ms - 81.68ms
this-change, tip-of-tree, previous-release: unsure 🔍 -1% - +5% (-0.21ms - +1.43ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -2% - +4% (-1.10ms - +1.74ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -3% - +2% (-1.43ms - +0.92ms)
^{this-change vs tip-of-tree}

update

this-change: 665.65ms - 680.75ms
this-change, tip-of-tree, previous-release: unsure 🔍 -3% - +4% (-1.86ms - +3.03ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -1% - +1% (-1.24ms - +1.05ms)
^{this-change vs tip-of-tree}
this-change, tip-of-tree, previous-release: unsure 🔍 -1% - +1% (-4.61ms - +4.88ms)
^{this-change vs tip-of-tree}

update-reflect

this-change: 636.84ms - 645.93ms
this-change, tip-of-tree, previous-release: unsure 🔍 -1% - +0% (-5.66ms - +2.00ms)
^{this-change vs tip-of-tree}

Results

this-change

Browser: chrome-headless 116.0.5845.187
Sample size: 50
Built by: Benchmarks #5487
Commit: 3188ff7

render

Version	Avg time	vs
	77.90ms - 81.68ms	-

update

Version	Avg time	vs
	665.65ms - 680.75ms	-

update-reflect

Version	Avg time	vs
	636.84ms - 645.93ms	-

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

Browser: chrome-headless 116.0.5845.187
Sample size: 30
Built by: Benchmarks #5487
Commit: 3188ff7

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	27.10ms - 28.22ms	-	unsure 🔍 -1% - +5% -0.21ms - +1.43ms	unsure 🔍 -2% - +6% -0.43ms - +1.50ms
tip-of-tree tip-of-tree	26.45ms - 27.65ms	unsure 🔍 -5% - +1% -1.43ms - +0.21ms	-	unsure 🔍 -4% - +3% -1.07ms - +0.91ms
previous-release previous-release	26.34ms - 27.91ms	unsure 🔍 -5% - +2% -1.50ms - +0.43ms	unsure 🔍 -3% - +4% -0.91ms - +1.07ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	70.77ms - 74.09ms	-	unsure 🔍 -3% - +4% -1.86ms - +3.03ms	unsure 🔍 -2% - +5% -1.78ms - +3.26ms
tip-of-tree tip-of-tree	70.05ms - 73.63ms	unsure 🔍 -4% - +3% -3.03ms - +1.86ms	-	unsure 🔍 -3% - +4% -2.45ms - +2.76ms
previous-release previous-release	69.80ms - 73.58ms	unsure 🔍 -4% - +2% -3.26ms - +1.78ms	unsure 🔍 -4% - +3% -2.76ms - +2.45ms	-

nop-update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	18.29ms - 22.09ms	-	unsure 🔍 -7% - +14% -1.43ms - +2.78ms	unsure 🔍 -8% - +15% -1.46ms - +2.85ms
tip-of-tree tip-of-tree	18.62ms - 20.42ms	unsure 🔍 -13% - +7% -2.78ms - +1.43ms	-	unsure 🔍 -7% - +7% -1.33ms - +1.37ms
previous-release previous-release	18.49ms - 20.51ms	unsure 🔍 -14% - +7% -2.85ms - +1.46ms	unsure 🔍 -7% - +7% -1.37ms - +1.33ms	-

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

Browser: chrome-headless 116.0.5845.187
Sample size: 50
Built by: Benchmarks #5487
Commit: 3188ff7

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	47.13ms - 49.60ms	-	unsure 🔍 -2% - +4% -1.10ms - +1.74ms	unsure 🔍 -2% - +4% -1.17ms - +1.73ms
tip-of-tree tip-of-tree	47.36ms - 48.74ms	unsure 🔍 -4% - +2% -1.74ms - +1.10ms	-	unsure 🔍 -2% - +2% -1.06ms - +0.98ms
previous-release previous-release	47.33ms - 48.85ms	unsure 🔍 -4% - +2% -1.73ms - +1.17ms	unsure 🔍 -2% - +2% -0.98ms - +1.06ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	100.54ms - 102.17ms	-	unsure 🔍 -1% - +1% -1.24ms - +1.05ms	unsure 🔍 -3% - +1% -2.64ms - +0.75ms
tip-of-tree tip-of-tree	100.64ms - 102.25ms	unsure 🔍 -1% - +1% -1.05ms - +1.24ms	-	unsure 🔍 -2% - +1% -2.54ms - +0.83ms
previous-release previous-release	100.82ms - 103.78ms	unsure 🔍 -1% - +3% -0.75ms - +2.64ms	unsure 🔍 -1% - +3% -0.83ms - +2.54ms	-

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

Browser: chrome-headless 116.0.5845.187
Sample size: 50
Built by: Benchmarks #5487
Commit: 3188ff7

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	48.94ms - 50.56ms	-	unsure 🔍 -3% - +2% -1.43ms - +0.92ms	unsure 🔍 -3% - +2% -1.55ms - +0.80ms
tip-of-tree tip-of-tree	49.15ms - 50.86ms	unsure 🔍 -2% - +3% -0.92ms - +1.43ms	-	unsure 🔍 -3% - +2% -1.32ms - +1.08ms
previous-release previous-release	49.28ms - 50.97ms	unsure 🔍 -2% - +3% -0.80ms - +1.55ms	unsure 🔍 -2% - +3% -1.08ms - +1.32ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	661.76ms - 669.61ms	-	unsure 🔍 -1% - +1% -4.61ms - +4.88ms	unsure 🔍 -1% - +1% -7.02ms - +3.55ms
tip-of-tree tip-of-tree	662.88ms - 668.22ms	unsure 🔍 -1% - +1% -4.88ms - +4.61ms	-	unsure 🔍 -1% - +0% -6.30ms - +2.57ms
previous-release previous-release	663.88ms - 670.96ms	unsure 🔍 -1% - +1% -3.55ms - +7.02ms	unsure 🔍 -0% - +1% -2.57ms - +6.30ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	664.88ms - 669.86ms	-	unsure 🔍 -1% - +0% -5.66ms - +2.00ms	unsure 🔍 -1% - +0% -4.70ms - +2.35ms
tip-of-tree tip-of-tree	666.28ms - 672.11ms	unsure 🔍 -0% - +1% -2.00ms - +5.66ms	-	unsure 🔍 -0% - +1% -3.18ms - +4.49ms
previous-release previous-release	666.05ms - 671.04ms	unsure 🔍 -0% - +1% -2.35ms - +4.70ms	unsure 🔍 -1% - +0% -4.49ms - +3.18ms	-

_{tachometer-reporter-action v2 for Benchmarks}

github-actions · 2023-09-01T15:55:53Z

The size of lit-html.js and lit-core.min.js are as expected.

rollup-common.js

packages/task/CHANGELOG.md

packages/labs/task/src/task.ts

This way the files are identical and git has the best chance possible to retain history.

We're keeping the tests, for now at least. This ensures that we did everything right, and @labs/task continues to function the same as it did before.

augustjk

🎓 🎊

Doing this results in multiple wireit invocations, which causes wasted effort in handling caches, as well as unclear output.

AndrewJakubowicz

Awesome! LGTM!

AndrewJakubowicz · 2023-09-13T00:55:06Z

packages/tests/package.json

+      }
+    },
+    "test:common:prod": {
+      "command": "MODE=prod node ./run-web-tests.js",


Nit, but can MODE=prod be removed because it's also passed in "env"?

Good point, done

AndrewJakubowicz · 2023-09-13T01:00:40Z

packages/task/package.json

+      ]
+    },
+    "test:dev": {
+      "command": "MODE=dev node ../tests/run-web-tests.js \"development/**/*_test.js\" --config ../tests/web-test-runner.config.js",


Nit: MODE=dev and MODE=prod (in the next test) could be moved into wireit env, but non blocking.

justinfagnani

🎉

justinfagnani · 2023-09-14T22:24:20Z

lit-next.code-workspace

      "name": "ssr",
      "path": "packages/labs/ssr"
    },
+    {


VS Code has gotten a lot better about working with nested packages that aren't workspace roots, so I don't know if we need to add every package here anymore. I'm also fine with it.

+1, but not in this PR

justinfagnani · 2023-09-14T22:25:30Z

packages/labs/task/README.md

 A controller for Lit that renders asynchronous tasks.

-## Overview
+This package has graduated from labs! It is now available as `@lit/task`. This package will no longer be updated, but it will continue to work and get updates through the ^1.0.0 version range of `@lit/task` because it's now just a re-export of that package. This should reduce duplication of code while everyone migrates their imports and dependencies.


I think the "it's now just a re-export of that package" part should com earlier, then mention this package is a proxy and won't be updated.

We might want a headline here too.

packages/labs/task/package.json

packages/labs/task/src/deep-equals.ts

justinfagnani · 2023-09-14T22:31:18Z

packages/task/package.json

@@ -0,0 +1,165 @@
+{
+  "name": "@lit/task",
+  "version": "0.1.0",


This could be 0.0.0 to make it clear it hasn't been released yet.

justinfagnani · 2023-09-14T22:38:44Z

packages/task/rollup.config.js

+export default litProdConfig({
+  packageName: createRequire(import.meta.url)('./package.json').name,
+  entryPoints: ['deep-equals', 'index', 'task'],
+  external: ['@lit/reactive-element'],


In the future I think we should change all of these to external: (id) => !(id.startsWith('.') || id.startsWith('/')),

rictic requested a review from justinfagnani September 1, 2023 15:53

rictic requested a review from kevinpschaaf as a code owner September 1, 2023 15:53

augustjk reviewed Sep 1, 2023

View reviewed changes

rollup-common.js Outdated Show resolved Hide resolved

packages/task/CHANGELOG.md Outdated Show resolved Hide resolved

packages/labs/task/src/task.ts Show resolved Hide resolved

rictic added 8 commits September 1, 2023 16:36

Do a direct copy of packages/labs/task to just packages/task

a672512

This way the files are identical and git has the best chance possible to retain history.

Get task tests passing.

a6714b9

Make @lit-labs/task a re-export of @lit/task.

abd3135

We're keeping the tests, for now at least. This ensures that we did everything right, and @labs/task continues to function the same as it did before.

Update READMEs

de216da

Remove checksize script in labs/task

b13199d

Changeset

a268dde

Update task tests to import from task not labs/task

64b6904

Address review comments

948ac3b

rictic force-pushed the graduate-task branch from 7b61d89 to 948ac3b Compare September 1, 2023 23:39

augustjk approved these changes Sep 1, 2023

View reviewed changes

rictic added 5 commits September 11, 2023 04:22

Fix build deps for labs task.

f447820

Avoid npm run from an npm script

ecf01d2

Doing this results in multiple wireit invocations, which causes wasted effort in handling caches, as well as unclear output.

Make prod tests separately runnable.

ddb12cc

Ensure task is built before testing labs/task

d980970

Add non-labs task to shared web-test-runner.config.ts

b8fc1e5

AndrewJakubowicz approved these changes Sep 13, 2023

View reviewed changes

justinfagnani approved these changes Sep 14, 2023

View reviewed changes

Address review comments.

3188ff7

rictic merged commit 2fa955d into 3.0 Sep 15, 2023

rictic deleted the graduate-task branch September 15, 2023 04:17

This was referenced Sep 28, 2023

Version Packages (pre) #4244

Closed

Version Packages (pre) #4246

Merged

Conversation

rictic commented Sep 1, 2023

Uh oh!

changeset-bot bot commented Sep 1, 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 Sep 1, 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!

github-actions bot commented Sep 1, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

augustjk left a comment

Choose a reason for hiding this comment

Uh oh!

AndrewJakubowicz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justinfagnani left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Sep 1, 2023 •

edited

Loading

github-actions bot commented Sep 1, 2023 •

edited

Loading