Skip to content

Locate inline call sites lexically rather than by text search #736

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
SimonCropp merged 1 commit into from
Aug 10, 2026
Merged

Locate inline call sites lexically rather than by text search #736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 46 additions & 0 deletions src/DiffEngine.Tests/InlineApplierTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,52 @@ public async Task Utf16Preserved()
}
}

// The whole file is rewritten, not just the patched span, so a byte that does not decode
// would come back as a replacement character everywhere it appears
[Test]
public async Task NonUtf8FileIsRefused()
{
byte[] bytes =
[
.. Utf8("class C\n{\n // caf", bom: false),
0xE9, // é in Latin-1, not valid UTF-8
.. Utf8("\n void M() => Verify(value).Snapshot(\"old\");\n}", bom: false)
];
var path = WriteTemp(bytes);
try
{
var result = InlineApplier.Apply(new(path, 4, "\"old\"", "new"));

await Assert.That(result.Status).IsEqualTo(InlineApplyStatus.Failed);
await Assert.That(result.Message!).Contains("Convert it to UTF-8");
await Assert.That((await File.ReadAllBytesAsync(path)).SequenceEqual(bytes)).IsTrue();
}
finally
{
File.Delete(path);
}
}

[Test]
public async Task NonAsciiUtf8IsPreserved()
{
var text = "class C\n{\n // café ☕\n void M() => Verify(value).Snapshot(\"old\");\n}";
var path = WriteTemp(Utf8(text, bom: false));
try
{
var result = InlineApplier.Apply(new(path, 4, "\"old\"", "naïve ☕"));

await Assert.That(result.Status).IsEqualTo(InlineApplyStatus.Applied);
var after = await File.ReadAllTextAsync(path);
await Assert.That(after).Contains("// café ☕");
await Assert.That(after).Contains("naïve ☕");
}
finally
{
File.Delete(path);
}
}

[Test]
public async Task CrlfPreserved()
{
Expand Down
242 changes: 242 additions & 0 deletions src/DiffEngine.Tests/InlinePatcherTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -652,4 +652,246 @@ public async Task SingleLineFileWithNoNewlines()
await Assert.That(newSource).Contains("new");
await Assert.That(newSource).DoesNotContain("\"old\"");
}

// The verify argument is the same text as the snapshot, and comes first on the line
[Test]
public async Task SameLiteralInTheVerifyArgumentIsNotPatched()
{
var source = Method(" await Verify(\"same\").Snapshot(\"same\");");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Set, "\"same\"", "changed", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains("await Verify(\"same\").Snapshot(\"\"\"");
await Assert.That(newSource).Contains("changed");
}

// The expression search must match a whole argument, not the quoted part of a longer literal
[Test]
public async Task PrefixedLiteralIsNotPatchedThroughItsQuote()
{
var source = Method(" await Verify(x).Snapshot(@\"old\");");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Set, "\"old\"", "new", out _, out var reason);

await Assert.That(status).IsEqualTo(PatchStatus.NotFound);
await Assert.That(reason).Contains("Re-run the test");
}

[Test]
public async Task SuffixedLiteralIsNotPatchedThroughItsQuote()
{
var source = Method(" await Verify(x).Snapshot(\"old\"u8);");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Set, "\"old\"", "new", out _, out var reason);

await Assert.That(status).IsEqualTo(PatchStatus.NotFound);
await Assert.That(reason).Contains("not a string literal");
}

[Test]
public async Task CommentedOutCallIsSkipped()
{
var source = string.Join(
"\n",
"class Tests",
"{",
" // await Verify(x).Snapshot(\"doc example\");",
" async Task Test() =>",
" await Verify(x).Snapshot();",
"}");

var status = InlinePatcher.TryApply(source, 3, InlinePatchMode.Set, null, "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains(" // await Verify(x).Snapshot(\"doc example\");\n");
await Assert.That(newSource).Contains(" await Verify(x).Snapshot(\"\"\"");
}

[Test]
public async Task CallInsideAStringIsSkipped()
{
var source = Method(
" var text = \"await Snapshot(\\\"x\\\")\";\n" +
" await Verify(x).Snapshot();");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Set, null, "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains("var text = \"await Snapshot(\\\"x\\\")\";\n");
await Assert.That(newSource).Contains("await Verify(x).Snapshot(\"\"\"");
}

// A declaration is a name followed by parens too, so it has to be told apart by what precedes it
[Test]
public async Task SnapshotDeclarationIsNotMistakenForACall()
{
var source = string.Join(
"\n",
"static class Extensions",
"{",
" public static Task Snapshot(this Task task, string? expected = null) =>",
" task;",
"}");

var status = InlinePatcher.TryApply(source, 3, InlinePatchMode.Set, null, "new", out _, out var reason);

await Assert.That(status).IsEqualTo(PatchStatus.NotFound);
await Assert.That(reason).Contains("Could not find a Snapshot call");
}

[Test]
public async Task AppendSkipsAVerifyPrefixedDeclaration()
{
var source = string.Join(
"\n",
"class Tests",
"{",
" Task VerifyThing(string value) => Verify(value);",
"}");

var status = InlinePatcher.TryApply(source, 3, InlinePatchMode.Append, null, "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains(
" Task VerifyThing(string value) => Verify(value)\n" +
" .Snapshot(\"\"\"");
}

// Snapshot terminates the chain, so a comment in the middle of one must not end the walk
[Test]
public async Task AppendGoesAfterACommentInTheChain()
{
var source = Method(
" await Verify(value) // note\n" +
" .UseDirectory(\"snapshots\");");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Append, null, "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains(
" .UseDirectory(\"snapshots\")\n" +
" .Snapshot(\"\"\"");
}

[Test]
public async Task LiteralInACommentIsNotPatched()
{
var source = Method(
" // was \"old\"\n" +
" await Verify(x).Snapshot(\"old\");");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Set, "\"old\"", "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains("// was \"old\"\n");
await Assert.That(newSource).Contains("Snapshot(\"\"\"");
}

[Test]
public async Task LiteralInAnotherMethodIsNotPatched()
{
var source = string.Join(
"\n",
"class Tests",
"{",
" void Helper() => Log(\"old\");",
"",
" async Task Test() =>",
" await Verify(x).Snapshot(\"old\");",
"}");

var status = InlinePatcher.TryApply(source, 3, InlinePatchMode.Set, "\"old\"", "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains("void Helper() => Log(\"old\");");
await Assert.That(newSource).Contains("Snapshot(\"\"\"");
}

// The empty literal is two characters, and the opening of every raw literal holds a pair
[Test]
public async Task EmptyOriginalIsNotMatchedInsideARawDelimiter()
{
var source = string.Join(
"\n",
"class Tests",
"{",
" Task A() =>",
" Verify(a).Snapshot(\"\"\"",
" content",
" \"\"\");",
"",
" Task B() =>",
" Verify(b).Snapshot(\"\");",
"}");

var status = InlinePatcher.TryApply(source, 7, InlinePatchMode.Set, "\"\"", "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains(" content\n \"\"\");");
await Assert.That(newSource).Contains("Verify(b).Snapshot(\"\"\"\n new\n \"\"\");");
}

[Test]
public async Task GenericSnapshotCall()
{
var source = Method(" await Verify(x).Snapshot<Thing>();");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Set, null, "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains(".Snapshot<Thing>(\"\"\"");
}

[Test]
public async Task AppendToAGenericVerify()
{
var source = Method(" await Verify<Thing>(value);");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Append, null, "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains("await Verify<Thing>(value)\n .Snapshot(\"\"\"");
}

[Test]
public async Task CommentInTheArgumentListIsNotTheArgument()
{
var source = Method(" await Verify(x).Snapshot(/* keep */);");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Set, null, "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains("Snapshot(/* keep */\"\"\"");
}

[Test]
public async Task CommentAfterTheArgumentIsKept()
{
var source = Method(" await Verify(x).Snapshot(\"old\" /* why */);");

var status = InlinePatcher.TryApply(source, 5, InlinePatchMode.Set, "\"old\"", "new", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).Contains("\"\"\" /* why */);");
}

// Pulling the call up onto the line above would take the semicolon into the comment
[Test]
public async Task RemoveLeavesALineCommentAboveIntact()
{
var source = Method(
" await Verify(value)\n" +
" // note\n" +
" .Snapshot(\"old\");");

var status = InlinePatcher.TryApply(source, 7, InlinePatchMode.Remove, null, "", out var newSource, out _);

await Assert.That(status).IsEqualTo(PatchStatus.Applied);
await Assert.That(newSource).IsEqualTo(
Method(
" await Verify(value)\n" +
" // note\n" +
" ;"));
}
}
Loading
Loading