Skip to content
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

[Stimulus] Fasten lazy loading + add debug lazy:loading and lazy:loaded #2463

Open
wants to merge 3 commits into
base: 2.x
Choose a base branch
from
+78 −44
Open

[Stimulus] Fasten lazy loading + add debug lazy:loading and lazy:loaded #2463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d764aff
Observe childList (added nodes) before attribute changes
smnandre Dec 22, 2024
f681ec8
Remove unnecessary function
smnandre Dec 22, 2024
0e5abca
Unlock controller loading & logDebugActivity
smnandre Dec 22, 2024
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
55 changes: 36 additions & 19 deletions src/StimulusBundle/assets/dist/loader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,50 @@ class StimulusLazyControllerHandler {
this.lazyLoadNewControllers(document.documentElement);
}
lazyLoadExistingControllers(element) {
this.queryControllerNamesWithin(element).forEach((controllerName) => this.loadLazyController(controllerName));
Array.from(element.querySelectorAll(`[${controllerAttribute}]`))
.flatMap(extractControllerNamesFrom)
.forEach((controllerName) => this.loadLazyController(controllerName));
}
async loadLazyController(name) {
if (canRegisterController(name, this.application)) {
if (this.lazyControllers[name] === undefined) {
return;
}
const controllerModule = await this.lazyControllers[name]();
registerController(name, controllerModule.default, this.application);
loadLazyController(name) {
if (!this.lazyControllers[name]) {
return;
}
const controllerLoader = this.lazyControllers[name];
delete this.lazyControllers[name];
if (!canRegisterController(name, this.application)) {
return;
}
this.application.logDebugActivity(name, 'lazy:loading');
controllerLoader()
.then((controllerModule) => {
this.application.logDebugActivity(name, 'lazy:loaded');
registerController(name, controllerModule.default, this.application);
})
.catch((error) => {
console.error(`Error loading controller "${name}":`, error);
});
}
lazyLoadNewControllers(element) {
if (Object.keys(this.lazyControllers).length === 0) {
return;
}
new MutationObserver((mutationsList) => {
for (const { attributeName, target, type } of mutationsList) {
switch (type) {
case 'attributes': {
if (attributeName === controllerAttribute &&
target.getAttribute(controllerAttribute)) {
extractControllerNamesFrom(target).forEach((controllerName) => this.loadLazyController(controllerName));
for (const mutation of mutationsList) {
switch (mutation.type) {
case 'childList': {
for (const node of mutation.addedNodes) {
if (node instanceof Element) {
extractControllerNamesFrom(node).forEach((controllerName) => {
this.loadLazyController(controllerName);
});
}
}
break;
}
case 'childList': {
this.lazyLoadExistingControllers(target);
case 'attributes': {
if (mutation.attributeName === controllerAttribute) {
extractControllerNamesFrom(mutation.target).forEach((controllerName) => this.loadLazyController(controllerName));
}
}
}
}
Expand All @@ -58,9 +78,6 @@ class StimulusLazyControllerHandler {
childList: true,
});
}
queryControllerNamesWithin(element) {
return Array.from(element.querySelectorAll(`[${controllerAttribute}]`)).flatMap(extractControllerNamesFrom);
}
}
function registerController(name, controller, application) {
if (canRegisterController(name, application)) {
Expand Down
67 changes: 42 additions & 25 deletions src/StimulusBundle/assets/src/loader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,40 +64,61 @@ class StimulusLazyControllerHandler {
}

private lazyLoadExistingControllers(element: Element) {
this.queryControllerNamesWithin(element).forEach((controllerName) => this.loadLazyController(controllerName));
Array.from(element.querySelectorAll(`[${controllerAttribute}]`))
.flatMap(extractControllerNamesFrom)
.forEach((controllerName) => this.loadLazyController(controllerName));
}

private async loadLazyController(name: string) {
if (canRegisterController(name, this.application)) {
if (this.lazyControllers[name] === undefined) {
return;
}
private loadLazyController(name: string) {
if (!this.lazyControllers[name]) {
return;
}

const controllerModule = await this.lazyControllers[name]();
// Delete the loader to avoid loading it twice
const controllerLoader = this.lazyControllers[name];
delete this.lazyControllers[name];

registerController(name, controllerModule.default, this.application);
if (!canRegisterController(name, this.application)) {
return;
}

this.application.logDebugActivity(name, 'lazy:loading');

controllerLoader()
.then((controllerModule) => {
this.application.logDebugActivity(name, 'lazy:loaded');
registerController(name, controllerModule.default, this.application);
})
.catch((error) => {
console.error(`Error loading controller "${name}":`, error);
});
}

private lazyLoadNewControllers(element: Element) {
if (Object.keys(this.lazyControllers).length === 0) {
return;
}
new MutationObserver((mutationsList) => {
for (const { attributeName, target, type } of mutationsList) {
switch (type) {
case 'attributes': {
if (
attributeName === controllerAttribute &&
(target as Element).getAttribute(controllerAttribute)
) {
extractControllerNamesFrom(target as Element).forEach((controllerName) =>
this.loadLazyController(controllerName)
);
for (const mutation of mutationsList) {
switch (mutation.type) {
case 'childList': {
// @ts-ignore
for (const node of mutation.addedNodes) {
if (node instanceof Element) {
extractControllerNamesFrom(node).forEach((controllerName) => {
this.loadLazyController(controllerName);
});
}
}

break;
}

case 'childList': {
this.lazyLoadExistingControllers(target as Element);
case 'attributes': {
if (mutation.attributeName === controllerAttribute) {
extractControllerNamesFrom(mutation.target as Element).forEach((controllerName) =>
this.loadLazyController(controllerName)
);
}
}
}
}
Expand All @@ -107,10 +128,6 @@ class StimulusLazyControllerHandler {
childList: true,
});
}

private queryControllerNamesWithin(element: Element): string[] {
return Array.from(element.querySelectorAll(`[${controllerAttribute}]`)).flatMap(extractControllerNamesFrom);
}
}

function registerController(name: string, controller: ControllerConstructor, application: Application) {
Expand Down
Loading