Skip to content

fix(b-form-input): fix debounce when value does not change #5632

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Aug 4, 2020
Merged

fix(b-form-input): fix debounce when value does not change #5632

merged 4 commits into from
Aug 4, 2020

Conversation

KarboniteKream
Copy link
Contributor

Describe the PR

This PR fixes the behavior of debounce on b-input-form when the initial and final value are the same.

Changing input like value -> valu -> value will cause the update event to receive valu instead of value. This is because value is the same as the initial value and will not update the triggered event.

I've modified the behavior to always replace the triggered event which then compares the initial and updated value before emitting an update event.

Now the flow value -> valu -> value will not emit an update event.

PR checklist

What kind of change does this PR introduce?

  • Bugfix (fixes a boo-boo in the code)
  • Feature (adds a new feature to BootstrapVue)
  • Enhancement (augments an existing feature)
  • ARIA accessibility (fixes or improves ARIA accessibility)
  • Documentation update (improves documentation or typo fixes)
  • Other (please describe)

Does this PR introduce a breaking change?

  • No
  • Yes

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.)

@codesandbox-ci
Copy link

codesandbox-ci bot commented Aug 3, 2020 •
edited
Loading

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 e102949:

Sandbox Source
BootstrapVue Starter Project Configuration

@codecov
Copy link

codecov bot commented Aug 3, 2020 •
edited
Loading

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5632   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          278       278           
  Lines         9409      9409           
  Branches      2514      2514           
=========================================
  Hits          9409      9409
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/mixins/form-text.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 f10103e...e102949. Read the comment docs.

@Hiws Hiws added Type: Fix PR: Patch Requires patch version bump labels Aug 3, 2020
@jacobmllr95 jacobmllr95 self-requested a review August 3, 2020 07:17
@vercel
Copy link

vercel bot commented Aug 3, 2020 •
edited
Loading

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/inrh8vaix
✅ Preview: https://bootstrap-vue-git-fork-karbonitekream-fix-input-debounce-equals.bootstrap-vue.vercel.app

@jacobmllr95
Copy link
Member

jacobmllr95 commented Aug 3, 2020 •
edited
Loading

@KarboniteKream I made some slight adjustments to the codes so share the exact same update logic between immediate and debounced value changes.

It also makes sure to always clear the debounce when updateValue() gets called.
This should get around any other problems with changed debounce values between value updates.

Can you please re-check if this solves your problem in the generated CodeSandbox wit the latest changes:
https://codesandbox.io/s/bootstrapvue-starter-project-tke9u

@KarboniteKream
Copy link
Contributor Author

@jackmu95 Thanks! I've verified that the code still works correctly.

@jacobmllr95 jacobmllr95 merged commit 111ca65 into bootstrap-vue:dev Aug 4, 2020
@jacobmllr95
Copy link
Member

Thanks @KarboniteKream!

@KarboniteKream KarboniteKream deleted the fix/input-debounce-equals branch August 4, 2020 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jacobmllr95 jacobmllr95 jacobmllr95 approved these changes

Assignees
No one assigned
Labels
PR: Patch Requires patch version bump Type: Fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@KarboniteKream @jacobmllr95 @Hiws