Fix change-in-update warning from Tasks

[justinfagnani]

Fixes #3566

The fix is to call the initial host.requestUpdate() (which is there to get the element to update and see the PENDING state of the task) in a microtask, so that it goes after the change-in-update check.

[changeset-bot]

🦋 Changeset detected

Latest commit: aa6aece

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

This PR includes changesets to release 1 package

Name	Type
@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]

📊 Tachometer Benchmark Results

Summary

nop-update

• lit-html-kitchen-sink: unsure 🔍 -10% - +12% (-2.41ms - +2.76ms)
  ^{this-change vs tip-of-tree}

render

• lit-element-list: 75.18ms - 80.11ms
• lit-html-kitchen-sink: unsure 🔍 -2% - +7% (-0.67ms - +2.01ms)
  ^{this-change vs tip-of-tree}
• lit-html-repeat: unsure 🔍 -8% - +1% (-0.95ms - +0.12ms)
  ^{this-change vs tip-of-tree}
• lit-html-template-heavy: unsure 🔍 -4% - +0% (-2.17ms - +0.14ms)
  ^{this-change vs tip-of-tree}
• reactive-element-list: unsure 🔍 -2% - +2% (-0.99ms - +1.15ms)
  ^{this-change vs tip-of-tree}

update

• lit-element-list: 683.94ms - 696.00ms
• lit-html-kitchen-sink: unsure 🔍 -5% - +4% (-4.02ms - +3.00ms)
  ^{this-change vs tip-of-tree}
• lit-html-repeat: unsure 🔍 -4% - +1% (-9.52ms - +3.73ms)
  ^{this-change vs tip-of-tree}
• lit-html-template-heavy: unsure 🔍 -1% - +1% (-1.49ms - +0.59ms)
  ^{this-change vs tip-of-tree}
• reactive-element-list: unsure 🔍 -0% - +1% (-2.68ms - +3.96ms)
  ^{this-change vs tip-of-tree}

update-reflect

• lit-element-list: 687.25ms - 696.27ms
• reactive-element-list: unsure 🔍 -1% - +0% (-3.96ms - +3.47ms)
  ^{this-change vs tip-of-tree}

Results

lit-element-list

• Browser: chrome-headless 109.0.5414.119
• Sample size: 50
• Built by: Benchmarks #4415

• Commit: 11018ce

render

Version	Avg time	vs
	75.18ms - 80.11ms	-

update

Version	Avg time	vs
	683.94ms - 696.00ms	-

update-reflect

Version	Avg time	vs
	687.25ms - 696.27ms	-

lit-html-kitchen-sink

• Browser: chrome-headless 109.0.5414.119
• Sample size: 30
• Built by: Benchmarks #4415

• Commit: 11018ce

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	30.22ms - 32.53ms	-	unsure 🔍 -2% - +7% -0.67ms - +2.01ms	unsure 🔍 -3% - +5% -1.04ms - +1.50ms
tip-of-tree tip-of-tree	30.02ms - 31.38ms	unsure 🔍 -6% - +2% -2.01ms - +0.67ms	-	unsure 🔍 -4% - +1% -1.30ms - +0.42ms
previous-release previous-release	30.62ms - 31.68ms	unsure 🔍 -5% - +3% -1.50ms - +1.04ms	unsure 🔍 -1% - +4% -0.42ms - +1.30ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	75.65ms - 80.03ms	-	unsure 🔍 -5% - +4% -4.02ms - +3.00ms	unsure 🔍 -5% - +4% -3.79ms - +2.93ms
tip-of-tree tip-of-tree	75.61ms - 81.09ms	unsure 🔍 -4% - +5% -3.00ms - +4.02ms	-	unsure 🔍 -5% - +5% -3.66ms - +3.83ms
previous-release previous-release	75.71ms - 80.81ms	unsure 🔍 -4% - +5% -2.93ms - +3.79ms	unsure 🔍 -5% - +5% -3.83ms - +3.66ms	-

nop-update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	21.93ms - 26.04ms	-	unsure 🔍 -10% - +12% -2.41ms - +2.76ms	unsure 🔍 -14% - +5% -3.58ms - +1.33ms
tip-of-tree tip-of-tree	22.23ms - 25.38ms	unsure 🔍 -11% - +10% -2.76ms - +2.41ms	-	unsure 🔍 -13% - +3% -3.37ms - +0.76ms
previous-release previous-release	23.77ms - 26.45ms	unsure 🔍 -6% - +15% -1.33ms - +3.58ms	unsure 🔍 -3% - +14% -0.76ms - +3.37ms	-

lit-html-repeat

• Browser: chrome-headless 109.0.5414.119
• Sample size: 30
• Built by: Benchmarks #4415

• Commit: 11018ce

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	11.35ms - 12.06ms	-	unsure 🔍 -8% - +1% -0.95ms - +0.12ms	unsure 🔍 -4% - +5% -0.52ms - +0.56ms
tip-of-tree tip-of-tree	11.72ms - 12.52ms	unsure 🔍 -1% - +8% -0.12ms - +0.95ms	-	unsure 🔍 -1% - +9% -0.13ms - +1.00ms
previous-release previous-release	11.28ms - 12.09ms	unsure 🔍 -5% - +4% -0.56ms - +0.52ms	unsure 🔍 -8% - +1% -1.00ms - +0.13ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	263.61ms - 271.73ms	-	unsure 🔍 -4% - +1% -9.52ms - +3.73ms	unsure 🔍 -2% - +3% -4.78ms - +7.54ms
tip-of-tree tip-of-tree	265.34ms - 275.80ms	unsure 🔍 -1% - +4% -3.73ms - +9.52ms	-	unsure 🔍 -1% - +4% -2.71ms - +11.26ms
previous-release previous-release	261.66ms - 270.93ms	unsure 🔍 -3% - +2% -7.54ms - +4.78ms	unsure 🔍 -4% - +1% -11.26ms - +2.71ms	-

lit-html-template-heavy

• Browser: chrome-headless 109.0.5414.119
• Sample size: 50
• Built by: Benchmarks #4415

• Commit: 11018ce

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	50.58ms - 51.92ms	-	unsure 🔍 -4% - +0% -2.17ms - +0.14ms	unsure 🔍 -3% - +1% -1.77ms - +0.36ms
tip-of-tree tip-of-tree	51.33ms - 53.20ms	unsure 🔍 -0% - +4% -0.14ms - +2.17ms	-	unsure 🔍 -2% - +3% -0.94ms - +1.56ms
previous-release previous-release	51.13ms - 52.78ms	unsure 🔍 -1% - +3% -0.36ms - +1.77ms	unsure 🔍 -3% - +2% -1.56ms - +0.94ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	105.00ms - 106.47ms	-	unsure 🔍 -1% - +1% -1.49ms - +0.59ms	unsure 🔍 -1% - +1% -0.80ms - +1.24ms
tip-of-tree tip-of-tree	105.46ms - 106.92ms	unsure 🔍 -1% - +1% -0.59ms - +1.49ms	-	unsure 🔍 -0% - +2% -0.34ms - +1.70ms
previous-release previous-release	104.81ms - 106.22ms	unsure 🔍 -1% - +1% -1.24ms - +0.80ms	unsure 🔍 -2% - +0% -1.70ms - +0.34ms	-

reactive-element-list

• Browser: chrome-headless 109.0.5414.119
• Sample size: 50
• Built by: Benchmarks #4415

• Commit: 11018ce

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	49.12ms - 50.74ms	-	unsure 🔍 -2% - +2% -0.99ms - +1.15ms	unsure 🔍 -3% - +2% -1.35ms - +0.84ms
tip-of-tree tip-of-tree	49.16ms - 50.54ms	unsure 🔍 -2% - +2% -1.15ms - +0.99ms	-	unsure 🔍 -3% - +1% -1.34ms - +0.67ms
previous-release previous-release	49.45ms - 50.91ms	unsure 🔍 -2% - +3% -0.84ms - +1.35ms	unsure 🔍 -1% - +3% -0.67ms - +1.34ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	690.13ms - 694.21ms	-	unsure 🔍 -0% - +1% -2.68ms - +3.96ms	unsure 🔍 -0% - +0% -2.55ms - +3.01ms
tip-of-tree tip-of-tree	688.91ms - 694.15ms	unsure 🔍 -1% - +0% -3.96ms - +2.68ms	-	unsure 🔍 -1% - +0% -3.64ms - +2.81ms
previous-release previous-release	690.06ms - 693.82ms	unsure 🔍 -0% - +0% -3.01ms - +2.55ms	unsure 🔍 -0% - +1% -2.81ms - +3.64ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	718.88ms - 724.13ms	-	unsure 🔍 -1% - +0% -3.96ms - +3.47ms	unsure 🔍 -0% - +1% -2.44ms - +5.40ms
tip-of-tree tip-of-tree	719.12ms - 724.37ms	unsure 🔍 -0% - +1% -3.47ms - +3.96ms	-	unsure 🔍 -0% - +1% -2.20ms - +5.64ms
previous-release previous-release	717.11ms - 722.93ms	unsure 🔍 -1% - +0% -5.40ms - +2.44ms	unsure 🔍 -1% - +0% -5.64ms - +2.20ms	-

_{tachometer-reporter-action v2 for Benchmarks}

[e111077]

What if you need DOM access or willUpdate property resolution?

[justinfagnani]

@e111077 that's a great question. We don't have any tests that cover and guarantee that ability, so if we want to preserve it we should add one.

There may be another way to solve #3566 where we just don't call host.requestUpdate() synchronously. Let me check on that.

[justinfagnani]

@e111077 I fixed this by putting host.requestUpdate() in a microtask and added a test that Tasks can see side effects of update() to ensure that behavior.

[e111077]

Wow great job!