Summary

Change ReviewRequest.createFromCommit to return a promise.

Review Request #11632 — Created May 27, 2021 and submitted Dec. 3, 2021, 3:48 p.m.

Information

Owner

david

Repository

Review Board

Branch

master

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This change updates the post-commit review request creation method to

return a promise instead of using callbacks for success and error.

Testing Done


Ran js-tests.
Created a post-commit review request.

Commits

Summary	ID
Change ReviewRequest.createFromCommit to return a promise. This change updates the post-commit review request creation method to return a promise instead of using callbacks for success and error. Testing Done: - Ran js-tests. - Created a post-commit review request.	d63d650176739c578c24bf16243b4c1eadb186d2

Issues

Description	From	Last Updated
Col: 44 'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').	reviewbot	May 27, 2021, 1:09 p.m.
Col: 27 'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').	reviewbot	May 27, 2021, 1:09 p.m.
Col: 44 'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').	reviewbot	May 27, 2021, 1:09 p.m.
The description went missing.	chipx86	Oct. 13, 2021, 10 a.m.

flake8 passed.

JSHint failed.

JSHint

reviewboard/static/rb/js/resources/models/reviewRequestModel.es6.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 44
 'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').
```
reviewboard/static/rb/js/resources/models/reviewRequestModel.es6.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 27
 'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').
```
reviewboard/static/rb/js/resources/models/reviewRequestModel.es6.js (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 44
 'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').
```

The code itself looks fine.
Before I jump into the other files, the thing we just really need to figure out is what we consider to be API-stable. While I have no idea which parts of the JS codebase are in use elsewhere, we do offer JavaScript extensions and those are in use extensively at some places. So I'm tempted to say we should avoid breaking function signatures wherever possible, especially in areas that interface with the API (like resources/).
The updates here remove options and replace it with a commitID argument. I'm fine with this, but if we do it, we should retain backwards-compatibility (check whether we have an object or a string) and go through a deprecation warning process like we do on the Python side.

Commits:

	Summary	ID
	Change ReviewRequest.createFromCommit to return a promise. This change updates the post-commit review request creation method to return a promise instead of using callbacks for success and error. Testing Done: - Ran js-tests. - Created a post-commit review request.	720e11e60f4948a00e6f6e93bb5c205fbccc1764
	Change ReviewRequest.createFromCommit to return a promise. This change updates the post-commit review request creation method to return a promise instead of using callbacks for success and error. Testing Done: - Ran js-tests. - Created a post-commit review request.	efa54a820be84bc5c59484b3186ce53e298cb8a7

Diff:

Revision 2 (+584 -484)

Show changes

	reviewboard/static/rb/js/newReviewRequest/views/postCommitView.es6.js
	reviewboard/static/rb/js/resources/models/reviewRequestModel.es6.js
	reviewboard/static/rb/js/resources/models/tests/reviewRequestModelTests.es6.js

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/static/rb/js/resources/models/reviewRequestModel.es6.js (Diff revision 2)
The issue has been resolved. Show all issues
```
The description went missing.
```

Commits:

	Summary	ID
	Change ReviewRequest.createFromCommit to return a promise. This change updates the post-commit review request creation method to return a promise instead of using callbacks for success and error. Testing Done: - Ran js-tests. - Created a post-commit review request.	efa54a820be84bc5c59484b3186ce53e298cb8a7
	Change ReviewRequest.createFromCommit to return a promise. This change updates the post-commit review request creation method to return a promise instead of using callbacks for success and error. Testing Done: - Ran js-tests. - Created a post-commit review request.	d63d650176739c578c24bf16243b4c1eadb186d2

Diff:

Revision 3 (+584 -482)

Show changes

	reviewboard/static/rb/js/newReviewRequest/views/postCommitView.es6.js
	reviewboard/static/rb/js/resources/models/reviewRequestModel.es6.js
	reviewboard/static/rb/js/resources/models/tests/reviewRequestModelTests.es6.js

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (0a0932b)