<!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>[13810] CalendarServer/trunk/txdav</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/13810">13810</a></dd>
<dt>Author</dt> <dd>gaya@apple.com</dd>
<dt>Date</dt> <dd>2014-07-31 14:05:16 -0700 (Thu, 31 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>delete unused cached groups</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunktxdavcommondatastoresqlpy">CalendarServer/trunk/txdav/common/datastore/sql.py</a></li>
<li><a href="#CalendarServertrunktxdavwhogroupspy">CalendarServer/trunk/txdav/who/groups.py</a></li>
<li><a href="#CalendarServertrunktxdavwhotesttest_groupspy">CalendarServer/trunk/txdav/who/test/test_groups.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunktxdavcommondatastoresqlpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/txdav/common/datastore/sql.py (13809 => 13810)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/txdav/common/datastore/sql.py 2014-07-31 20:15:15 UTC (rev 13809)
+++ CalendarServer/trunk/txdav/common/datastore/sql.py 2014-07-31 21:05:16 UTC (rev 13810)
</span><span class="lines">@@ -1107,8 +1107,8 @@
</span><span class="cx"> )
</span><span class="cx">
</span><span class="cx"> record = yield self.directoryService().recordWithUID(groupUID)
</span><del>- yield self._refreshGroup(
- groupUID, record, groupID, name.encode("utf-8"), membershipHash
</del><ins>+ yield self.refreshGroup(
+ groupUID, record, groupID, name.encode("utf-8"), membershipHash, True
</ins><span class="cx"> )
</span><span class="cx"> returnValue(groupID)
</span><span class="cx">
</span><span class="lines">@@ -1320,45 +1320,8 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> @inlineCallbacks
</span><del>- def refreshGroup(self, groupUID):
</del><ins>+ def refreshGroup(self, groupUID, record, groupID, cachedName, cachedMembershipHash, cachedExtant):
</ins><span class="cx"> """
</span><del>- Refreshes the group membership cache.
-
- @param groupUID: the group UID
- @type groupUID: C{unicode}
-
- @return: Deferred firing with tuple of group ID C{str}, and
- membershipChanged C{boolean}
-
- """
- log.debug("Faulting in group: {g}", g=groupUID)
- record = (yield self.directoryService().recordWithUID(groupUID))
- if record is None:
- # the group has disappeared from the directory
- log.info("Group is missing: {g}", g=groupUID)
- else:
- log.debug("Got group record: {u}", u=record.uid)
-
- (
- groupID, cachedName, cachedMembershipHash, _ignore_modified,
- _ignore_extant
- ) = yield self.groupByUID(
- groupUID,
- create=(record is not None)
- )
-
- membershipChanged = False
- if groupID:
- membershipChanged = yield self._refreshGroup(
- groupUID, record, groupID, cachedName, cachedMembershipHash
- )
-
- returnValue((groupID, membershipChanged))
-
-
- @inlineCallbacks
- def _refreshGroup(self, groupUID, record, groupID, cachedName, cachedMembershipHash):
- """
</del><span class="cx"> @param groupUID: the directory record
</span><span class="cx"> @type groupUID: C{unicode}
</span><span class="cx"> @param record: the directory record
</span><span class="lines">@@ -1369,6 +1332,8 @@
</span><span class="cx"> @type cachedName: C{unicode}
</span><span class="cx"> @param cachedMembershipHash: membership hash in the database
</span><span class="cx"> @type cachedMembershipHash: C{str}
</span><ins>+ @param cachedExtant: extent field from in the database
+ @type cachedExtant: C{bool}
</ins><span class="cx">
</span><span class="cx"> @return: Deferred firing with membershipChanged C{boolean}
</span><span class="cx">
</span><span class="lines">@@ -1383,9 +1348,7 @@
</span><span class="cx"> extant = False
</span><span class="cx">
</span><span class="cx"> membershipHashContent = hashlib.md5()
</span><del>- members = list(members)
- members.sort(key=lambda x: x.uid)
- for member in members:
</del><ins>+ for member in sorted(members, key=lambda x: x.uid):
</ins><span class="cx"> membershipHashContent.update(str(member.uid))
</span><span class="cx"> membershipHash = membershipHashContent.hexdigest()
</span><span class="cx">
</span><span class="lines">@@ -1397,7 +1360,7 @@
</span><span class="cx"> else:
</span><span class="cx"> membershipChanged = False
</span><span class="cx">
</span><del>- if membershipChanged or record is not None:
</del><ins>+ if membershipChanged or extant != cachedExtant:
</ins><span class="cx"> # also updates group mod date
</span><span class="cx"> yield self.updateGroup(
</span><span class="cx"> groupUID, name, membershipHash, extant=extant
</span></span></pre></div>
<a id="CalendarServertrunktxdavwhogroupspy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/txdav/who/groups.py (13809 => 13810)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/txdav/who/groups.py 2014-07-31 20:15:15 UTC (rev 13809)
+++ CalendarServer/trunk/txdav/who/groups.py 2014-07-31 21:05:16 UTC (rev 13810)
</span><span class="lines">@@ -22,7 +22,7 @@
</span><span class="cx"> from pycalendar.datetime import DateTime
</span><span class="cx"> from pycalendar.duration import Duration
</span><span class="cx"> from twext.enterprise.dal.record import fromTable
</span><del>-from twext.enterprise.dal.syntax import Delete, Select
</del><ins>+from twext.enterprise.dal.syntax import Delete, Select, Parameter
</ins><span class="cx"> from twext.enterprise.jobqueue import WorkItem, RegeneratingWorkItem
</span><span class="cx"> from twext.python.log import Logger
</span><span class="cx"> from twisted.internet.defer import inlineCallbacks, returnValue, succeed
</span><span class="lines">@@ -331,7 +331,16 @@
</span><span class="cx"> )
</span><span class="cx"> self.log.debug("Enqueued group refresh for {u}", u=groupUID)
</span><span class="cx">
</span><ins>+ # remove unused groups
+ gr = schema.GROUPS
+ yield Delete(
+ From=gr,
+ Where=gr.GROUP_UID.NotIn(
+ Parameter("groupUIDs", len(groupUIDs))
+ ) if groupUIDs else None
+ ).on(txn, groupUIDs=groupUIDs)
</ins><span class="cx">
</span><ins>+
</ins><span class="cx"> @inlineCallbacks
</span><span class="cx"> def applyExternalAssignments(self, txn, newAssignments):
</span><span class="cx">
</span><span class="lines">@@ -380,13 +389,33 @@
</span><span class="cx"> and updates the GROUP_MEMBERSHIP table
</span><span class="cx"> WorkProposal is returned for tests
</span><span class="cx"> """
</span><del>- groupID, membershipChanged = yield txn.refreshGroup(groupUID)
</del><ins>+ self.log.debug("Faulting in group: {g}", g=groupUID)
+ record = (yield self.directory.recordWithUID(groupUID))
+ if record is None:
+ # the group has disappeared from the directory
+ self.log.info("Group is missing: {g}", g=groupUID)
+ else:
+ self.log.debug("Got group record: {u}", u=record.uid)
</ins><span class="cx">
</span><del>- if membershipChanged:
- wpsAttendee = yield self.scheduleGroupAttendeeReconciliations(txn, groupID)
- wpsShareee = yield self.scheduleGroupShareeReconciliations(txn, groupID)
- returnValue(wpsAttendee + wpsShareee)
</del><ins>+ (
+ groupID, cachedName, cachedMembershipHash, _ignore_modified,
+ cachedExtant
+ ) = yield txn.groupByUID(
+ groupUID,
+ create=(record is not None)
+ )
</ins><span class="cx">
</span><ins>+ if groupID:
+ membershipChanged = yield txn.refreshGroup(
+ groupUID, record, groupID,
+ cachedName, cachedMembershipHash, cachedExtant
+ )
+
+ if membershipChanged:
+ wpsAttendee = yield self.scheduleGroupAttendeeReconciliations(txn, groupID)
+ wpsShareee = yield self.scheduleGroupShareeReconciliations(txn, groupID)
+ returnValue(wpsAttendee + wpsShareee)
+
</ins><span class="cx"> returnValue(tuple())
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -462,7 +491,7 @@
</span><span class="cx">
</span><span class="cx"> @inlineCallbacks
</span><span class="cx"> def groupsToRefresh(self, txn):
</span><del>- delegatedUIDs = set((yield txn.allGroupDelegates()))
</del><ins>+ delegatedUIDs = frozenset((yield txn.allGroupDelegates()))
</ins><span class="cx"> self.log.info(
</span><span class="cx"> "There are {count} group delegates", count=len(delegatedUIDs)
</span><span class="cx"> )
</span><span class="lines">@@ -481,7 +510,7 @@
</span><span class="cx"> )
</span><span class="cx"> )
</span><span class="cx"> ).on(txn)
</span><del>- attendeeGroupUIDs = set([row[0] for row in rows])
</del><ins>+ attendeeGroupUIDs = frozenset([row[0] for row in rows])
</ins><span class="cx"> self.log.info(
</span><span class="cx"> "There are {count} group attendees", count=len(attendeeGroupUIDs)
</span><span class="cx"> )
</span><span class="lines">@@ -500,11 +529,9 @@
</span><span class="cx"> )
</span><span class="cx"> )
</span><span class="cx"> ).on(txn)
</span><del>- shareeGroupUIDs = set([row[0] for row in rows])
</del><ins>+ shareeGroupUIDs = frozenset([row[0] for row in rows])
</ins><span class="cx"> self.log.info(
</span><span class="cx"> "There are {count} group sharees", count=len(shareeGroupUIDs)
</span><span class="cx"> )
</span><span class="cx">
</span><del>- # FIXME: is this a good place to clear out unreferenced groups?
-
</del><span class="cx"> returnValue(frozenset(delegatedUIDs | attendeeGroupUIDs | shareeGroupUIDs))
</span></span></pre></div>
<a id="CalendarServertrunktxdavwhotesttest_groupspy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/txdav/who/test/test_groups.py (13809 => 13810)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/txdav/who/test/test_groups.py 2014-07-31 20:15:15 UTC (rev 13809)
+++ CalendarServer/trunk/txdav/who/test/test_groups.py 2014-07-31 21:05:16 UTC (rev 13810)
</span><span class="lines">@@ -478,19 +478,21 @@
</span><span class="cx"> )
</span><span class="cx"> )
</span><span class="cx">
</span><del>- # Add a group
- records.append(
- TestRecord(
- self.directory,
- {
- fieldName.uid: u"testgroup",
- fieldName.recordType: RecordType.group,
- }
</del><ins>+ # Add two groups
+ for uid in (u"testgroup", u"emptygroup",):
+ records.append(
+ TestRecord(
+ self.directory,
+ {
+ fieldName.uid: uid,
+ fieldName.recordType: RecordType.group,
+ }
+ )
</ins><span class="cx"> )
</span><del>- )
</del><span class="cx">
</span><del>- yield self.directory.updateRecords(records, create=True)
</del><ins>+ yield self.directory.updateRecords(records, create=True)
</ins><span class="cx">
</span><ins>+ # add members to test group
</ins><span class="cx"> group = yield self.directory.recordWithUID(u"testgroup")
</span><span class="cx"> members = yield self.directory.recordsWithRecordType(RecordType.user)
</span><span class="cx"> yield group.setMembers(members)
</span><span class="lines">@@ -505,67 +507,129 @@
</span><span class="cx"> """
</span><span class="cx"> store = self.storeUnderTest()
</span><span class="cx">
</span><del>- txn = store.newTransaction()
- yield self.groupCacher.refreshGroup(txn, u"testgroup")
- (
- _ignore_groupID, _ignore_name, _ignore_membershipHash, _ignore_modified,
- extant
- ) = (yield txn.groupByUID(u"testgroup"))
- yield txn.commit()
</del><ins>+ for uid in (u"testgroup", u"emptygroup",):
</ins><span class="cx">
</span><del>- self.assertTrue(extant)
</del><ins>+ txn = store.newTransaction()
+ yield self.groupCacher.refreshGroup(txn, uid)
+ (
+ _ignore_groupID, _ignore_name, _ignore_membershipHash, _ignore_modified,
+ extant
+ ) = (yield txn.groupByUID(uid))
+ yield txn.commit()
</ins><span class="cx">
</span><del>- # Remove the group
- yield self.directory.removeRecords([u"testgroup"])
</del><ins>+ self.assertTrue(extant)
</ins><span class="cx">
</span><del>- txn = store.newTransaction()
- yield self.groupCacher.refreshGroup(txn, u"testgroup")
- (
- groupID, _ignore_name, _ignore_membershipHash, _ignore_modified,
- extant
- ) = (yield txn.groupByUID(u"testgroup"))
- yield txn.commit()
</del><ins>+ # Remove the group
+ yield self.directory.removeRecords([uid])
</ins><span class="cx">
</span><del>- # Extant = False
- self.assertFalse(extant)
</del><ins>+ txn = store.newTransaction()
+ yield self.groupCacher.refreshGroup(txn, uid)
+ (
+ groupID, _ignore_name, _ignore_membershipHash, _ignore_modified,
+ extant
+ ) = (yield txn.groupByUID(uid))
+ yield txn.commit()
</ins><span class="cx">
</span><del>- # The list of members stored in the DB for this group is now empty
- txn = store.newTransaction()
- members = yield txn.groupMemberUIDs(groupID)
- yield txn.commit()
- self.assertEquals(members, set())
</del><ins>+ # Extant = False
+ self.assertFalse(extant)
</ins><span class="cx">
</span><del>- # Add the group back into the directory
- fieldName = self.directory.fieldName
- yield self.directory.updateRecords(
- (
- TestRecord(
- self.directory,
- {
- fieldName.uid: u"testgroup",
- fieldName.recordType: RecordType.group,
- }
</del><ins>+ # The list of members stored in the DB for this group is now empty
+ txn = store.newTransaction()
+ members = yield txn.groupMemberUIDs(groupID)
+ yield txn.commit()
+ self.assertEquals(members, set())
+
+ # Add the group back into the directory
+ fieldName = self.directory.fieldName
+ yield self.directory.updateRecords(
+ (
+ TestRecord(
+ self.directory,
+ {
+ fieldName.uid: uid,
+ fieldName.recordType: RecordType.group,
+ }
+ ),
</ins><span class="cx"> ),
</span><del>- ),
- create=True
- )
- group = yield self.directory.recordWithUID(u"testgroup")
- members = yield self.directory.recordsWithRecordType(RecordType.user)
- yield group.setMembers(members)
</del><ins>+ create=True
+ )
+ if uid == u"testgroup":
+ group = yield self.directory.recordWithUID(uid)
+ members = yield self.directory.recordsWithRecordType(RecordType.user)
+ yield group.setMembers(members)
</ins><span class="cx">
</span><ins>+ txn = store.newTransaction()
+ yield self.groupCacher.refreshGroup(txn, uid)
+ (
+ groupID, _ignore_name, _ignore_membershipHash, _ignore_modified,
+ extant
+ ) = (yield txn.groupByUID(uid))
+ yield txn.commit()
+
+ # Extant = True
+ self.assertTrue(extant)
+
+ # The list of members stored in the DB for this group has 100 users
+ txn = store.newTransaction()
+ members = yield txn.groupMemberUIDs(groupID)
+ yield txn.commit()
+ self.assertEquals(len(members), 100 if uid == u"testgroup" else 0)
+
+
+ @inlineCallbacks
+ def test_update_delete(self):
+ """
+ Verify that unused groups are deleted from group cache
+ """
+ store = self.storeUnderTest()
+
+ # unused group deleted
+ for uid in (u"testgroup", u"emptygroup",):
+
+ txn = store.newTransaction()
+ yield self.groupCacher.refreshGroup(txn, uid)
+ groupID = (yield txn.groupByUID(uid, create=False))[0]
+ yield txn.commit()
+
+ self.assertNotEqual(groupID, None)
+
+ txn = store.newTransaction()
+ yield self.groupCacher.update(txn)
+ groupID = (yield txn.groupByUID(uid, create=False))[0]
+
+ self.assertEqual(groupID, None)
+
+ # delegate groups not deleted
+ for uid in (u"testgroup", u"emptygroup",):
+
+ groupID = (yield txn.groupByUID(uid))[0]
+ yield txn.addDelegateGroup(delegator=u"sagen", delegateGroupID=groupID, readWrite=True)
+ yield txn.commit()
+
+ self.assertNotEqual(groupID, None)
+
+ txn = store.newTransaction()
+ yield self.groupCacher.update(txn)
+ groupID = (yield txn.groupByUID(uid, create=False))[0]
+
+ self.assertNotEqual(groupID, None)
+
+ # delegate group is deleted. unused group is deleted
</ins><span class="cx"> txn = store.newTransaction()
</span><del>- yield self.groupCacher.refreshGroup(txn, u"testgroup")
- (
- groupID, _ignore_name, _ignore_membershipHash, _ignore_modified,
- extant
- ) = (yield txn.groupByUID(u"testgroup"))
</del><ins>+ testGroupID = (yield txn.groupByUID(u"testgroup", create=False))[0]
+ yield txn.removeDelegateGroup(delegator=u"sagen", delegateGroupID=testGroupID, readWrite=True)
+ testGroupID = (yield txn.groupByUID(u"testgroup", create=False))[0]
+ emptyGroupID = (yield txn.groupByUID(u"emptygroup", create=False))[0]
</ins><span class="cx"> yield txn.commit()
</span><span class="cx">
</span><del>- # Extant = True
- self.assertTrue(extant)
</del><ins>+ self.assertNotEqual(testGroupID, None)
+ self.assertNotEqual(emptyGroupID, None)
</ins><span class="cx">
</span><del>- # The list of members stored in the DB for this group has 100 users
</del><span class="cx"> txn = store.newTransaction()
</span><del>- members = yield txn.groupMemberUIDs(groupID)
</del><ins>+ yield self.groupCacher.update(txn)
+ testGroupID = (yield txn.groupByUID(u"testgroup", create=False))[0]
+ emptyGroupID = (yield txn.groupByUID(u"emptygroup", create=False))[0]
</ins><span class="cx"> yield txn.commit()
</span><del>- self.assertEquals(len(members), 100)
</del><ins>+
+ self.assertEqual(testGroupID, None)
+ self.assertNotEqual(emptyGroupID, None)
</ins></span></pre>
</div>
</div>
</body>
</html>