annotate patchsource.py @ 0:c3f0a692c4cb

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