Using semver for flexible browser version detection

This change is backward incompatible; the old config properties `majorVersion`, `minorVersion` and `revision` were replaced with semver-compliant `browserVersion`. Close attester#40.
jakub-g · Jul 29, 2013 · eda684c · eda684c
1 parent ccd5c26
commit eda684c
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -132,27 +132,36 @@ browsers:
   # However, if the browsers section is present, each test will be run once in each browser listed here.
   # (and browsers not listed here will have nothing to do if they are connected)
   - browserName: 'PhantomJS'
-  - browserName: 'Chrome'
+  - browserName: 'Opera'
+  - browserName: 'Safari'
   # It's possible to distinguish browsers by operating systems, read more below
-  - browserName: 'Firefox'
+  - browserName: 'Chrome'
     os: 'Windows 7'
-  - browserName: 'Firefox'
+  - browserName: 'Chrome'
     os: 'Desktop Linux'
-  - browserName: 'Firefox'
+  - browserName: 'Chrome'
     os: 'Android'
-  - browserName: 'Opera'
-  - browserName: 'Safari'
   # It is also possible to distinguish several versions of the same browser:
   - browserName: 'IE'
-    majorVersion: 7
+    browserVersion: 7
   - browserName: 'IE'
-    majorVersion: 8
+    browserVersion: 8
   - browserName: 'IE'
-    majorVersion: 9
+    browserVersion: 9
   - browserName: 'IE'
-    majorVersion: 10
-  # Note that 'minorVersion' and 'revision' are also available
-  # The 'name' property allows to change the display name of the browser in the reports.
+    browserVersion: 10
+  # 'browserVersion' can be also a semver-compliant string; see https://github.com/isaacs/node-semver
+  - browserName: 'Firefox'
+    browserVersion: '3.6'
+  - browserName: 'Firefox'
+    browserVersion: '>=20'
+  # Additionally, the 'name' property allows to change the display name of the browser in the reports.
+  - browserName: 'Chrome'
+    browserVersion: 27
+    name: 'Chrome Stable 27'
+  - browserName: 'Chrome'
+    browserVersion: 29
+    name: 'Chrome Canary 29'
 ```
 
 #### Regarding browser detection by operating system:

diff --git a/lib/browser-detection.js b/lib/browser-detection.js
@@ -13,14 +13,28 @@
  * limitations under the License.
  */
 
+var semver = require('semver');
 var uaParser = require('ua-parser');
 
+// semver-compliant version must be x.y.z
+var toSemVer = function (version) {
+    var nbDots = (version.match(/\./g) || "").length;
+    if (nbDots === 0) {
+        return version + ".0.0";
+    } else if (nbDots === 1) {
+        return version + ".0";
+    } else {
+        return version;
+    }
+};
+
 exports.detectBrowser = function (data) {
     var parsedAgent = uaParser.parse(data.userAgent);
     var ua = parsedAgent.ua;
     var osFamily = parsedAgent.os.family;
     var res = {
         displayName: parsedAgent.toString(),
+        semverString: toSemVer(parsedAgent.toVersionString()),
         family: ua.family,
         major: ua.major,
         minor: ua.minor,
@@ -49,6 +63,7 @@ exports.detectBrowser = function (data) {
             res.minor = 0;
             res.patch = null;
             res.displayName = "IE " + documentMode + ".0";
+            res.semverString = documentMode + ".0.0";
         }
     }
     return res;
@@ -59,11 +74,9 @@ exports.browserMatch = function (config, browserInfo) {
     if (config.browserName != null) {
         match = match && (config.browserName == browserInfo.family);
     }
-    if (match && config.majorVersion != null) {
-        match = config.majorVersion == browserInfo.major;
-    }
-    if (match && config.minorVersion != null) {
-        match = config.minorVersion == browserInfo.minor;
+    if (match && config.browserVersion != null) {
+        // user may pass version as a number, hence using String()
+        match = semver.satisfies(browserInfo.semverString, String(config.browserVersion));
     }
     if (match && config.os != null) {
         // a little bit verbose to have readable code
@@ -77,4 +90,4 @@ exports.browserMatch = function (config, browserInfo) {
         }
     }
     return match;
-};
+};
diff --git a/lib/test-campaign/browser.js b/lib/test-campaign/browser.js
@@ -19,14 +19,8 @@ var buildNameFromConfig = function (config) {
     var name = "";
     if (config.browserName) {
         name = config.browserName;
-        if (config.majorVersion != null) {
-            name += " " + config.majorVersion;
-            if (config.minorVersion != null) {
-                name += "." + config.minorVersion;
-                if (config.revision != null) {
-                    name += "." + config.revision;
-                }
-            }
+        if (config.browserVersion != null) {
+            name += " " + config.browserVersion;
         }
     }
     if (config.os) {
@@ -72,4 +66,4 @@ Browser.prototype.onTaskFinished = function () {
     this.pendingTasks--;
 };
 
-module.exports = Browser;
+module.exports = Browser;
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
         "node-coverage": "1.0.2",
         "optimist": "0.6.0",
         "portfinder": "0.2.1",
+        "semver": "2.0.11",
         "send": "0.1.0",
         "socket.io": "0.9.16",
         "ua-parser": "0.3.3",