nodebb-plugin-ezoic-infinite 1.5.60 → 1.5.62

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-ezoic-infinite",
-  "version": "1.5.60",
+  "version": "1.5.62",
   "description": "Production-ready Ezoic infinite ads integration for NodeBB 4.x",
   "main": "library.js",
   "license": "MIT",

package/public/client.js

@@ -4,108 +4,12 @@
   // NodeBB client context
   const $ = (typeof window.jQuery === 'function') ? window.jQuery : null;
 
-  const WRAP_CLASS = 'ezoic-ad';
+  // IMPORTANT: must NOT collide with Ezoic's own markup (they use `.ezoic-ad`).
+  // If we reuse that class, cleanup/pruning can delete real ads and cause
+  // "placeholder does not exist" spam + broken 1/X insertion.
+  const WRAP_CLASS = 'nodebb-ezoic-wrap';
   const PLACEHOLDER_PREFIX = 'ezoic-pub-ad-placeholder-';
 
-
-// Offscreen pool to keep placeholder elements alive across ajaxify/navigation.
-// This prevents Ezoic from trying to define ids that are not currently injected,
-// and eliminates "HTML element with id ... does not exist" noise.
-const POOL_ID = 'ezoic-placeholder-pool';
-
-function isInPool(el) {
-  try { return !!(el && el.closest && el.closest('#' + POOL_ID)); } catch (e) { return false; }
-}
-
-function isPlaceholderInUse(ph) {
-  // In use = connected AND not parked in our offscreen pool.
-  try { return !!(ph && ph.isConnected && !isInPool(ph)); } catch (e) { return false; }
-}
-
-function ensurePool() {
-  let pool = document.getElementById(POOL_ID);
-  if (pool) {
-    // In rare cases (aggressive SPA navigation), the pool may get detached.
-    if (!pool.isConnected) {
-      try { (document.documentElement || document.body).appendChild(pool); } catch (e) {}
-    }
-    return pool;
-  }
-  pool = document.createElement('div');
-  pool.id = POOL_ID;
-  pool.style.position = 'absolute';
-  pool.style.left = '-99999px';
-  pool.style.top = '0';
-  pool.style.width = '1px';
-  pool.style.height = '1px';
-  pool.style.overflow = 'hidden';
-  pool.setAttribute('aria-hidden', 'true');
-  // Attach early (documentElement exists before body), so placeholders are always connected.
-  try { (document.documentElement || document.body).appendChild(pool); } catch (e) {}
-  // If body exists later, move it under body (purely cosmetic).
-  try {
-    if (document.body && pool.parentNode !== document.body) {
-      document.body.appendChild(pool);
-    }
-  } catch (e) {}
-  return pool;
-}
-
-// Create placeholder divs for all configured ids upfront.
-// Ezoic sometimes attempts to initialize/refresh a range of ids even if we
-// haven't injected them yet; keeping them in the offscreen pool prevents
-// "HTML element ... does not exist" spam.
-function primePool(ids) {
-  try {
-    if (!ids || !ids.length) return;
-    const pool = ensurePool();
-    for (const v of ids) {
-      const id = parseInt(v, 10);
-      if (!Number.isFinite(id) || id <= 0) continue;
-      const domId = `${PLACEHOLDER_PREFIX}${id}`;
-      let ph = document.getElementById(domId);
-      if (!ph) {
-        ph = document.createElement('div');
-        ph.id = domId;
-        ph.setAttribute('data-ezoic-id', String(id));
-        pool.appendChild(ph);
-      } else if (!ph.isConnected) {
-        pool.appendChild(ph);
-      }
-    }
-  } catch (e) {}
-}
-
-function acquirePlaceholder(id) {
-  const domId = `${PLACEHOLDER_PREFIX}${id}`;
-  let ph = document.getElementById(domId);
-  if (!ph) {
-    ph = document.createElement('div');
-    ph.id = domId;
-    ph.setAttribute('data-ezoic-id', String(id));
-    ensurePool().appendChild(ph);
-  } 
-  // Note: appendChild will automatically move the node, no manual detach (avoids race gaps).
-  // Clear request/defined flags when reusing
-  try {
-    if (ph.dataset) {
-      ph.dataset.ezRequested = '0';
-      ph.dataset.ezDefined = '0';
-      ph.dataset.ezActive = '0';
-    }
-  } catch (e) {}
-  return ph;
-}
-
-function parkPlaceholderFromWrap(wrap) {
-  try {
-    const ph = wrap && wrap.querySelector ? wrap.querySelector(`[id^="${PLACEHOLDER_PREFIX}"]`) : null;
-    if (!ph) return;
-    try { if (state && state.io) state.io.unobserve(ph); } catch (e) {}
-    try { if (ph.dataset) ph.dataset.ezActive = '0'; } catch (e) {}
-    ensurePool().appendChild(ph);
-  } catch (e) {}
-}
   // Insert at most N ads per run to keep the UI smooth on infinite scroll
   const MAX_INSERTS_PER_RUN = 3;
 
@@ -318,107 +222,34 @@ function parkPlaceholderFromWrap(wrap) {
     } catch (e) {}
   }
 
-  
   // Patch showAds to avoid warnings when a placeholder disappears (infinite scroll, ajaxify)
-  // Ezoic can (re)define ezstandalone.showAds over time; we hook assignments to keep the guard.
   function patchShowAds() {
-    function wrapShowAds(ez, orig) {
-      if (orig && orig.__nodebbWrapped) return orig;
-
-      const wrapped = function (...args) {
-        if (isBlocked()) return;
-
-        let ids = [];
-        if (args.length === 1 && Array.isArray(args[0])) ids = args[0];
-        else ids = args;
-
-        const seen = new Set();
-        for (const v of ids) {
-          const id = parseInt(v, 10);
-          if (!Number.isFinite(id) || id <= 0 || seen.has(id)) continue;
-
-          const domId = `${PLACEHOLDER_PREFIX}${id}`;
-          let ph = document.getElementById(domId);
-          if (!ph || !ph.isConnected) {
-            // If Ezoic (or another script) tries to show an id we haven't injected yet,
-            // create the placeholder in the offscreen pool so it exists, but don't load.
-            try {
-              ph = document.createElement('div');
-              ph.id = domId;
-              ph.setAttribute('data-ezoic-id', String(id));
-              if (ph.dataset) ph.dataset.ezActive = '0';
-              ensurePool().appendChild(ph);
-            } catch (e) {}
-            continue;
-          }
-
-          // Only allow loads for placeholders actively injected into the page (not parked in the pool)
-          // and currently marked active.
-          if (!isPlaceholderInUse(ph)) continue;
-          if (ph.dataset && ph.dataset.ezActive !== '1') continue;
-
-          // Prevent repeated "define" attempts on the same placeholder while it remains in DOM.
-          if (ph.dataset && (ph.dataset.ezRequested === '1' || ph.dataset.ezDefined === '1')) continue;
-
-          seen.add(id);
-          try {
-            if (ph.dataset) ph.dataset.ezRequested = '1';
-            orig.call(ez, id);
-            if (ph.dataset) {
-              ph.dataset.ezDefined = '1';
-              ph.dataset.ezRequested = '0';
-            }
-          } catch (e) {
-            try { if (ph.dataset) ph.dataset.ezRequested = '0'; } catch (_) {}
-          }
-        }
-      };
-      try { wrapped.__nodebbWrapped = true; } catch (e) {}
-      return wrapped;
-    }
-
-    function ensureHook() {
+    const applyPatch = () => {
       try {
         window.ezstandalone = window.ezstandalone || {};
         const ez = window.ezstandalone;
+        if (window.__nodebbEzoicPatched) return;
+        if (typeof ez.showAds !== 'function') return;
 
-        // Hook future assignments to showAds so we keep our wrapper even if Ezoic overwrites it.
-        if (!ez.__nodebbShowAdsHooked) {
-          ez.__nodebbShowAdsHooked = true;
-          let _showAds = ez.showAds;
-
-          Object.defineProperty(ez, 'showAds', {
-            configurable: true,
-            enumerable: true,
-            get() {
-              return _showAds;
-            },
-            set(fn) {
-              _showAds = (typeof fn === 'function') ? wrapShowAds(ez, fn) : fn;
-            },
-          });
-
-          // If showAds already exists, wrap it immediately
-          if (typeof _showAds === 'function') {
-            _showAds = wrapShowAds(ez, _showAds);
-          }
-        } else if (typeof ez.showAds === 'function' && !ez.showAds.__nodebbWrapped) {
-          // In case defineProperty wasn't possible (rare), re-wrap
-          ez.showAds = wrapShowAds(ez, ez.showAds);
-        }
-      } catch (e) {}
-    }
-
-    ensureHook();
+        window.__nodebbEzoicPatched = true;
+        const orig = ez.showAds;
 
-    // Also attempt via cmd queue
-    try {
-      window.ezstandalone = window.ezstandalone || {};
-      window.ezstandalone.cmd = window.ezstandalone.cmd || [];
-      window.ezstandalone.cmd.push(ensureHook);
-    } catch (e) {}
-  }
+        ez.showAds = function (...args) {
+          if (isBlocked()) return;
 
+          let ids = [];
+          if (args.length === 1 && Array.isArray(args[0])) ids = args[0];
+          else ids = args;
+
+          const seen = new Set();
+          for (const v of ids) {
+            const id = parseInt(v, 10);
+            if (!Number.isFinite(id) || id <= 0 || seen.has(id)) continue;
+            const ph = document.getElementById(`${PLACEHOLDER_PREFIX}${id}`);
+            if (!ph || !ph.isConnected) continue;
+            seen.add(id);
+            try { orig.call(ez, id); } catch (e) {}
+          }
         };
       } catch (e) {}
     };
@@ -473,12 +304,6 @@ function withInternalDomChange(fn) {
     if (state.allTopics.length === 0) state.allTopics = parsePool(cfg.placeholderIds);
     if (state.allPosts.length === 0) state.allPosts = parsePool(cfg.messagePlaceholderIds);
     if (state.allCategories.length === 0) state.allCategories = parsePool(cfg.categoryPlaceholderIds);
-
-    // Keep placeholders alive even before they're injected.
-    // This avoids Ezoic trying to touch ids that we haven't inserted yet.
-    primePool(state.allTopics);
-    primePool(state.allPosts);
-    primePool(state.allCategories);
   }
 
   // ---------- insertion primitives ----------
@@ -505,20 +330,9 @@ function withInternalDomChange(fn) {
 
   function safeDestroyById(id) {
     try {
-      const domId = `${PLACEHOLDER_PREFIX}${id}`;
-      const ph = document.getElementById(domId);
-
-      // If the element is already gone, do NOT call destroyPlaceholders (Ezoic will log "does not exist").
-      if (!ph || !ph.isConnected) return;
-
-      if (ph.dataset) {
-        delete ph.dataset.ezDefined;
-        delete ph.dataset.ezRequested;
-      }
-
       const ez = window.ezstandalone;
       if (ez && typeof ez.destroyPlaceholders === 'function') {
-        ez.destroyPlaceholders([domId]);
+        ez.destroyPlaceholders([`${PLACEHOLDER_PREFIX}${id}`]);
       }
     } catch (e) {}
   }
@@ -543,7 +357,6 @@ function withInternalDomChange(fn) {
         withInternalDomChange(() => {
           try {
             if (id) safeDestroyById(id);
-            parkPlaceholderFromWrap(wrap);
             wrap.remove();
           } catch (e) {}
         });
@@ -577,8 +390,9 @@ function buildWrap(id, kindClass, afterPos) {
     wrap.setAttribute('data-ezoic-wrapid', String(id));
     wrap.style.width = '100%';
 
-    const ph = acquirePlaceholder(id);
-    try { if (ph.dataset) ph.dataset.ezActive = '1'; } catch (e) {}
+    const ph = document.createElement('div');
+    ph.id = `${PLACEHOLDER_PREFIX}${id}`;
+    ph.setAttribute('data-ezoic-id', String(id));
     wrap.appendChild(ph);
 
     return wrap;
@@ -594,7 +408,7 @@ function buildWrap(id, kindClass, afterPos) {
     if (insertingIds.has(id)) return null;
 
     const existingPh = document.getElementById(`${PLACEHOLDER_PREFIX}${id}`);
-    if (existingPh && isPlaceholderInUse(existingPh)) return null;
+    if (existingPh && existingPh.isConnected) return null;
 
     insertingIds.add(id);
     try {
@@ -617,7 +431,7 @@ function buildWrap(id, kindClass, afterPos) {
 
       const id = allIds[idx];
       const ph = document.getElementById(`${PLACEHOLDER_PREFIX}${id}`);
-      if (ph && isPlaceholderInUse(ph)) continue;
+      if (ph && ph.isConnected) continue;
 
       return id;
     }
@@ -645,7 +459,6 @@ function buildWrap(id, kindClass, afterPos) {
         if (ph && state.io) state.io.unobserve(ph);
       } catch (e) {}
 
-      parkPlaceholderFromWrap(victim);
       victim.remove();
       return true;
     } catch (e) {
@@ -682,11 +495,9 @@ function drainQueue() {
   }
 }
 
-
 function startShow(id) {
-  if (!id) return;
+  if (!id || isBlocked()) return;
 
-  // Reserve an inflight slot, but ALWAYS release on any early exit.
   state.inflight++;
   let released = false;
   const release = () => {
@@ -700,41 +511,30 @@ function startShow(id) {
 
   requestAnimationFrame(() => {
     try {
-      if (isBlocked()) { clearTimeout(hardTimer); release(); return; }
+      if (isBlocked()) return;
 
-      const domId = `${PLACEHOLDER_PREFIX}${id}`;
-      const phNow = document.getElementById(domId);
-      if (!phNow || !phNow.isConnected) { clearTimeout(hardTimer); release(); return; }
+      const ph = document.getElementById(`${PLACEHOLDER_PREFIX}${id}`);
+      if (!ph || !ph.isConnected) return;
 
       const now2 = Date.now();
       const last2 = state.lastShowById.get(id) || 0;
-      if (now2 - last2 < 900) { clearTimeout(hardTimer); release(); return; }
+      if (now2 - last2 < 900) return;
       state.lastShowById.set(id, now2);
 
       window.ezstandalone = window.ezstandalone || {};
       const ez = window.ezstandalone;
 
       const doShow = () => {
-        try {
-          if (isBlocked()) return;
-
-          // Re-check at execution time (ez.cmd can run later).
-          const ph = document.getElementById(domId);
-          if (!ph || !ph.isConnected) return;
-
-          // If this id was used before, destroy safely using full DOM id.
-          if (state.usedOnce && state.usedOnce.has(id)) {
-            safeDestroyById(id);
-          }
-
-          // showAds is patched to ignore missing placeholders and repeated defines.
-          ez.showAds(id);
-
-          try { state.usedOnce && state.usedOnce.add(id); } catch (e) {}
-        } catch (e) {}
-        finally {
-          setTimeout(() => { try { clearTimeout(hardTimer); } catch (_) {} release(); }, 650);
-        }
+        // Do NOT call destroyPlaceholders here.
+        // In ajaxify + infinite scroll flows, Ezoic can be in the middle of a refresh cycle.
+        // Calling destroy on active placeholders is a common source of:
+        //  - "HTML element ... does not exist"
+        //  - "Placeholder Id ... already been defined"
+        // Prefer a straight showAds; Ezoic will refresh as needed.
+        try { ez.showAds(id); } catch (e) {}
+        try { markEmptyWrapper(id); } catch (e) {}
+
+        setTimeout(() => { clearTimeout(hardTimer); release(); }, 650);
       };
 
       if (Array.isArray(ez.cmd)) {
@@ -742,15 +542,13 @@ function startShow(id) {
       } else {
         doShow();
       }
-    } catch (e) {
-      try { clearTimeout(hardTimer); } catch (_) {}
-      release();
+    } finally {
+      // If we returned early, hardTimer will release.
     }
   });
 }
 
 
-
   // ---------- preload / above-the-fold ----------
 
   function ensurePreloadObserver() {
@@ -857,25 +655,6 @@ function startShow(id) {
       inserted += 1;
     }
 
-    // Safety: if DOM churn results in two consecutive ad wrappers, remove the latter.
-    // (This can happen when NodeBB inserts/removes spacer elements around the anchor.)
-    try {
-      const wraps = Array.from(document.querySelectorAll(`.${WRAP_CLASS}.${kindClass}`));
-      for (const w of wraps) {
-        const prev = w.previousElementSibling;
-        if (prev && prev.classList && prev.classList.contains(WRAP_CLASS)) {
-          withInternalDomChange(() => {
-            try {
-              const id = getWrapIdFromWrap(w);
-              if (id) safeDestroyById(id);
-              parkPlaceholderFromWrap(w);
-              w.remove();
-            } catch (e) {}
-          });
-        }
-      }
-    } catch (e) {}
-
     return inserted;
   }
 
@@ -1011,7 +790,6 @@ function startShow(id) {
     // remove all wrappers
     try {
       document.querySelectorAll(`.${WRAP_CLASS}`).forEach((el) => {
-        try { parkPlaceholderFromWrap(el); } catch (e) {}
         try { el.remove(); } catch (e) {}
       });
     } catch (e) {}

package/public/style.css

@@ -1,5 +1,8 @@
-/* Keep Ezoic wrappers “CLS-safe” and remove the extra vertical spacing Ezoic often injects */
-.ezoic-ad {
+/*
+  Keep our NodeBB-inserted wrappers CLS-safe.
+  NOTE: must not rely on `.ezoic-ad` because Ezoic uses that class internally.
+*/
+.nodebb-ezoic-wrap {
   display: block;
   width: 100%;
   margin: 0 !important;
@@ -7,22 +10,22 @@
   overflow: hidden;
 }
 
-.ezoic-ad > [id^="ezoic-pub-ad-placeholder-"] {
+.nodebb-ezoic-wrap > [id^="ezoic-pub-ad-placeholder-"] {
   margin: 0 !important;
   padding: 0 !important;
   min-height: 1px; /* keeps placeholder measurable for IO */
 }
 
-/* Ezoic sometimes wraps in extra spans/divs with margins */
-.ezoic-ad span.ezoic-ad,
-.ezoic-ad .ezoic-ad {
+/* If Ezoic wraps inside our wrapper, keep it tight */
+.nodebb-ezoic-wrap span.ezoic-ad,
+.nodebb-ezoic-wrap .ezoic-ad {
   margin: 0 !important;
   padding: 0 !important;
 }
 
 
 /* Collapse empty ad blocks (prevents "holes" when an ad doesn't fill or gets destroyed) */
-.ezoic-ad.is-empty {
+.nodebb-ezoic-wrap.is-empty {
   display: block !important;
   margin: 0 !important;
   padding: 0 !important;
@@ -31,12 +34,19 @@
   overflow: hidden !important;
 }
 
-.ezoic-ad {
+.nodebb-ezoic-wrap {
   min-height: 0 !important;
 }
 
-.ezoic-ad > [id^="ezoic-pub-ad-placeholder-"] {
+.nodebb-ezoic-wrap > [id^="ezoic-pub-ad-placeholder-"] {
   min-height: 0 !important;
 }
 
-#ezoic-placeholder-pool{display:block;}
+/*
+  Optional: also neutralize spacing on native Ezoic `.ezoic-ad` blocks.
+  (Keeps your previous "CSS very good" behavior.)
+*/
+.ezoic-ad {
+  margin: 0 !important;
+  padding: 0 !important;
+}