<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[12768] CalendarServer/trunk/calendarserver/webadmin</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/12768">12768</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2014-02-27 15:16:58 -0800 (Thu, 27 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Make EventStream.read() defer on new events.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarserverwebadmineventsourcepy">CalendarServer/trunk/calendarserver/webadmin/eventsource.py</a></li>
<li><a href="#CalendarServertrunkcalendarserverwebadmintesttest_eventsourcepy">CalendarServer/trunk/calendarserver/webadmin/test/test_eventsource.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcalendarserverwebadmineventsourcepy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/calendarserver/webadmin/eventsource.py (12767 => 12768)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/webadmin/eventsource.py 2014-02-27 20:17:30 UTC (rev 12767)
+++ CalendarServer/trunk/calendarserver/webadmin/eventsource.py 2014-02-27 23:16:58 UTC (rev 12768)
</span><span class="lines">@@ -30,7 +30,7 @@
</span><span class="cx">
</span><span class="cx"> from zope.interface import implementer, Interface
</span><span class="cx">
</span><del>-from twisted.internet.defer import succeed
</del><ins>+from twisted.internet.defer import Deferred, succeed
</ins><span class="cx">
</span><span class="cx"> from txweb2.stream import IByteStream, fallbackSplit
</span><span class="cx"> from txweb2.resource import Resource
</span><span class="lines">@@ -132,12 +132,17 @@
</span><span class="cx">
</span><span class="cx"> self._eventDecoder = eventDecoder
</span><span class="cx"> self._events = deque(maxlen=bufferSize)
</span><ins>+ self._streams = set()
</ins><span class="cx">
</span><span class="cx">
</span><del>- def addEvent(self, event):
- self._events.append(event)
</del><ins>+ def addEvents(self, events):
+ self._events.extend(events)
</ins><span class="cx">
</span><ins>+ # Notify outbound streams that there is new data to vend
+ for stream in self._streams:
+ stream.didAddEvents()
</ins><span class="cx">
</span><ins>+
</ins><span class="cx"> def render(self, request):
</span><span class="cx"> lastID = request.headers.getRawHeaders(u"last-event-id")
</span><span class="cx">
</span><span class="lines">@@ -146,6 +151,13 @@
</span><span class="cx"> response.headers.setHeader(
</span><span class="cx"> b"content-type", MimeType.fromString(b"text/event-stream")
</span><span class="cx"> )
</span><ins>+
+ # Keep track of the event streams
+ request.addResponseFilter(
+ lambda r: self._streams.remove(response.stream)
+ )
+ self._streams.add(response.stream)
+
</ins><span class="cx"> return response
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -178,11 +190,19 @@
</span><span class="cx"> self._events = events
</span><span class="cx"> self._lastID = lastID
</span><span class="cx"> self._closed = False
</span><ins>+ self._deferredRead = None
</ins><span class="cx">
</span><span class="cx">
</span><ins>+ def didAddEvents(self):
+ d = self._deferredRead
+ if d is not None:
+ d.addCallback(lambda _: self.read())
+ d.callback(None)
+
+
</ins><span class="cx"> def read(self):
</span><span class="cx"> if self._closed:
</span><del>- return None
</del><ins>+ return succeed(None)
</ins><span class="cx">
</span><span class="cx"> lastID = self._lastID
</span><span class="cx"> eventID = None
</span><span class="lines">@@ -209,7 +229,7 @@
</span><span class="cx"> self._lastID = eventID
</span><span class="cx">
</span><span class="cx"> return succeed(
</span><del>- textAsEvent(eventText, eventID, eventClass).encode("utf-8")
</del><ins>+ textAsEvent(eventText, eventID, eventClass)
</ins><span class="cx"> )
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -218,19 +238,17 @@
</span><span class="cx"> # client saw.
</span><span class="cx"> self._lastID = None
</span><span class="cx">
</span><del>- return succeed("")
</del><ins>+ return succeed(b"")
</ins><span class="cx">
</span><del>- return succeed(None)
</del><ins>+ d = Deferred()
+ self._deferredRead = d
+ return d
</ins><span class="cx">
</span><del>- # from twisted.internet.task import deferLater
- # from twisted.internet import reactor
</del><span class="cx">
</span><del>- # return deferLater(reactor, 1.0, self.read)
-
-
</del><span class="cx"> def split(self, point):
</span><span class="cx"> return fallbackSplit(self, point)
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> def close(self):
</span><ins>+ print("************ CLOSE ************")
</ins><span class="cx"> self._closed = True
</span></span></pre></div>
<a id="CalendarServertrunkcalendarserverwebadmintesttest_eventsourcepy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/calendarserver/webadmin/test/test_eventsource.py (12767 => 12768)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/webadmin/test/test_eventsource.py 2014-02-27 20:17:30 UTC (rev 12767)
+++ CalendarServer/trunk/calendarserver/webadmin/test/test_eventsource.py 2014-02-27 23:16:58 UTC (rev 12768)
</span><span class="lines">@@ -23,7 +23,7 @@
</span><span class="cx"> from twisted.internet.defer import inlineCallbacks
</span><span class="cx"> from twisted.trial.unittest import TestCase
</span><span class="cx">
</span><del>-from txweb2.http import Request
</del><ins>+from txweb2.server import Request
</ins><span class="cx"> from txweb2.http_headers import Headers
</span><span class="cx">
</span><span class="cx"> from ..eventsource import textAsEvent, EventSourceResource
</span><span class="lines">@@ -118,15 +118,10 @@
</span><span class="cx"> Tests for L{EventSourceResource}.
</span><span class="cx"> """
</span><span class="cx">
</span><del>- def eventSourceResource(self, events=()):
- resource = EventSourceResource(DictionaryEventDecoder)
</del><ins>+ def eventSourceResource(self):
+ return EventSourceResource(DictionaryEventDecoder)
</ins><span class="cx">
</span><del>- for event in events:
- resource.addEvent(event)
</del><span class="cx">
</span><del>- return resource
-
-
</del><span class="cx"> def render(self, resource):
</span><span class="cx"> headers = Headers()
</span><span class="cx">
</span><span class="lines">@@ -190,11 +185,13 @@
</span><span class="cx"> dict(eventID=u"4", eventText=u"D"),
</span><span class="cx"> )
</span><span class="cx">
</span><del>- resource = self.eventSourceResource(events)
</del><ins>+ resource = self.eventSourceResource()
+ resource.addEvents(events)
+
</ins><span class="cx"> response = self.render(resource)
</span><span class="cx">
</span><span class="cx"> # Each result from read() is another event
</span><del>- for i in range(4):
</del><ins>+ for i in range(len(events)):
</ins><span class="cx"> result = yield response.stream.read()
</span><span class="cx"> self.assertEquals(
</span><span class="cx"> result,
</span><span class="lines">@@ -204,11 +201,68 @@
</span><span class="cx"> )
</span><span class="cx"> )
</span><span class="cx">
</span><del>- result = yield response.stream.read()
- self.assertEquals(result, None)
</del><ins>+ # The next read should block on new events.
+ d = response.stream.read()
+ self.assertFalse(d.called)
</ins><span class="cx">
</span><ins>+ d.addErrback(lambda f: None)
+ d.cancel()
</ins><span class="cx">
</span><span class="cx">
</span><ins>+ @inlineCallbacks
+ def test_streamNewEvents(self):
+ """
+ Events not already buffered are vended after they are posted.
+ """
+ events = (
+ dict(eventID=u"1", eventText=u"A"),
+ dict(eventID=u"2", eventText=u"B"),
+ dict(eventID=u"3", eventText=u"C"),
+ dict(eventID=u"4", eventText=u"D"),
+ )
+
+ resource = self.eventSourceResource()
+
+ response = self.render(resource)
+
+ # The first read should block on new events.
+ d = response.stream.read()
+ self.assertFalse(d.called)
+
+ # Add some events
+ resource.addEvents(events)
+
+ # We should now be unblocked
+ self.assertTrue(d.called)
+
+ # Each result from read() is another event
+ for i in range(len(events)):
+ if d is None:
+ result = yield response.stream.read()
+ else:
+ result = yield d
+ d = None
+
+ self.assertEquals(
+ result,
+ textAsEvent(
+ text=events[i]["eventText"],
+ eventID=(events[i]["eventID"])
+ )
+ )
+
+ # The next read should block on new events.
+ d = response.stream.read()
+ self.assertFalse(d.called)
+
+ d.addErrback(lambda f: None)
+ d.cancel()
+
+
+
+ # Test closed
+
+
</ins><span class="cx"> class DictionaryEventDecoder(object):
</span><span class="cx"> """
</span><span class="cx"> Decodes events represented as dictionaries.
</span></span></pre>
</div>
</div>
</body>
</html>