Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(perf): reactivity issues with bvAttrs and bvListeners (closes #5520) #5753

Merged
merged 5 commits into from Sep 10, 2020

Conversation

jacobmllr95
Copy link
Member

@jacobmllr95 jacobmllr95 commented Sep 9, 2020

Describe the PR

This PR fixes reactivity issues with the cached bvAttrs and bvListeners props that were introduced with #4825.

The problem was that when no $attrs or $listeners were defined initially, but added later on, the initially defined proxied prop itself was not updated which prevented components that used the the proxied props from properly being re-rendered.

Closes #5520.

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix (fixes a boo-boo in the code) - fix(...), requires a patch version update
  • Feature (adds a new feature to BootstrapVue) - feat(...), requires a minor version update
  • Enhancement (augments an existing feature) - feat(...), requires a minor version update
  • ARIA accessibility (fixes or improves ARIA accessibility) - fix(...), requires a patch or minor version update
  • Documentation update (improves documentation or typo fixes) - chore(docs), requires a patch version update
  • Other (please describe)

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe since breaking changes require a minor version update)

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, chore(docs): fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages, and determines the next version type (patch or minor).

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates
  • Includes component package.json meta section updates (prop, slot and event changes/updates)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (required for new features and enhancements)
  • Existing test suites are passing
  • CodeCov for patch has met target (all changes/updates have been tested)
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

@jacobmllr95 jacobmllr95 added Type: Fix PR: Patch Requires patch version bump labels Sep 9, 2020
@jacobmllr95 jacobmllr95 requested a review from Hiws Sep 9, 2020
@jacobmllr95 jacobmllr95 added this to In progress in v2.17.0 via automation Sep 9, 2020
@vercel
Copy link

vercel bot commented Sep 9, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/bootstrap-vue/bootstrap-vue/1ilrc8a4t
Preview: https://bootstrap-vue-git-fix-b-table-reactivity-issues.bootstrap-vue.vercel.app

@codecov
Copy link

codecov bot commented Sep 9, 2020

Codecov Report

Merging #5753 into dev will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5753   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          284       284           
  Lines         9571      9575    +4     
  Branches      2527      2530    +3     
=========================================
+ Hits          9571      9575    +4     
Flag Coverage Δ
#unittests 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/utils/cache.js 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2f7d3c8...d61d80f. Read the comment docs.

@jacobmllr95
Copy link
Member Author

jacobmllr95 commented Sep 9, 2020

@Hiws @alfianwahid I don't know why the CodeSanbox CI was not picked up by this PR but I was able to confirm that the code from #5520 worked in the Payground fo the deployment preview.

Edit: CodeSanbox is also available now https://codesandbox.io/s/bvtable-sortable-g6lyz-rc7py.

@jacobmllr95 jacobmllr95 changed the title fix: reactivity issues with bvAttrs and bvListeners (closes #5520) fix(perf): reactivity issues with bvAttrs and bvListeners (closes #5520) Sep 9, 2020
@codesandbox-ci
Copy link

codesandbox-ci bot commented Sep 10, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit d61d80f:

Sandbox Source
BootstrapVue Starter Project Configuration
bvtable-sortable-g6lyz Issue #5520
bvtable-sortable-g6lyz Issue #5520

Hiws
Hiws approved these changes Sep 10, 2020
@jacobmllr95 jacobmllr95 merged commit d83a2b1 into dev Sep 10, 2020
5 checks passed
v2.17.0 automation moved this from In progress to Done Sep 10, 2020
@jacobmllr95 jacobmllr95 deleted the fix-b-table-reactivity-issues branch Sep 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Patch Requires patch version bump Type: Fix Type: Perf
Projects
No open projects
v2.17.0
  
Done
Development

Successfully merging this pull request may close these issues.

Clicking on a sortable table column header not working (not sort) when 'sortable' value is dynamic
2 participants