annotate lib/patchablegraph/patchsource.py @ 1341:08dc3baa7d14

release 0.2.0 Ignore-this: 720a712599a00ca21e1a8a97a7c03a34 darcs-hash:c45119596b434bd7ffa2b276f1ec1de0095ecb28
author drewp <drewp@bigasterisk.com>
date Thu, 25 Apr 2019 22:17:10 -0700
parents 43791ec0beb2
children 26dd28671f70
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1317
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
1 import logging
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
2 import traceback
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
3 from rdflib import ConjunctiveGraph
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
4 from rdflib.parser import StringInputSource
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
5 from twisted.internet import reactor, defer
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
6
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
7 from patchablegraph import patchFromJson
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
8 from rdfdb.patch import Patch
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
9 from twisted_sse_demo.eventsource import EventSource
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
10
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
11 log = logging.getLogger('fetch')
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
12
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
13 class PatchSource(object):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
14 """wrap EventSource so it emits Patch objects and has an explicit stop method."""
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
15 def __init__(self, url, agent):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
16 self.url = str(url)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
17
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
18 # add callbacks to these to learn if we failed to connect
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
19 # (approximately) or if the ccnnection was unexpectedly lost
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
20 self.connectionFailed = defer.Deferred()
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
21 self.connectionLost = defer.Deferred()
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
22
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
23 self._listeners = set()
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
24 log.info('start read from %s', url)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
25 # note: fullGraphReceived isn't guaranteed- the stream could
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
26 # start with patches
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
27 self._fullGraphReceived = False
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
28 self._eventSource = EventSource(url.toPython().encode('utf8'),
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
29 userAgent=agent)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
30
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
31 self._eventSource.addEventListener(b'fullGraph', self._onFullGraph)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
32 self._eventSource.addEventListener(b'patch', self._onPatch)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
33 self._eventSource.onerror(self._onError)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
34 self._eventSource.onConnectionLost = self._onDisconnect
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
35
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
36 def state(self):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
37 return {
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
38 'url': self.url,
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
39 'fullGraphReceived': self._fullGraphReceived,
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
40 }
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
41
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
42 def addPatchListener(self, func):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
43 """
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
44 func(patch, fullGraph=[true if the patch is the initial fullgraph])
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
45 """
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
46 self._listeners.add(func)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
47
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
48 def stop(self):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
49 log.info('stop read from %s', self.url)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
50 try:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
51 self._eventSource.protocol.stopProducing() # needed?
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
52 except AttributeError:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
53 pass
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
54 self._eventSource = None
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
55
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
56 def _onDisconnect(self, reason):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
57 log.debug('PatchSource._onDisconnect from %s (%s)', self.url, reason)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
58 # skip this if we're doing a stop?
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
59 self.connectionLost.callback(None)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
60
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
61 def _onError(self, msg):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
62 log.debug('PatchSource._onError from %s %r', self.url, msg)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
63 if not self._fullGraphReceived:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
64 self.connectionFailed.callback(msg)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
65 else:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
66 self.connectionLost.callback(msg)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
67
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
68 def _onFullGraph(self, message):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
69 try:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
70 g = ConjunctiveGraph()
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
71 g.parse(StringInputSource(message), format='json-ld')
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
72 p = Patch(addGraph=g)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
73 self._sendPatch(p, fullGraph=True)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
74 except Exception:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
75 log.error(traceback.format_exc())
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
76 raise
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
77 self._fullGraphReceived = True
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
78
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
79 def _onPatch(self, message):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
80 try:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
81 p = patchFromJson(message)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
82 self._sendPatch(p, fullGraph=False)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
83 except:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
84 log.error(traceback.format_exc())
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
85 raise
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
86
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
87 def _sendPatch(self, p, fullGraph):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
88 log.debug('PatchSource %s received patch %s (fullGraph=%s)',
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
89 self.url, p.shortSummary(), fullGraph)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
90 for lis in self._listeners:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
91 lis(p, fullGraph=fullGraph)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
92
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
93 def __del__(self):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
94 if self._eventSource:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
95 raise ValueError("PatchSource wasn't stopped before del")
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
96
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
97 class ReconnectingPatchSource(object):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
98 """
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
99 PatchSource api, but auto-reconnects internally and takes listener
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
100 at init time to not miss any patches. You'll get another
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
101 fullGraph=True patch if we have to reconnect.
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
102
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
103 todo: generate connection stmts in here
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
104 """
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
105 def __init__(self, url, listener, reconnectSecs=60, agent='unset'):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
106 # type: (str, Any, Any, str)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
107 self.url = url
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
108 self._stopped = False
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
109 self._listener = listener
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
110 self.reconnectSecs = reconnectSecs
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
111 self.agent = agent
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
112 self._reconnect()
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
113
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
114 def _reconnect(self):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
115 if self._stopped:
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
116 return
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
117 self._ps = PatchSource(self.url, agent=self.agent)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
118 self._ps.addPatchListener(self._onPatch)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
119 self._ps.connectionFailed.addCallback(self._onConnectionFailed)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
120 self._ps.connectionLost.addCallback(self._onConnectionLost)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
121
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
122 def _onPatch(self, p, fullGraph):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
123 self._listener(p, fullGraph=fullGraph)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
124
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
125 def state(self):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
126 return {
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
127 'reconnectedPatchSource': self._ps.state(),
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
128 }
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
129
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
130 def stop(self):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
131 self._stopped = True
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
132 self._ps.stop()
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
133
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
134 def _onConnectionFailed(self, arg):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
135 reactor.callLater(self.reconnectSecs, self._reconnect)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
136
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
137 def _onConnectionLost(self, arg):
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
138 reactor.callLater(self.reconnectSecs, self._reconnect)
43791ec0beb2 make patchablegraph release
drewp <drewp@bigasterisk.com>
parents:
diff changeset
139