Merge lp:~jerith/txjsonrpc/add-id-to-response into lp:txjsonrpc

[Jeremy Thurgood]

This adds support for request ids, necessary for both #456441 and #456351.

Unmerged revisions

95. By Jeremy Thurgood on 2013-07-30

Add support for request id.

=== modified file 'txjsonrpc/jsonrpc.py'
--- txjsonrpc/jsonrpc.py	2009-11-09 06:10:20 +0000
+++ txjsonrpc/jsonrpc.py	2013-07-30 14:07:37 +0000
@@ -1,3 +1,5 @@
+import uuid
+
 from twisted.internet import defer, protocol
 from twisted.python import reflect
 
@@ -67,19 +69,17 @@
     deferred = None
     protocol = None
 
-    # XXX add an "id" parameter
-    def __init__(self, method, version=jsonrpclib.VERSION_PRE1, *args):
-        # XXX pass the "id" parameter here
-        self.payload = self._buildVersionedPayload(version, method, args)
+    def __init__(self, method, version=jsonrpclib.VERSION_PRE1, id="", *args):
+        self.payload = self._buildVersionedPayload(version, id, method, args)
         self.deferred = defer.Deferred()
 
-    def _buildVersionedPayload(self, version, *args):
+    def _buildVersionedPayload(self, version, id, *args):
         if version == jsonrpclib.VERSION_PRE1:
             return jsonrpclib._preV1Request(*args)
         elif version == jsonrpclib.VERSION_1:
-            return jsonrpclib._v1Request(*args)
+            return jsonrpclib._v1Request(*args, id=id)
         elif version == jsonrpclib.VERSION_2:
-            return jsonrpclib._v2Request(*args)
+            return jsonrpclib._v2Request(*args, id=id)
 
     def parseResponse(self, contents):
         if not self.deferred:
@@ -127,6 +127,12 @@
             version = self.version
         return version
 
+    def _getId(self, keywords):
+        id = keywords.get("id")
+        if id == None:
+            id = str(uuid.uuid4())
+        return id
+
     def _getFactoryClass(self, keywords):
         factoryClass = keywords.get("factoryClass")
         if not factoryClass:

=== modified file 'txjsonrpc/netstring/jsonrpc.py'
--- txjsonrpc/netstring/jsonrpc.py	2012-01-28 01:35:54 +0000
+++ txjsonrpc/netstring/jsonrpc.py	2013-07-30 14:07:37 +0000
@@ -134,8 +134,9 @@
 
     def callRemote(self, method, *args, **kwargs):
         version = self._getVersion(kwargs)
+        id = self._getId(kwargs)
         factoryClass = self._getFactoryClass(kwargs)
-        factory = factoryClass(method, version, *args)
+        factory = factoryClass(method, version, id, *args)
         reactor.connectTCP(self.host, self.port, factory)
         return factory.deferred
 

=== modified file 'txjsonrpc/test/test_jsonrpc.py'
--- txjsonrpc/test/test_jsonrpc.py	2009-11-09 06:31:56 +0000
+++ txjsonrpc/test/test_jsonrpc.py	2013-07-30 14:07:37 +0000
@@ -13,20 +13,20 @@
 
     def test_buildVersionedPayloadPre1(self):
         factory = BaseQueryFactory("someMethod")
-        payload = factory._buildVersionedPayload(VERSION_PRE1)
+        payload = factory._buildVersionedPayload(VERSION_PRE1, "")
         self.assertEquals(
             payload, '{"params": [], "method": ""}')
 
     def test_buildVersionedPayload1(self):
         factory = BaseQueryFactory("someMethod")
-        payload = factory._buildVersionedPayload(VERSION_1)
+        payload = factory._buildVersionedPayload(VERSION_1, "")
         self.assertEquals(
             payload,
             '{"params": [], "method": "", "id": ""}')
 
     def test_buildVersionedPayload2(self):
         factory = BaseQueryFactory("someMethod")
-        payload = factory._buildVersionedPayload(VERSION_2)
+        payload = factory._buildVersionedPayload(VERSION_2, "")
         self.assertEquals(
             payload,
             '{"params": [], "jsonrpc": "2.0", "method": "", "id": ""}')

=== modified file 'txjsonrpc/web/jsonrpc.py'
--- txjsonrpc/web/jsonrpc.py	2012-01-28 01:11:15 +0000
+++ txjsonrpc/web/jsonrpc.py	2013-07-30 14:07:37 +0000
@@ -13,6 +13,7 @@
 from __future__ import nested_scopes
 import urlparse
 import xmlrpclib
+import uuid
 
 from twisted.web import resource, server
 from twisted.internet import defer, reactor
@@ -122,10 +123,10 @@
                 result = (result,)
             # Convert the result (python) to JSON-RPC
         try:
-            s = jsonrpclib.dumps(result, version=version)
+            s = jsonrpclib.dumps(result, id=id, version=version)
         except:
             f = jsonrpclib.Fault(self.FAILURE, "can't serialize output")
-            s = jsonrpclib.dumps(f, version=version)
+            s = jsonrpclib.dumps(f, id=id, version=version)
         request.setHeader("content-length", str(len(s)))
         request.write(s)
         request.finish()
@@ -166,8 +167,8 @@
     protocol = QueryProtocol
 
     def __init__(self, path, host, method, user=None, password=None,
-                 version=jsonrpclib.VERSION_PRE1, *args):
-        BaseQueryFactory.__init__(self, method, version, *args)
+                 version=jsonrpclib.VERSION_PRE1, id="", *args):
+        BaseQueryFactory.__init__(self, method, version, id, *args)
         self.path, self.host = path, host
         self.user, self.password = user, password
 
@@ -238,10 +239,10 @@
 
     def callRemote(self, method, *args, **kwargs):
         version = self._getVersion(kwargs)
-        # XXX generate unique id and pass it as a parameter
+        id = self._getId(kwargs)
         factoryClass = self._getFactoryClass(kwargs)
         factory = factoryClass(self.path, self.host, method, self.user,
-            self.password, version, *args)
+            self.password, version, id, *args)
         if self.secure:
             from twisted.internet import ssl
             reactor.connectSSL(self.host, self.port or 443,

=== modified file 'txjsonrpc/web/test/test_jsonrpc.py'
--- txjsonrpc/web/test/test_jsonrpc.py	2012-01-28 01:11:15 +0000
+++ txjsonrpc/web/test/test_jsonrpc.py	2013-07-30 14:07:37 +0000
@@ -104,6 +104,13 @@
         return self.request.getUser(), self.request.getPassword()
 
 
+class RawResponseQueryFactory(jsonrpc.QueryFactory):
+    def parseResponse(self, contents):
+        if self.deferred:
+            self.deferred.callback(contents)
+            self.deferred = None
+
+
 class JSONRPCTestCase(unittest.TestCase):
 
     def setUp(self):
@@ -117,6 +124,10 @@
     def proxy(self):
         return jsonrpc.Proxy("http://127.0.0.1:%d/" % self.port)
 
+    def raw_proxy(self):
+        return jsonrpc.Proxy("http://127.0.0.1:%d/" % self.port,
+                             factoryClass=RawResponseQueryFactory)
+
     def getExpectedOutput(self):
         return [
             5,
@@ -143,6 +154,12 @@
             dl.append(d)
         return defer.DeferredList(dl, fireOnOneErrback=True)
 
+    def testIdReturned(self):
+        d = self.raw_proxy().callRemote("add", 2, 2, id="abc", version=1)
+        d.addCallback(self.assertEquals,
+                      '{"id": "abc", "result": 4, "error": null}')
+        return d
+
     def testErrors(self):
         dl = []
         for code, methodName in [(666, "fail"), (666, "deferFail"),