jasmine-browser-runner 2.5.0 → 3.0.0-beta.2

package/README.md

@@ -345,13 +345,13 @@ import('./spec/support/jasmine-browser.mjs')
 jasmine-browser-runner tests itself across popular browsers (Safari, Chrome, 
 Firefox, and Microsoft Edge) as well as Node.
 
-| Environment       | Supported versions     |
-|-------------------|------------------------|
-| Node              | 18, 20                 |
-| Safari            | 15-17                  |
-| Chrome            | Evergreen              |
-| Firefox           | Evergreen, 102, 115    |
-| Edge              | Evergreen              |
+| Environment       | Supported versions         |
+|-------------------|----------------------------|
+| Node              | 18, 20, 22                 |
+| Safari            | 15*, 16, 17                |
+| Chrome            | Evergreen                  |
+| Firefox           | Evergreen, 102*, 115*, 128 |
+| 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 
@@ -359,6 +359,11 @@ 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.
 
+\* Environments that are past end of life are supported on a best-effort
+basis. They may be dropped in a future minor release if continued support
+becomes impractical.
+
+
 To find out what environments work with a particular Jasmine release, see the [release notes](https://github.com/jasmine/jasmine/tree/main/release_notes).
 
 Copyright (c) 2019 Pivotal Labs<br>

package/index.js

@@ -56,13 +56,12 @@ module.exports = {
   /**
    * Starts a {@link Server} that will serve the specs and supporting files via HTTP.
    * @param {ServerCtorOptions} options to use to construct the server
-   * @param {ServerStartOptions} serverOptions Options to use to start the server
    * @return {Promise<undefined>} A promise that is resolved when the server is
    * started.
    */
-  startServer: function(options, serverOptions) {
+  startServer: function(options) {
     const server = new Server(options);
-    return server.start(serverOptions || {});
+    return server.start();
   },
   /**
    * Runs the specs.
@@ -70,8 +69,18 @@ module.exports = {
    * @return {Promise<JasmineDoneInfo>} A promise that resolves to the {@link https://jasmine.github.io/api/edge/global.html#JasmineDoneInfo|overall result} when the suite has finished running.
    */
   runSpecs: async function(options, deps) {
-    options = options || {};
+    options = { ...options };
     deps = deps || {};
+    const useRemote = options.browser && options.browser.useRemoteSeleniumGrid;
+
+    if (!options.port) {
+      if (useRemote) {
+        options.port = 5555;
+      } else {
+        options.port = 0;
+      }
+    }
+
     const ServerClass = deps.Server || Server;
     const RunnerClass = deps.Runner || Runner;
     const buildWebdriver =
@@ -80,23 +89,11 @@ module.exports = {
     const server = new ServerClass(options);
 
     const reporters = await createReporters(options, deps);
-    const useLegacySauce = options.browser && options.browser.useSauce;
-    const useRemote = options.browser && options.browser.useRemoteSeleniumGrid;
     const useSauceCompletionReporting =
-      useLegacySauce ||
-      (useRemote &&
-        options.browser.remoteSeleniumGrid?.url?.includes('saucelabs.com'));
-    let portRequest;
-
-    if (options.port) {
-      portRequest = options.port;
-    } else if (useLegacySauce || useRemote) {
-      portRequest = 5555;
-    } else {
-      portRequest = 0;
-    }
+      useRemote &&
+      options.browser.remoteSeleniumGrid?.url?.includes('saucelabs.com');
 
-    await server.start({ port: portRequest });
+    await server.start();
 
     try {
       const webdriver = buildWebdriver(options.browser);

package/lib/command.js

@@ -80,12 +80,6 @@ const subCommands = [
         type: 'string',
         description: 'specify a seed for randomization',
       },
-      {
-        name: 'reporter',
-        type: 'string',
-        description:
-          'path to reporter to use instead of the default Jasmine reporter',
-      },
       {
         name: 'browser',
         type: 'string',

package/lib/examples/default_config.mjs

@@ -13,7 +13,9 @@ export default {
   env: {
     stopSpecOnExpectationFailure: false,
     stopOnSpecFailure: false,
-    random: true
+    random: true,
+    // Fail if a suite contains multiple suites or specs with the same name.
+    forbidDuplicateNames: true
   },
 
   // For security, listen only to localhost. You can also specify a different

package/lib/examples/default_esm_config.mjs

@@ -17,7 +17,9 @@ export default {
   env: {
     stopSpecOnExpectationFailure: false,
     stopOnSpecFailure: false,
-    random: true
+    random: true,
+    // Fail if a suite contains multiple suites or specs with the same name.
+    forbidDuplicateNames: true
   },
 
   // For security, listen only to localhost. You can also specify a different

package/lib/server.js

@@ -19,8 +19,6 @@ class Server {
     this.options = { ...options };
     this._deps = deps || { http, https };
     this.express = this.options.express || defaultExpress;
-    this.useHtmlReporter =
-      options.useHtmlReporter === undefined ? true : options.useHtmlReporter;
     this.projectBaseDir = options.projectBaseDir || path.resolve();
     this.jasmineCore = options.jasmineCore || require('./jasmineCore');
     this.jasmineCssFiles = this.jasmineCore.files.cssFiles.map(function(
@@ -70,10 +68,6 @@ class Server {
 
   getSupportFiles() {
     const result = ['/__support__/loaders.js'];
-    if (!this.useHtmlReporter) {
-      result.push('/__support__/clearReporters.js');
-    }
-
     result.push('/__support__/batchReporter.js');
     return result;
   }
@@ -133,11 +127,9 @@ class Server {
 
   /**
    * Starts the server.
-   * @param {ServerStartOptions} options
    * @return {Promise<undefined>} A promise that resolves upon successful start.
    */
-  start(serverOptions) {
-    serverOptions = serverOptions || {};
+  start() {
     const app = this.express();
 
     app.use('/__jasmine__', this.express.static(this.jasmineCore.files.path));
@@ -220,19 +212,18 @@ class Server {
       }
     });
 
-    const port = findPort(serverOptions.port, this.options.port);
-    const tlsCert = serverOptions.tlsCert || this.options.tlsCert;
-    const tlsKey = serverOptions.tlsKey || this.options.tlsKey;
-    const hostname = serverOptions.hostname || this.options.hostname;
-    // The last two fallbacks here are necessary for backwards compatibility.
-    let listenAddress =
-      serverOptions.listenAddress ||
-      this.options.listenAddress ||
-      hostname ||
-      '';
-
-    if (listenAddress === '*') {
-      listenAddress = '';
+    const port = this.options.port === undefined ? 8888 : this.options.port;
+    const tlsCert = this.options.tlsCert;
+    const tlsKey = this.options.tlsKey;
+    const hostname = this.options.hostname;
+    let listenAddress;
+
+    if (!this.options.listenAddress) {
+      listenAddress = 'localhost';
+    } else if (this.options.listenAddress === '*') {
+      listenAddress = ''; // all interfaces
+    } else {
+      listenAddress = this.options.listenAddress;
     }
 
     const listenOptions = {
@@ -332,18 +323,6 @@ class Server {
   }
 }
 
-function findPort(serverPort, optionsPort) {
-  if (typeof serverPort !== 'undefined') {
-    return serverPort;
-  }
-
-  if (typeof optionsPort !== 'undefined') {
-    return optionsPort;
-  }
-
-  return 8888;
-}
-
 function isUrl(s) {
   return s.startsWith('http://') || s.startsWith('https://');
 }

package/lib/types.js

@@ -8,12 +8,6 @@
  * certainly want to provide at least specFiles and srcFiles as well.
  * @see Server
  */
-/**
- * Whether to use Jasmine's default HTML reporter.
- * @name ServerCtorOptions#useHtmlReporter
- * @type boolean | undefined
- * @default true
- */
 /**
  * An array of CSS file paths or {@link https://github.com/isaacs/node-glob#glob-primer|globs}
  * that match CSS files. Each path or glob will be evaluated relative to
@@ -53,19 +47,15 @@
  */
 /**
  * The hostname or IP address of the network interface to listen on. For
- * security, this should be set to localhost or an equivalent unless you need
- * the server to be accessible over other network interfaces. Set to "*" to
- * listen on all interfaces, which may be required by some remote Selenium
- * grids.
+ * security, jasmine-browser-runner will listen to localhost unless if this
+ * property is not specified. Set to "*" to listen on all interfaces, which may
+ * be required by some remote Selenium grids.
  * @name ServerCtorOptions#listenAddress
- * @default The value of {@link ServerCtorOptions#hostname} or {@link ServerStartOptions#hostname} if configured, otherwise "*"
+ * @default "localhost"
  * @type string | undefined
  */
 /**
- * The hostname to use in the URL given to browsers. For backward compatibility,
- * setting this property without also setting {@link ServerCtorOptions#listenAddress}
- * or {@link ServerStartOptions#listenAddress} has the same effect as setting
- * the listen address to the hostname.
+ * The hostname to use in the URL given to browsers.
  * @name ServerCtorOptions#hostname
  * @default "localhost"
  * @type string | undefined
@@ -191,12 +181,6 @@
  * Describes a web browser.
  * @interface BrowserInfo
  */
-/**
- * Whether to run the specs on {@link https://saucelabs.com/|Saucelabs}.
- * Defaults to false.
- * @name BrowserInfo#useSauce
- * @type boolean | undefined
- */
 /**
  * Whether to run the specs on a remote Selenium grid.
  * Defaults to false.
@@ -209,63 +193,11 @@
  * @name BrowserInfo#name
  * @type string | undefined
  */
-/**
- * Configuration for running specs on {@link https://saucelabs.com/|Saucelabs}
- * @name BrowserInfo#sauce
- * @type SauceConfig | undefined
- */
 /**
  * Configuration for running specs on a remote Selenium grid
  * @name BrowserInfo#remoteSeleniumGrid
  * @type RemoteSeleniumGridConfig | undefined
  */
-
-/**
- * Configuration for running specs on {@link https://saucelabs.com/|Saucelabs}
- * @interface SauceConfig
- */
-/**
- * Saucelabs username
- * @name SauceConfig#username
- * @type string
- */
-/**
- * Saucelabs access key
- * @name SauceConfig#accessKey
- * @type string
- */
-/**
- * Browser version. Omit this to use the latest version of the specified browser.
- * @name SauceConfig#browserVersion
- * @type string
- */
-/**
- * Identifier of the Sauce Connect tunnel to use.
- * @name SauceConfig#tunnelIdentifier
- * @type string
- */
-/**
- * Operating system to run the browser on.
- *
- * _Note_: It's best to omit this property
- * unless you really need your specs to run on a specific OS. If you omit it,
- * Saucelabs will select a suitable OS. If you specify an unsupported combination
- * of os and browserVersion, Saucelabs will select a different browser version
- * that's available on the specified OS.
- * @name SauceConfig#os
- * @type string
- */
-/**
- * Build identifier to pass to Saucelabs
- * @name SauceConfig#build
- * @type string
- */
-/**
- * Tags to pass to Saucelabs
- * @name SauceConfig#tags
- * @type Array.<string>
- */
-
 /**
  * Configuration for running specs on a remote Selenium grid
  * Any additional properties, such as "sauce:options" or "bstack:options", will
@@ -292,37 +224,6 @@
  * @type string
  */
 
-/**
- * Options passed to {@link Server#start}
- * @interface
- * @name ServerStartOptions
- */
-/**
- * The port number to listen on.
- * @name ServerStartOptions#port
- * @type number | undefined
- */
-/**
- * The path to a TLS key. Activates HTTPS mode. If specified, tlsCert must also
- * be specified.
- * @name ServerStartOptions#tlsKey
- * @type string
- */
-/**
- * The path to a TLS cert. Activates HTTPS mode. If specified, tlsKey must also
- * be specified.
- * @name ServerStartOptions#tlsCert
- * @type string
- */
-/**
- * @see ServerCtorOptions#hostname
- * @name ServerStartOptions#hostname
- */
-/**
- * @see ServerCtorOptions#listenAddress
- * @name ServerStartOptions#listenAddress
- */
-
 /**
  * Describes an import map.
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap}

package/lib/webdriver.js

@@ -3,7 +3,6 @@ function buildWebdriver(browserInfo, webdriverBuilder) {
     Capability = webdriver.Capability;
 
   webdriverBuilder = webdriverBuilder || new webdriver.Builder();
-  const useSauce = typeof browserInfo === 'object' && browserInfo.useSauce;
   const useRemote =
     typeof browserInfo === 'object' && browserInfo.useRemoteSeleniumGrid;
   let browserName;
@@ -16,7 +15,7 @@ function buildWebdriver(browserInfo, webdriverBuilder) {
 
   browserName = browserName || 'firefox';
 
-  if (!(useRemote || useSauce)) {
+  if (!useRemote) {
     if (browserName === 'headlessChrome') {
       const caps = webdriver.Capabilities.chrome();
       caps.set('goog:chromeOptions', {
@@ -58,29 +57,6 @@ function buildWebdriver(browserInfo, webdriverBuilder) {
       };
       delete capabilities.url;
     }
-  } else if (useSauce) {
-    // handle legacy `sauce` object
-    console.warn(
-      'Deprecation warning: Direct support for Saucelabs is deprecated and ' +
-        'will be removed in a future release. Please use Saucelabs via the ' +
-        'remote Selenium grid feature. See the jasmine-browser-runner README ' +
-        'for details.'
-    );
-    const sauce = browserInfo.sauce;
-    if (sauce) {
-      url = `http://${sauce.username}:${sauce.accessKey}@ondemand.saucelabs.com/wd/hub`;
-      capabilities = {
-        [Capability.BROWSER_NAME]: browserName,
-        build: sauce.build,
-        tags: sauce.tags,
-      };
-
-      capabilities[Capability.PLATFORM_NAME] = sauce.os;
-      capabilities[Capability.BROWSER_VERSION] = sauce.browserVersion;
-      capabilities['sauce:options'] = {
-        'tunnel-identifier': sauce.tunnelIdentifier,
-      };
-    }
   }
 
   if (!capabilities) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jasmine-browser-runner",
-  "version": "2.5.0",
+  "version": "3.0.0-beta.2",
   "description": "Serve and run your Jasmine specs in a browser",
   "bin": "bin/jasmine-browser-runner",
   "exports": "./index.js",
@@ -38,19 +38,18 @@
   "homepage": "https://github.com/jasmine/jasmine-browser-runner#readme",
   "dependencies": {
     "ejs": "^3.1.6",
-    "express": "^4.19.2",
+    "express": "^5.0.0",
     "glob": "^10.0.0",
     "selenium-webdriver": "^4.12.0"
   },
   "peerDependencies": {
-    "jasmine-core": "^5.0.0"
+    "jasmine-core": "^5.5.0"
   },
   "devDependencies": {
-    "ejs-lint": "^2.0.0",
     "eslint": "^8.50.0",
     "eslint-plugin-jasmine": "^4.1.3",
     "jasmine": "^5.0.0",
-    "jasmine-core": "^5.0.0",
+    "jasmine-core": "^5.5.0",
     "prettier": "^1.17.1",
     "shelljs": "^0.8.3",
     "temp": "^0.9.4"

package/lib/support/clearReporters.js

@@ -1,2 +0,0 @@
-/* eslint-env browser, jasmine */
-jasmine.getEnv().clearReporters();