Skip to content

[LiveComponent] Fix loadingDirectives match elements from nested components #1392

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

Merged
merged 1 commit into from
Jan 30, 2024
Merged

[LiveComponent] Fix loadingDirectives match elements from nested components #1392

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
6 changes: 3 additions & 3 deletions src/LiveComponent/assets/dist/Component/plugins/LoadingPlugin.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ interface ElementLoadingDirectives {
}
export default class implements PluginInterface {
attachToComponent(component: Component): void;
startLoading(targetElement: HTMLElement | SVGElement, backendRequest: BackendRequest): void;
finishLoading(targetElement: HTMLElement | SVGElement): void;
startLoading(component: Component, targetElement: HTMLElement | SVGElement, backendRequest: BackendRequest): void;
finishLoading(component: Component, targetElement: HTMLElement | SVGElement): void;
private handleLoadingToggle;
private handleLoadingDirective;
getLoadingDirectives(element: HTMLElement | SVGElement): ElementLoadingDirectives[];
getLoadingDirectives(component: Component, element: HTMLElement | SVGElement): ElementLoadingDirectives[];
private showElement;
private hideElement;
private addClass;
Expand Down
23 changes: 12 additions & 11 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 @@ -2370,27 +2370,27 @@ class StandardElementDriver {
class LoadingPlugin {
attachToComponent(component) {
component.on('loading.state:started', (element, request) => {
this.startLoading(element, request);
this.startLoading(component, element, request);
});
component.on('loading.state:finished', (element) => {
this.finishLoading(element);
this.finishLoading(component, element);
});
this.finishLoading(component.element);
this.finishLoading(component, component.element);
}
startLoading(targetElement, backendRequest) {
this.handleLoadingToggle(true, targetElement, backendRequest);
startLoading(component, targetElement, backendRequest) {
this.handleLoadingToggle(component, true, targetElement, backendRequest);
}
finishLoading(targetElement) {
this.handleLoadingToggle(false, targetElement, null);
finishLoading(component, targetElement) {
this.handleLoadingToggle(component, false, targetElement, null);
}
handleLoadingToggle(isLoading, targetElement, backendRequest) {
handleLoadingToggle(component, isLoading, targetElement, backendRequest) {
if (isLoading) {
this.addAttributes(targetElement, ['busy']);
}
else {
this.removeAttributes(targetElement, ['busy']);
}
this.getLoadingDirectives(targetElement).forEach(({ element, directives }) => {
this.getLoadingDirectives(component, targetElement).forEach(({ element, directives }) => {
if (isLoading) {
this.addAttributes(element, ['data-live-is-loading']);
}
Expand Down Expand Up @@ -2474,9 +2474,10 @@ class LoadingPlugin {
}
loadingDirective();
}
getLoadingDirectives(element) {
getLoadingDirectives(component, element) {
const loadingDirectives = [];
let matchingElements = element.querySelectorAll('[data-loading]');
let matchingElements = [...element.querySelectorAll('[data-loading]')];
matchingElements = matchingElements.filter((elt) => elementBelongsToThisComponent(elt, component));
if (element.hasAttribute('data-loading')) {
matchingElements = [element, ...matchingElements];
}
Expand Down
26 changes: 15 additions & 11 deletions src/LiveComponent/assets/src/Component/plugins/LoadingPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
DirectiveModifier,
parseDirectives
} from '../../Directive/directives_parser';
import { elementBelongsToThisComponent } from '../../dom_utils';
import { combineSpacedArray } from '../../string_utils';
import BackendRequest from '../../Backend/BackendRequest';
import Component from '../../Component';
Expand All @@ -16,32 +17,32 @@ interface ElementLoadingDirectives {
export default class implements PluginInterface {
attachToComponent(component: Component): void {
component.on('loading.state:started', (element: HTMLElement, request: BackendRequest) => {
this.startLoading(element, request);
this.startLoading(component, element, request);
Copy link
Member

Choose a reason for hiding this comment

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

We already have the component as the argument to attachToComponent and we're attaching the loading.state.started to that specific component. So o need for the new argument to the callback: we can use the component variable already

Copy link
Member Author

Choose a reason for hiding this comment

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

As i could not test, i did it in a defensive way :)

I'll remove it

Copy link
Member Author

Choose a reason for hiding this comment

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

Fix / rebased / rebuilded (style cannot test locally -- will fix this next week)

Copy link
Member Author

Choose a reason for hiding this comment

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

Think i did what you meant but not sure

});
component.on('loading.state:finished', (element: HTMLElement) => {
this.finishLoading(element);
this.finishLoading(component, element);
});
// hide "loading" elements to begin with
// This is done with CSS, but only for the most basic cases
this.finishLoading(component.element);
this.finishLoading(component, component.element);
}

startLoading(targetElement: HTMLElement|SVGElement, backendRequest: BackendRequest): void {
this.handleLoadingToggle(true, targetElement, backendRequest);
startLoading(component: Component, targetElement: HTMLElement|SVGElement, backendRequest: BackendRequest): void {
this.handleLoadingToggle(component, true, targetElement, backendRequest);
}

finishLoading(targetElement: HTMLElement|SVGElement): void {
this.handleLoadingToggle(false, targetElement, null);
finishLoading(component: Component, targetElement: HTMLElement|SVGElement): void {
this.handleLoadingToggle(component,false, targetElement, null);
}

private handleLoadingToggle(isLoading: boolean, targetElement: HTMLElement|SVGElement, backendRequest: BackendRequest|null) {
private handleLoadingToggle(component: Component, isLoading: boolean, targetElement: HTMLElement|SVGElement, backendRequest: BackendRequest|null) {
if (isLoading) {
this.addAttributes(targetElement, ['busy']);
} else {
this.removeAttributes(targetElement, ['busy']);
}

this.getLoadingDirectives(targetElement).forEach(({ element, directives }) => {
this.getLoadingDirectives(component, targetElement).forEach(({ element, directives }) => {
// so we can track, at any point, if an element is in a "loading" state
if (isLoading) {
this.addAttributes(element, ['data-live-is-loading']);
Expand Down Expand Up @@ -148,9 +149,12 @@ export default class implements PluginInterface {
loadingDirective();
}

getLoadingDirectives(element: HTMLElement|SVGElement) {
getLoadingDirectives(component: Component, element: HTMLElement|SVGElement) {
const loadingDirectives: ElementLoadingDirectives[] = [];
let matchingElements = element.querySelectorAll('[data-loading]');
let matchingElements = [...element.querySelectorAll('[data-loading]')];

// ignore elements which are inside a nested "live" component
matchingElements = matchingElements.filter((elt) => elementBelongsToThisComponent(elt, component));

// querySelectorAll doesn't include the element itself
if (element.hasAttribute('data-loading')) {
Expand Down
47 changes: 47 additions & 0 deletions src/LiveComponent/assets/test/controller/loading.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,4 +223,51 @@ describe('LiveController data-loading Tests', () => {
await (new Promise(resolve => setTimeout(resolve, 30)));
expect(getByTestId(test.element, 'loading-element')).not.toBeVisible();
});

it('does not trigger loading inside component children', async () => {
const childTemplate = (data: any) => `
<div ${initComponent(data, {id: 'child-id'})} data-testid="child">
<span data-loading="show" data-testid="child-loading-element-showing">Loading...</span>
<span data-loading="hide" data-testid="child-loading-element-hiding">Loading...</span>
</div>
`;

const test = await createTest({} , (data: any) => `
<div ${initComponent(data, {id: 'parent-id'})} data-testid="parent">
<span data-loading="show" data-testid="parent-loading-element-showing">Loading...</span>
<span data-loading="hide" data-testid="parent-loading-element-hiding">Loading...</span>
${childTemplate({})}
<button data-action="live#$render">Render</button>
</div>
`);

test.expectsAjaxCall()
// delay so we can check loading
.delayResponse(20);

// All showing elements should be hidden / hiding elements should be visible
await waitFor(() => expect(getByTestId(test.element, 'parent-loading-element-showing')).not.toBeVisible());
await waitFor(() => expect(getByTestId(test.element, 'parent-loading-element-hiding')).toBeVisible());
await waitFor(() => expect(getByTestId(test.element, 'child-loading-element-showing')).not.toBeVisible());
await waitFor(() => expect(getByTestId(test.element, 'child-loading-element-hiding')).toBeVisible());

getByText(test.element, 'Render').click();

// Parent: showing elements should be visible / hiding elements should be hidden
expect(getByTestId(test.element, 'parent-loading-element-showing')).toBeVisible();
expect(getByTestId(test.element, 'parent-loading-element-hiding')).not.toBeVisible();
// Child: no change
expect(getByTestId(test.element, 'child-loading-element-showing')).not.toBeVisible();
expect(getByTestId(test.element, 'child-loading-element-hiding')).toBeVisible();

// wait for loading to finish
await (new Promise(resolve => setTimeout(resolve, 30)));

// Parent: back to original state
expect(getByTestId(test.element, 'parent-loading-element-showing')).not.toBeVisible();
expect(getByTestId(test.element, 'parent-loading-element-hiding')).toBeVisible();
// Child: no change
expect(getByTestId(test.element, 'child-loading-element-showing')).not.toBeVisible();
expect(getByTestId(test.element, 'child-loading-element-hiding')).toBeVisible();
});
});
Loading