Skip to content

[LiveComponent] Refactor elementBelongsToThisComponent #2399

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
Nov 24, 2024
Merged

[LiveComponent] Refactor elementBelongsToThisComponent #2399

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
164 changes: 78 additions & 86 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 @@ -131,82 +131,6 @@ function getElementAsTagText(element) {
: element.outerHTML;
}

let componentMapByElement = new WeakMap();
let componentMapByComponent = new Map();
const registerComponent = (component) => {
componentMapByElement.set(component.element, component);
componentMapByComponent.set(component, component.name);
};
const unregisterComponent = (component) => {
componentMapByElement.delete(component.element);
componentMapByComponent.delete(component);
};
const getComponent = (element) => new Promise((resolve, reject) => {
let count = 0;
const maxCount = 10;
const interval = setInterval(() => {
const component = componentMapByElement.get(element);
if (component) {
clearInterval(interval);
resolve(component);
}
count++;
if (count > maxCount) {
clearInterval(interval);
reject(new Error(`Component not found for element ${getElementAsTagText(element)}`));
}
}, 5);
});
const findComponents = (currentComponent, onlyParents, onlyMatchName) => {
const components = [];
componentMapByComponent.forEach((componentName, component) => {
if (onlyParents && (currentComponent === component || !component.element.contains(currentComponent.element))) {
return;
}
if (onlyMatchName && componentName !== onlyMatchName) {
return;
}
components.push(component);
});
return components;
};
const findChildren = (currentComponent) => {
const children = [];
componentMapByComponent.forEach((componentName, component) => {
if (currentComponent === component) {
return;
}
if (!currentComponent.element.contains(component.element)) {
return;
}
let foundChildComponent = false;
componentMapByComponent.forEach((childComponentName, childComponent) => {
if (foundChildComponent) {
return;
}
if (childComponent === component) {
return;
}
if (childComponent.element.contains(component.element)) {
foundChildComponent = true;
}
});
children.push(component);
});
return children;
};
const findParent = (currentComponent) => {
let parentElement = currentComponent.element.parentElement;
while (parentElement) {
const component = componentMapByElement.get(parentElement);
if (component) {
return component;
}
parentElement = parentElement.parentElement;
}
return null;
};

function getValueFromElement(element, valueStore) {
if (element instanceof HTMLInputElement) {
if (element.type === 'checkbox') {
Expand Down Expand Up @@ -328,16 +252,8 @@ function elementBelongsToThisComponent(element, component) {
if (!component.element.contains(element)) {
return false;
}
let foundChildComponent = false;
findChildren(component).forEach((childComponent) => {
if (foundChildComponent) {
return;
}
if (childComponent.element === element || childComponent.element.contains(element)) {
foundChildComponent = true;
}
});
return !foundChildComponent;
const closestLiveComponent = element.closest('[data-controller~="live"]');
return closestLiveComponent === component.element;
}
function cloneHTMLElement(element) {
const newElement = element.cloneNode(true);
Expand Down Expand Up @@ -1883,6 +1799,82 @@ class ExternalMutationTracker {
}
}

let componentMapByElement = new WeakMap();
let componentMapByComponent = new Map();
const registerComponent = (component) => {
componentMapByElement.set(component.element, component);
componentMapByComponent.set(component, component.name);
};
const unregisterComponent = (component) => {
componentMapByElement.delete(component.element);
componentMapByComponent.delete(component);
};
const getComponent = (element) => new Promise((resolve, reject) => {
let count = 0;
const maxCount = 10;
const interval = setInterval(() => {
const component = componentMapByElement.get(element);
if (component) {
clearInterval(interval);
resolve(component);
}
count++;
if (count > maxCount) {
clearInterval(interval);
reject(new Error(`Component not found for element ${getElementAsTagText(element)}`));
}
}, 5);
});
const findComponents = (currentComponent, onlyParents, onlyMatchName) => {
const components = [];
componentMapByComponent.forEach((componentName, component) => {
if (onlyParents && (currentComponent === component || !component.element.contains(currentComponent.element))) {
return;
}
if (onlyMatchName && componentName !== onlyMatchName) {
return;
}
components.push(component);
});
return components;
};
const findChildren = (currentComponent) => {
const children = [];
componentMapByComponent.forEach((componentName, component) => {
if (currentComponent === component) {
return;
}
if (!currentComponent.element.contains(component.element)) {
return;
}
let foundChildComponent = false;
componentMapByComponent.forEach((childComponentName, childComponent) => {
if (foundChildComponent) {
return;
}
if (childComponent === component) {
return;
}
if (childComponent.element.contains(component.element)) {
foundChildComponent = true;
}
});
children.push(component);
});
return children;
};
const findParent = (currentComponent) => {
let parentElement = currentComponent.element.parentElement;
while (parentElement) {
const component = componentMapByElement.get(parentElement);
if (component) {
return component;
}
parentElement = parentElement.parentElement;
}
return null;
};

class Component {
constructor(element, name, props, listeners, id, backend, elementDriver) {
this.fingerprint = '';
Expand Down
15 changes: 2 additions & 13 deletions src/LiveComponent/assets/src/dom_utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import type ValueStore from './Component/ValueStore';
import { type Directive, parseDirectives } from './Directive/directives_parser';
import { normalizeModelName } from './string_utils';
import type Component from './Component';
import { findChildren } from './ComponentRegistry';
import getElementAsTagText from './Util/getElementAsTagText';

/**
Expand Down Expand Up @@ -208,19 +207,9 @@ export function elementBelongsToThisComponent(element: Element, component: Compo
return false;
}

let foundChildComponent = false;
findChildren(component).forEach((childComponent) => {
if (foundChildComponent) {
// return early
return;
}

if (childComponent.element === element || childComponent.element.contains(element)) {
foundChildComponent = true;
}
});
const closestLiveComponent = element.closest('[data-controller~="live"]');

return !foundChildComponent;
return closestLiveComponent === component.element;
}

export function cloneHTMLElement(element: HTMLElement): HTMLElement {
Expand Down
13 changes: 10 additions & 3 deletions src/LiveComponent/assets/test/dom_utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,11 +271,19 @@ describe('elementBelongsToThisComponent', () => {
expect(elementBelongsToThisComponent(targetElement, component)).toBeFalsy();
});

it('returns true if element lives inside of controller', () => {
const targetElement = htmlToElement('<input name="user[firstName]">');
it('returns true if element lives inside of a div', () => {
const targetElement = htmlToElement('<input name="user[firstName]"/>');
const component = createComponent('<div></div>');
component.element.appendChild(targetElement);

expect(elementBelongsToThisComponent(targetElement, component)).toBeFalsy();
});

it('returns true if element lives inside of live controller', () => {
const targetElement = htmlToElement('<input name="user[firstName]"/>');
const component = createComponent('<div data-controller="live" data-live-name-value="parentLabel"></div>');
component.element.appendChild(targetElement);

expect(elementBelongsToThisComponent(targetElement, component)).toBeTruthy();
});

Expand All @@ -287,7 +295,6 @@ describe('elementBelongsToThisComponent', () => {
const component = createComponent('<div class="parent"></div>');
component.element.appendChild(childComponent.element);

//expect(elementBelongsToThisComponent(targetElement, childComponent)).toBeTruthy();
expect(elementBelongsToThisComponent(targetElement, component)).toBeFalsy();
});

Expand Down