scriptoriumadmin/zotero
1
0
Fork 0
mirror of https://github.com/zotero/zotero.git synced 2026-08-28 05:25:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Activate window in focus traversal tests, fixing intermittent timeouts

Browse source 
The #focus() Tab/Shift-Tab tests dispatch synthetic keydowns and wait on
a focusin event to sync with the collections search field's async
(setTimeout) focus. Gecko only fires focus/blur events while the window
is active, so when the pane window wasn't active -- it opens in the
background on macOS/Windows and can lose activation on Linux/CI -- the
focusin never fired and the test hung until Mocha's timeout. Activate
the window in beforeEach, as the item pane and tags box focus tests
already do.

Also removes the temporary open-window logging added in e1f19f34f5.
This commit is contained in:
Dan Stillman 2026-07-09 10:57:39 -04:00
parent c3787495cc
commit 03a610e696
1 changed files with 8 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
test/tests/zoteroPaneTest.js
View file

@ -1673,7 +1673,12 @@ describe("ZoteroPane", function () {
"zotero-tb-sync",
"zotero-tb-tabs-menu"
];
beforeEach(function () {
beforeEach(async function () {
// The focus traversal relies on focus/blur events, which only fire when
// the window is active. It opens in the background on macOS and Windows,
// and can lose activation on Linux, so make sure it's active first.
await activateZoteroPane();
// Reset collection search field state
let collectionSearchField = doc.getElementById("zotero-collections-search");
let collectionSearchButton = doc.getElementById("zotero-tb-collections-search");
@ -1686,38 +1691,6 @@ describe("ZoteroPane", function () {
});
it("should shift-tab across the zotero pane", async function () {
// TEMP: List open windows to diagnose the intermittent timeout
let describeWindows = function () {
let lines = [];
for (let openWin of Services.wm.getEnumerator(null)) {
lines.push("type=" + (openWin.document.documentElement.getAttribute("windowtype") || "")
+ ", URL=" + openWin.location.href
+ ", title=" + JSON.stringify(openWin.document.title)
+ ", active=" + (openWin === Services.focus.activeWindow));
}
return lines.length ? "\n " + lines.join("\n ") : " (none)";
};
let windowsAtStart = describeWindows();
// Surface the open-window list in the failure message. On a plain
// hang Mocha just reports a context-free 15s timeout and none of our
// code runs, so wrap each await to reject with the window list instead.
// Done this way rather than logging at the start via Zotero.Debug.init(),
// which enables app-wide debug output that adds latency into the focus
// race and could keep the intermittent failure from reproducing.
let withTimeout = function (promise, label) {
let timer;
let timeout = new Promise(function (resolve, reject) {
timer = setTimeout(function () {
reject(new Error("Timed out waiting for " + label
+ "\nActive element: "
+ (doc.activeElement.id || [...doc.activeElement.classList].join("."))
+ "\nOpen windows at start:" + windowsAtStart
+ "\nOpen windows now:" + describeWindows()));
}, 5000);
});
return Promise.race([promise, timeout]).finally(() => clearTimeout(timer));
};
// Start from the Advanced Search button (the last focusable element in the
// search field) so the first shift-tab exercises advanced button -> search field
let advancedButton = doc.getElementById('zotero-tb-search-advanced-button');
@ -1745,10 +1718,10 @@ describe("ZoteroPane", function () {
}
doc.activeElement.dispatchEvent(shiftTab);
if (focusPromise) {
await withTimeout(focusPromise, "focusin on " + id);
await focusPromise;
}
if (hidePromise) {
await withTimeout(hidePromise, "collections-search to hide before " + id);
await hidePromise;
}
// Some elements don't have id, so use classes to verify they're focused
if (doc.activeElement.id) {