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: ensure all intervals/timeouts/observers are cleared when component is destroyed #5362

Merged
merged 20 commits into from May 14, 2020

Conversation

jacobmllr95
Copy link
Member

@jacobmllr95 jacobmllr95 commented May 13, 2020

Describe the PR

This PR ensures that all intervals/timeouts/observers are cleared/destroyed when the component is destroyed to avoid memory leaks.

It also introduces a unified naming scheme for non-reactive properties (this.$_xyz).

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 Status: WIP Type: Fix PR: Patch labels May 13, 2020
@jacobmllr95 jacobmllr95 requested a review from tmorehouse May 13, 2020
@vercel
Copy link

@vercel vercel bot commented May 13, 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/lub6pat28
Preview: https://bootstrap-vue-git-fix-proper-interval-timeout-observer-cleanup.bootstrap-vue.now.sh

@codesandbox-ci
Copy link

@codesandbox-ci codesandbox-ci bot commented May 13, 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 45ee856:

Sandbox Source
lingering-feather-vrd16 Configuration

@codecov
Copy link

@codecov codecov bot commented May 13, 2020

Codecov Report

Merging #5362 into dev will decrease coverage by 0.01%.
The diff coverage is 98.87%.

Impacted file tree graph

@@             Coverage Diff             @@
##               dev    #5362      +/-   ##
===========================================
- Coverage   100.00%   99.98%   -0.02%     
===========================================
  Files          281      281              
  Lines         8833     8847      +14     
  Branches      2507     2507              
===========================================
+ Hits          8833     8846      +13     
- Misses           0        1       +1     
Flag Coverage Δ
#unittests 99.98% <98.87%> (-0.02%) ⬇️
Impacted Files Coverage Δ
src/directives/scrollspy/scrollspy.class.js 100.00% <ø> (ø)
src/components/carousel/carousel.js 99.47% <96.15%> (-0.53%) ⬇️
src/components/form-spinbutton/form-spinbutton.js 100.00% <100.00%> (ø)
src/components/modal/modal.js 100.00% <100.00%> (ø)
src/components/table/helpers/mixin-filtering.js 100.00% <100.00%> (ø)
src/components/table/helpers/mixin-tbody.js 100.00% <100.00%> (ø)
src/components/tabs/tabs.js 100.00% <100.00%> (ø)
src/components/tooltip/helpers/bv-popper.js 100.00% <100.00%> (ø)
src/components/tooltip/helpers/bv-tooltip.js 100.00% <100.00%> (ø)
src/components/tooltip/tooltip.js 100.00% <100.00%> (ø)
... and 4 more

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 c3db758...45ee856. Read the comment docs.

@vercel vercel bot temporarily deployed to Preview May 14, 2020 Inactive
@jacobmllr95 jacobmllr95 merged commit 064cdf4 into dev May 14, 2020
14 checks passed
@jacobmllr95 jacobmllr95 added this to Done in v2.15.0 via automation May 14, 2020
@jacobmllr95 jacobmllr95 deleted the fix-proper-interval-timeout-observer-cleanup branch May 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Patch Type: Fix
Projects
No open projects
v2.15.0
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants