1
0
mirror of https://github.com/bitwarden/browser synced 2025-12-06 00:13:28 +00:00

Lets shadow DOM check signal page update (#16114)

* Removes overprotective check, signal fn intent, ensure proper scope of callback.

* Lets shadow DOM check be called dyanmically; triggers page detail update.

* Restores behavior of using static value to reduce calls to shadow query.

* Restores check page contains shadow DOM on init.
This commit is contained in:
Miles Blackwood
2025-09-08 14:28:40 -04:00
committed by GitHub
parent 49359c33e5
commit 6129ca5366
5 changed files with 44 additions and 13 deletions

View File

@@ -6,5 +6,5 @@ export interface DomQueryService {
mutationObserver?: MutationObserver,
forceDeepQueryAttempt?: boolean,
): T[];
checkPageContainsShadowDom(): void;
checkPageContainsShadowDom(): boolean;
}

View File

@@ -395,7 +395,7 @@ describe("CollectAutofillContentService", () => {
});
});
it("sets the noFieldsFond property to true if the page has no forms or fields", async function () {
it("sets the noFieldsFound property to true if the page has no forms or fields", async function () {
document.body.innerHTML = "";
collectAutofillContentService["noFieldsFound"] = false;
jest.spyOn(collectAutofillContentService as any, "buildAutofillFormsData");
@@ -2649,4 +2649,33 @@ describe("CollectAutofillContentService", () => {
);
});
});
describe("processMutations", () => {
beforeEach(() => {
jest.useFakeTimers();
});
afterEach(() => {
jest.runOnlyPendingTimers();
jest.useRealTimers();
});
it("will require an update to page details if shadow DOM is present", () => {
jest
.spyOn(domQueryService as any, "checkPageContainsShadowDom")
.mockImplementationOnce(() => true);
collectAutofillContentService["requirePageDetailsUpdate"] = jest.fn();
collectAutofillContentService["mutationsQueue"] = [[], []];
collectAutofillContentService["processMutations"]();
jest.runOnlyPendingTimers();
expect(domQueryService.checkPageContainsShadowDom).toHaveBeenCalled();
expect(collectAutofillContentService["mutationsQueue"]).toHaveLength(0);
expect(collectAutofillContentService["requirePageDetailsUpdate"]).toHaveBeenCalled();
});
});
});

View File

@@ -996,6 +996,13 @@ export class CollectAutofillContentService implements CollectAutofillContentServ
* within an idle callback to help with performance and prevent excessive updates.
*/
private processMutations = () => {
// If the page contains shadow DOM, we require a page details update from the autofill service.
// Will wait for an idle moment on main thread to execute, unless timeout has passed.
requestIdleCallbackPolyfill(
() => this.domQueryService.checkPageContainsShadowDom() && this.requirePageDetailsUpdate(),
{ timeout: 500 },
);
const queueLength = this.mutationsQueue.length;
for (let queueIndex = 0; queueIndex < queueLength; queueIndex++) {
@@ -1018,13 +1025,13 @@ export class CollectAutofillContentService implements CollectAutofillContentServ
* Triggers several flags that indicate that a collection of page details should
* occur again on a subsequent call after a mutation has been observed in the DOM.
*/
private flagPageDetailsUpdateIsRequired() {
private requirePageDetailsUpdate = () => {
this.domRecentlyMutated = true;
if (this.autofillOverlayContentService) {
this.autofillOverlayContentService.pageDetailsUpdateRequired = true;
}
this.noFieldsFound = false;
}
};
/**
* Processes all mutation records encountered by the mutation observer.
@@ -1052,7 +1059,7 @@ export class CollectAutofillContentService implements CollectAutofillContentServ
(this.isAutofillElementNodeMutated(mutation.removedNodes, true) ||
this.isAutofillElementNodeMutated(mutation.addedNodes))
) {
this.flagPageDetailsUpdateIsRequired();
this.requirePageDetailsUpdate();
return;
}

View File

@@ -72,7 +72,6 @@ describe("DomQueryService", () => {
});
it("queries form field elements that are nested within multiple ShadowDOM elements", () => {
domQueryService["pageContainsShadowDom"] = true;
const root = document.createElement("div");
const shadowRoot1 = root.attachShadow({ mode: "open" });
const root2 = document.createElement("div");
@@ -95,7 +94,6 @@ describe("DomQueryService", () => {
});
it("will fallback to using the TreeWalker API if a depth larger than 4 ShadowDOM elements is encountered", () => {
domQueryService["pageContainsShadowDom"] = true;
const root = document.createElement("div");
const shadowRoot1 = root.attachShadow({ mode: "open" });
const root2 = document.createElement("div");

View File

@@ -79,8 +79,9 @@ export class DomQueryService implements DomQueryServiceInterface {
/**
* Checks if the page contains any shadow DOM elements.
*/
checkPageContainsShadowDom = (): void => {
checkPageContainsShadowDom = (): boolean => {
this.pageContainsShadowDom = this.queryShadowRoots(globalThis.document.body, true).length > 0;
return this.pageContainsShadowDom;
};
/**
@@ -109,7 +110,7 @@ export class DomQueryService implements DomQueryServiceInterface {
): T[] {
let elements = this.queryElements<T>(root, queryString);
const shadowRoots = this.recursivelyQueryShadowRoots(root);
const shadowRoots = this.pageContainsShadowDom ? this.recursivelyQueryShadowRoots(root) : [];
for (let index = 0; index < shadowRoots.length; index++) {
const shadowRoot = shadowRoots[index];
elements = elements.concat(this.queryElements<T>(shadowRoot, queryString));
@@ -152,10 +153,6 @@ export class DomQueryService implements DomQueryServiceInterface {
root: Document | ShadowRoot | Element,
depth: number = 0,
): ShadowRoot[] {
if (!this.pageContainsShadowDom) {
return [];
}
if (depth >= MAX_DEEP_QUERY_RECURSION_DEPTH) {
throw new Error("Max recursion depth reached");
}