changeset 169:6d744040aa4e

Refactor jvm-memory and jvm-gc endpoints to use path-based query This series of patches brings the jvm-gc and jvm-memory APIs in line with the other web services. Previously, you would GET or PUT ? https://host**/jvm-memory/0.0.2?query=jvmId=={jvmId} (properly escaped, of course). Now, you call ? https://host/jvm-memory/0.0.3/systems/{systemId}/jvms/{jvmId}. In addition, I've added a new endpoint (valid for GET only) ? https://host/jvm-memory/0.0.3/jvms/{jvmId} ...which is easier for the web client to call.? I didn't implement this for POST, etc. Reviewed-by: aazores, jkang Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-August/024586.html
author Simon Tooke <stooke@redhat.com>
date Fri, 25 Aug 2017 10:00:51 -0400
parents becd239128c2
children f47aa9ec9b92
files mock-api/endpoints/jvm-gc.endpoint.js mock-api/endpoints/jvm-memory.endpoint.js src/app/components/jvm-info/jvm-gc/jvm-gc.service.js src/app/components/jvm-info/jvm-gc/jvm-gc.service.spec.js src/app/components/jvm-info/jvm-memory/jvm-memory.service.js src/app/components/jvm-info/jvm-memory/jvm-memory.service.spec.js
diffstat 6 files changed, 14 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
--- a/mock-api/endpoints/jvm-gc.endpoint.js	Wed Aug 23 17:21:50 2017 -0400
+++ b/mock-api/endpoints/jvm-gc.endpoint.js	Fri Aug 25 10:00:51 2017 -0400
@@ -2,7 +2,7 @@
   var _ = require('lodash');
   server.init('jvmGc');
   var accumulatedMicros = 1000;
-  server.app.get('/jvm-gc/0.0.2', function (req, res, next) {
+  server.app.get('/jvm-gc/0.0.3/jvms', function (req, res, next) {
     server.logRequest('jvm-gc', req);
 
     var query = req.query.query;
--- a/mock-api/endpoints/jvm-memory.endpoint.js	Wed Aug 23 17:21:50 2017 -0400
+++ b/mock-api/endpoints/jvm-memory.endpoint.js	Fri Aug 25 10:00:51 2017 -0400
@@ -1,7 +1,7 @@
 function jvmMemory (server) {
   var _ = require('lodash');
   server.init('jvmMemory');
-  server.app.get('/jvm-memory/0.0.2', function (req, res, next) {
+  server.app.get('/jvm-memory/0.0.3', function (req, res, next) {
     server.logRequest('jvm-memory', req);
 
     var query = req.query.query;
--- a/src/app/components/jvm-info/jvm-gc/jvm-gc.service.js	Wed Aug 23 17:21:50 2017 -0400
+++ b/src/app/components/jvm-info/jvm-gc/jvm-gc.service.js	Fri Aug 25 10:00:51 2017 -0400
@@ -39,12 +39,11 @@
     let params = {
       limit: limit,
       sort: '-timeStamp',
-      query: 'jvmId==' + jvmId
     };
     if (collectorName) {
-      params.query += ',collectorName==' + collectorName;
+      params.query = 'collectorName==' + collectorName;
     }
-    return this.http.get(urlJoin(this.gatewayUrl, 'jvm-gc', '0.0.2'), { params: params });
+    return this.http.get(urlJoin(this.gatewayUrl, 'jvm-gc', '0.0.3', 'jvms', jvmId), { params: params });
   }
 }
 
--- a/src/app/components/jvm-info/jvm-gc/jvm-gc.service.spec.js	Wed Aug 23 17:21:50 2017 -0400
+++ b/src/app/components/jvm-info/jvm-gc/jvm-gc.service.spec.js	Fri Aug 25 10:00:51 2017 -0400
@@ -59,13 +59,13 @@
       let expected = {
         metaspace: 100
       };
-      httpBackend.when('GET', 'http://example.com:1234/jvm-gc/0.0.2?limit=1&sort=-timeStamp&query=jvmId%3D%3Dfoo-jvmId')
+      httpBackend.when('GET', 'http://example.com:1234/jvm-gc/0.0.3/jvms/foo-jvmId?limit=1&sort=-timeStamp')
         .respond(expected);
       svc.getJvmGcData('foo-jvmId').then(res => {
         res.data.should.deepEqual(expected);
         done();
       });
-      httpBackend.expectGET('http://example.com:1234/jvm-gc/0.0.2?limit=1&sort=-timeStamp&query=jvmId%3D%3Dfoo-jvmId');
+      httpBackend.expectGET('http://example.com:1234/jvm-gc/0.0.3/jvms/foo-jvmId?limit=1&sort=-timeStamp');
       httpBackend.flush();
       scope.$apply();
     });
@@ -74,13 +74,13 @@
       let expected = {
         metaspace: 100
       };
-      httpBackend.when('GET', 'http://example.com:1234/jvm-gc/0.0.2?limit=5&sort=-timeStamp&query=jvmId%3D%3Dfoo-jvmId')
+      httpBackend.when('GET', 'http://example.com:1234/jvm-gc/0.0.3/jvms/foo-jvmId?limit=5&sort=-timeStamp')
         .respond(expected);
       svc.getJvmGcData('foo-jvmId', 5).then(res => {
         res.data.should.deepEqual(expected);
         done();
       });
-      httpBackend.expectGET('http://example.com:1234/jvm-gc/0.0.2?limit=5&sort=-timeStamp&query=jvmId%3D%3Dfoo-jvmId');
+      httpBackend.expectGET('http://example.com:1234/jvm-gc/0.0.3/jvms/foo-jvmId?limit=5&sort=-timeStamp');
       httpBackend.flush();
       scope.$apply();
     });
@@ -89,13 +89,13 @@
       let expected = {
         metaspace: 100
       };
-      httpBackend.when('GET', 'http://example.com:1234/jvm-gc/0.0.2?limit=5&query=jvmId%3D%3Dfoo-jvmId,collectorName%3D%3DfooCollector&sort=-timeStamp')
+      httpBackend.when('GET', 'http://example.com:1234/jvm-gc/0.0.3/jvms/foo-jvmId?limit=5&query=collectorName%3D%3DfooCollector&sort=-timeStamp')
         .respond(expected);
       svc.getJvmGcData('foo-jvmId', 5, 'fooCollector').then(res => {
         res.data.should.deepEqual(expected);
         done();
       });
-      httpBackend.expectGET('http://example.com:1234/jvm-gc/0.0.2?limit=5&query=jvmId%3D%3Dfoo-jvmId,collectorName%3D%3DfooCollector&sort=-timeStamp');
+      httpBackend.expectGET('http://example.com:1234/jvm-gc/0.0.3/jvms/foo-jvmId?limit=5&query=collectorName%3D%3DfooCollector&sort=-timeStamp');
       httpBackend.flush();
       scope.$apply();
     });
--- a/src/app/components/jvm-info/jvm-memory/jvm-memory.service.js	Wed Aug 23 17:21:50 2017 -0400
+++ b/src/app/components/jvm-info/jvm-memory/jvm-memory.service.js	Fri Aug 25 10:00:51 2017 -0400
@@ -36,11 +36,10 @@
   }
 
   getJvmMemory (jvmId) {
-    return this.http.get(urlJoin(this.gatewayUrl, 'jvm-memory', '0.0.2'), {
+    return this.http.get(urlJoin(this.gatewayUrl, 'jvm-memory', '0.0.3', 'jvms', jvmId), {
       params: {
         limit: 1,
-        sort: '-timeStamp',
-        query: 'jvmId==' + jvmId
+        sort: '-timeStamp'
       }
     });
   }
--- a/src/app/components/jvm-info/jvm-memory/jvm-memory.service.spec.js	Wed Aug 23 17:21:50 2017 -0400
+++ b/src/app/components/jvm-info/jvm-memory/jvm-memory.service.spec.js	Fri Aug 25 10:00:51 2017 -0400
@@ -59,13 +59,13 @@
       let expected = {
         metaspace: 100
       };
-      httpBackend.when('GET', 'http://example.com:1234/jvm-memory/0.0.2?limit=1&sort=-timeStamp&query=jvmId%3D%3Dfoo-jvmId')
+      httpBackend.when('GET', 'http://example.com:1234/jvm-memory/0.0.3/jvms/foo-jvmId?limit=1&sort=-timeStamp')
         .respond(expected);
       svc.getJvmMemory('foo-jvmId').then(res => {
         res.data.should.deepEqual(expected);
         done();
       });
-      httpBackend.expectGET('http://example.com:1234/jvm-memory/0.0.2?limit=1&sort=-timeStamp&query=jvmId%3D%3Dfoo-jvmId');
+      httpBackend.expectGET('http://example.com:1234/jvm-memory/0.0.3/jvms/foo-jvmId?limit=1&sort=-timeStamp');
       httpBackend.flush();
       scope.$apply();
     });