Skip to content

Fix(collapse): prevent race condition on rapid accordion clicks #42844

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

Open
MohamedAlfeky1 wants to merge 1 commit into
base: main
Choose a base branch
from
+79 −2
Open

Fix(collapse): prevent race condition on rapid accordion clicks #42844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions js/src/collapse.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const CLASS_NAME_HORIZONTAL = 'collapse-horizontal'
const WIDTH = 'width'
const HEIGHT = 'height'

const SELECTOR_ACTIVES = '.collapse.show, .collapse.collapsing'
const SELECTOR_ACTIVES = '.collapse.show, .collapsing'
const SELECTOR_DATA_TOGGLE = '[data-bs-toggle="collapse"]'

const Default = {
Expand All @@ -61,6 +61,7 @@ class Collapse extends BaseComponent {
super(element, config)

this._isTransitioning = false
this._isExpanding = false
this._triggerArray = []

const toggleList = SelectorEngine.find(SELECTOR_DATA_TOGGLE)
Expand Down Expand Up @@ -120,9 +121,10 @@ class Collapse extends BaseComponent {
activeChildren = this._getFirstLevelChildren(SELECTOR_ACTIVES)
.filter(element => element !== this._element)
.map(element => Collapse.getOrCreateInstance(element, { toggle: false }))
.filter(activeInstance => !this._triggerArray.some(trigger => activeInstance._triggerArray.includes(trigger)))
}

if (activeChildren.length && activeChildren[0]._isTransitioning) {
if (activeChildren.some(activeChild => activeChild._isTransitioning && activeChild._isExpanding)) {
return
}

Expand All @@ -144,9 +146,11 @@ class Collapse extends BaseComponent {

this._addAriaAndCollapsedClass(this._triggerArray, true)
this._isTransitioning = true
this._isExpanding = true

const complete = () => {
this._isTransitioning = false
this._isExpanding = false

this._element.classList.remove(CLASS_NAME_COLLAPSING)
this._element.classList.add(CLASS_NAME_COLLAPSE, CLASS_NAME_SHOW)
Expand Down
73 changes: 73 additions & 0 deletions js/tests/unit/collapse.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,36 @@ describe('Collapse', () => {
expect(spy).not.toHaveBeenCalled()
})

it('should do nothing if any active sibling is transitioning', () => {
fixtureEl.innerHTML = [
'<div id="accordion">',
' <div id="collapse1" class="collapse show" data-bs-parent="#accordion"></div>',
' <div id="collapse2" class="collapse collapsing" data-bs-parent="#accordion"></div>',
' <div id="collapse3" class="collapse" data-bs-parent="#accordion"></div>',
'</div>'
].join('')

const collapseEl1 = fixtureEl.querySelector('#collapse1')
const collapseEl2 = fixtureEl.querySelector('#collapse2')
const collapseEl3 = fixtureEl.querySelector('#collapse3')

const collapse1 = new Collapse(collapseEl1, { toggle: false })
const collapse2 = new Collapse(collapseEl2, { toggle: false })
const collapse3 = new Collapse(collapseEl3, { toggle: false })

collapse1._isTransitioning = false
collapse2._isTransitioning = true
collapse2._isExpanding = true

const spy = spyOn(EventHandler, 'trigger').and.callThrough()

collapse3.show()

expect(spy).not.toHaveBeenCalled()
expect(collapse3._isTransitioning).toBeFalse()
expect(collapseEl3).not.toHaveClass('show')
})

it('should show a collapsed element', () => {
return new Promise(resolve => {
fixtureEl.innerHTML = '<div class="collapse" style="height: 0px;"></div>'
Expand Down Expand Up @@ -941,6 +971,49 @@ describe('Collapse', () => {
trigger3.click()
})
})

it('should not allow multiple items to open when triggers are clicked rapidly in succession', () => {
return new Promise(resolve => {
fixtureEl.innerHTML = [
'<div id="accordion">',
' <div class="accordion-item">',
' <button id="btn1" data-bs-toggle="collapse" data-bs-target="#collapse1"></button>',
' <div id="collapse1" class="collapse show" data-bs-parent="#accordion"></div>',
' </div>',
' <div class="accordion-item">',
' <button id="btn2" data-bs-toggle="collapse" data-bs-target="#collapse2"></button>',
' <div id="collapse2" class="collapse" data-bs-parent="#accordion"></div>',
' </div>',
' <div class="accordion-item">',
' <button id="btn3" data-bs-toggle="collapse" data-bs-target="#collapse3"></button>',
' <div id="collapse3" class="collapse" data-bs-parent="#accordion"></div>',
' </div>',
'</div>'
].join('')

const btn1 = fixtureEl.querySelector('#btn1')
const btn2 = fixtureEl.querySelector('#btn2')
const btn3 = fixtureEl.querySelector('#btn3')
const collapse1 = fixtureEl.querySelector('#collapse1')
const collapse2 = fixtureEl.querySelector('#collapse2')
const collapse3 = fixtureEl.querySelector('#collapse3')

collapse3.addEventListener('shown.bs.collapse', () => {
setTimeout(() => {
const shownCollapses = fixtureEl.querySelectorAll('.collapse.show')
expect(shownCollapses.length).toEqual(1)
expect(collapse3).toHaveClass('show')
expect(collapse1).not.toHaveClass('show')
expect(collapse2).not.toHaveClass('show')
resolve()
}, 10)
})

btn3.click()
btn2.click()
btn1.click()
})
})
})

describe('jQueryInterface', () => {
Expand Down