jasmine-browser-runner 1.3.0 → 2.0.0-beta.0

package/README.md

@@ -75,6 +75,9 @@ config field to something that's high enough up to include both spec and source
 files, and set `srcFiles` to `[]`. You can autogenerate such a configuration by
 running `npx jasmine-browser-runner init --esm`.
 
+If you have specs or helper files that use top-level await, set the
+`enableTopLevelAwait` config property is set to `true`.
+
 ## Use with Rails
 
 You can use jasmine-browser-runner to test your Rails application's JavaScript,
@@ -194,5 +197,24 @@ config.projectBaseDir = path.resolve('some/path');
 jasmineBrowser.startServer(config, { port: 4321 });
 ```
 
+## Supported environments
+
+jasmine-browser-runner tests itself across popular browsers (Safari, Chrome, 
+Firefox, and Microsoft Edge) as well as Node.
+
+| Environment       | Supported versions     |
+|-------------------|------------------------|
+| Node              | 12.17+, 14, 16, 18, 20 |
+| Safari            | 15-16                  |
+| Chrome            | Evergreen              |
+| Firefox           | Evergreen, 102         |
+| Edge              | Evergreen              |
+
+For evergreen browsers, each version of jasmine-browser-runner is tested against
+the version of the browser that is available to us at the time of release. Other 
+browsers, as well as older & newer versions of some supported browsers, are
+likely to work. However, jasmine-browser-runner isn't tested against them and 
+they aren't actively supported.
 
+To find out what environments work with a particular Jasmine release, see the [release notes](https://github.com/jasmine/jasmine/tree/main/release_notes).
 

package/lib/server.js

@@ -2,8 +2,7 @@ const express = require('express'),
   glob = require('glob'),
   ejs = require('ejs'),
   path = require('path'),
-  fs = require('fs'),
-  os = require('os');
+  fs = require('fs');
 
 /**
  * @class Server
@@ -30,28 +29,6 @@ class Server {
         return unWindows(path.join('/__jasmine__', fileName));
       })
       .concat(this.bootFiles());
-
-    // Validate globs
-    const isWindows = (options.platform || os.platform)() === 'win32';
-    for (const globs of [
-      options.specFiles,
-      options.srcFiles,
-      options.helpers,
-    ]) {
-      if (globs) {
-        for (const g of globs) {
-          if (isWindows && g.includes('\\')) {
-            const fixed = g.replace(/\\/g, '/');
-            console.warn(
-              'Backslashes in file paths behave inconsistently ' +
-                'between platforms and might not be treated as directory ' +
-                'separators in a future version. Consider changing ' +
-                `${g} to ${fixed}.`
-            );
-          }
-        }
-      }
-    }
   }
 
   bootFiles() {
@@ -80,7 +57,7 @@ class Server {
   }
 
   getSupportFiles() {
-    var result = ['/__support__/loadEsModule.js'];
+    const result = ['/__support__/loaders.js'];
     if (!this.useHtmlReporter) {
       result.push('/__support__/clearReporters.js');
     }
@@ -152,6 +129,7 @@ class Server {
             cssFiles: self.allCss(),
             jasmineJsFiles: self.jasmineJs(),
             userJsFiles: self.userJs(),
+            enableTopLevelAwait: self.options.enableTopLevelAwait || false,
           })
         );
       } catch (error) {

package/lib/support/loaders.js

@@ -0,0 +1,65 @@
+/* eslint-env browser, jasmine */
+
+window._jasmine_loadEsModule = function(src) {
+  var script = document.createElement('script');
+  script.type = 'module';
+
+  // Safari reports syntax errors in ES modules as a script element error
+  // event rather than a global error event. Rethrow so that Jasmine can
+  // pick it up and fail the suite.
+  script.addEventListener('error', function(event) {
+    var msg =
+      'An error occurred while loading ' +
+      src +
+      '. Check the browser console for details.';
+    throw new Error(msg);
+  });
+
+  script.src = src;
+  document.head.appendChild(script);
+};
+
+window._jasmine_loadWithTopLevelAwaitSupport = async function(scriptUrls) {
+  const scriptsLoaded = (async function() {
+    // Load scripts sequentially to ensure that users can get a stable order
+    // by disabling randomization or setting a seed. This can be considerably
+    // slower than the normal way of doing things because the browser won't
+    // parallelize the HTTP requests. But it's the only way to ensure that the
+    // describes will execute in a consistent order in the presence of top-level
+    // await.
+    for (const url of scriptUrls) {
+      const isEsm = url.endsWith('.mjs');
+
+      if (isEsm) {
+        try {
+          await import(url);
+        } catch (e) {
+          setTimeout(function() {
+            // Rethrow the error so jasmine-core's global error handler can pick it up.
+            throw e;
+          });
+          await new Promise(function(resolve) {
+            setTimeout(resolve);
+          });
+        }
+      } else {
+        await new Promise(function(resolve) {
+          const script = document.createElement('script');
+          script.addEventListener('load', function() {
+            resolve();
+          });
+          script.addEventListener('error', function() {
+            resolve();
+          });
+          script.src = url;
+          document.head.appendChild(script);
+        });
+      }
+    }
+  })();
+
+  const bootJasmine = window.onload;
+  window.onload = function() {
+    scriptsLoaded.then(bootJasmine);
+  };
+};

package/lib/types.js

@@ -111,6 +111,13 @@
  * @type boolean | undefined
  * @default true
  */
+/**
+ * Whether to enable support for top-level await. This option is off by default
+ * because it comes with a performance penalty.
+ * @name Configuration#enableTopLevelAwait
+ * @type boolean | undefined
+ * @default false
+ */
 
 /**
  * Describes a web browser.

package/lib/webdriver.js

@@ -23,6 +23,7 @@ function buildWebdriver(browserInfo, webdriverBuilder) {
           '--no-sandbox',
           'window-size=1024,768',
           '--disable-gpu',
+          '--disable-dev-shm-usage', // flag needed to avoid issues within docker https://stackoverflow.com/questions/56218242/headless-chromium-on-docker-fails
         ],
       });
       return webdriverBuilder
@@ -50,17 +51,11 @@ function buildWebdriver(browserInfo, webdriverBuilder) {
     tags: sauce.tags,
   };
 
-  if (sauceRequiresLegacyJWPProps(browserName, sauce.browserVersion)) {
-    capabilities.platform = sauce.os;
-    capabilities.version = sauce.browserVersion;
-    capabilities.tunnelIdentifier = sauce.tunnelIdentifier;
-  } else {
-    capabilities[Capability.PLATFORM_NAME] = sauce.os;
-    capabilities[Capability.BROWSER_VERSION] = sauce.browserVersion;
-    capabilities['sauce:options'] = {
-      'tunnel-identifier': sauce.tunnelIdentifier,
-    };
-  }
+  capabilities[Capability.PLATFORM_NAME] = sauce.os;
+  capabilities[Capability.BROWSER_VERSION] = sauce.browserVersion;
+  capabilities['sauce:options'] = {
+    'tunnel-identifier': sauce.tunnelIdentifier,
+  };
 
   return webdriverBuilder
     .withCapabilities(capabilities)
@@ -72,12 +67,4 @@ function buildWebdriver(browserInfo, webdriverBuilder) {
     .build();
 }
 
-function sauceRequiresLegacyJWPProps(browserName, browserVersion) {
-  // Saucelabs supports W3C capability property names for most browsers,
-  // but requires legacy JWP property names for some older browsers.
-  // See <https://wiki.saucelabs.com/display/DOCS/W3C+Capabilities+Support>.
-  // Of the browsers that Jasmine supports, only Safari <12 need JWP names.
-  return browserName === 'safari' && parseInt(browserVersion, 10) < 12;
-}
-
 module.exports = { buildWebdriver };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jasmine-browser-runner",
-  "version": "1.3.0",
+  "version": "2.0.0-beta.0",
   "description": "Serve and run your Jasmine specs in a browser",
   "bin": "bin/jasmine-browser-runner",
   "exports": "./index.js",
@@ -39,17 +39,18 @@
   "dependencies": {
     "ejs": "^3.1.6",
     "express": "^4.16.4",
-    "glob": "^7.1.7",
-    "selenium-webdriver": ">=4.1.0 <4.8.0"
+    "glob": "^10.0.0",
+    "selenium-webdriver": "^4.8.2"
   },
   "peerDependencies": {
-    "jasmine-core": "^4.0.0"
+    "jasmine-core": "^5.0.0-beta.0"
   },
   "devDependencies": {
-    "eslint": "^7.32.0",
+    "ejs-lint": "^2.0.0",
+    "eslint": "^8.38.0",
     "eslint-plugin-jasmine": "^4.1.3",
-    "jasmine": "^4.0.0",
-    "jasmine-core": "^4.0.0",
+    "jasmine": "^5.0.0-beta.0",
+    "jasmine-core": "^5.0.0-beta.0",
     "prettier": "^1.17.1",
     "shelljs": "^0.8.3",
     "temp": "^0.9.4"

package/run.html.ejs

@@ -13,13 +13,23 @@
   <% jasmineJsFiles.forEach(function(jsFile) { %>
     <script src="<%= jsFile %>" type="text/javascript"></script>
   <% }) %>
-  <% userJsFiles.forEach(function(jsFile) { %>
-    <% if (jsFile.endsWith('.mjs')) { %>
-      <script type="module">_jasmine_loadEsModule('<%= jsFile %>')</script>
-    <% } else { %>
-      <script src="<%= jsFile %>" type="text/javascript"></script>
-    <% } %>
-  <% }) %>
+  <% if (enableTopLevelAwait) { %>
+    <script type="module">
+      await _jasmine_loadWithTopLevelAwaitSupport([
+        <% userJsFiles.forEach(function(jsFile) { %>
+          '<%= jsFile %>',
+        <% }) %>
+      ]);
+    </script>
+  <% } else { %>
+    <% userJsFiles.forEach(function(jsFile) { %>
+      <% if (jsFile.endsWith('.mjs')) { %>
+        <script type="module">_jasmine_loadEsModule('<%= jsFile %>')</script>
+      <% } else { %>
+        <script src="<%= jsFile %>" type="text/javascript"></script>
+      <% } %>
+    <% }) %>
+  <% } %>
 
 <div id="jasmine_content"></div>
 </body>

package/lib/support/loadEsModule.js

@@ -1,20 +0,0 @@
-/* eslint-env browser, jasmine */
-
-window._jasmine_loadEsModule = function(src) {
-  var script = document.createElement('script');
-  script.type = 'module';
-
-  // Safari reports syntax errors in ES modules as a script element error
-  // event rather than a global error event. Rethrow so that Jasmine can
-  // pick it up and fail the suite.
-  script.addEventListener('error', function(event) {
-    var msg =
-      'An error occurred while loading ' +
-      src +
-      '. Check the browser console for details.';
-    throw new Error(msg);
-  });
-
-  script.src = src;
-  document.head.appendChild(script);
-};