spectrum-web-components icon indicating copy to clipboard operation
spectrum-web-components copied to clipboard

chore(reactive-controllers): updates lit dependency

Open jnjosh opened this issue 1 year ago • 7 comments

Description

When we updated to support Lit 2 or Lit 3 we left Reactive Controllers behind, only supporting 3. This has created downstream issues in consumers that don't support Lit 3.

How has this been tested?

  • [ ] Need some help in how to best test this.

Checklist

  • [X] I have signed the Adobe Open Source CLA.
  • [X] My code follows the code style of this project.
  • [X] If my change required a change to the documentation, I have updated the documentation in this pull request.
  • [X] I have read the CONTRIBUTING document.
  • [-] I have added tests to cover my changes.
  • [-] All new and existing tests passed.
  • [X] I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

jnjosh avatar Sep 13 '24 18:09 jnjosh

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file. If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

github-actions[bot] avatar Sep 13 '24 20:09 github-actions[bot]

Lighthouse scores

Category Latest (report) Main (report) Branch (report)
Performance 0.99 0.99 0.98
Accessibility 1 1 1
Best Practices 1 1 1
SEO 1 0.92 0.92
PWA 1 1 1
What is this?

Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on main ("Main"). Higher scores are better, but note that the SEO scores on Netlify URLs are artifically constrained to 0.92.

Transfer Size

Category Latest Main Branch
Total 245.587 kB 230.73 kB 🏆 230.817 kB
Scripts 61.598 kB 54.315 kB 🏆 54.448 kB
Stylesheet 47.897 kB 41.931 kB 41.889 kB 🏆
Document 6.24 kB 5.519 kB 5.498 kB 🏆
Font 126.854 kB 126.615 kB 🏆 126.631 kB

Request Count

Category Latest Main Branch
Total 52 52 52
Scripts 41 41 41
Stylesheet 5 5 5
Document 1 1 1
Font 2 2 2

github-actions[bot] avatar Sep 13 '24 20:09 github-actions[bot]

Pull Request Test Coverage Report for Build 13562860079

Details

  • 9 of 9 (100.0%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.966%

Totals Coverage Status
Change from base Build 13553587344: 0.0%
Covered Lines: 33665
Relevant Lines: 34167

💛 - Coveralls

coveralls avatar Sep 13 '24 20:09 coveralls

Tachometer results

Currently, no packages are changed by this PR...

github-actions[bot] avatar Sep 13 '24 21:09 github-actions[bot]

reactive-controllers lit dependency needs to be pointed to ^3.1.3

@Rajdeepc, can you provide any detail on why the @spectrum-web-components/reactive-controllers package won't work with Lit 2.5.0?

graynorton avatar Sep 16 '24 15:09 graynorton

reactive-controllers lit dependency needs to be pointed to ^3.1.3

@Rajdeepc, can you provide any detail on why the @spectrum-web-components/reactive-controllers package won't work with Lit 2.5.0?

My initial findings is that with lit: 2.5.0, storybook 7.x is not supported under @storybook/types. Component preview breaks under S7.

Rajdeepc avatar Sep 19 '24 11:09 Rajdeepc

My initial findings is that with lit: 2.5.0, storybook 7.x is not supported under @storybook/types. Component preview breaks under S7.

@Rajdeepc Let's try to sync up next week, maybe in the internal discussions meeting on Tuesday. I tried a bunch of things and couldn't identify any failures as a result of making this change, so would be good to compare notes. Thanks!

graynorton avatar Sep 19 '24 22:09 graynorton

⚠️ No Changeset found

Latest commit: 9a3ac659bcb8a326f05babdc3d7626dd5f12f809

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Jan 29 '25 13:01 changeset-bot[bot]

@graynorton @Rajdeepc what was the outcome of the convo mentioned above? Do we still support Lit2? If so we should get this in

caseyisonit avatar Feb 26 '25 22:02 caseyisonit

This got fixed by https://github.com/adobe/spectrum-web-components/pull/5105. Closing.

rubencarvalho avatar Feb 27 '25 09:02 rubencarvalho