test: Fix Chromecast testing in lab (#6643)

These changes are necessary for compatibility with Chromecast WebDriver Server v2.

 - Fix a bug in Karma's flat environment support (joeyparrish/karma@9875e98)
 - Add a test boot file to load CAF on Chromecast devices; required by Chromecast WebDriver Server v2's redirect mode (flat environment at that level)
 - Also load this cast-boot file in support.html
 - Rename/reorganize Cast-related externs, which were messy even before the addition of CAF
 - Remove proxy-cast-platform.js; no longer needed as we move to flatten the test environment
 - Ignore error events with "null" error; these appear on Linux Chromecasts, only since including CAF
 - Ignore error events that are actually strings; these appear on Linux Chromecasts, only since including CAF
 - Disable Fuchsia in the lab until autoplay issues can be resolved

Author: joeyparrish

build/build.py

@@ -45,6 +45,7 @@
 import logging
 import os
 import re
+import shutil
 
 import compiler
 import generateLocalizations
@@ -302,11 +303,12 @@ def build_library(self, name, langout, locales, force, is_debug):
     if not closure.compile(closure_opts, force):
       return False
 
+    source_base = shakaBuildHelpers.get_source_base()
+
     # Don't pass local node modules to the extern generator.  But don't simply
     # exclude the string 'node_modules', either, since Shaka Player could be
     # rebuilt after installing it as a node module.
-    node_modules_path = os.path.join(
-        shakaBuildHelpers.get_source_base(), 'node_modules')
+    node_modules_path = os.path.join(source_base, 'node_modules')
     local_include = set([f for f in self.include if node_modules_path not in f])
     extern_generator = compiler.ExternGenerator(local_include, build_name)
 
@@ -323,6 +325,11 @@ def build_library(self, name, langout, locales, force, is_debug):
     if not ts_def_generator.generate(force):
       return False
 
+    # Copy this file to dist/ where support.html can use it
+    shutil.copy(
+        os.path.join(source_base, 'test', 'test', 'cast-boot.js'),
+        os.path.join(source_base, 'dist', 'cast-boot.js'))
+
     return True
 
 

build/check.py

@@ -283,7 +283,6 @@ def check_tests(args):
       [closure_base_js]))
   files.add(os.path.join(base, 'demo', 'common', 'asset.js'))
   files.add(os.path.join(base, 'demo', 'common', 'assets.js'))
-  files.add(os.path.join(base, 'proxy-cast-platform.js'))
 
   localizations = compiler.GenerateLocalizations(None)
   localizations.generate(args.force)

build/conformance.textproto

@@ -73,7 +73,6 @@ requirement {
   whitelist_regexp: "demo/"
   whitelist_regexp: "test/"
   whitelist_regexp: "node_modules/"
-  whitelist_regexp: "proxy-cast-platform.js"
 
   # This global variable is generated by Google-internal tooling, and should be
   # allowed.  It will not end up in the compiled code, only at an intermediate
@@ -287,7 +286,6 @@ requirement: {
     "shaka.util.Timer instead."
   whitelist_regexp: "demo/"
   whitelist_regexp: "test/"
-  whitelist_regexp: "proxy-cast-platform.js"
 }
 
 # Disallow eval, except when testing for modern JS syntax in demo

build/shaka-lab.yaml

@@ -241,6 +241,8 @@ ChromecastGTV:
 ChromecastHub:
   browser: chromecast
   version: hub
+  # Disabled by default until we resolve issues with autoplay on Fuchsia.
+  disabled: true
 
 ChromecastSpeaker:
   # This is a headless device, and our tests are not yet known to work here.

externs/cast-namespace.js

@@ -0,0 +1,14 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Google Cast namespace definitions, shared by other externs
+ * files.
+ * @externs
+ */
+
+/** @const */
+var cast = {};

externs/chromecast.js externs/cast-sdk-v2.jsexterns/chromecast.js renamed to externs/cast-sdk-v2.js

@@ -15,10 +15,6 @@
 var __onGCastApiAvailable;
 
 
-/** @const */
-var cast = {};
-
-
 /** @const */
 cast.receiver = {};
 

externs/cast-sdk-v3.js

@@ -0,0 +1,35 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Externs for the limited subset of the Cast Application
+ * Framework (Receiver SDK v3) that we use in our test infrastructure.
+ *
+ * @externs
+ */
+
+/** @const */
+cast.framework = {};
+
+/**
+ * @typedef {{
+ *   statusText: string,
+ *   disableIdleTimeout: boolean,
+ *   skipPlayersLoad: boolean
+ * }}
+ */
+cast.framework.CastReceiverOptions;
+
+cast.framework.CastReceiverContext = class {
+  /** @return {!cast.framework.CastReceiverContext} */
+  static getInstance() {}
+
+  /**
+   * @param {!cast.framework.CastReceiverOptions} options
+   * @return {!cast.framework.CastReceiverContext}
+   */
+  start(options) {}
+};

externs/mediatailor.js

@@ -5,8 +5,8 @@
  */
 
 /**
- * @fileoverview Externs for HTMLMediaElement related to casting which were
- * missing in the Closure compiler.
+ * @fileoverview Externs for HTMLMediaElement related to remote playback which
+ * were missing in the Closure compiler.
  *
  * @externs
  */

externs/cast.js externs/remote-playback.jsexterns/cast.js renamed to externs/remote-playback.js

@@ -197,7 +197,13 @@ module.exports = (config) => {
 
     // list of files / patterns to load in the browser
     files: [
-      // Polyfills first, primarily for IE 11 and older TVs:
+      // The Cast boot file must come first, to start the SDK and respond as
+      // quickly as possible to the Cast platform.  Without this up front, we
+      // tend to see the Chromecast time out and shut down the receiver that
+      // hosts our tests.
+      'test/test/cast-boot.js',
+
+      // Polyfills before anything else, primarily for older TVs:
       //   Promise polyfill, required since we test uncompiled code on IE11
       'node_modules/es6-promise-polyfill/promise.js',
       //   Babel polyfill, required for async/await
@@ -230,9 +236,6 @@ module.exports = (config) => {
       // test utilities next, which fill in that namespace
       'test/test/util/*.js',
 
-      // Proxy cast.__platform__ methods across frames, necessary in testing
-      'proxy-cast-platform.js',
-
       // bootstrapping for the test suite last; this will load the actual tests
       'test/test/boot.js',
 
@@ -389,7 +392,6 @@ module.exports = (config) => {
         'ui/**/*.js': ['babel', 'sourcemap'],
         'test/**/*.js': ['babel', 'sourcemap'],
         'third_party/**/*.js': ['babel', 'sourcemap'],
-        'proxy-cast-platform.js': ['babel', 'sourcemap'],
       },
 
       babelPreprocessor: {