annotate patchsource.py @ 4:dc4f852d0d70

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