Skip to content

fix error with empty index by including raw information in diff #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lyrixx merged 3 commits into from
Jan 29, 2025
Merged

fix error with empty index by including raw information in diff #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9a0135
fix error with empty index by including raw information in diff
Patrick-Beuks Jan 7, 2025
e7a6ac1
fix style error
Patrick-Beuks Jan 7, 2025
a640c6e
Merge branch 'main' into fix-empty-index
Patrick-Beuks Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Gitonomy/Git/Commit.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public function setData(array $data)
*/
public function getDiff()
{
$args = ['-r', '-p', '-m', '-M', '--no-commit-id', '--full-index', $this->revision];
$args = ['-r', '-p', '--raw', '-m', '-M', '--no-commit-id', '--full-index', $this->revision];

$diff = Diff::parse($this->repository->run('diff-tree', $args));
$diff->setRepository($this->repository);
Expand Down
8 changes: 8 additions & 0 deletions src/Gitonomy/Git/Diff/File.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,10 @@ public function getOldBlob()
throw new \LogicException('Can\'t return old Blob on a creation');
}

if ($this->oldIndex === '') {
throw new \RuntimeException('Index is missing to return Blob object.');
}

return $this->repository->getBlob($this->oldIndex);
}

Expand All @@ -291,6 +295,10 @@ public function getNewBlob()
throw new \LogicException('Can\'t return new Blob on a deletion');
}

if ($this->newIndex === '') {
throw new \RuntimeException('Index is missing to return Blob object.');
}

return $this->repository->getBlob($this->newIndex);
}
}
21 changes: 19 additions & 2 deletions src/Gitonomy/Git/Parser/DiffParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,31 @@ class DiffParser extends ParserBase
protected function doParse()
{
$this->files = [];
$indexes = [];
// Diff contains raw information
if (str_starts_with($this->content, ':')) {
while ($this->expects(':')) {
$this->consumeRegexp('/\d{6} \d{6} /');
$oldIndex = $this->consumeShortHash();
$this->consume(' ');
$newIndex = $this->consumeShortHash();
$this->consumeTo("\n");
$this->consumeNewLine();
$indexes[] = [$oldIndex, $newIndex];
}
$this->consumeNewLine();
} elseif (!$this->isFinished()) {
trigger_error('Using Diff::parse without raw information is deprecated. See https://github.com/gitonomy/gitlib/issues/227.', E_USER_DEPRECATED);
Copy link

@veewee veewee Dec 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello there @Patrick-Beuks @lyrixx,

I'm just wondering:

Would this actually have to result in a deprecation warning?
For other tools using the DiffParser (like grumphp), we don't really care much about the raw index data.

See phpro/grumphp#1199

Copy link
Contributor Author

@Patrick-Beuks Patrick-Beuks Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are edge cases for parsing the diff that would result in an incorrect parse, not finding changed files, see issue #227.
I will check the use case as you described in your ticket to see if you would have hit the same edge cases tomorrow.

}

$fileIndex = 0;
while (!$this->isFinished()) {
// 1. title
$vars = $this->consumeRegexp("/diff --git \"?(a\/.*?)\"? \"?(b\/.*?)\"?\n/");
$oldName = $vars[1];
$newName = $vars[2];
$oldIndex = null;
$newIndex = null;
$oldIndex = isset($indexes[$fileIndex]) ? $indexes[$fileIndex][0] : null;
$newIndex = isset($indexes[$fileIndex]) ? $indexes[$fileIndex][1] : null;
$oldMode = null;
$newMode = null;

Expand Down
2 changes: 1 addition & 1 deletion src/Gitonomy/Git/Repository.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ public function getDiff($revisions)
$revisions = new RevisionList($this, $revisions);
}

$args = array_merge(['-r', '-p', '-m', '-M', '--no-commit-id', '--full-index'], $revisions->getAsTextArray());
$args = array_merge(['-r', '-p', '--raw', '-m', '-M', '--no-commit-id', '--full-index'], $revisions->getAsTextArray());

$diff = Diff::parse($this->run('diff', $args));
$diff->setRepository($this);
Expand Down
4 changes: 2 additions & 2 deletions src/Gitonomy/Git/WorkingCopy.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ public function getUntrackedFiles()

public function getDiffPending()
{
$diff = Diff::parse($this->run('diff', ['-r', '-p', '-m', '-M', '--full-index']));
$diff = Diff::parse($this->run('diff', ['-r', '-p', '--raw', '-m', '-M', '--full-index']));
$diff->setRepository($this->repository);

return $diff;
}

public function getDiffStaged()
{
$diff = Diff::parse($this->run('diff', ['-r', '-p', '-m', '-M', '--full-index', '--staged']));
$diff = Diff::parse($this->run('diff', ['-r', '-p', '--raw', '-m', '-M', '--full-index', '--staged']));
$diff->setRepository($this->repository);

return $diff;
Expand Down
109 changes: 109 additions & 0 deletions tests/Gitonomy/Git/Tests/DiffTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
namespace Gitonomy\Git\Tests;

use Gitonomy\Git\Diff\Diff;
use Gitonomy\Git\Diff\File;
use Gitonomy\Git\Repository;

class DiffTest extends AbstractTest
{
Expand Down Expand Up @@ -151,6 +153,113 @@ public function testWorksWithUmlauts($repository)
$this->assertSame('file_with_umlauts_\303\244\303\266\303\274', $files[0]->getNewName());
}

public function testDeleteFileWithoutRaw()
{
$deprecationCalled = false;
$self = $this;
set_error_handler(function (int $errno, string $errstr) use ($self, &$deprecationCalled): void {
$deprecationCalled = true;
$self->assertSame('Using Diff::parse without raw information is deprecated. See https://github.com/gitonomy/gitlib/issues/227.', $errstr);
}, E_USER_DEPRECATED);

$diff = Diff::parse(<<<'DIFF'
diff --git a/test b/test
deleted file mode 100644
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000

DIFF);
$firstFile = $diff->getFiles()[0];

restore_exception_handler();

$this->assertTrue($deprecationCalled);
$this->assertFalse($firstFile->isCreation());
// TODO: Enable after #226 is merged
//$this->assertTrue($firstFile->isDeletion());
//$this->assertFalse($firstFile->isChangeMode());
$this->assertSame('e69de29bb2d1d6434b8b29ae775ad8c2e48c5391', $firstFile->getOldIndex());
$this->assertNull($firstFile->getNewIndex());
}

public function testModeChangeFileWithoutRaw()
{
$deprecationCalled = false;
$self = $this;
set_error_handler(function (int $errno, string $errstr) use ($self, &$deprecationCalled): void {
$deprecationCalled = true;
$self->assertSame('Using Diff::parse without raw information is deprecated. See https://github.com/gitonomy/gitlib/issues/227.', $errstr);
}, E_USER_DEPRECATED);

$diff = Diff::parse(<<<'DIFF'
diff --git a/a.out b/a.out
old mode 100755
new mode 100644

DIFF);
$firstFile = $diff->getFiles()[0];

restore_exception_handler();

$this->assertTrue($deprecationCalled);
$this->assertFalse($firstFile->isCreation());
$this->assertFalse($firstFile->isDeletion());
$this->assertTrue($firstFile->isChangeMode());
$this->assertSame('', $firstFile->getOldIndex());
$this->assertSame('', $firstFile->getNewIndex());
}

public function testModeChangeFileWithRaw()
{
$deprecationCalled = false;
set_error_handler(function (int $errno, string $errstr) use (&$deprecationCalled): void {
$deprecationCalled = true;
}, E_USER_DEPRECATED);

$diff = Diff::parse(<<<'DIFF'
:100755 100644 d1af4b23d0cc9313e5b2d3ef2fb9696c94afaa81 d1af4b23d0cc9313e5b2d3ef2fb9696c94afaa81 M a.out

diff --git a/a.out b/a.out
old mode 100755
new mode 100644

DIFF);
$firstFile = $diff->getFiles()[0];

restore_exception_handler();

$this->assertFalse($deprecationCalled);
$this->assertFalse($firstFile->isCreation());
$this->assertFalse($firstFile->isDeletion());
$this->assertTrue($firstFile->isChangeMode());
$this->assertSame('d1af4b23d0cc9313e5b2d3ef2fb9696c94afaa81', $firstFile->getOldIndex());
$this->assertSame('d1af4b23d0cc9313e5b2d3ef2fb9696c94afaa81', $firstFile->getNewIndex());
}

public function testThrowErrorOnBlobGetWithoutIndex()
{
$repository = $this->getMockBuilder(Repository::class)->disableOriginalConstructor()->getMock();
$file = new File('oldName', 'newName', '100755', '100644', '', '', false);
$file->setRepository($repository);

try {
$file->getOldBlob();
} catch(\RuntimeException $exception) {
$this->assertSame('Index is missing to return Blob object.', $exception->getMessage());
}

try {
$file->getNewBlob();
} catch(\RuntimeException $exception) {
$this->assertSame('Index is missing to return Blob object.', $exception->getMessage());
}

$this->assertFalse($file->isCreation());
$this->assertFalse($file->isDeletion());
$this->assertTrue($file->isChangeMode());
$this->assertSame('', $file->getOldIndex());
$this->assertSame('', $file->getNewIndex());
}

public function testEmptyNewFile()
{
$diff = Diff::parse("diff --git a/test b/test\nnew file mode 100644\nindex 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391\n");
Expand Down