Fix subtitle nudge site gating

2026-04-24 21:42:53 -04:00 · 2026-04-07 14:31:39 -04:00
parent f32d1b3f71
commit 0cb13905ff
2 changed files with 122 additions and 7 deletions
@@ -38,7 +38,7 @@ var tc = {
    controllerButtons: ["rewind", "slower", "faster", "advance", "display"],
    defaultLogLevel: 3,
    logLevel: 3,
-    enableSubtitleNudge: true, // Enabled by default, but only activates on YouTube
+    enableSubtitleNudge: false,
    subtitleNudgeInterval: 50, // Default 50ms balances subtitle tracking with CPU cost
    subtitleNudgeAmount: 0.001,
    customButtonIcons: {}
@@ -649,19 +649,32 @@ function isSubtitleNudgeSupported(video) {
  return Boolean(video);
 }

+function isSubtitleNudgeAvailableForVideo(video) {
+  return isSubtitleNudgeSupported(video) && Boolean(tc.settings.enableSubtitleNudge);
+}
+
 function isSubtitleNudgeEnabledForVideo(video) {
-  if (!video || !video.vsc) return tc.settings.enableSubtitleNudge;
+  if (!isSubtitleNudgeAvailableForVideo(video)) return false;
+
+  if (!video || !video.vsc) return true;

  if (typeof video.vsc.subtitleNudgeEnabledOverride === "boolean") {
    return video.vsc.subtitleNudgeEnabledOverride;
  }

-  return tc.settings.enableSubtitleNudge;
+  return true;
 }

 function setSubtitleNudgeEnabledForVideo(video, enabled) {
  if (!video || !video.vsc) return false;

+  if (!isSubtitleNudgeAvailableForVideo(video)) {
+    video.vsc.subtitleNudgeEnabledOverride = null;
+    video.vsc.stopSubtitleNudge();
+    updateSubtitleNudgeIndicator(video);
+    return false;
+  }
+
  var normalizedEnabled = Boolean(enabled);
  video.vsc.subtitleNudgeEnabledOverride = normalizedEnabled;

@@ -725,14 +738,19 @@ function renderSubtitleNudgeIndicatorContent(target, isEnabled) {
 function updateSubtitleNudgeIndicator(video) {
  if (!video || !video.vsc) return;

+  var isAvailable = isSubtitleNudgeAvailableForVideo(video);
  var isEnabled = isSubtitleNudgeEnabledForVideo(video);
-  var title = isEnabled ? "Subtitle nudge enabled" : "Subtitle nudge disabled";
+  var title = !isAvailable
+    ? "Subtitle nudge unavailable on this site"
+    : isEnabled
+      ? "Subtitle nudge enabled"
+      : "Subtitle nudge disabled";

  var indicator = video.vsc.subtitleNudgeIndicator;
  if (indicator) {
    renderSubtitleNudgeIndicatorContent(indicator, isEnabled);
    indicator.dataset.enabled = isEnabled ? "true" : "false";
-    indicator.dataset.supported = "true";
+    indicator.dataset.supported = isAvailable ? "true" : "false";
    indicator.title = title;
    indicator.setAttribute("aria-label", title);
  }
@@ -741,7 +759,7 @@ function updateSubtitleNudgeIndicator(video) {
  if (flashEl) {
    renderSubtitleNudgeIndicatorContent(flashEl, isEnabled);
    flashEl.dataset.enabled = isEnabled ? "true" : "false";
-    flashEl.dataset.supported = "true";
+    flashEl.dataset.supported = isAvailable ? "true" : "false";
    flashEl.setAttribute("aria-label", title);
  }
 }
@@ -2580,7 +2598,14 @@ function runAction(action, value, e) {
      "toggleSubtitleNudge",
      "display"
    ];
-    if (userDrivenActionsThatShowController.includes(action) && action !== "display") {
+    var subtitleNudgeActionBlocked =
+      (action === "toggleSubtitleNudge" || action === "nudge") &&
+      !isSubtitleNudgeAvailableForVideo(v);
+    if (
+      userDrivenActionsThatShowController.includes(action) &&
+      action !== "display" &&
+      !subtitleNudgeActionBlocked
+    ) {
      showController(controller, 2000, true);
    }
    if (v.classList.contains("vsc-cancelled")) return;
@@ -0,0 +1,90 @@
+import { describe, expect, it, vi } from "vitest";
+import { createChromeMock, flushAsyncWork, loadScript } from "./helpers/browser.js";
+
+function loadBlankDocument() {
+  document.open();
+  document.write("<!doctype html><html><body></body></html>");
+  document.close();
+}
+
+async function bootInject({ sync = {}, local = {} } = {}) {
+  loadBlankDocument();
+  globalThis.chrome = createChromeMock({ sync, local });
+  window.chrome = globalThis.chrome;
+  globalThis.chrome.runtime.onMessage = {
+    addListener: vi.fn()
+  };
+  const originalSyncGet = globalThis.chrome.storage.sync.get;
+  const originalLocalGet = globalThis.chrome.storage.local.get;
+  globalThis.chrome.storage.sync.get = vi.fn((keys, callback) => {
+    Promise.resolve().then(() => originalSyncGet(keys, callback));
+  });
+  globalThis.chrome.storage.local.get = vi.fn((keys, callback) => {
+    Promise.resolve().then(() => originalLocalGet(keys, callback));
+  });
+  globalThis.requestIdleCallback = (callback, options) =>
+    setTimeout(
+      () =>
+        callback({
+          didTimeout: false,
+          timeRemaining() {
+            return 1;
+          }
+        }),
+      (options && options.timeout) || 0
+    );
+  globalThis.cancelIdleCallback = (id) => clearTimeout(id);
+
+  loadScript("shared/controller-utils.js");
+  loadScript("shared/key-bindings.js");
+  loadScript("shared/site-rules.js");
+  loadScript("ui-icons.js");
+  loadScript("inject.js");
+
+  for (let i = 0; i < 3; i += 1) {
+    await flushAsyncWork();
+    await new Promise((resolve) => setTimeout(resolve, 0));
+  }
+}
+
+describe("inject runtime", () => {
+  it("keeps subtitle nudge disabled when the effective setting is off", async () => {
+    await bootInject({
+      sync: {
+        enableSubtitleNudge: false
+      }
+    });
+
+    const stopSubtitleNudge = vi.fn();
+    const startSubtitleNudge = vi.fn();
+    const flashEl = document.createElement("span");
+    const video = {
+      paused: false,
+      playbackRate: 1.5,
+      vsc: {
+        stopSubtitleNudge,
+        startSubtitleNudge,
+        subtitleNudgeEnabledOverride: null,
+        subtitleNudgeIndicator: null,
+        nudgeFlashIndicator: flashEl
+      }
+    };
+
+    expect(window.tc.settings.enableSubtitleNudge).toBe(false);
+    expect(window.isSubtitleNudgeEnabledForVideo(video)).toBe(false);
+    expect(window.setSubtitleNudgeEnabledForVideo(video, true)).toBe(false);
+    expect(video.vsc.subtitleNudgeEnabledOverride).toBeNull();
+    expect(stopSubtitleNudge).toHaveBeenCalledTimes(1);
+    expect(startSubtitleNudge).not.toHaveBeenCalled();
+    expect(flashEl.classList.contains("visible")).toBe(false);
+
+    window.tc.settings.enableSubtitleNudge = true;
+    expect(window.setSubtitleNudgeEnabledForVideo(video, true)).toBe(true);
+    expect(window.isSubtitleNudgeEnabledForVideo(video)).toBe(true);
+
+    window.tc.settings.enableSubtitleNudge = false;
+    expect(window.isSubtitleNudgeEnabledForVideo(video)).toBe(false);
+
+    await new Promise((resolve) => setTimeout(resolve, 0));
+  });
+});