Removed version.json file, api version is now set by package.json.

Updated bookmarks routes so that latest route always applies to current minor/patch version.
xbrowsersync · Jul 15, 2018 · fa9ea3d · fa9ea3d
1 parent d4ff170
commit fa9ea3d
Show file tree

Hide file tree

Showing 16 changed files with 37 additions and 38 deletions.
diff --git a/config/version.json b/config/version.json
diff --git a/dist/core/config.js b/dist/core/config.js
diff --git a/dist/core/config.js.map b/dist/core/config.js.map
diff --git a/dist/routers/bookmarks.router.js b/dist/routers/bookmarks.router.js
diff --git a/dist/routers/bookmarks.router.js.map b/dist/routers/bookmarks.router.js.map
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "xbrowsersync-api",
   "description": "The REST API service component of the xBrowserSync application.",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "author": "xBrowserSync",
   "license": "MIT",
   "main": "dist/api.js",

diff --git a/src/core/config.ts b/src/core/config.ts
@@ -26,12 +26,11 @@ export default class Config {
     const settings = merge(defaultSettings, userSettings);
 
     // Get current version number
-    const pathToVersion = path.join(pathToConfig, 'version.json');
-    const version = require(pathToVersion);
+    const { version } = require('../../package.json');
 
     this.config = {
       ...settings,
-      ...version
+      version
     };
 
     return this.config;

diff --git a/src/routers/bookmarks.router.ts b/src/routers/bookmarks.router.ts
@@ -14,15 +14,17 @@ export default class BookmarksRouter extends BaseRouter<BookmarksService> implem
     this.app.use('/bookmarks', this.router);    
     this.createRoute(ApiVerb.post, '/', {
       '~1.0.0': this.createBookmarks_v1,
-      '~1.1.3': this.createBookmarks_v2
+      // tslint:disable-next-line:object-literal-sort-keys
+      '^1.1.3': this.createBookmarks_v2
     });
     this.createRoute(ApiVerb.get, '/:id', { '^1.0.0': this.getBookmarks });
     this.createRoute(ApiVerb.put, '/:id', {
       '~1.0.0': this.updateBookmarks_v1,
-      '~1.1.3': this.updateBookmarks_v2
+      // tslint:disable-next-line:object-literal-sort-keys
+      '^1.1.3': this.updateBookmarks_v2
     });
     this.createRoute(ApiVerb.get, '/:id/lastUpdated', { '^1.0.0': this.getLastUpdated });
-    this.createRoute(ApiVerb.get, '/:id/version', { '~1.1.3': this.getVersion });
+    this.createRoute(ApiVerb.get, '/:id/version', { '^1.1.3': this.getVersion });
   }
 
   // Creates a new bookmarks sync and returns new sync ID

diff --git a/test/integration/bookmarks.test.ts b/test/integration/bookmarks.test.ts
@@ -29,10 +29,11 @@ describe('BookmarksRouter', () => {
   let testConfig: any;
 
   beforeEach(async () => {
+    const { version } = require('../../package.json');
     testConfig = {
       ...require('../../config/settings.default.json'),
-      ...require('../../config/version.json')
-    };    
+      version
+    };
     testConfig.db.name = `${testConfig.db.name}test`;
     testConfig.log.enabled = false;
     sandbox = sinon.createSandbox();
@@ -51,7 +52,6 @@ describe('BookmarksRouter', () => {
     await server.stop();
     sandbox.restore();
     decache('../../config/settings.default.json');
-    decache('../../config/version.json');
   });
 
   it('POST /bookmarks should return a NewSyncsForbiddenException error code if new syncs are not allowed', async () => {

diff --git a/test/integration/docs.test.ts b/test/integration/docs.test.ts
@@ -17,10 +17,11 @@ describe('Docs', () => {
   let testConfig: any;
 
   beforeEach(async () => {
+    const { version } = require('../../package.json');
     testConfig = {
       ...require('../../config/settings.default.json'),
-      ...require('../../config/version.json')
-    };    
+      version
+    };
     testConfig.db.name = `${testConfig.db.name}test`;
     testConfig.log.enabled = false;
     sandbox = sinon.createSandbox();
@@ -36,7 +37,6 @@ describe('Docs', () => {
     await server.stop();
     sandbox.restore();
     decache('../../config/settings.default.json');
-    decache('../../config/version.json');
   });
 
   it('GET /: Should return a 200 code', async () => {

diff --git a/test/integration/info.test.ts b/test/integration/info.test.ts
@@ -17,10 +17,11 @@ describe('InfoRouter', () => {
   let testConfig: any;
 
   beforeEach(async () => {
+    const { version } = require('../../package.json');
     testConfig = {
       ...require('../../config/settings.default.json'),
-      ...require('../../config/version.json')
-    };    
+      version
+    };
     testConfig.db.name = `${testConfig.db.name}test`;
     testConfig.log.enabled = false;
     sandbox = sinon.createSandbox();
@@ -36,7 +37,6 @@ describe('InfoRouter', () => {
     await server.stop();
     sandbox.restore();
     decache('../../config/settings.default.json');
-    decache('../../config/version.json');
   });
 
   it('GET info: should return api status info', async () => {

diff --git a/test/integration/server.test.ts b/test/integration/server.test.ts
@@ -29,10 +29,11 @@ describe('Server', () => {
   let testConfig: any;
 
   beforeEach(async () => {
+    const { version } = require('../../package.json');
     testConfig = {
       ...require('../../config/settings.default.json'),
-      ...require('../../config/version.json')
-    };    
+      version
+    };
     testConfig.db.name = `${testConfig.db.name}test`;
     testConfig.log.enabled = false;
     sandbox = sinon.createSandbox();
@@ -48,7 +49,6 @@ describe('Server', () => {
     await server.stop();
     sandbox.restore();
     decache('../../config/settings.default.json');
-    decache('../../config/version.json');
   });
 
   it('Should return a NotImplementedException error code for an invalid route', async () => {

diff --git a/test/unit/bookmarks.service.test.ts b/test/unit/bookmarks.service.test.ts
@@ -25,9 +25,10 @@ describe('BookmarksService', () => {
   let testConfig: any;
 
   beforeEach(() => {
+    const { version } = require('../../package.json');
     testConfig = {
       ...require('../../config/settings.default.json'),
-      ...require('../../config/version.json')
+      version
     };
     const log = () => { };
     newSyncLogsService = new NewSyncLogsService(null, log);
@@ -40,7 +41,6 @@ describe('BookmarksService', () => {
   afterEach(() => {
     sandbox.restore();
     decache('../../config/settings.default.json');
-    decache('../../config/version.json');
   });
 
   it('createBookmarks: should throw a NewSyncsForbiddenException if service is not accepting new syncs', async () => {

diff --git a/test/unit/info.service.test.ts b/test/unit/info.service.test.ts
@@ -16,9 +16,10 @@ describe('InfoService', () => {
   let testConfig: any;
 
   beforeEach(() => {
+    const { version } = require('../../package.json');
     testConfig = {
       ...require('../../config/settings.default.json'),
-      ...require('../../config/version.json')
+      version
     };
     const log = () => { };
     bookmarksService = new BookmarksService(null, log);
@@ -31,7 +32,6 @@ describe('InfoService', () => {
   afterEach(() => {
     sandbox.restore();
     decache('../../config/settings.default.json');
-    decache('../../config/version.json');
   });
 
   it('getInfo: should return max sync size config value', async () => {

diff --git a/test/unit/newSyncLogs.service.test.ts b/test/unit/newSyncLogs.service.test.ts
@@ -16,9 +16,10 @@ describe('NewSyncLogsService', () => {
   let testConfig: any;
 
   beforeEach(() => {
+    const { version } = require('../../package.json');
     testConfig = {
       ...require('../../config/settings.default.json'),
-      ...require('../../config/version.json')
+      version
     };
     const log = () => { };
     newSyncLogsService = new NewSyncLogsService(null, log);
@@ -29,7 +30,6 @@ describe('NewSyncLogsService', () => {
   afterEach(() => {
     sandbox.restore();
     decache('../../config/settings.default.json');
-    decache('../../config/version.json');
   });
 
   it('createLog: should create a new sync log using the request IP address', async () => {

diff --git a/test/unit/server.test.ts b/test/unit/server.test.ts
@@ -12,9 +12,10 @@ describe('Server', () => {
   let testConfig: any;
 
   beforeEach(() => {
+    const { version } = require('../../package.json');
     testConfig = {
       ...require('../../config/settings.default.json'),
-      ...require('../../config/version.json')
+      version
     };
     sandbox = sinon.createSandbox();
     sandbox.stub(Config, 'get').returns(testConfig);
@@ -23,7 +24,6 @@ describe('Server', () => {
   afterEach(() => {
     sandbox.restore();
     decache('../../config/settings.default.json');
-    decache('../../config/version.json');
   });
 
   it('checkServiceAvailability: should not throw an error when status set as online in config settings', done => {