Add closing/reopening signals
Review Request #7407 — Created June 11, 2015 and submitted
Fire "review_request_closing" when attempting to close a review request.
If a signal receiver raises a CloseError abort the close operation.
This signal allows extensions to prevent a review request from being
closed. Alert the user in the UI when a close request has failed.Also introduce a new "review_request_reopening" signal which behaves the
same way as the closing signal but deals with reopening review requests.These new signals expand upon publishing signals that were previously
added to allow extensions control over publishing - see commit
ab84ccdf3d5bb883f18d34133c30af410c7ff1d2.Documentation for the new WebAPI errorss have been added to the manual.
NB: This work is just some minor fixups of work done by Steven MacLeod.
Wrote a dummy extension to raise the new errors inside of the new
signals - API requests were properly blocked and the error messages
were alerted to the user.Compared change description behaviour to Review Board without this
change and observed it to be unchanged after the patch.Built and looked at the docs.
- Change Summary:
-
Fix typo
- Commit:
-
d8c9cb00e92ec0326833fbb81fe18179cd5102b31d4d28f11502371f67a880b770d8929cad092e35
-
Tool: Pyflakes Processed Files: reviewboard/webapi/resources/review_request.py reviewboard/webapi/errors.py reviewboard/reviews/signals.py reviewboard/reviews/errors.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/views/reviewRequestEditorView.js Tool: PEP8 Style Checker Processed Files: reviewboard/webapi/resources/review_request.py reviewboard/webapi/errors.py reviewboard/reviews/signals.py reviewboard/reviews/errors.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/views/reviewRequestEditorView.js
- Change Summary:
-
Address Christian's issues.
- Commit:
-
1d4d28f11502371f67a880b770d8929cad092e351f6a97cf65d37aba2d41d66e19b825b480cc6dfb
-
Tool: Pyflakes Processed Files: reviewboard/webapi/resources/review_request.py reviewboard/webapi/errors.py reviewboard/reviews/signals.py reviewboard/reviews/errors.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/views/reviewRequestEditorView.js Tool: PEP8 Style Checker Processed Files: reviewboard/webapi/resources/review_request.py reviewboard/webapi/errors.py reviewboard/reviews/signals.py reviewboard/reviews/errors.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/views/reviewRequestEditorView.js
-
Oh, one last thing I almost forgot. Can you add the doc files for these new errors in docs/manual/webapi/2.0/errors?
- Description:
-
Fire "review_request_closing" when attempting to close a review request.
If a signal receiver raises a CloseError abort the close operation. This signal allows extensions to prevent a review request from being closed. Alert the user in the UI when a close request has failed. Also introduce a new "review_request_reopening" signal which behaves the
same way as the closing signal but deals with reopening review requests. These new signals expand upon publishing signals that were previously
added to allow extensions control over publishing - see commit ~ ab84ccdf3d5bb883f18d34133c30af410c7ff1d2 ~ ab84ccdf3d5bb883f18d34133c30af410c7ff1d2. ~ NB: This work is just some minor fixups of work done by Steven MacLeod
~ Documentation for the new WebAPI errorss have been added to the manual.
+ + NB: This work is just some minor fixups of work done by Steven MacLeod.
- Testing Done:
-
Wrote a dummy extension to raise the new errors inside of the new
signals - API requests were properly blocked and the error messages were alerted to the user. Compared change description behaviour to Review Board without this
change and observed it to be unchanged after the patch. + + Built and looked at the docs.
- Commit:
-
1f6a97cf65d37aba2d41d66e19b825b480cc6dfb875b8f04ccc17928b107c41a9e8e3c3b466ccfbf
- Diff:
-
Revision 4 (+185 -71)
-
Tool: Pyflakes Processed Files: reviewboard/webapi/resources/review_request.py reviewboard/webapi/errors.py reviewboard/reviews/signals.py reviewboard/reviews/errors.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/views/reviewRequestEditorView.js docs/manual/webapi/2.0/errors/230-close-error.rst docs/manual/webapi/2.0/errors/231-reopen-error.rst docs/manual/webapi/2.0/errors/index.rst Tool: PEP8 Style Checker Processed Files: reviewboard/webapi/resources/review_request.py reviewboard/webapi/errors.py reviewboard/reviews/signals.py reviewboard/reviews/errors.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/views/reviewRequestEditorView.js docs/manual/webapi/2.0/errors/230-close-error.rst docs/manual/webapi/2.0/errors/231-reopen-error.rst docs/manual/webapi/2.0/errors/index.rst
Tool: Pyflakes Processed Files: reviewboard/webapi/resources/review_request.py reviewboard/webapi/errors.py reviewboard/reviews/signals.py reviewboard/reviews/errors.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/views/reviewRequestEditorView.js Tool: PEP8 Style Checker Processed Files: reviewboard/webapi/resources/review_request.py reviewboard/webapi/errors.py reviewboard/reviews/signals.py reviewboard/reviews/errors.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/views/reviewRequestEditorView.js