Skip to content

js: Do not trigger rendered for unchanged content #5505

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

Draft
nilmerg wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

js: Do not trigger rendered for unchanged content #5505

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
11 changes: 11 additions & 0 deletions doc/80-Upgrading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@
Specific version upgrades are described below. Please note that upgrades are incremental. An upgrade from
v2.6 to v2.8 requires to follow the instructions for v2.7 too.

## Upgrading to Icinga Web x.xx

**Framework changes affecting third-party code**

* Our JavaScript framework does not trigger the `rendered` event for content that didn't update anymore. In case
`beforerender` triggers, it is still guaranteed that `rendered` will be triggered. But listeners should still
be inspected to ensure compatibility.
* The JavaScript framework triggers the `rendered` event on content now that changes due to a multipart update.
Previously, the event was only triggered on the related main container. Any listener that guards itself with
`event.currentTarget === event.target` in order to ignore bubbled events will still behave as expected.

## Upgrading to Icinga Web 2.14

**Framework changes affecting third-party code**
Expand Down
23 changes: 19 additions & 4 deletions public/js/icinga/loader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,7 @@

req.$target = $target;
req.$redirectTarget = $target;
req.renderTargets = new Set();
req.url = url;
req.done(this.onResponse);
req.fail(this.onFailure);
Expand Down Expand Up @@ -856,6 +857,17 @@
forceFocus = req.forceFocus;
}

req.renderTargets.add($target[0]);
const container = $target[0].closest('.container');
if (container !== null) {
if (req.renderTargets.has(container)) {
// Ensure parent containers are processed last
req.renderTargets.delete(container);
}

req.renderTargets.add(container);
}

_this.renderContentToContainer(
match[3],
$target,
Expand All @@ -875,6 +887,9 @@
}
})
} else {
req.$target[0].querySelectorAll(':scope .container').forEach((c) => req.renderTargets.add(c));
req.renderTargets.add(req.$target[0]);

this.renderContentToContainer(
req.responseText,
req.$target,
Expand Down Expand Up @@ -1027,10 +1042,10 @@
// Lazy load module javascript (Applies only to module.js code)
this.icinga.ensureSubModules(req.$target);

req.$target.find('.container').each(function () {
$(this).trigger('rendered', [req.autorefresh, req.scripted, req.autosubmit]);
});
req.$target.trigger('rendered', [req.autorefresh, req.scripted, req.autosubmit]);
for (const target of req.renderTargets) {
this.icinga.logger.debug('Triggering rendered event for target', target);
$(target).trigger('rendered', [req.autorefresh, req.scripted, req.autosubmit]);
}

this.icinga.ui.refreshDebug();
},
Expand Down
Loading