Summary

Add formal storage of symlink targets when parsing diffs.

Review Request #12066 — Created Feb. 20, 2022 and submitted Feb. 21, 2022, 7:10 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-4.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

ParsedDiffFile and FileDiff both contained information on whether a
file was a symlink, but nothing more than that. There was no information
on targets, meaning that it was up to the diff implementation and
patch to generate a suitable symlink for display or when applying a
patch. This wasn't ideal.

ParsedDiffFile now contains typed attributes for old and new symlink
targets. These are optional, but can be set by the diff parser. The
DiffX parser is currently the only one that sets these.

FileDiff provides attributes for getting or setting all symlink state.
These are is_symlink, old_symlink_target, and new_symlink_target.
These all wrap extra_data, giving us a formal way of working with
these attributes.

An upcoming SCM will need thess. A separate upcoming change will enable
this support for Git (and Mercurial by extension). Eventually, we'll be
able to use these to avoid some hacks we're currently using to render
symlink changes in diffs.

This will also be useful for Review Bot and RBTools, which will benefit
from being able to know how to correctly manage symlinks.

Testing Done

Unit tests pass.

Commits

Summary	ID
Add formal storage of symlink targets when parsing diffs. `ParsedDiffFile` and `FileDiff` both contained information on whether a file was a symlink, but nothing more than that. There was no information on targets, meaning that it was up to the diff implementation and `patch` to generate a suitable symlink for display or when applying a patch. This wasn't ideal. `ParsedFileDiff` now contains typed attributes for old and new symlink targets. These are optional, but can be set by the diff parser. The DiffX parser is currently the only one that sets these. `FileDiff` provides attributes for getting or setting all symlink state. These are `is_symlink`, `old_symlink_target`, and `new_symlink_target`. These all wrap `extra_data`, giving us a formal way of working with these attributes. An upcoming SCM will need thess. A separate upcoming change will enable this support for Git (and Mercurial by extension). Eventually, we'll be able to use these to avoid some hacks we're currently using to render symlink changes in diffs. This will also be useful for Review Bot and RBTools, which will benefit from being able to know how to correctly manage symlinks.	c72f8aeb64c60920357e5e84098449f7cc8d86f8

Summary

Add formal storage of symlink targets when parsing diffs.

`ParsedDiffFile` and `FileDiff` both contained information on whether a file was a symlink, but nothing more than that. There was no information on targets, meaning that it was up to the diff implementation and `patch` to generate a suitable symlink for display or when applying a patch. This wasn't ideal. `ParsedFileDiff` now contains typed attributes for old and new symlink targets. These are optional, but can be set by the diff parser. The DiffX parser is currently the only one that sets these. `FileDiff` provides attributes for getting or setting all symlink state. These are `is_symlink`, `old_symlink_target`, and `new_symlink_target`. These all wrap `extra_data`, giving us a formal way of working with these attributes. An upcoming SCM will need thess. A separate upcoming change will enable this support for Git (and Mercurial by extension). Eventually, we'll be able to use these to avoid some hacks we're currently using to render symlink changes in diffs. This will also be useful for Review Bot and RBTools, which will benefit from being able to know how to correctly manage symlinks.

c72f8aeb64c60920357e5e84098449f7cc8d86f8

Issues

Description	From	Last Updated
E122 continuation line missing indentation or outdented	reviewbot	Feb. 20, 2022, 1:32 a.m.
E122 continuation line missing indentation or outdented	reviewbot	Feb. 20, 2022, 3:29 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/diffviewer/tests/test_diffx_parser.py (Diff revision 1)
The issue has been dropped. Show all issues
```
E122 continuation line missing indentation or outdented
```

Change Summary:

Fixed some issues in new docstrings.

Commits:

	Summary	ID
	Add formal storage of symlink targets when parsing diffs. `ParsedFileDiff` and `FileDiff` both contained information on whether a file was a symlink, but nothing more than that. There was no information on targets, meaning that it was up to the diff implementation and `patch` to generate a suitable symlink for display or when applying a patch. This wasn't ideal. `ParsedFileDiff` now contains typed attributes for old and new symlink targets. These are optional, but can be set by the diff parser. The DiffX parser is currently the only one that sets these. `FileDiff` provides attributes for getting or setting all symlink state. These are `is_symlink`, `old_symlink_target`, and `new_symlink_target`. These all wrap `extra_data`, giving us a formal way of working with these attributes. An upcoming SCM will need thess. A separate upcoming change will enable this support for Git (and Mercurial by extension). Eventually, we'll be able to use these to avoid some hacks we're currently using to render symlink changes in diffs. This will also be useful for Review Bot and RBTools, which will benefit from being able to know how to correctly manage symlinks.	78a00e684d8faaed99ad7760423f9edd3f2a7ad2
	Add formal storage of symlink targets when parsing diffs. `ParsedFileDiff` and `FileDiff` both contained information on whether a file was a symlink, but nothing more than that. There was no information on targets, meaning that it was up to the diff implementation and `patch` to generate a suitable symlink for display or when applying a patch. This wasn't ideal. `ParsedFileDiff` now contains typed attributes for old and new symlink targets. These are optional, but can be set by the diff parser. The DiffX parser is currently the only one that sets these. `FileDiff` provides attributes for getting or setting all symlink state. These are `is_symlink`, `old_symlink_target`, and `new_symlink_target`. These all wrap `extra_data`, giving us a formal way of working with these attributes. An upcoming SCM will need thess. A separate upcoming change will enable this support for Git (and Mercurial by extension). Eventually, we'll be able to use these to avoid some hacks we're currently using to render symlink changes in diffs. This will also be useful for Review Bot and RBTools, which will benefit from being able to know how to correctly manage symlinks.	e07f58b77bcea51808d0941ccc92af108797d694

Diff:

Revision 2 (+1284 -80)

Show changes

	reviewboard/diffviewer/filediff_creator.py
	reviewboard/diffviewer/parser.py
	reviewboard/diffviewer/models/filediff.py
	reviewboard/diffviewer/testing/mixins.py
	reviewboard/diffviewer/tests/test_diffx_parser.py
	reviewboard/diffviewer/tests/test_filediff.py
	reviewboard/diffviewer/tests/test_filediff_creator.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/diffviewer/tests/test_diffx_parser.py (Diff revision 2)
The issue has been resolved. Show all issues
```
E122 continuation line missing indentation or outdented
```

Change Summary:


Fixed an indentation issue
Fixed the description to reference ParsedDiffFile rather than ParsedFileDiff.
Small updates to the DiffX parser to improve code organization.

Description:

~		`ParsedFileDiff` and `FileDiff` both contained information on whether a
	~	`ParsedDiffFile` and `FileDiff` both contained information on whether a
		file was a symlink, but nothing more than that. There was no information
		on targets, meaning that it was up to the diff implementation and
		`patch` to generate a suitable symlink for display or when applying a
		patch. This wasn't ideal.

~		`ParsedFileDiff` now contains typed attributes for old and new symlink
	~	`ParsedDiffFile` now contains typed attributes for old and new symlink
		targets. These are optional, but can be set by the diff parser. The
		DiffX parser is currently the only one that sets these.

		`FileDiff` provides attributes for getting or setting all symlink state.
		These are `is_symlink`, `old_symlink_target`, and `new_symlink_target`.
		These all wrap `extra_data`, giving us a formal way of working with
		these attributes.

		An upcoming SCM will need thess. A separate upcoming change will enable
		this support for Git (and Mercurial by extension). Eventually, we'll be
		able to use these to avoid some hacks we're currently using to render
		symlink changes in diffs.

		This will also be useful for Review Bot and RBTools, which will benefit
		from being able to know how to correctly manage symlinks.

Commits:

	Summary	ID
	Add formal storage of symlink targets when parsing diffs. `ParsedFileDiff` and `FileDiff` both contained information on whether a file was a symlink, but nothing more than that. There was no information on targets, meaning that it was up to the diff implementation and `patch` to generate a suitable symlink for display or when applying a patch. This wasn't ideal. `ParsedFileDiff` now contains typed attributes for old and new symlink targets. These are optional, but can be set by the diff parser. The DiffX parser is currently the only one that sets these. `FileDiff` provides attributes for getting or setting all symlink state. These are `is_symlink`, `old_symlink_target`, and `new_symlink_target`. These all wrap `extra_data`, giving us a formal way of working with these attributes. An upcoming SCM will need thess. A separate upcoming change will enable this support for Git (and Mercurial by extension). Eventually, we'll be able to use these to avoid some hacks we're currently using to render symlink changes in diffs. This will also be useful for Review Bot and RBTools, which will benefit from being able to know how to correctly manage symlinks.	e07f58b77bcea51808d0941ccc92af108797d694
	Add formal storage of symlink targets when parsing diffs. `ParsedDiffFile` and `FileDiff` both contained information on whether a file was a symlink, but nothing more than that. There was no information on targets, meaning that it was up to the diff implementation and `patch` to generate a suitable symlink for display or when applying a patch. This wasn't ideal. `ParsedFileDiff` now contains typed attributes for old and new symlink targets. These are optional, but can be set by the diff parser. The DiffX parser is currently the only one that sets these. `FileDiff` provides attributes for getting or setting all symlink state. These are `is_symlink`, `old_symlink_target`, and `new_symlink_target`. These all wrap `extra_data`, giving us a formal way of working with these attributes. An upcoming SCM will need thess. A separate upcoming change will enable this support for Git (and Mercurial by extension). Eventually, we'll be able to use these to avoid some hacks we're currently using to render symlink changes in diffs. This will also be useful for Review Bot and RBTools, which will benefit from being able to know how to correctly manage symlinks.	c72f8aeb64c60920357e5e84098449f7cc8d86f8

Diff:

Revision 3 (+1296 -84)

Show changes

	reviewboard/diffviewer/filediff_creator.py
	reviewboard/diffviewer/parser.py
	reviewboard/diffviewer/models/filediff.py
	reviewboard/diffviewer/testing/mixins.py
	reviewboard/diffviewer/tests/test_diffx_parser.py
	reviewboard/diffviewer/tests/test_filediff.py
	reviewboard/diffviewer/tests/test_filediff_creator.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-4.0.x (c758bb7)