Skip to content

POC: Ast Merging and Scoped Cache Invalidation #2980

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

Draft
dantleech wants to merge 13 commits into
base: master
Choose a base branch
from
Draft

POC: Ast Merging and Scoped Cache Invalidation #2980

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
bc42d76
Ast Merging
dantleech Dec 6, 2025
94066b9
Sanity test for merging parser
dantleech Dec 7, 2025
263cea9
Failing test
dantleech Dec 7, 2025
9030385
Argh
dantleech Dec 7, 2025
6f773d2
It's in some kind of working state
dantleech Dec 7, 2025
6c13a82
Nope
dantleech Dec 7, 2025
da77a89
Parser still not working
dantleech Dec 7, 2025
946503e
Failing test
dantleech Dec 7, 2025
ce5774d
Seems to work
dantleech Dec 7, 2025
51b68d8
Update diff test for shortcut
dantleech Dec 7, 2025
4bce110
Add debug node ID
dantleech Dec 7, 2025
74366da
Get full text
dantleech Dec 7, 2025
3a8f0d0
Refactor test to simulate session
dantleech Dec 7, 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
Prev Previous commit
Next Next commit
Sanity test for merging parser
  • Loading branch information
@dantleech
dantleech committed Dec 7, 2025
commit 94066b9f93eedcef42eeda786c4af97ddcb353f7
9 changes: 4 additions & 5 deletions lib/TolerantAstDiff/AstDiff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@
use Microsoft\PhpParser\Token;
use Phpactor\TextDocument\TextEdit;
use Phpactor\TextDocument\TextEdits;
use ReflectionClass;
use ReflectionProperty;
use RuntimeException;
use function Amp\Promise\wait;

final class AstDiff
{
private SourceFileNode $fileSource1;

private SourceFileNode $fileSource2;

public function merge(Node $node1, Node $node2): void
Expand Down Expand Up @@ -182,9 +180,10 @@ private function applyEdit(Node $node, TextEdit $edit): void
private function mapNode(Node $node1, Node $node2): void
{
if ($node2::class !== $node1::class) {
throw new \RuntimeException(sprintf(
throw new RuntimeException(sprintf(
'Can only map nodes of the same type to eachother, got %s and %s',
$node2::class, $node1::class
$node2::class,
$node1::class
));
}

Expand Down
25 changes: 25 additions & 0 deletions lib/TolerantAstDiff/Tests/Unit/AstDiffTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,30 @@ public function baz()
}
PHP
];

yield 'intoduce new line' => [
<<<'PHP'
<?php
class Foo
{
public function bar()
{
echo 'foobar';
}
}
PHP,
<<<'PHP'
<?php
class Foo
{
public function bar()
{


echo 'foobar';
}
}
PHP
];
}
}
41 changes: 41 additions & 0 deletions lib/WorseReflection/Bridge/TolerantParser/Parser/MergingParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?php

namespace Phpactor\WorseReflection\Bridge\TolerantParser\Parser;

use Microsoft\PhpParser\Node;
use Microsoft\PhpParser\Node\SourceFileNode;
use Microsoft\PhpParser\Parser;
use Phpactor\TolerantAstDiff\AstDiff;
use Phpactor\WorseReflection\Core\CacheForDocument;

class MergingParser extends Parser
{
/**
* @var array<string,SourceFileNode>
*/
private $documents = [];

public function __construct(
private AstDiff $merger
) {
parent::__construct();
}

public function parseSourceFile(string $source, ?string $uri = null): SourceFileNode
{
if (null === $uri) {
return parent::parseSourceFile($source);
}
if (!isset($this->documents[$uri])) {

@dantleech dantleech Dec 7, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

we should probably, for now, use a Ttl caching mechanism, but should use the #2882

$node = parent::parseSourceFile($source);
$this->documents[$uri] = $node;
return $node;
}

$node1 = $this->documents[$uri];
$node2 = parent::parseSourceFile($source);

$this->merger->merge($node1, $node2);
return $node1;
}
}
61 changes: 61 additions & 0 deletions lib/WorseReflection/Tests/Unit/Bridge/TolerantParser/Parser/MergingParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<?php

namespace Phpactor\WorseReflection\Tests\Unit\Bridge\TolerantParser\Parser;

use Microsoft\PhpParser\Node\Statement\EchoStatement;
use PHPUnit\Framework\TestCase;
use Phpactor\TolerantAstDiff\AstDiff;
use Phpactor\WorseReflection\Bridge\TolerantParser\Parser\MergingParser;

class MergingParserTest extends TestCase
{
public function testUpdate(): void
{
$parser = new MergingParser(new AstDiff());

$ast = $parser->parseSourceFile(<<<'PHP'
<?php
function a() {
if (true) {
echo 'hello';
echo 'goodbye';
}
if (true) {
echo 'coming';
echo 'going';
}
}
PHP, 'file://path');

$node = $ast->getDescendantNodeAtPosition(46);
self::assertInstanceOf(EchoStatement::class, $node);
$node1OriginalId = spl_object_id($node);
$node = $ast->getDescendantNodeAtPosition(114);
self::assertInstanceOf(EchoStatement::class, $node);
$node2OriginalId = spl_object_id($node);

// new source code introduces new line between the two nodes
$ast = $parser->parseSourceFile(<<<'PHP'
<?php
function a() {
if (true) {
echo 'hello';
echo 'goodbye';
}


if (true) {
echo 'coming';
echo 'going';
}
}
PHP, 'file://path');

$node = $ast->getDescendantNodeAtPosition(46);
self::assertInstanceOf(EchoStatement::class, $node);
self::assertSame($node1OriginalId, spl_object_id($node));
$node = $ast->getDescendantNodeAtPosition(115);
self::assertInstanceOf(EchoStatement::class, $node);
self::assertEquals($node2OriginalId, spl_object_id($node));
}
}