chore: Simplify Apple detection (#8035)

Our Apple device detection misdetects any Webkit-based STB as Apple, due to looking only at vendor property. To mitigate it, we were excluding another user agents, but maintenance of this is problematic. This PR tries to change direction - an Apple device right now is a device with Apple vendor AND with characteristics of MacOS or iOS. --------- Co-authored-by: Álvaro Velad Galván <ladvan91@hotmail.com>
shaka-project · Feb 7, 2025 · d03eb6e · d03eb6e
1 parent 7141e67
commit d03eb6e
Show file tree

Hide file tree

Showing 3 changed files with 236 additions and 173 deletions.
diff --git a/lib/polyfill/media_capabilities.js b/lib/polyfill/media_capabilities.js
@@ -60,9 +60,8 @@ shaka.polyfill.MediaCapabilities = class {
         shaka.util.Platform.isPS4() ||
         shaka.util.Platform.isWebOS() ||
         shaka.util.Platform.isTizen() ||
-        shaka.util.Platform.isEOS() ||
         shaka.util.Platform.isHisense() ||
-        shaka.util.Platform.isComcastX1()) {
+        shaka.util.Platform.isWebkitSTB()) {
       canUseNativeMCap = false;
     }
     if (canUseNativeMCap && navigator.mediaCapabilities) {

diff --git a/lib/util/platform.js b/lib/util/platform.js
@@ -303,19 +303,8 @@ shaka.util.Platform = class {
    * @return {boolean}
    */
   static isApple() {
-    return !!navigator.vendor && navigator.vendor.includes('Apple') &&
-        !shaka.util.Platform.isTizen() &&
-        !shaka.util.Platform.isEOS() &&
-        !shaka.util.Platform.isAPL() &&
-        !shaka.util.Platform.isAPP() &&
-        !shaka.util.Platform.isVirginMedia() &&
-        !shaka.util.Platform.isOrange() &&
-        !shaka.util.Platform.isPS4() &&
-        !shaka.util.Platform.isAmazonFireTV() &&
-        !shaka.util.Platform.isComcastX1() &&
-        !shaka.util.Platform.isZenterio() &&
-        !shaka.util.Platform.isSkyQ() &&
-        !shaka.util.Platform.isMultiChoice();
+    return shaka.util.Platform.isAppleVendor_() &&
+        (shaka.util.Platform.isMac() || shaka.util.Platform.isIOS());
   }
 
   /**
@@ -348,14 +337,6 @@ shaka.util.Platform = class {
         shaka.util.Platform.userAgentContains_('VIDAA');
   }
 
-  /**
-   * Check if the current platform is Virgin Media device.
-   * @return {boolean}
-   */
-  static isVirginMedia() {
-    return shaka.util.Platform.userAgentContains_('VirginMedia');
-  }
-
   /**
    * Check if the current platform is Orange.
    * @return {boolean}
@@ -372,16 +353,6 @@ shaka.util.Platform = class {
     return shaka.util.Platform.userAgentContains_('Sky_STB');
   }
 
-  /**
-   * Check if the current platform is Amazon Fire TV.
-   * https://developer.amazon.com/docs/fire-tv/identify-amazon-fire-tv-devices.html
-   *
-   * @return {boolean}
-   */
-  static isAmazonFireTV() {
-    return shaka.util.Platform.userAgentContains_('AFT');
-  }
-
   /**
    * Check if the current platform is Comcast X1.
    * @return {boolean}
@@ -398,16 +369,6 @@ shaka.util.Platform = class {
     return shaka.util.Platform.userAgentContains_('DT_STB_BCM');
   }
 
-  /**
-   * Check if the current platform is a MultiChoice STB.
-   * @return {boolean}
-   */
-  static isMultiChoice() {
-    // cspell: ignore MDMP
-    return shaka.util.Platform.userAgentContains_('MDMP1001S') ||
-      shaka.util.Platform.userAgentContains_('PS5525IMC');
-  }
-
   /**
    * Returns a major version number for Safari, or Safari-based iOS browsers.
    *
@@ -456,38 +417,11 @@ shaka.util.Platform = class {
   }
 
   /**
-   * Check if the current platform is an EOS set-top box.
-   *
+   * Guesses if the platform is an Apple mobile one (iOS, iPad, iPod).
    * @return {boolean}
    */
-  static isEOS() {
-    return shaka.util.Platform.userAgentContains_('PC=EOS');
-  }
-
-  /**
-   * Check if the current platform is an APL set-top box.
-   *
-   * @return {boolean}
-   */
-  static isAPL() {
-    return shaka.util.Platform.userAgentContains_('PC=APL');
-  }
-
-  /**
-   * Check if the current platform is an APPSTB set-top box.
-   * @return {boolean}
-   */
-  static isAPP() {
-    return shaka.util.Platform.userAgentContains_('PC=APPSTB');
-  }
-
-  /**
-   * Guesses if the platform is a mobile one (iOS or Android).
-   *
-   * @return {boolean}
-   */
-  static isMobile() {
-    if (/(?:iPhone|iPad|iPod|Android)/.test(navigator.userAgent)) {
+  static isIOS() {
+    if (/(?:iPhone|iPad|iPod)/.test(navigator.userAgent)) {
       // This is Android, iOS, or iPad < 13.
       return true;
     }
@@ -505,7 +439,18 @@ shaka.util.Platform = class {
     // As of January 2020, this is mainly used to adjust the default UI config
     // for mobile devices, so it's low risk if something changes to break this
     // detection.
-    return shaka.util.Platform.isApple() && navigator.maxTouchPoints > 1;
+    return shaka.util.Platform.isAppleVendor_() && navigator.maxTouchPoints > 1;
+  }
+
+  /**
+   * Guesses if the platform is a mobile one.
+   * @return {boolean}
+   */
+  static isMobile() {
+    if (navigator.userAgentData) {
+      return navigator.userAgentData.mobile;
+    }
+    return shaka.util.Platform.isIOS() || shaka.util.Platform.isAndroid();
   }
 
   /**
@@ -540,6 +485,15 @@ shaka.util.Platform = class {
     return true;
   }
 
+  /**
+   * Checks is non-Apple STB based on Webkit.
+   * @return {boolean}
+   */
+  static isWebkitSTB() {
+    return shaka.util.Platform.isAppleVendor_() &&
+        !shaka.util.Platform.isApple();
+  }
+
   /**
    * Return true if the platform is a Windows, regardless of the browser.
    *
@@ -584,12 +538,8 @@ shaka.util.Platform = class {
     const Platform = shaka.util.Platform;
     if (Platform.isTizen() || Platform.isWebOS() ||
         Platform.isXboxOne() || Platform.isPS4() ||
-        Platform.isPS5() || Platform.isAmazonFireTV() ||
-        Platform.isEOS() || Platform.isAPL() ||
-        Platform.isVirginMedia() || Platform.isOrange() ||
-        Platform.isComcastX1() || Platform.isChromecast() ||
-        Platform.isHisense() || Platform.isZenterio() ||
-        Platform.isAPP() || Platform.isMultiChoice()) {
+        Platform.isPS5() || Platform.isChromecast() ||
+        Platform.isHisense() || Platform.isWebkitSTB()) {
       return true;
     }
     return false;
@@ -609,6 +559,14 @@ shaka.util.Platform = class {
     return userAgent.includes(key);
   }
 
+  /**
+   * @return {boolean}
+   * @private
+   */
+  static isAppleVendor_() {
+    return (navigator.vendor || '').includes('Apple');
+  }
+
   /**
    * For canPlayType queries, we just need any instance.
    *