Skip to content

Self-hosted project management for devs and their clients: tickets, time tracking, docs and meetings, with an AI assistant that cites its sources. AGPL-3.0.

Let the lane ask the Escape owners instead of a list of selectors

Guido Boykedf635969a7cd
diff --git a/app/javascript/controllers/layout_toggle_controller.js b/app/javascript/controllers/layout_toggle_controller.js
index 4f87021..8732a78 100644
--- a/app/javascript/controllers/layout_toggle_controller.js
+++ b/app/javascript/controllers/layout_toggle_controller.js
@@ -1,5 +1,6 @@
import { Controller } from "@hotwired/stimulus"
import { readLaneParams, laneParamNames } from "lane/params"
+import { escapeOwned } from "escape_owner"
// The fixed-height list/detail grids (Tickets table, Knowledge, Meetings) fill the
// viewport instead of carrying a hardcoded `calc(100vh - <magic>)` height. The bottom
@@ -117,7 +118,11 @@ export default class extends Controller {
this.element.addEventListener('click', this.boundSyncFilterContext, true)
this.element.addEventListener('submit', this.boundSyncFilterContext, true)
- // ESC key closes content panel
+ // ESC key closes content panel, unless something on top owns it. Who owns
+ // it is asked in the capture phase on window, before any listener has run:
+ // an owner that closes itself on its own element looks closed afterwards.
+ this.boundNoteEscapeOwner = this.noteEscapeOwner.bind(this)
+ window.addEventListener('keydown', this.boundNoteEscapeOwner, true)
this.boundCloseOnEscape = this.closeOnEscape.bind(this)
document.addEventListener('keydown', this.boundCloseOnEscape)
@@ -132,6 +137,7 @@ export default class extends Controller {
document.removeEventListener('turbo:before-stream-render', this.boundHandleListStream)
this.element.removeEventListener('click', this.boundSyncFilterContext, true)
this.element.removeEventListener('submit', this.boundSyncFilterContext, true)
+ window.removeEventListener('keydown', this.boundNoteEscapeOwner, true)
document.removeEventListener('keydown', this.boundCloseOnEscape)
window.removeEventListener('resize', this.boundScheduleGridHeight)
if (this._gridHeightRaf) cancelAnimationFrame(this._gridHeightRaf)
@@ -144,24 +150,23 @@ export default class extends Controller {
}
}
- // Menus and dialogs own the first Escape. Since their document/window
- // listeners may run after this controller's listener, visible DOM state is
- // the reliable signal; event.defaultPrevented alone depends on connect order.
+ noteEscapeOwner(event) {
+ if (event.key !== 'Escape') return
+ this.escapeOwnerAtKeydown = { event, owned: this.escapeOwnedNow() }
+ }
+
+ // Menus, modals and drawers own the first Escape (lib/escape_owner.js). The
+ // answer noted at keydown counts; an event that came without that note (a
+ // dispatched one) is asked now.
escapeBelongsToOverlay(event) {
if (event.defaultPrevented) return true
- return Boolean(document.querySelector([
- 'dialog[open]',
- '[data-neo-inline-popover-target="panel"]:not(.hidden)',
- '[data-dropdown-target="menu"]:not(.hidden)',
- '[data-neo-dropdown-target="menu"]:not(.hidden)',
- // The bulk panel's layers and field picker hide with the attribute.
- '[data-values-layer]:not([hidden])',
- '[data-select-layer]:not([hidden])',
- '[data-ticket-bulk-panel-target="pickerMenu"]:not([hidden])',
- // The "Link" modal is the content of its frame: present only while open.
- '[data-controller~="ticket-relation-modal"]'
- ].join(', ')))
+ const noted = this.escapeOwnerAtKeydown
+ return noted?.event === event ? noted.owned : this.escapeOwnedNow()
+ }
+
+ escapeOwnedNow() {
+ return escapeOwned(this.application?.controllers || [], document)
}
handleFrameLoad(event) {
diff --git a/spec/javascript/controllers/layout_toggle_controller.test.js b/spec/javascript/controllers/layout_toggle_controller.test.js
index d181add..adee341 100644
--- a/spec/javascript/controllers/layout_toggle_controller.test.js
+++ b/spec/javascript/controllers/layout_toggle_controller.test.js
@@ -3,6 +3,7 @@ import assert from 'node:assert/strict'
import { readFileSync } from 'node:fs'
import { runInNewContext } from 'node:vm'
import { laneParamNames } from '../../../app/javascript/lib/lane/params.js'
+import { escapeOwned } from '../../../app/javascript/lib/escape_owner.js'
const source = readFileSync(new URL('../../../app/javascript/controllers/layout_toggle_controller.js', import.meta.url), 'utf8')
.replace(/^import .*\n/gm, '')
@@ -15,7 +16,7 @@ function controllerWith(document, { window = {}, groups = null, element = null }
CustomEvent: class {
constructor(type, options) { this.type = type; Object.assign(this, options) }
},
- readLaneParams: () => groups, laneParamNames
+ readLaneParams: () => groups, laneParamNames, escapeOwned
})
const controller = new Controller()
controller.listFilterParamsValue = []
@@ -23,37 +24,53 @@ function controllerWith(document, { window = {}, groups = null, element = null }
return controller
}
-test('an open dialog or menu owns Escape before the detail lane', () => {
- const overlays = [
- 'dialog[open]',
- '[data-neo-inline-popover-target="panel"]:not(.hidden)',
- '[data-dropdown-target="menu"]:not(.hidden)',
- '[data-neo-dropdown-target="menu"]:not(.hidden)',
- // The bulk panel's own layers (tags, people, a select) and its field
- // picker hide with the attribute, not the class.
- '[data-values-layer]:not([hidden])',
- '[data-select-layer]:not([hidden])',
- '[data-ticket-bulk-panel-target="pickerMenu"]:not([hidden])',
- // The "Link" modal of a ticket page is the content of its frame, so it
- // exists only while open. Without it Escape closed the lane BEHIND it.
- '[data-controller~="ticket-relation-modal"]'
- ]
+test('a controller that owns Escape keeps the lane open', () => {
+ let owns = true
+ let closed = 0
+ let prevented = 0
+ const controller = controllerWith({ querySelector: () => null })
+ controller.application = { controllers: [{ ownsEscape: () => owns }, controller] }
+ controller.layoutState = { content: true }
+ controller.closeContent = () => { closed += 1 }
+ const escape = () => ({ key: 'Escape', defaultPrevented: false, preventDefault: () => { prevented += 1 } })
- for (const overlay of overlays) {
- let closed = 0
- let prevented = 0
- const document = { querySelector: (selector) => selector.includes(overlay) ? { overlay } : null }
- const controller = controllerWith(document)
- controller.layoutState = { content: true }
- controller.closeContent = () => { closed += 1 }
- controller.closeOnEscape({ key: 'Escape', defaultPrevented: false, preventDefault: () => { prevented += 1 } })
- assert.equal(closed, 0)
- assert.equal(prevented, 0)
- }
+ controller.closeOnEscape(escape())
+ assert.equal(closed, 0)
+ assert.equal(prevented, 0)
+ owns = false
+ controller.closeOnEscape(escape())
+ assert.equal(closed, 1)
+})
+
+test('the owner is asked at keydown, before it can close itself', () => {
+ let owns = true
+ let closed = 0
const controller = controllerWith({ querySelector: () => null })
- assert.equal(controller.escapeBelongsToOverlay({ defaultPrevented: false }), false)
- assert.equal(controller.escapeBelongsToOverlay({ defaultPrevented: true }), true)
+ controller.application = { controllers: [{ ownsEscape: () => owns }] }
+ controller.layoutState = { content: true }
+ controller.closeContent = () => { closed += 1 }
+ const event = { key: 'Escape', defaultPrevented: false, preventDefault: () => {} }
+
+ controller.noteEscapeOwner(event)
+ // The owner's own listener runs and closes it before the lane's listener.
+ owns = false
+ controller.closeOnEscape(event)
+
+ assert.equal(closed, 0)
+})
+
+test('an open native dialog, a marked layer or a prevented Escape keep the lane open', () => {
+ const page = { querySelector: (selector) => selector.includes('dialog[open]') ? {} : null }
+ const controller = controllerWith(page)
+ controller.application = { controllers: [] }
+
+ assert.equal(controller.escapeBelongsToOverlay({ defaultPrevented: false }), true)
+
+ const empty = controllerWith({ querySelector: () => null })
+ empty.application = { controllers: [] }
+ assert.equal(empty.escapeBelongsToOverlay({ defaultPrevented: false }), false)
+ assert.equal(empty.escapeBelongsToOverlay({ defaultPrevented: true }), true)
})
test('clearing a meeting lane publishes the frame cleanup contract', () => {
diff --git a/spec/system/meeting_filters_columns_spec.rb b/spec/system/meeting_filters_columns_spec.rb
index 297a4b3..d4c7b69 100644
--- a/spec/system/meeting_filters_columns_spec.rb
+++ b/spec/system/meeting_filters_columns_spec.rb
@@ -159,6 +159,39 @@ RSpec.describe 'Meeting filters and columns', type: :system do
expect(page).to have_current_path(/participant/)
end
+ # lib/escape_owner.js: the topmost thing takes Escape, the lane only when
+ # nothing above it owns the key. The value menu of the filter bar was on no
+ # list until 2026-10-17 and closed the lane with its first Escape.
+ it 'closes the filter menu step by step before the lane behind it' do
+ page.driver.browser.manage.window.resize_to(1440, 1000)
+ visit path
+ # The rows show before their scripts listen: a click before that opens nothing.
+ page.document.synchronize do
+ connected = page.evaluate_script(<<~JS)
+ Boolean(window.Stimulus?.getControllerForElementAndIdentifier(document.querySelector('tr[data-meeting-id]'), 'list-row'))
+ JS
+ raise Capybara::ExpectationNotMet, 'the row controller is not connected yet' unless connected
+ end
+ find("tr[data-meeting-id='#{meetings.first.id}']").click
+ expect(page).to have_css('#meeting-header', text: 'Alpha')
+
+ find('[data-filter-bar-target="filterButton"]').click
+ find('[role="menuitem"][data-category="participant"]').click
+ expect(page).to have_css('[data-filter-bar-target="valueMenu"]:not(.hidden)', wait: 3)
+
+ page.send_keys(:escape)
+ expect(page).to have_css('[data-filter-bar-target="valueMenu"].hidden', visible: :all)
+ expect(page).to have_css('[data-filter-bar-target="filterMenu"]:not(.hidden)')
+ expect(page).to have_css('.labor-layout-view.show-content #meeting-header', text: 'Alpha')
+
+ page.send_keys(:escape)
+ expect(page).to have_css('[data-filter-bar-target="filterMenu"].hidden', visible: :all)
+ expect(page).to have_css('.labor-layout-view.show-content #meeting-header', text: 'Alpha')
+
+ page.send_keys(:escape)
+ expect(page).to have_no_css('.labor-layout-view.show-content')
+ end
+
it 'enters the rows from the search field and opens a meeting with the keyboard' do
page.driver.browser.manage.window.resize_to(1440, 1000)
visit path(search: 'a', search_mode: 'title_only')