Skip to content

luci-base: mark background poll XHRs with X-Ubus-No-Touch header #8916

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
micpf wants to merge 1 commit into
base: master
Choose a base branch
from
Open

luci-base: mark background poll XHRs with X-Ubus-No-Touch header #8916

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
26 changes: 26 additions & 0 deletions modules/luci-base/htdocs/luci-static/resources/luci.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,14 @@

const requestQueue = [];

/* Requests made within BACKGROUND_THRESHOLD ms of a user gesture are
* foreground (session-touching); all others are background.
*/
const BACKGROUND_THRESHOLD = 5000;

@openwrt-ai openwrt-ai Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: the PR description still documents the superseded mechanism. It describes a Request.background boolean that capture-phase listeners clear "for the synchronous duration of the handler" with "a microtask [that] resets it to true immediately after", and claims the flag "is guaranteed to be false only while a user event handler is executing". None of that exists any more — this revision records a timestamp and compares it against a 5 s threshold, which is precisely what makes the async-continuation case (ui.changes.apply, uci.save) work. The commit message is accurate; the PR body is what carries over into the merge discussion, so it is worth syncing before merge.

Generated by Claude Code

for (const type of ['click', 'submit', 'change', 'input', 'keydown', 'mousedown', 'touchstart', 'wheel']) {

@openwrt-ai openwrt-ai Aug 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: the PR description enumerates this list as "common user-interaction event types (click, submit, change, input, keydown, mousedown, touchstart)" — wheel is missing, so the body still reads as the pre-wheel revision. That is the one entry worth naming explicitly, since it is what keeps a user scrolling a realtime view (Status → System Log, bandwidth graph) counting as active; the rest of the list only covers editing-type activity. The commit message says "common user interaction event types" without enumerating, so it stays accurate either way — it is just the body that has drifted.

Generated by Claude Code

@micpf micpf Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, updated the PR description to include wheel.

document.addEventListener(type, () => { Request.lastUserInteraction = Date.now() }, { capture: true, passive: true });
}

/**
* Check whether a Request.options object is eligible to be queued for RPC
* batching.
Expand Down Expand Up @@ -570,6 +578,8 @@
reqopt.content[i] = batch[i][0].content;
}

reqopt.background = batch.every(e => e[0].background);

requestQueue.length = 0;

Request.request(rpcBaseURL, reqopt).then(reply => {
Expand Down Expand Up @@ -605,6 +615,8 @@

interceptors: [],

lastUserInteraction: 0,

/**
* Turn the given relative URL into an absolute URL if necessary.
*
Expand Down Expand Up @@ -665,6 +677,11 @@
* @property {Object<string, string>} [header]
* Specifies HTTP headers to set for the request.
*
* @property {boolean} [background]
* Whether the request is a background poll that should not reset the
* server-side session idle timer. Determined automatically from
* recent user interaction; set explicitly to override.
*
* @property {function()} [progress]
* An optional request callback function which receives ProgressEvent
* instances as sole argument during the HTTP request transfer.
Expand All @@ -689,6 +706,9 @@
* The resulting HTTP response.
*/
request(target, options) {
const background = options?.background ??
(Date.now() - Request.lastUserInteraction) > BACKGROUND_THRESHOLD;

return Promise.resolve(target).then(url => {
const state = { xhr: new XMLHttpRequest(), url: this.expandURL(url), start: Date.now() };
const opt = Object.assign({}, options, state);
Expand All @@ -698,6 +718,9 @@

return new Promise((resolveFn, rejectFn) => {
opt.xhr.onreadystatechange = callback.bind(opt, resolveFn, rejectFn);

opt.background = background;

opt.method = String(opt.method ?? 'GET').toUpperCase();

if ('query' in opt) {
Expand Down Expand Up @@ -787,6 +810,9 @@
contenttype = opt.headers[header];
}

if (opt.background && new URL(opt.url, location.href).origin == location.origin)

@openwrt-ai openwrt-ai Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: the same-origin restriction is new in this revision and is not mentioned in the commit message. The message says only "Fix this by setting an X-Ubus-No-Touch: 1 request header on XHRs that are not driven by a user gesture", which reads as unconditional; the PR body does document the CORS-preflight rationale, but the commit message is what survives into the tree. Worth one line, e.g. "The header is restricted to same-origin targets so cross-origin XHRs (attendedsysupgrade, repository key fetches) are not turned into preflighted requests."

Generated by Claude Code

opt.xhr.setRequestHeader('X-Ubus-No-Touch', '1');

if ('progress' in opt && 'upload' in opt.xhr)
opt.xhr.upload.addEventListener('progress', opt.progress);

Expand Down