Return void from undoPrehide()

duckduckgo · Jan 7, 2025 · 9660283 · 9660283
1 parent db3cd9e
commit 9660283
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 14 deletions.
diff --git a/lib/dom-actions.ts b/lib/dom-actions.ts
@@ -83,13 +83,11 @@ export class DomActions implements DomActionsProvider {
         return hideElements(styleEl, selector, 'opacity');
     }
 
-    undoPrehide(): boolean {
+    undoPrehide(): void {
         const existingElement = getStyleElement('autoconsent-prehide');
         this.autoconsentInstance.config.logs.lifecycle && console.log('[undoprehide]', existingElement, location.href);
-        if (existingElement) {
-            existingElement.remove();
-        }
-        return !!existingElement;
+
+        existingElement.remove();
     }
 
     async createOrUpdateStyleSheet(cssText: string, styleSheet?: CSSStyleSheet) {

diff --git a/lib/types.ts b/lib/types.ts
@@ -30,7 +30,7 @@ export interface DomActionsProvider {
     wait(ms: number): Promise<true>;
     hide(selector: string, method: HideMethod): boolean;
     prehide(selector: string): boolean;
-    undoPrehide(): boolean;
+    undoPrehide(): void;
     querySingleReplySelector(selector: string, parent?: any): HTMLElement[];
     querySelectorChain(selectors: string[]): HTMLElement[];
     elementSelector(selector: ElementSelector): HTMLElement[];

diff --git a/lib/web.ts b/lib/web.ts
@@ -461,9 +461,9 @@ export default class AutoConsent {
         return this.domActions.prehide(selectors.join(','));
     }
 
-    undoPrehide(): boolean {
+    undoPrehide(): void {
         this.updateState({ prehideOn: false });
-        return this.domActions.undoPrehide();
+        this.domActions.undoPrehide();
     }
 
     /**

diff --git a/tests-wtr/dom-actions/undo-prehide/dom-actions.undo-prehide.nonexistent-style-element.ts b/tests-wtr/dom-actions/undo-prehide/dom-actions.undo-prehide.nonexistent-style-element.ts
@@ -11,14 +11,14 @@ describe('undoPrehide', () => {
         domActions = instantiateDomActions();
     });
 
-    it('returns false when element does not exist', () => {
+    it('creates style element if it did not previously exist and immediately removes it', () => {
         // Given
         expect(document.querySelector('style#autoconsent-prehide')).to.be.null; // check that style element does not yet exist
 
         // When
-        const result = domActions.undoPrehide();
+        domActions.undoPrehide();
 
         // Then
-        expect(result).to.be.false;
+        expect(document.querySelector('style#autoconsent-prehide')).to.be.null; // check that style element again does not exist (in fact, it was created for a bit and then removed immediately)
     });
 });
diff --git a/tests-wtr/dom-actions/undo-prehide/dom-actions.undo-prehide.preexisting-style-element.ts b/tests-wtr/dom-actions/undo-prehide/dom-actions.undo-prehide.preexisting-style-element.ts
@@ -11,15 +11,14 @@ describe('undoPrehide', () => {
         domActions = instantiateDomActions();
     });
 
-    it('returns true when style element not exist', () => {
+    it('removes preexisting style element', () => {
         // Given
         expect(document.querySelector('style#autoconsent-prehide')).to.not.be.null; // check that style element already exists
 
         // When
-        const result = domActions.undoPrehide();
+        domActions.undoPrehide();
 
         // Then
-        expect(result).to.be.true;
         expect(document.querySelector('style#autoconsent-prehide')).to.be.null; // check that style element was removed
     });
 });