Skip to content

[LiveComponent] Enhance polling with limit, visible modifiers and dynamic PHP control #3365

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
xDeSwa wants to merge 1 commit into
base: 2.x
Choose a base branch
from
Open

[LiveComponent] Enhance polling with limit, visible modifiers and dynamic PHP control #3365

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
2 changes: 2 additions & 0 deletions src/LiveComponent/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
}
```

- Add `limit` and `visible` modifiers to `data-poll`, alongside new `stopPoll()` and `stopAllPolls()` methods

## 2.31

- Add browser events assertions in `InteractsWithLiveComponents`:
Expand Down
113 changes: 90 additions & 23 deletions src/LiveComponent/assets/dist/live_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1961,46 +1961,96 @@ var PageUnloadingPlugin_default = class {
var PollingDirector_default = class {
constructor(component) {
this.isPollingActive = true;
this.polls = [];
this.pollingIntervals = [];
this.isPageVisible = true;
this.isComponentIntersecting = true;
this.memoryCounts = {};
this.component = component;
this.isPageVisible = !document.hidden;
this.visibilityChangeListener = () => {
this.isPageVisible = !document.hidden;
this.evaluatePollingStates();
};
document.addEventListener("visibilitychange", this.visibilityChangeListener);
if (typeof IntersectionObserver !== "undefined") {
this.observer = new IntersectionObserver((entries) => {
entries.forEach((entry) => {
this.isComponentIntersecting = entry.isIntersecting;
this.evaluatePollingStates();
});
});
this.observer.observe(this.component.element);
}
}
addPoll(actionName, duration) {
this.polls.push({
addPoll(actionName, duration, limit = 0, visibilityMode = false) {
const pollConfig = {
actionName,
duration
});
if (this.isPollingActive) this.initiatePoll(actionName, duration);
duration,
limit,
count: this.memoryCounts[actionName] || 0,
visibilityMode
};
this.polls.push(pollConfig);
if (this.isPollingActive) this.evaluatePollingStates();
}
startAllPolling() {
if (this.isPollingActive) return;
this.isPollingActive = true;
this.polls.forEach(({ actionName, duration }) => {
this.initiatePoll(actionName, duration);
this.evaluatePollingStates();
}
evaluatePollingStates() {
if (!this.isPollingActive) return;
this.polls.forEach((poll) => {
if (poll.limit > 0 && poll.count >= poll.limit) return;
let shouldRun = true;
if (poll.visibilityMode === "page") shouldRun = this.isPageVisible;
else if (poll.visibilityMode === "component") shouldRun = this.isPageVisible && this.isComponentIntersecting;
const isRunning = this.pollingIntervals.some((i) => i.actionName === poll.actionName);
if (shouldRun && !isRunning) this.initiatePoll(poll);
else if (!shouldRun && isRunning) this.stopPolling(poll.actionName);
});
}
stopAllPolling() {
this.isPollingActive = false;
this.pollingIntervals.forEach((interval) => {
clearInterval(interval);
this.pollingIntervals.forEach(({ timer }) => {
window.clearInterval(timer);
});
this.pollingIntervals = [];
}
stopPolling(actionName) {
this.pollingIntervals = this.pollingIntervals.filter(({ actionName: intervalAction, timer }) => {
if (intervalAction === actionName) {
window.clearInterval(timer);
return false;
}
return true;
});
}
clearPolling() {
this.stopAllPolling();
this.polls = [];
this.startAllPolling();
}
initiatePoll(actionName, duration) {
let callback;
if (actionName === "$render") callback = () => {
this.component.render();
};
else callback = () => {
this.component.action(actionName, {}, 0);
};
initiatePoll(poll) {
let callback = poll.actionName === "$render" ? () => this.component.render() : () => this.component.action(poll.actionName, {}, 0);
const timer = window.setInterval(() => {
callback();
}, duration);
this.pollingIntervals.push(timer);
if (poll.limit > 0) {
poll.count++;
this.memoryCounts[poll.actionName] = poll.count;
if (poll.count >= poll.limit) this.stopPolling(poll.actionName);
}
}, poll.duration);
this.pollingIntervals.push({
actionName: poll.actionName,
timer
});
}
destroy() {
document.removeEventListener("visibilitychange", this.visibilityChangeListener);
if (this.observer) this.observer.disconnect();
this.stopAllPolling();
}
};
var PollingPlugin_default = class {
Expand All @@ -2012,14 +2062,19 @@ var PollingPlugin_default = class {
this.pollingDirector.startAllPolling();
});
component.on("disconnect", () => {
this.pollingDirector.stopAllPolling();
this.pollingDirector.destroy();
});
component.on("render:finished", () => {
this.initializePolling();
});
this.element.addEventListener("live:stop-poll", ((event) => {
const actionToStop = event.detail?.action;
if (actionToStop) this.pollingDirector.stopPolling(actionToStop);
else this.pollingDirector.stopAllPolling();
}));
}
addPoll(actionName, duration) {
this.pollingDirector.addPoll(actionName, duration);
addPoll(actionName, duration, limit, visibilityMode = false) {
this.pollingDirector.addPoll(actionName, duration, limit, visibilityMode);
}
clearPolling() {
this.pollingDirector.clearPolling();
Expand All @@ -2030,15 +2085,27 @@ var PollingPlugin_default = class {
const rawPollConfig = this.element.dataset.poll;
parseDirectives(rawPollConfig || "$render").forEach((directive) => {
let duration = 2e3;
let limit = 0;
let visibilityMode = false;
directive.modifiers.forEach((modifier) => {
switch (modifier.name) {
case "delay":
if (modifier.value) duration = Number.parseInt(modifier.value);
break;
case "limit":
if (modifier.value) {
const parsed = Number.parseInt(modifier.value, 10);
limit = Number.isNaN(parsed) || parsed <= 0 ? 0 : parsed;
}
break;
case "visible":
if (modifier.value === "page") visibilityMode = "page";
else visibilityMode = "component";
break;
default: console.warn(`Unknown modifier "${modifier.name}" in data-poll "${rawPollConfig}".`);
}
});
this.addPoll(directive.action, duration);
this.addPoll(directive.action, duration, limit, visibilityMode);
});
}
};
Expand Down
42 changes: 37 additions & 5 deletions src/LiveComponent/assets/src/Component/plugins/PollingPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,32 @@ export default class implements PluginInterface {
this.pollingDirector.startAllPolling();
});
component.on('disconnect', () => {
this.pollingDirector.stopAllPolling();
// Clean up intervals, observers, and event listeners to prevent memory leaks
this.pollingDirector.destroy();
});
component.on('render:finished', () => {
// re-start polling, in case polling changed
this.initializePolling();
});

// Listen for the stop-poll event dispatched from the server (PHP)
this.element.addEventListener('live:stop-poll', ((event: CustomEvent) => {
const actionToStop = event.detail?.action;
if (actionToStop) {
this.pollingDirector.stopPolling(actionToStop);
} else {
this.pollingDirector.stopAllPolling();
}
}) as EventListener);
}

addPoll(actionName: string, duration: number): void {
this.pollingDirector.addPoll(actionName, duration);
addPoll(
actionName: string,
duration: number,
limit: number,
visibilityMode: 'component' | 'page' | false = false
): void {
this.pollingDirector.addPoll(actionName, duration, limit, visibilityMode);
}

clearPolling(): void {
Expand All @@ -44,21 +60,37 @@ export default class implements PluginInterface {

directives.forEach((directive) => {
let duration = 2000;
let limit = 0;
let visibilityMode: 'component' | 'page' | false = false; // Default: runs always in the background (BC)

directive.modifiers.forEach((modifier) => {
switch (modifier.name) {
case 'delay':
if (modifier.value) {
duration = Number.parseInt(modifier.value);
}

break;
case 'limit':
if (modifier.value) {
const parsed = Number.parseInt(modifier.value, 10);
// Fallback to 0 (infinite) if NaN or negative
limit = Number.isNaN(parsed) || parsed <= 0 ? 0 : parsed;
}
break;
case 'visible':
if (modifier.value === 'page') {
visibilityMode = 'page';
} else {
// Default to 'component' if only "visible" or "visible(component)" is provided
visibilityMode = 'component';
}
break;
default:
console.warn(`Unknown modifier "${modifier.name}" in data-poll "${rawPollConfig}".`);
}
});

this.addPoll(directive.action, duration);
this.addPoll(directive.action, duration, limit, visibilityMode);
});
}
}
Loading