def close_child_review_requests(user, review_request, status,
child_close_description):
"""Closes all child review requests for a squashed review request."""
# At the point of closing, it's possible that if this review
# request was never published, that most of the fields are empty
# (See https://code.google.com/p/reviewboard/issues/detail?id=3465).
# Luckily, the extra_data is still around, and more luckily, it's
# not exposed in the UI for user-meddling. We can find all of the
# child review requests via extra_data.p2rb.commits.
for child in gen_child_rrs(review_request):
child.close(status,
user=user,
description=child_close_description)
# We want to discard any review requests that this squashed review
# request never got to publish, so were never part of its "commits"
# list.
for child in gen_rrs_by_extra_data_key(review_request,
UNPUBLISHED_RRIDS_KEY):
child.close(ReviewRequest.DISCARDED,
user=user,
description=NEVER_USED_DESCRIPTION)
review_request.extra_data['p2rb.unpublished_rids'] = '[]'
review_request.extra_data['p2rb.discard_on_publish_rids'] = '[]'
review_request.save()
def _close_child_review_requests(user,
review_request,
status,
child_close_description,
commit_data=None):
"""Closes all child review requests for a squashed review request."""
commit_data = fetch_commit_data(review_request, commit_data)
# At the point of closing, it's possible that if this review
# request was never published, that most of the fields are empty
# (See https://code.google.com/p/reviewboard/issues/detail?id=3465).
# Luckily, the extra_data is still around, and more luckily, it's
# not exposed in the UI for user-meddling. We can find all of the
# child review requests via extra_data.p2rb.commits.
for child in gen_child_rrs(review_request, commit_data=commit_data):
child.close(status, user=user, description=child_close_description)
# We want to discard any review requests that this squashed review
# request never got to publish, so were never part of its "commits"
# list.
for child in gen_rrs_by_extra_data_key(review_request,
UNPUBLISHED_KEY,
commit_data=commit_data):
child.close(ReviewRequest.DISCARDED,
user=user,
description=NEVER_USED_DESCRIPTION)
commit_data.extra_data[UNPUBLISHED_KEY] = '[]'
commit_data.extra_data[DISCARD_ON_PUBLISH_KEY] = '[]'
commit_data.save(update_fields=['extra_data'])
def on_draft_pre_delete(sender, instance, using, **kwargs):
""" Handle draft discards.
There are no handy signals built into Review Board (yet) for us to detect
when a squashed Review Request Draft is discarded. Instead, we monitor for
deletions of models, and handle cases where the models being deleted are
ReviewRequestDrafts. We then do some processing to ensure that the draft
is indeed a draft of a squashed review request that we want to handle,
and then propagate the discard down to the child review requests.
"""
if not sender == ReviewRequestDraft:
return
# Drafts can get deleted for a number of reasons. They get deleted when
# drafts are discarded, obviously, but also whenever review requests are
# published, because the data gets copied over to the review request, and
# then the draft is blown away. Unfortunately, on_pre_delete doesn't give
# us too many clues about which scenario we're in, so we have to infer it
# based on other things attached to the model. This is a temporary fix until
# we get more comprehensive draft deletion signals built into Review Board.
#
# In the case where the review request is NOT public yet, the draft will
# not have a change description. In this case, we do not need to
# differentiate between publish and discard because discards of non-public
# review request's drafts will always cause the review request to be closed
# as discarded, and this case is handled by on_review_request_closed().
#
# In the case where the review request has a change description, but it's
# set to public, we must have just published this draft before deleting it,
# so there's nothing to do here.
if (instance.changedesc is None or instance.changedesc.public):
return
review_request = instance.review_request
if not review_request:
return
if not is_review_request_squashed(review_request):
return
# If the review request is marked as discarded, then we must be closing
# it, and so the on_review_request_closed() handler will take care of it.
if review_request.status == ReviewRequest.DISCARDED:
return
user = review_request.submitter
for child in gen_child_rrs(review_request):
draft = child.get_draft()
if draft:
draft.delete()
for child in gen_rrs_by_extra_data_key(review_request,
UNPUBLISHED_RRIDS_KEY):
child.close(ReviewRequest.DISCARDED,
user=user,
description=NEVER_USED_DESCRIPTION)
review_request.extra_data['p2rb.discard_on_publish_rids'] = '[]'
review_request.extra_data['p2rb.unpublished_rids'] = '[]'
review_request.save()
def on_draft_pre_delete(sender, instance, using, **kwargs):
""" Handle draft discards.
There are no handy signals built into Review Board (yet) for us to detect
when a squashed Review Request Draft is discarded. Instead, we monitor for
deletions of models, and handle cases where the models being deleted are
ReviewRequestDrafts. We then do some processing to ensure that the draft
is indeed a draft of a squashed review request that we want to handle,
and then propagate the discard down to the child review requests.
"""
if not sender == ReviewRequestDraft:
return
# Drafts can get deleted for a number of reasons. They get deleted when
# drafts are discarded, obviously, but also whenever review requests are
# published, because the data gets copied over to the review request, and
# then the draft is blown away. Unfortunately, on_pre_delete doesn't give
# us too many clues about which scenario we're in, so we have to infer it
# based on other things attached to the model. This is a temporary fix
# until we get more comprehensive draft deletion signals built into Review
# Board.
#
# In the case where the review request is NOT public yet, the draft will
# not have a change description. In this case, we do not need to
# differentiate between publish and discard because discards of non-public
# review request's drafts will always cause the review request to be closed
# as discarded, and this case is handled by on_review_request_closed().
#
# In the case where the review request has a change description, but it's
# set to public, we must have just published this draft before deleting it,
# so there's nothing to do here.
if (instance.changedesc is None or instance.changedesc.public):
return
review_request = instance.review_request
if not review_request:
return
commit_data = fetch_commit_data(review_request)
if not is_parent(review_request, commit_data):
return
# If the review request is marked as discarded, then we must be closing
# it, and so the on_review_request_closed() handler will take care of it.
if review_request.status == ReviewRequest.DISCARDED:
return
user = review_request.submitter
for child in gen_child_rrs(review_request, commit_data=commit_data):
draft = child.get_draft()
if draft:
draft.delete()
for child in gen_rrs_by_extra_data_key(review_request,
UNPUBLISHED_KEY,
commit_data=commit_data):
child.close(ReviewRequest.DISCARDED,
user=user,
description=NEVER_USED_DESCRIPTION)
commit_data.extra_data[DISCARD_ON_PUBLISH_KEY] = '[]'
commit_data.extra_data[UNPUBLISHED_KEY] = '[]'
commit_data.save(update_fields=['extra_data'])
