[labs/context] Rename context decorators to consume and provide #3398

justinfagnani · 2022-10-27T21:01:33Z

Fixes #3389
Fixes #3058

This is just one potential choice of names, so we should make sure we get consensus.

cc @benjamind <- I can't add you as a reviewer right now.

changeset-bot · 2022-10-27T21:01:36Z

🦋 Changeset detected

Latest commit: 29f2dbf

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/context	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

benjamind

LGTM! I much prefer this naming.

github-actions · 2022-11-05T17:24:15Z

📊 Tachometer Benchmark Results

Summary

nop-update

lit-html-kitchen-sink: unsure 🔍 -3% - +6% (-0.86ms - +1.67ms)
^{this-change vs tip-of-tree}

render

lit-element-list: 97.05ms - 103.68ms
lit-html-kitchen-sink: unsure 🔍 -5% - +4% (-2.06ms - +1.59ms)
^{this-change vs tip-of-tree}
lit-html-repeat: unsure 🔍 -4% - +8% (-0.52ms - +0.96ms)
^{this-change vs tip-of-tree}
lit-html-template-heavy: unsure 🔍 -2% - +4% (-1.59ms - +2.81ms)
^{this-change vs tip-of-tree}
reactive-element-list: unsure 🔍 -2% - +3% (-1.78ms - +2.07ms)
^{this-change vs tip-of-tree}

update

lit-element-list: 952.95ms - 980.44ms
lit-html-kitchen-sink: unsure 🔍 -4% - +6% (-3.88ms - +5.81ms)
^{this-change vs tip-of-tree}
lit-html-repeat: unsure 🔍 -3% - +3% (-8.85ms - +7.85ms)
^{this-change vs tip-of-tree}
lit-html-template-heavy: unsure 🔍 -5% - +2% (-6.37ms - +3.23ms)
^{this-change vs tip-of-tree}
reactive-element-list: unsure 🔍 -4% - +5% (-37.49ms - +45.51ms)
^{this-change vs tip-of-tree}

update-reflect

lit-element-list: 964.75ms - 992.79ms
reactive-element-list: unsure 🔍 -1% - +6% (-9.40ms - +64.82ms)
^{this-change vs tip-of-tree}

Results

lit-element-list

Browser: chrome-headless 107.0.5304.87
Sample size: 50
Built by: Benchmarks #4024
Commit: aabae5f

render

Version	Avg time	vs
	97.05ms - 103.68ms	-

update

Version	Avg time	vs
	952.95ms - 980.44ms	-

update-reflect

Version	Avg time	vs
	964.75ms - 992.79ms	-

lit-html-kitchen-sink

Browser: chrome-headless 107.0.5304.87
Sample size: 30
Built by: Benchmarks #4024
Commit: aabae5f

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	38.87ms - 42.09ms	-	unsure 🔍 -5% - +4% -2.06ms - +1.59ms	unsure 🔍 -7% - +3% -2.98ms - +1.05ms
tip-of-tree tip-of-tree	39.86ms - 41.57ms	unsure 🔍 -4% - +5% -1.59ms - +2.06ms	-	unsure 🔍 -5% - +2% -2.21ms - +0.76ms
previous-release previous-release	40.23ms - 42.66ms	unsure 🔍 -3% - +7% -1.05ms - +2.98ms	unsure 🔍 -2% - +5% -0.76ms - +2.21ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	100.67ms - 108.29ms	-	unsure 🔍 -4% - +6% -3.88ms - +5.81ms	unsure 🔍 -7% - +3% -7.71ms - +3.27ms
tip-of-tree tip-of-tree	100.51ms - 106.51ms	unsure 🔍 -6% - +4% -5.81ms - +3.88ms	-	unsure 🔍 -8% - +2% -8.15ms - +1.78ms
previous-release previous-release	102.74ms - 110.65ms	unsure 🔍 -3% - +7% -3.27ms - +7.71ms	unsure 🔍 -2% - +8% -1.78ms - +8.15ms	-

nop-update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	26.22ms - 27.72ms	-	unsure 🔍 -3% - +6% -0.86ms - +1.67ms	unsure 🔍 -4% - +5% -1.03ms - +1.29ms
tip-of-tree tip-of-tree	25.54ms - 27.58ms	unsure 🔍 -6% - +3% -1.67ms - +0.86ms	-	unsure 🔍 -6% - +4% -1.62ms - +1.08ms
previous-release previous-release	25.95ms - 27.72ms	unsure 🔍 -5% - +4% -1.29ms - +1.03ms	unsure 🔍 -4% - +6% -1.08ms - +1.62ms	-

lit-html-repeat

Browser: chrome-headless 107.0.5304.87
Sample size: 30
Built by: Benchmarks #4024
Commit: aabae5f

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	11.69ms - 12.78ms	-	unsure 🔍 -4% - +8% -0.52ms - +0.96ms	unsure 🔍 -3% - +7% -0.37ms - +0.89ms
tip-of-tree tip-of-tree	11.51ms - 12.52ms	unsure 🔍 -8% - +4% -0.96ms - +0.52ms	-	unsure 🔍 -5% - +5% -0.56ms - +0.64ms
previous-release previous-release	11.65ms - 12.30ms	unsure 🔍 -7% - +3% -0.89ms - +0.37ms	unsure 🔍 -5% - +5% -0.64ms - +0.56ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	303.40ms - 314.55ms	-	unsure 🔍 -3% - +3% -8.85ms - +7.85ms	unsure 🔍 -3% - +2% -9.27ms - +7.47ms
tip-of-tree tip-of-tree	303.26ms - 315.69ms	unsure 🔍 -3% - +3% -7.85ms - +8.85ms	-	unsure 🔍 -3% - +3% -9.21ms - +8.41ms
previous-release previous-release	303.63ms - 316.12ms	unsure 🔍 -2% - +3% -7.47ms - +9.27ms	unsure 🔍 -3% - +3% -8.41ms - +9.21ms	-

lit-html-template-heavy

Browser: chrome-headless 107.0.5304.87
Sample size: 50
Built by: Benchmarks #4024
Commit: aabae5f

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	65.03ms - 67.91ms	-	unsure 🔍 -2% - +4% -1.59ms - +2.81ms	unsure 🔍 -2% - +4% -1.58ms - +2.84ms
tip-of-tree tip-of-tree	64.19ms - 67.53ms	unsure 🔍 -4% - +2% -2.81ms - +1.59ms	-	unsure 🔍 -4% - +4% -2.35ms - +2.38ms
previous-release previous-release	64.16ms - 67.52ms	unsure 🔍 -4% - +2% -2.84ms - +1.58ms	unsure 🔍 -4% - +4% -2.38ms - +2.35ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	130.48ms - 136.99ms	-	unsure 🔍 -5% - +2% -6.37ms - +3.23ms	unsure 🔍 -2% - +5% -2.15ms - +6.86ms
tip-of-tree tip-of-tree	131.78ms - 138.83ms	unsure 🔍 -2% - +5% -3.23ms - +6.37ms	-	unsure 🔍 -1% - +7% -0.78ms - +8.63ms
previous-release previous-release	128.27ms - 134.49ms	unsure 🔍 -5% - +2% -6.86ms - +2.15ms	unsure 🔍 -6% - +1% -8.63ms - +0.78ms	-

reactive-element-list

Browser: chrome-headless 107.0.5304.87
Sample size: 50
Built by: Benchmarks #4024
Commit: aabae5f

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	71.78ms - 74.39ms	-	unsure 🔍 -2% - +3% -1.78ms - +2.07ms	unsure 🔍 -4% - +3% -2.60ms - +2.16ms
tip-of-tree tip-of-tree	71.53ms - 74.35ms	unsure 🔍 -3% - +2% -2.07ms - +1.78ms	-	unsure 🔍 -4% - +3% -2.80ms - +2.07ms
previous-release previous-release	71.32ms - 75.29ms	unsure 🔍 -3% - +4% -2.16ms - +2.60ms	unsure 🔍 -3% - +4% -2.07ms - +2.80ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	973.46ms - 1025.78ms	-	unsure 🔍 -4% - +5% -37.49ms - +45.51ms	unsure 🔍 -3% - +5% -25.67ms - +48.18ms
tip-of-tree tip-of-tree	963.39ms - 1027.83ms	unsure 🔍 -5% - +4% -45.51ms - +37.49ms	-	unsure 🔍 -3% - +5% -34.19ms - +48.68ms
previous-release previous-release	962.31ms - 1014.42ms	unsure 🔍 -5% - +3% -48.18ms - +25.67ms	unsure 🔍 -5% - +3% -48.68ms - +34.19ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	1031.93ms - 1088.26ms	-	unsure 🔍 -1% - +6% -9.40ms - +64.82ms	unsure 🔍 -1% - +6% -6.65ms - +65.87ms
tip-of-tree tip-of-tree	1008.23ms - 1056.54ms	unsure 🔍 -6% - +1% -64.82ms - +9.40ms	-	unsure 🔍 -3% - +3% -31.34ms - +35.14ms
previous-release previous-release	1007.65ms - 1053.32ms	unsure 🔍 -6% - +1% -65.87ms - +6.65ms	unsure 🔍 -3% - +3% -35.14ms - +31.34ms	-

_{tachometer-reporter-action v2 for Benchmarks}

* Move the render function to the end of lit-html (#3284) * Move the render function to the end of lit-html Believe it or not, this is part of some work to better integrate with closure compiler's dead code elimination. * Add an empty changeset. * Fix empty changeset. * Task: Do not reset task value or error on pending (#3283) * [infra] Enable IntersectionController and PerformanceController tests (#3291) Add intersection controller and performance controller tests to CI - skipping Safari. Deflake Firefox intersection controller tests. * [labs/ssr] fix Hydrating LitElements example markup (#3298) * [labs/observers] Fix controllers not observing target if initialized after host connected (#3293) Co-authored-by: Steve Orvell <sorvell@google.com> * [labs/analyzer] Refactor Analyzer into better fit for use in plugins (#3288) * Refactor context * Make Analyzer implement AnalyzerInterface rather than has-a AnalyzerContext * Add PackageInfo and pass to getModule * Add changeset. Minor cleanup. * Fix cli test * Normalize rootDir * Refactor PackageAnalyzer into factory * Address feedback. Minor cleanup. * Slack -> Discord readme (#3307) * [@labs/gen-wrapper-react] TestOutput links to monorepo for dependencies (#3310) * test-output points to the same react dependency * remove types from tsconfig in labs_react * restore multiple react versions * [labs/cli] Lazily install and locally version localize (#2936) * [cli] Lazily install and locally version localize Also merge the two localize commands into one They have just about the same deps and share some setup and teardown code, there's no win in putting them in separate modules. * Use better assertions of no errors. This should print out the stderr output in the case there was some. * Fix error output The .finally fork of the Promise.race result promise was causing an early exit from node before the ordinary uvu error handling could kick in. * Fix failing test It was passing locally because the cwd was set to the CLI directory, but we want to run in a fake workspace directory. * Add an installation message when running npm install. * Changeset * Use try/finally instead of promise methods * Move localize command into its own package. * Task add onComplete and onError (#3287) * [lit] Add "types" to package exports (#3320) * [lit-html] Add `isServer` environment checker module (#3318) Adds an `isServer` variable export to `lit` and `lit-html/is-server.js` which will be `true` in Node and `false` in the browser. This can be used when authoring components to change behavior based on whether or not the component is executing in an SSR context. * [labs/analyzer] Adds support for analyzing JavaScript packages (#3304) * Add support for analyzing JavaScript packages * Fix customElements.define detection, add comments. * Better comments / error handling * Revert accidental SSR changes * Add optional/non-null to model * Run analyzer_test in JS. Add changeset. * Fix gen-wrapper-angular * Fix another inadvertant SSR change * Address review feedback. * Add test based on feedback. * [labs/observers] Improve controllers value type from unknown to generic (#3294) Fix value property of type `unknown` on exported controllers. The type of `value` is now generic and can be inferred from the return type of your passed in `callback`. The default callback `() => true` was removed, and is now undefined by default. * [labs/react] Provide explicit return type from createComponent (#3163) * create params object * add changeset * update readme * eeek, this requires generics * found correct return type * more refined type * add ref typing * adjust ref typings * type forwarded instance * expose types at top of file * organize types * no react window module * no react window module * add event listeners * checkout readmes from main * remove as casting in render * remove anys * create minimal JSXInterface for library * save types * jsxmodule * attrubtes over htmlprops * explicit return of element types * move comments * minimal references to window * remove ref cast * remove code changes, type only changes * update changeset * ideal * roll back to minimal amount of changes * types at top of file * better comment * rename userprops to element props * add types to test refs * add extends to exported element props type * pause to sync * add comments, more specific names for events * update EventNames downstream * include package types in tsconfig * undo * tests pass with no extra exports * exposing element props successful * wow only the exposed ReactWebComponent fails * add react types to workspaces * move types to dev deps * remove artifacts from different PR * remove rollup artifact from other PR * declare types in test-output tsconfig * capitals for classes * add export to ReactWebComponent * a/b the types array in test-output * add test for ReactWebComponent type * simplify test * componentProps to ReactComponentProps * type only test * update description * unblocked gen-wrapper-react * add comment for type test * restore modified files * restore modified files, again * remove types tsconfig property * only export what's required * remove old code * add return type * remove extra line in index * [labs/observers] observed targets are re-observed when the host is reconnected (#3321) Controllers now track all observed targets and will restore observing targets when host is reconnected. Fixes: #2902 * [labs/observers] Add unobserve method to ResizeController and IntersectionController (#3323) Add unobserve method to `ResizeController` and `IntersectionController` to match native API. Fixes: #3237 * [labs/gen-utils] Add core packages to testing install with link (#3330) * [infra] Update changesets and package for release (#3332) * Update changesets for release * Update cli-localize package.json for release * Add @lit-labs/cli-localize to changeset * Remove gen-wrapper-angular from changesets (#3336) * Version Packages (#3337) * Unpin Node version for windows-tools test (#3338) * [labs/react] introduce a options object (#2988) * create params object * add changeset * update readme * eeek, this requires generics * found correct return type * more refined type * add ref typing * adjust ref typings * type forwarded instance * expose types at top of file * organize types * no react window module * no react window module * more merge main * initial params bag * add changeset, remove commented code * ReactOrParams * destructure params * update tests, react is optional * remove optional react * remove default react * change is a patch * forgot options.react * [labs/react] Update REAMDE for function overload (#3350) * initial commit * add empty changeset * [@lit-labs/router] add Routes.link tests (#3348) * [gen-manifest] Initial impl of CEM generator (#2990) * [gen-manifest] Initial impl of CEM generator Reset changelog Fix readme * Sync with monorepo changes * Fix comments * Add variable declaration * Update to changes on main. * Fix version for gen-utils * Fix analyzer version * Fix and add tests for type reference serialization * [labs/analyzer] Cache Module models based on dependencies. (#3333) * Cache Module models based on dependencies. * Cleanup and add changeset. * Windows path fixes * Normalize all the paths for Windows * Move moduleCache from module var to Analyzer field. * Add missing wireit input * Add missing wireit output * Fix typo in task README (#3385) * Initializers are copied but separate from superclass initializers (#3374) Initializers are copied but separate from superclass initializers, fixes #/3373. * Example code had an h1 tag closed by an h3 tag (#3392) I changed the h3 tag to be an h1 tag to match the other routes * Improvements to Vue/React wrappers (#3377) Updates react wrapper to correctly type events Update vue wrapper * update vite/vue deps * properly type events * configure defaults using the Vue convention: whenever unset, revert to default value. * Wrapper test elements + runtime tests (#3384) * Adds additional test elements * element-events: for testing events * element-props: for testing property types * element-slots: for testing slotting. * Adds property types to angular wrapper * [@labs/react] certain attributes should be removed when undefined or null (#3128) * add sieve for boolean attributes * unchange stuff that isn't required yet * add changeset * no sieve, use hasAttribute * use hasOwnProperty * boolean attributes should test as null * pause * let react handle the nullifies * remove unnecessary return * add comment, update changeset * remove 232 * cascade logic over nested * update comments * don't watch for disabled * show test updates and output * hidden attr is alright * passing tests * set HTMLPrototype undefined values to empty string * id is the special case * add tests for properties * update tests for properties * remove nested iffs from set property * format * set as empty string * change value, don't assign * value as str * remove attribute if undefined * set value as string on htmlelement attr * match vanilla react behavior * order ifs by cost, comment alternatives * forgot return * checkpoint * sync with example gist * draggable is null * checkpoint * update tests, wrappedEl vs el * test div against web component * remove extra lines * update changeset * include unwrapped web component x-foo * add null checks at end of attribute checks * add comments, add undefined tests after boolean * typo, enumerated * add null checkes to test, add ts-expect-errors * add test ordering * forgot one truthy test * [infra] Use new projectV2 object in issue workflow (#3419) * Add lit to changeset along side reactive-element (#3422) * Version Packages (#3423) * Update chromedriver to 107 for benchmark tests (#3427) * Update chromedriver to 107 for benchmark tests * [labs/virtualizer] Fix width inheritance calculation (issue #3400) (#3424) * Added a test to demonstrate virtualizer width inheritance bug in #3400 * Applied the fix to Virtualizer _updateView to interpret width correctly. * Added changeset describing the fix for #3400. * [labs/virtualizer] Export event classes through a new events.js (#3430) * Added an events.js to export the RangeChangedEvent and VisibilityChangedEvent classes. * Point to events.js to get the event classes now and moved the custom Range interface into there. * Added events.js files to package.json's files property and the wireit outputs for build:ts. * [labs/context] Rename context decorators to consume and provide (#3398) * [@labs/react] Filter __forwardedRef in prod build (#3409) * [labs/react] Filter __forwardedRef in prod build * rebased from main, branched from react-forwarded-ref * added changeset * update ref setting * add dunders back in * add comments, update changeset * iterrate userprops Co-authored-by: Justin Fagnani <justinfagnani@google.com> * [labs/context] Make @consume decorator work with optional fields (#3399) * [labs/context] Rename ContextKey to Context (#3404) * Allow ContextProvider to be added lazily and still work with ContextRoot (#3434) * [infra] Fix npm install with version 9 (#3448) * Fix dep on missing folder. Fixes npm install on npm 9. * Add empty changeset * Implement `lit init element` (#3248) Co-authored-by: Justin Fagnani <justinfagnani@google.com> * Logo dark mode support (#3457) * Update logo.svg * empty changeset * lit logo dark mode * add light theme too * fix file locations * use srcset * slack to discord badge * Gitignore build output files from virtualizer (#3454) * Gitignore build output files from virtualizer * add prettierignore files * [labs/analyzer] Add lazy Declaration analysis, Reference dereferencing, and Superclass support (#3380) * Fix comment * Use NODE_OPTIONS=--enable-source-maps * Make declarations lazy * Analyze exports and add ability to dereference References to them * Add superClass reference analysis * Add changeset * fixup! Use NODE_OPTIONS=--enable-source-maps * Fix references to ImportTypes * Add CEM generation to CLI * Fix type import references * Address review feedback. * Fix path normalization on Windows * Updates based on feedback. * Add getSpecifierString to another site. * [labs/gen-manifest] Adds `exports` and more metadata to manifest generator (#3464) * Adds exports to manifest generator Also fixes a few bugs in export analysis and adds better tests. * Add `@slot`, `@cssProp`, and `@cssPart` to manifest generator * Fix config to make JS program analysis faster. * Add windows line ending to regex * Add changeset * Additional Windows line endings fix. * Add support for parsing description, summary, & deprecated * Add more exports support * Emit summary & description in manifest. * Gitignore build output files from virtualizer (#3454) * Gitignore build output files from virtualizer * add prettierignore files * Add the js.map extension to the files property for events.js. * update .prettierignore and .gitignore to include events.js.map Co-authored-by: Peter Burns <rictic@google.com> Co-authored-by: Elliott Marquez <5981958+e111077@users.noreply.github.com> Co-authored-by: Andrew Jakubowicz <ajakubowicz@google.com> Co-authored-by: Michael Potter <mgp140@gmail.com> Co-authored-by: Steve Orvell <sorvell@google.com> Co-authored-by: Kevin Schaaf <kschaaf@google.com> Co-authored-by: Brian Taylor Vann <brian.t.vann@gmail.com> Co-authored-by: Augustine Kim <augustinekim@google.com> Co-authored-by: Lit Robot <98060554+lit-robot@users.noreply.github.com> Co-authored-by: Nick Cipriani <nick.cipriani@gmail.com> Co-authored-by: Brendan Baldwin <brendan@usergenic.com> Co-authored-by: Justin Fagnani <justinfagnani@google.com>

Rename context decorators to consume and provide

87bb1af

justinfagnani requested review from sorvell and kevinpschaaf October 27, 2022 21:01

Add changeset

40424d1

justinfagnani force-pushed the context-api-names branch from efd14f5 to 40424d1 Compare October 27, 2022 21:49

justinfagnani mentioned this pull request Oct 27, 2022

[labs/context]: Invalid example code #3058

Closed

6 tasks

benjamind approved these changes Oct 27, 2022

View reviewed changes

kevinpschaaf changed the title ~~Rename context decorators to consume and provide~~ [labs/context] Rename context decorators to consume and provide Nov 1, 2022

kevinpschaaf approved these changes Nov 4, 2022

View reviewed changes

Merge branch 'main' into context-api-names

29f2dbf

justinfagnani merged commit 50f2e42 into main Nov 5, 2022

justinfagnani deleted the context-api-names branch November 5, 2022 17:50

This was referenced Dec 7, 2022

Version Packages #3504

Closed

Version Packages #3506

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[labs/context] Rename context decorators to consume and provide #3398

[labs/context] Rename context decorators to consume and provide #3398

justinfagnani commented Oct 27, 2022 •

edited

changeset-bot bot commented Oct 27, 2022 •

edited

benjamind left a comment

github-actions bot commented Nov 5, 2022 •

edited

📊 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

[labs/context] Rename context decorators to consume and provide #3398

[labs/context] Rename context decorators to consume and provide #3398

Conversation

justinfagnani commented Oct 27, 2022 • edited

changeset-bot bot commented Oct 27, 2022 • edited

🦋 Changeset detected

benjamind left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 5, 2022 • edited

📊 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

justinfagnani commented Oct 27, 2022 •

edited

changeset-bot bot commented Oct 27, 2022 •

edited

github-actions bot commented Nov 5, 2022 •

edited