Summary

Enhance the diff file attachment resource a bit.

Review Request #13603 — Created March 4, 2024 and submitted March 26, 2024, 10:16 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-7.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This change makes two enhancements to the diff file attachment resource.

First, a new source_file argument allows uploading a file for the source
version of the FileDiff. In most cases we can allow the server to fetch
it from the repository, but in the case where there's a parent diff, the
uploading client needs to provide both the source and modified versions.

Second, I did run into a case where I successfully uploaded two files
for the same FileDiff, which caused errors later on. A new API error has
been added for this case.

Testing Done


Ran unit tests.
Posted binary file changes that used a parent diff and successfully

  uploaded both the source and modified versions.

Commits

Summary	ID
Enhance the diff file attachment resource a bit. This change makes two enhancements to the diff file attachment resource. First, a new source_file argument allows uploading a file for the source version of the FileDiff. In most cases we can allow the server to fetch it from the repository, but in the case where there's a parent diff, the uploading client needs to provide both the source and modified versions. Second, I did run into a case where I successfully uploaded two files for the same FileDiff, which caused errors later on. A new API error has been added for this case. Testing Done: - Ran unit tests. - Posted binary file changes that used a parent diff and successfully uploaded both the source and modified versions.	c758222eb441e6b6c36473de0e0e547aaaa72f97

Summary

Enhance the diff file attachment resource a bit.

This change makes two enhancements to the diff file attachment resource. First, a new source_file argument allows uploading a file for the source version of the FileDiff. In most cases we can allow the server to fetch it from the repository, but in the case where there's a parent diff, the uploading client needs to provide both the source and modified versions. Second, I did run into a case where I successfully uploaded two files for the same FileDiff, which caused errors later on. A new API error has been added for this case. Testing Done: - Ran unit tests. - Posted binary file changes that used a parent diff and successfully uploaded both the source and modified versions.

c758222eb441e6b6c36473de0e0e547aaaa72f97

Issues

Description	From	Last Updated
Can we make this keyword-only? (Ideally both, but at least this one.)	chipx86	March 4, 2024, 3:39 p.m.
This is missing a return value.	chipx86	March 4, 2024, 3:39 p.m.
Should state that these are now keyword-only.	chipx86	March 4, 2024, 4:34 p.m.
We should add version info here and in the method's docstring.	chipx86	March 4, 2024, 3:40 p.m.
This is missing version info.	chipx86	March 4, 2024, 3:40 p.m.
This is set above as modified.	chipx86	March 4, 2024, 3:40 p.m.

flake8 passed.

JSHint passed.

reviewboard/attachments/forms.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we make this keyword-only? (Ideally both, but at least this one.)
```
reviewboard/attachments/forms.py (Diff revision 1)
The issue has been resolved. Show all issues
```
This is missing a return value.
```
reviewboard/attachments/forms.py (Diff revision 1)
The issue has been resolved. Show all issues
```
We should add version info here and in the method's docstring.
```

reviewboard/webapi/resources/diff_file_attachment.py (Diff revision 1)

The issue has been resolved. Show all issues

This is missing version info.

reviewboard/webapi/resources/diff_file_attachment.py (Diff revision 1)
The issue has been resolved. Show all issues
```
This is set above as modified.
```

Commits:

	Summary	ID
	Enhance the diff file attachment resource a bit. This change makes two enhancements to the diff file attachment resource. First, a new source_file argument allows uploading a file for the source version of the FileDiff. In most cases we can allow the server to fetch it from the repository, but in the case where there's a parent diff, the uploading client needs to provide both the source and modified versions. Second, I did run into a case where I successfully uploaded two files for the same FileDiff, which caused errors later on. A new API error has been added for this case. Testing Done: - Ran unit tests. - Posted binary file changes that used a parent diff and successfully uploaded both the source and modified versions.	3831748b76c4e27268f1ce38fe1a6dd5dd61ee31
	Enhance the diff file attachment resource a bit. This change makes two enhancements to the diff file attachment resource. First, a new source_file argument allows uploading a file for the source version of the FileDiff. In most cases we can allow the server to fetch it from the repository, but in the case where there's a parent diff, the uploading client needs to provide both the source and modified versions. Second, I did run into a case where I successfully uploaded two files for the same FileDiff, which caused errors later on. A new API error has been added for this case. Testing Done: - Ran unit tests. - Posted binary file changes that used a parent diff and successfully uploaded both the source and modified versions.	c758222eb441e6b6c36473de0e0e547aaaa72f97

Diff:

Revision 2 (+238 -14)

Show changes

	reviewboard/attachments/forms.py
	reviewboard/webapi/resources/diff_file_attachment.py
	reviewboard/webapi/resources/draft_filediff.py
	reviewboard/webapi/tests/test_diff_file_attachment.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

reviewboard/attachments/forms.py (Diff revisions 1 - 2)
The issue has been resolved. Show all issues
```
Should state that these are now keyword-only.
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.x (33fb5e9)