Feature detection mechanism #20

- Removed dependency on semver package
- Implemented a simple algorithm of comparing versions

dist-node/cuba.d.ts

@@ -140,4 +140,3 @@ export declare class CubaApp {
 export declare function getBasicAuthHeaders(client: string, secret: string, locale?: string): {
     [header: string]: string;
 };
-export declare function matchesVersion(versionToTest: string, versionToMatch: string): boolean;

dist-node/cuba.js

@@ -51,7 +51,6 @@ function __export(m) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var storage_1 = require("./storage");
 var util_1 = require("./util");
-var semver = require("semver");
 __export(require("./model"));
 __export(require("./storage"));
 var apps = [];
@@ -423,7 +422,7 @@ var CubaApp = /** @class */ (function () {
                     case 1:
                         _a.sent();
                         _a.label = 2;
-                    case 2: return [2 /*return*/, matchesVersion(this.apiVersion, minVersion)];
+                    case 2: return [2 /*return*/, util_1.matchesVersion(this.apiVersion, minVersion)];
                 }
             });
         });
@@ -464,17 +463,3 @@ function getBasicAuthHeaders(client, secret, locale) {
     };
 }
 exports.getBasicAuthHeaders = getBasicAuthHeaders;
-function matchesVersion(versionToTest, versionToMatch) {
-    var semverToTest = semver.coerce(versionToTest);
-    if (!semverToTest) {
-        // versionToTest cannot be converted to semver
-        return false;
-    }
-    var semverToMatch = semver.coerce(versionToMatch);
-    if (!semverToMatch) {
-        // versionToMatch cannot be converted to semver
-        throw new Error("Cannot determine required REST API version: value " + versionToMatch + " cannot be converted to semver");
-    }
-    return semver.gte(semverToTest, semverToMatch);
-}
-exports.matchesVersion = matchesVersion;

dist-node/util.d.ts

@@ -1,2 +1,15 @@
 export declare function base64encode(str: string): string;
+/**
+ * Compares version strings. Intended to be used only for comparing versions consisting of major, minor and
+ * (optional) patch version (dot-separated) and optional `-SNAPSHOT` suffix. Does not conform to
+ * Semantic Versioning Specification and will produce incorrect results in some cases not covered above
+ * (e.g. it doesn't take into account any text including pre-release identifiers, so 7.2.0-beta will be considered
+ * equal to 7.2.0).
+ *
+ * @param testVersion
+ * @param minimumVersion
+ *
+ * @returns true if testVersion is greater or equal than minimumVersion
+ */
+export declare function matchesVersion(testVersion: string, minimumVersion: string): boolean;
 export declare function encodeGetParams(data: any): string;

dist-node/util.js

@@ -14,6 +14,48 @@ function base64encode(str) {
     /* tslint:enable:no-string-literal */
 }
 exports.base64encode = base64encode;
+/**
+ * Compares version strings. Intended to be used only for comparing versions consisting of major, minor and
+ * (optional) patch version (dot-separated) and optional `-SNAPSHOT` suffix. Does not conform to
+ * Semantic Versioning Specification and will produce incorrect results in some cases not covered above
+ * (e.g. it doesn't take into account any text including pre-release identifiers, so 7.2.0-beta will be considered
+ * equal to 7.2.0).
+ *
+ * @param testVersion
+ * @param minimumVersion
+ *
+ * @returns true if testVersion is greater or equal than minimumVersion
+ */
+function matchesVersion(testVersion, minimumVersion) {
+    if (!testVersion) {
+        return false;
+    }
+    if (!minimumVersion) {
+        throw new Error('Cannot determine required REST API version: the minimum version is not valid');
+    }
+    var testVersionComponents = testVersion.split('.');
+    var requiredVersionComponents = minimumVersion.split('.');
+    for (var i = 0; i < requiredVersionComponents.length; i++) {
+        var match = parseInt(requiredVersionComponents[i], 10);
+        var test = parseInt(testVersionComponents[i], 10);
+        if (isNaN(match) || match < 0) {
+            throw new Error('Cannot determine required REST API version: the minimum version is not valid');
+        }
+        if ((test === undefined || test === null || isNaN(test)) && match > 0) {
+            // Required version has more components than test version, and current required version component is > 0
+            return false;
+        }
+        if (test > match) {
+            return true;
+        }
+        else if (test < match) {
+            return false;
+        }
+    }
+    // Versions are equal
+    return true;
+}
+exports.matchesVersion = matchesVersion;
 function encodeGetParams(data) {
     return Object
         .keys(data)

package.json

@@ -26,7 +26,6 @@
     "mocha": "~5.0.5",
     "node-fetch": "^2.6.0",
     "nyc": "~14.1.1",
-    "semver": "^6.3.0",
     "tslint": "~5.17.0",
     "typescript": "3.5.2"
   },

src/cuba.ts

@@ -10,8 +10,7 @@ import {
 } from "./model";
 import {DefaultStorage} from "./storage";
 import {EntityFilter} from "./filter";
-import {base64encode, encodeGetParams} from "./util";
-import * as semver from "semver";
+import {base64encode, encodeGetParams, matchesVersion} from "./util";
 
 export * from './model';
 export * from './storage';
@@ -524,20 +523,3 @@ export function getBasicAuthHeaders(client: string, secret: string, locale = 'en
     "Content-Type": "application/x-www-form-urlencoded; charset=UTF-8",
   };
 }
-
-export function matchesVersion(versionToTest: string, versionToMatch: string): boolean {
-  const semverToTest = semver.coerce(versionToTest);
-  if (!semverToTest) {
-    // versionToTest cannot be converted to semver
-    return false;
-  }
-
-  const semverToMatch = semver.coerce(versionToMatch);
-  if (!semverToMatch) {
-    // versionToMatch cannot be converted to semver
-    throw new Error(
-      `Cannot determine required REST API version: value ${versionToMatch} cannot be converted to semver`);
-  }
-
-  return semver.gte(semverToTest, semverToMatch);
-}

src/util.ts

@@ -13,6 +13,54 @@ export function base64encode(str: string): string {
   /* tslint:enable:no-string-literal */
 }
 
+/**
+ * Compares version strings. Intended to be used only for comparing versions consisting of major, minor and
+ * (optional) patch version (dot-separated) and optional `-SNAPSHOT` suffix. Does not conform to
+ * Semantic Versioning Specification and will produce incorrect results in some cases not covered above
+ * (e.g. it doesn't take into account any text including pre-release identifiers, so 7.2.0-beta will be considered
+ * equal to 7.2.0).
+ *
+ * @param testVersion
+ * @param minimumVersion
+ *
+ * @returns true if testVersion is greater or equal than minimumVersion
+ */
+export function matchesVersion(testVersion: string, minimumVersion: string): boolean {
+  if (!testVersion) {
+    return false;
+  }
+
+  if (!minimumVersion) {
+    throw new Error('Cannot determine required REST API version: the minimum version is not valid');
+  }
+
+  const testVersionComponents = testVersion.split('.');
+  const requiredVersionComponents = minimumVersion.split('.');
+
+  for (let i = 0; i < requiredVersionComponents.length; i++) {
+    const match = parseInt(requiredVersionComponents[i], 10);
+    const test = parseInt(testVersionComponents[i], 10);
+
+    if (isNaN(match) || match < 0) {
+      throw new Error('Cannot determine required REST API version: the minimum version is not valid');
+    }
+
+    if ((test === undefined || test === null || isNaN(test)) && match > 0) {
+      // Required version has more components than test version, and current required version component is > 0
+      return false;
+    }
+
+    if (test > match) {
+      return true;
+    } else if (test < match) {
+      return false;
+    }
+  }
+
+  // Versions are equal
+  return true;
+}
+
 export function encodeGetParams(data): string {
   return Object
     .keys(data)

test/cuba.spec.js

@@ -76,31 +76,6 @@ describe('cuba', function () {
   });
 });
 
-describe('.matchesVersion()', function () {
-  it('should compare versions correctly', async function () {
-    const matchesVersion = cuba.matchesVersion;
-    assert( matchesVersion('7.2.0', '7.2.0'));
-    assert( matchesVersion('7.2.1', '7.2.0'));
-    assert( matchesVersion('7.3.0', '7.2.0'));
-    assert( matchesVersion('8.2.0', '7.2.0'));
-    assert( matchesVersion('7.2-SNAPSHOT', '7.2.0'));
-
-    assert(!matchesVersion('7.2.0', '7.2.1'));
-    assert(!matchesVersion('7.2.0', '7.3.0'));
-    assert(!matchesVersion('7.2.0', '8.2.0'));
-    assert(!matchesVersion('7.2-SNAPSHOT', '7.2.1'));
-    assert(!matchesVersion('7.2-SNAPSHOT', '7.3.0'));
-    assert(!matchesVersion('0', '7.2.0'));
-    assert(!matchesVersion(undefined, '7.2.0'));
-    assert(!matchesVersion(null, '7.2.0'));
-    assert(!matchesVersion('A string that cannot be converted to a semver', '7.2.0'));
-
-    assert.throws(() => matchesVersion('7.2.0', undefined));
-    assert.throws(() => matchesVersion('7.2.0', null));
-    assert.throws(() => matchesVersion('7.2.0', 'A string that cannot be converted to a semver'));
-  })
-});
-
 describe('CubaApp', function () {
 
   let app;

test/utlil.spec.js

@@ -20,4 +20,39 @@ describe('util', function() {
     });
   });
 
+  describe('.matchesVersion()', function () {
+    it('should compare versions correctly', async function () {
+      const matchesVersion = util.matchesVersion;
+      assert(matchesVersion('7.2.0', '7.2.0'));
+      assert(matchesVersion('7.2.1', '7.2.0'));
+      assert(matchesVersion('7.3.0', '7.2.0'));
+      assert(matchesVersion('7.3.0', '7.2.9'));
+      assert(matchesVersion('7.2.10', '7.2.2'));
+      assert(matchesVersion('7.2.0', '7.2'));
+      assert(matchesVersion('7.10.0', '7.9.0'));
+      assert(matchesVersion('7.02.0', '7.2.0'));
+      assert(matchesVersion('8.2.0', '7.2.0'));
+      assert(matchesVersion('7.2-SNAPSHOT', '7.2.0'));
+      assert(matchesVersion('7.2.0-SNAPSHOT', '7.2.0'));
+      assert(matchesVersion('7.2beta', '7.2.0'));
+      assert(matchesVersion('7.2.beta', '7.2.0'));
+
+      assert(!matchesVersion('7.2.0', '7.2.1'));
+      assert(!matchesVersion('7.2.0', '7.3.0'));
+      assert(!matchesVersion('7.2.0', '8.2.0'));
+      assert(!matchesVersion('7.2-SNAPSHOT', '7.2.1'));
+      assert(!matchesVersion('7.2-SNAPSHOT', '7.3.0'));
+      assert(!matchesVersion('7.2.0-SNAPSHOT', '7.2.1'));
+      assert(!matchesVersion('0', '7.2.0'));
+      assert(!matchesVersion(undefined, '7.2.0'));
+      assert(!matchesVersion(null, '7.2.0'));
+      assert(!matchesVersion('A string that cannot be converted to a semver', '7.2.0'));
+
+      assert.throws(() => matchesVersion('7.2.0', undefined));
+      assert.throws(() => matchesVersion('7.2.0', null));
+      assert.throws(() => matchesVersion('7.2.0', 'A string that cannot be converted to a semver'));
+    })
+  });
+
+
 });