[@task] allow initial value #2836

taylor-vann · 2022-05-05T18:30:04Z

Currently the initial value of Task is assumed to be undefined.
This is the default behavior. When a Task is "re-run", value is set as undefined.

This PR adds an initialValue to the TaskConfig interface.
When no intialValue is set, the behavior described above is preserved.

When initialValue is set, the value is only updated when the task completes. As in, the initial value will not be set in future PENDING states.

changeset-bot · 2022-05-05T18:30:06Z

🦋 Changeset detected

Latest commit: b848485

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

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 · 2022-05-05T18:30:28Z

📊 Tachometer Benchmark Results

Summary

nop-update

lit-html-kitchen-sink: unsure 🔍 -2% - +9% (-0.62ms - +2.86ms)
^{this-change vs tip-of-tree}

render

lit-element-list: unsure 🔍 -7% - +0% (-7.66ms - +0.29ms)
^{this-change vs tip-of-tree}
lit-html-kitchen-sink: unsure 🔍 -3% - +5% (-1.33ms - +2.24ms)
^{this-change vs tip-of-tree}
lit-html-repeat: unsure 🔍 -7% - +2% (-0.98ms - +0.26ms)
^{this-change vs tip-of-tree}
lit-html-template-heavy: unsure 🔍 -2% - +5% (-1.57ms - +3.18ms)
^{this-change vs tip-of-tree}
reactive-element-list: unsure 🔍 -0% - +21% (+0.03ms - +16.47ms)
^{this-change vs tip-of-tree}

update

lit-element-list: unsure 🔍 -1% - +5% (-12.88ms - +46.79ms)
^{this-change vs tip-of-tree}
lit-html-kitchen-sink: unsure 🔍 -1% - +10% (-0.41ms - +10.62ms)
^{this-change vs tip-of-tree}
lit-html-repeat: unsure 🔍 -9% - +6% (-32.53ms - +22.68ms)
^{this-change vs tip-of-tree}
lit-html-template-heavy: unsure 🔍 -4% - +2% (-5.94ms - +3.48ms)
^{this-change vs tip-of-tree}
reactive-element-list: faster ✔ 0% - 17% (0.74ms - 298.71ms)
^{this-change vs tip-of-tree}

update-reflect

lit-element-list: unsure 🔍 -2% - +1% (-16.60ms - +11.90ms)
^{this-change vs tip-of-tree}
reactive-element-list: unsure 🔍 -3% - +1% (-38.82ms - +7.29ms)
^{this-change vs tip-of-tree}

Results

lit-element-list

Browser: chrome-headless 101.0.4951.64
Sample size: 50
Built by: Benchmarks #3241
Commit: a525c80

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	98.53ms - 103.63ms	-	unsure 🔍 -7% - +0% -7.66ms - +0.29ms	faster ✔ 22% - 27% 28.46ms - 37.53ms
tip-of-tree tip-of-tree	101.72ms - 107.82ms	unsure 🔍 -0% - +8% -0.29ms - +7.66ms	-	faster ✔ 19% - 25% 24.47ms - 34.14ms
previous-release previous-release	130.33ms - 137.82ms	slower ❌ 28% - 38% 28.46ms - 37.53ms	slower ❌ 23% - 33% 24.47ms - 34.14ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	1004.70ms - 1062.62ms	-	unsure 🔍 -1% - +5% -12.88ms - +46.79ms	faster ✔ 33% - 37% 515.58ms - 585.49ms
tip-of-tree tip-of-tree	1009.53ms - 1023.89ms	unsure 🔍 -4% - +1% -46.79ms - +12.88ms	-	faster ✔ 35% - 37% 546.64ms - 588.34ms
previous-release previous-release	1564.62ms - 1603.77ms	slower ❌ 49% - 58% 515.58ms - 585.49ms	slower ❌ 54% - 58% 546.64ms - 588.34ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	1003.49ms - 1025.09ms	-	unsure 🔍 -2% - +1% -16.60ms - +11.90ms	faster ✔ 8% - 10% 87.58ms - 117.91ms
tip-of-tree tip-of-tree	1007.35ms - 1025.94ms	unsure 🔍 -1% - +2% -11.90ms - +16.60ms	-	faster ✔ 8% - 10% 86.26ms - 114.52ms
previous-release previous-release	1106.39ms - 1127.68ms	slower ❌ 9% - 12% 87.58ms - 117.91ms	slower ❌ 8% - 11% 86.26ms - 114.52ms	-

lit-html-kitchen-sink

Browser: chrome-headless 101.0.4951.64
Sample size: 30
Built by: Benchmarks #3241
Commit: a525c80

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	41.89ms - 44.49ms	-	unsure 🔍 -3% - +5% -1.33ms - +2.24ms	faster ✔ 5% - 12% 2.28ms - 5.76ms
tip-of-tree tip-of-tree	41.51ms - 43.96ms	unsure 🔍 -5% - +3% -2.24ms - +1.33ms	-	faster ✔ 6% - 13% 2.79ms - 6.16ms
previous-release previous-release	46.05ms - 48.37ms	slower ❌ 5% - 14% 2.28ms - 5.76ms	slower ❌ 6% - 15% 2.79ms - 6.16ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	107.66ms - 115.33ms	-	unsure 🔍 -1% - +10% -0.41ms - +10.62ms	unsure 🔍 -2% - +9% -2.15ms - +9.26ms
tip-of-tree tip-of-tree	102.43ms - 110.35ms	unsure 🔍 -9% - +0% -10.62ms - +0.41ms	-	unsure 🔍 -7% - +4% -7.34ms - +4.24ms
previous-release previous-release	103.71ms - 112.17ms	unsure 🔍 -8% - +2% -9.26ms - +2.15ms	unsure 🔍 -4% - +7% -4.24ms - +7.34ms	-

nop-update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	32.90ms - 35.50ms	-	unsure 🔍 -2% - +9% -0.62ms - +2.86ms	faster ✔ 2% - 11% 0.60ms - 3.90ms
tip-of-tree tip-of-tree	31.92ms - 34.24ms	unsure 🔍 -8% - +2% -2.86ms - +0.62ms	-	faster ✔ 5% - 13% 1.83ms - 4.91ms
previous-release previous-release	35.44ms - 37.46ms	slower ❌ 2% - 12% 0.60ms - 3.90ms	slower ❌ 5% - 15% 1.83ms - 4.91ms	-

lit-html-repeat

Browser: chrome-headless 101.0.4951.64
Sample size: 30
Built by: Benchmarks #3241
Commit: a525c80

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	12.52ms - 13.40ms	-	unsure 🔍 -7% - +2% -0.98ms - +0.26ms	faster ✔ 12% - 20% 1.77ms - 3.11ms
tip-of-tree tip-of-tree	12.89ms - 13.76ms	unsure 🔍 -2% - +8% -0.26ms - +0.98ms	-	faster ✔ 9% - 17% 1.41ms - 2.74ms
previous-release previous-release	14.89ms - 15.91ms	slower ❌ 13% - 24% 1.77ms - 3.11ms	slower ❌ 10% - 21% 1.41ms - 2.74ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	349.91ms - 388.70ms	-	unsure 🔍 -9% - +6% -32.53ms - +22.68ms	faster ✔ 23% - 33% 115.89ms - 171.09ms
tip-of-tree tip-of-tree	354.58ms - 393.88ms	unsure 🔍 -6% - +9% -22.68ms - +32.53ms	-	faster ✔ 22% - 32% 110.79ms - 166.34ms
previous-release previous-release	493.16ms - 532.43ms	slower ❌ 30% - 48% 115.89ms - 171.09ms	slower ❌ 28% - 46% 110.79ms - 166.34ms	-

lit-html-template-heavy

Browser: chrome-headless 101.0.4951.64
Sample size: 50
Built by: Benchmarks #3241
Commit: a525c80

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	66.63ms - 70.28ms	-	unsure 🔍 -2% - +5% -1.57ms - +3.18ms	faster ✔ 13% - 18% 10.44ms - 15.08ms
tip-of-tree tip-of-tree	66.14ms - 69.16ms	unsure 🔍 -5% - +2% -3.18ms - +1.57ms	-	faster ✔ 14% - 19% 11.48ms - 15.65ms
previous-release previous-release	79.78ms - 82.65ms	slower ❌ 15% - 22% 10.44ms - 15.08ms	slower ❌ 17% - 23% 11.48ms - 15.65ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	144.40ms - 150.41ms	-	unsure 🔍 -4% - +2% -5.94ms - +3.48ms	faster ✔ 13% - 18% 22.89ms - 32.58ms
tip-of-tree tip-of-tree	145.01ms - 152.26ms	unsure 🔍 -2% - +4% -3.48ms - +5.94ms	-	faster ✔ 12% - 18% 21.25ms - 31.76ms
previous-release previous-release	171.34ms - 178.94ms	slower ❌ 15% - 22% 22.89ms - 32.58ms	slower ❌ 14% - 22% 21.25ms - 31.76ms	-

reactive-element-list

Browser: chrome-headless 101.0.4951.64
Sample size: 50
Built by: Benchmarks #3241
Commit: a525c80

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	82.01ms - 94.75ms	-	unsure 🔍 -0% - +21% +0.03ms - +16.47ms	unsure 🔍 -8% - +13% -7.12ms - +11.13ms
tip-of-tree tip-of-tree	74.94ms - 85.34ms	faster ✔ 1% - 18% 0.03ms - 16.47ms	-	unsure 🔍 -16% - +2% -14.59ms - +2.11ms
previous-release previous-release	79.84ms - 92.91ms	unsure 🔍 -12% - +8% -11.13ms - +7.12ms	unsure 🔍 -3% - +19% -2.11ms - +14.59ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	1479.12ms - 1708.03ms	-	faster ✔ 0% - 17% 0.74ms - 298.71ms	unsure 🔍 -9% - +13% -130.85ms - +206.29ms
tip-of-tree tip-of-tree	1647.93ms - 1838.67ms	unsure 🔍 -0% - +19% +0.74ms - +298.71ms	-	slower ❌ 1% - 23% 31.20ms - 343.68ms
previous-release previous-release	1432.10ms - 1679.61ms	unsure 🔍 -13% - +8% -206.29ms - +130.85ms	faster ✔ 2% - 19% 31.20ms - 343.68ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	1097.35ms - 1129.03ms	-	unsure 🔍 -3% - +1% -38.82ms - +7.29ms	unsure 🔍 -1% - +3% -6.33ms - +35.23ms
tip-of-tree tip-of-tree	1112.21ms - 1145.71ms	unsure 🔍 -1% - +4% -7.29ms - +38.82ms	-	slower ❌ 1% - 5% 8.74ms - 51.70ms
previous-release previous-release	1085.30ms - 1112.18ms	unsure 🔍 -3% - +1% -35.23ms - +6.33ms	faster ✔ 1% - 5% 8.74ms - 51.70ms	-

_{tachometer-reporter-action v2 for Benchmarks}

taylor-vann · 2022-05-05T19:11:03Z

related to: #2367

packages/labs/task/src/task.ts

mohe2015 · 2022-05-07T10:29:53Z

What is a concrete use case for this? I don't fully understand that yet.

packages/labs/task/src/task.ts

taylor-vann · 2022-05-10T17:26:49Z

@mohe2015 one potential use-case is lazy loading / lazy execution of a task, providing data for the initial render but before a remote request, a kind of Null Object for tasks that correlate to an initial render.

User loads page. Component needs a visual "stencil" up until the asynchronous task is requested / performed / completed.

taylor-vann · 2022-05-10T17:53:10Z

addressed feedback

sorvell

Please add a test where initialValue is set.

taylor-vann · 2022-05-18T20:34:28Z

@sorvell added a test for initial values :) ready for another review

AndrewJakubowicz

Please remove all the .wireit directory files.

They should have been ignored by .gitignore?

taylor-vann · 2022-05-20T15:46:52Z

thanks @AndrewJakubowicz, theyve been removed.

sorvell

Almost there, just a couple of points to address, see comments. Let's also make sure to update the PR description to say that the value is only updated when the task completes (currently, it incorrectly says that it's reset to the initialValue).

.changeset/fifty-games-eat.md

sorvell · 2022-05-20T20:59:21Z

packages/labs/task/src/test/task_test.ts

    assert.equal(el.taskValue, undefined);
  });

+  test('tasks start with initialValues in the first PENDING state', async () => {


Please add another test that specifically validates the task value during the different states when it's re-run. Some of the changes here reflect the new behavior but I think it makes sense to have a test that focuses on that aspect.

We want specifically a test that validates that the value is not reset when the task is re-run (before it completes). This has nothing to do with initial value, but the behavior is being changed with this PR.

.changeset/fifty-games-eat.md

taylor-vann · 2022-05-23T21:40:06Z

Sweet! thanks yall
Andrew:

got rid of the .wireit files
left a more descriptive changelog
Steve:
updated the description of the PR to correctly reflect behavior
added a test to test the described behavior: only set initialValue on first PENDING state, not after.

sorvell · 2022-05-25T17:06:38Z

When a Task is "re-run", value is set as undefined.

This is not true is it?

sorvell · 2022-05-25T17:07:24Z

.changeset/lucky-apples-serve.md

+---
+
+Added `initialValue` parameter to `TaskConfig`.
+Task can start with an initial value from TaskConfig.


We are changing the behavior of how value is treated when the task is re-run. This should be called out specifically here.

sorvell · 2022-05-25T17:08:22Z

packages/labs/task/src/task.ts

    }
    this.status = TaskStatus.PENDING;
    this._error = undefined;
-    this._value = undefined;


This is the significant change that I want to make sure we're documenting and testing.

First I think we need to decide that this is the behavior we want. Is it required to add an initial value? Should it be controlled with an option? Let's chat.

sorvell · 2022-05-25T17:09:20Z

packages/labs/task/src/test/task_test.ts

    assert.equal(el.taskValue, undefined);
  });

+  test('tasks start with initialValues in the first PENDING state', async () => {


We want specifically a test that validates that the value is not reset when the task is re-run (before it completes). This has nothing to do with initial value, but the behavior is being changed with this PR.

e111077

Technically this looks fine to me. Code LGTM

I'm also in favor of this behavior – Task has the tendency to flicker. Would be cool if value is the way to make it not

taylor-vann · 2022-11-08T23:05:43Z

Haven't checked on this PR in a while, will update and rerequest a review. I think the tests could be better

justinfagnani · 2023-07-08T00:24:09Z

Superseded by #4001

taylor-vann added 4 commits May 4, 2022 12:21

add initial value

8fc1897

set initial value, and reset initial value

7ab1339

do not reset initial value

9decf1a

set initial value, preserve test structure

513fa06

taylor-vann requested a review from justinfagnani as a code owner May 5, 2022 18:30

taylor-vann requested a review from sorvell May 5, 2022 18:30

add changeset, patch

c33df26

mohe2015 reviewed May 7, 2022

View reviewed changes

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

mohe2015 reviewed May 7, 2022

View reviewed changes

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

sorvell requested changes May 9, 2022

View reviewed changes

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

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

renderer::complete args are not optional

36bc2f3

remove reset initialValue, update tests

87f2ae4

taylor-vann requested a review from sorvell May 10, 2022 17:53

sorvell requested changes May 17, 2022

View reviewed changes

taylor-vann added 2 commits May 18, 2022 11:36

create initialState test

ac050f6

Merge branch 'main' into task__initial_value

c1c7547

taylor-vann requested a review from sorvell May 19, 2022 17:03

AndrewJakubowicz requested changes May 19, 2022

View reviewed changes

taylor-vann added 2 commits May 20, 2022 08:44

remove wireit dirs

4217fba

Merge branch 'main' into task__initial_value

9a230eb

sorvell requested changes May 20, 2022

View reviewed changes

AndrewJakubowicz self-requested a review May 20, 2022 22:10

taylor-vann added 3 commits May 23, 2022 11:49

Merge branch 'main' into task__initial_value

0d1cdbb

add minor bump

5b684af

test pending values arent the initial value

073235f

taylor-vann requested a review from sorvell May 23, 2022 21:40

sorvell requested changes May 25, 2022

View reviewed changes

taylor-vann added 2 commits May 26, 2022 17:35

better test name, update changeset

ab5e20c

Merge branch 'main' into task__initial_value

b848485

justinfagnani mentioned this pull request Jun 1, 2022

[labs/task] Allow setting initial data #2367

Closed

sorvell mentioned this pull request Jul 19, 2022

[labs/task] Initial pending template #3143

Closed

e111077 approved these changes Nov 8, 2022

View reviewed changes

justinfagnani mentioned this pull request Jul 8, 2023

[labs/task] Allow tasks to have an initial value #4001

Merged

justinfagnani closed this Jul 8, 2023

[@task] allow initial value #2836

[@task] allow initial value #2836

Uh oh!

Conversation

taylor-vann commented May 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented May 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented May 5, 2022 • 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!

taylor-vann commented May 5, 2022

Uh oh!

Uh oh!

Uh oh!

mohe2015 commented May 7, 2022

Uh oh!

Uh oh!

Uh oh!

taylor-vann commented May 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

taylor-vann commented May 10, 2022

Uh oh!

sorvell left a comment

Choose a reason for hiding this comment

Uh oh!

taylor-vann commented May 18, 2022

Uh oh!

AndrewJakubowicz left a comment

Choose a reason for hiding this comment

Uh oh!

taylor-vann commented May 20, 2022

Uh oh!

sorvell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sorvell May 20, 2022

Choose a reason for hiding this comment

Uh oh!

taylor-vann May 24, 2022

Choose a reason for hiding this comment

Uh oh!

sorvell May 25, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

taylor-vann commented May 23, 2022

Uh oh!

sorvell commented May 25, 2022

Uh oh!

sorvell May 25, 2022

Choose a reason for hiding this comment

Uh oh!

sorvell May 25, 2022

Choose a reason for hiding this comment

taylor-vann commented May 5, 2022 •

edited

Loading

changeset-bot bot commented May 5, 2022 •

edited

Loading

github-actions bot commented May 5, 2022 •

edited

Loading

taylor-vann commented May 10, 2022 •

edited

Loading