Skip to content

Commit f2f559d

Browse files
razzmatazzrazzmatazz
authored
Fix errors related to source generated-files (#190)
* tests/CSharpLanguageServer.Tests/Tooling.fs: copy in .cshtml files to the tmp project tree too * tests/CSharpLanguageServer.Tests/Tooling.fs: handle "error" responses from the client too * tests/CSharpLanguageServer.Tests/ReferenceTests.fs: add tests for testReferenceWorksToAspNetRazorPageReferencedValue * Fix an issue where some endpoints would file silently on projects using code generators. * CHANGELOG.md: update
1 parent bd0f4bf commit f2f559d

File tree

17 files changed

+284
-40
lines changed

17 files changed

+284
-40
lines changed

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
99
- By @granitrocky in https://github.com/razzmatazz/csharp-language-server/pull/189
1010
* Make sure textDocument/findReferences respects Context.IncludeDeclaration
1111
- https://github.com/razzmatazz/csharp-language-server/pull/199
12+
* Fix an issue where server would file on projects using code generators (like Asp.Net razor) on some of the endpoints:
13+
- https://github.com/razzmatazz/csharp-language-server/pull/190
14+
15+
**Full Changelog**: https://github.com/razzmatazz/csharp-language-server/compare/0.15.0...0.16.0
1216

1317
## [0.15.0] - 2024-08-15 / Šventoji
1418
* Upgrade Roslyn to 4.10.0:
1519
- https://github.com/razzmatazz/csharp-language-server/pull/182
1620
* Implement pull diagnostics for better performance;
1721
- https://github.com/razzmatazz/csharp-language-server/pull/174
1822

23+
**Full Changelog**: https://github.com/razzmatazz/csharp-language-server/compare/0.14.0...0.15.0
24+
1925
## [0.14.0] - 2024-06-23 / Palanga
2026
* Speed up completion by not showing name suggestions or items from unimported namespaces
2127
- https://github.com/razzmatazz/csharp-language-server/pull/168

‎src/CSharpLanguageServer/Conversions.fs

+31-15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
namespace CSharpLanguageServer.Conversions
22

33
open System
4+
open System.IO
45

56
open Microsoft.CodeAnalysis
67
open Microsoft.CodeAnalysis.Completion
@@ -67,13 +68,25 @@ module Range =
6768

6869

6970
module Location =
70-
let fromRoslynLocation (loc: Microsoft.CodeAnalysis.Location): Location =
71-
if loc.IsInSource then
72-
{ Uri = loc.SourceTree.FilePath |> Path.toUri
73-
Range = loc.GetLineSpan().Span |> Range.fromLinePositionSpan }
74-
else
75-
{ Uri = ""
76-
Range = { Start = { Line = 0u; Character = 0u }; End = { Line = 0u; Character = 0u } } }
71+
let fromRoslynLocation (loc: Microsoft.CodeAnalysis.Location): option<Location> =
72+
let toLspLocation (path: string) span: Location =
73+
{ Uri = path |> Path.toUri
74+
Range = span |> Range.fromLinePositionSpan }
75+
76+
match loc.Kind with
77+
| LocationKind.SourceFile ->
78+
let mappedLoc = loc.GetMappedLineSpan()
79+
80+
if mappedLoc.IsValid && File.Exists(mappedLoc.Path) then
81+
toLspLocation mappedLoc.Path mappedLoc.Span
82+
|> Some
83+
elif File.Exists(loc.SourceTree.FilePath) then
84+
toLspLocation loc.SourceTree.FilePath (loc.GetLineSpan().Span)
85+
|> Some
86+
else
87+
None
88+
89+
| _ -> None
7790

7891

7992
module TextEdit =
@@ -193,16 +206,19 @@ module TypeHierarchyItem =
193206

194207
module SymbolInformation =
195208
let fromSymbol (format: SymbolDisplayFormat) (symbol: ISymbol): SymbolInformation list =
196-
let name = SymbolName.fromSymbol format symbol
197-
let kind = SymbolKind.fromSymbol symbol
198-
symbol.Locations
199-
|> Seq.map (fun loc ->
200-
{ Name = name
201-
Kind = kind
202-
Location = Location.fromRoslynLocation loc
209+
let toSymbolInformation loc =
210+
{ Name = SymbolName.fromSymbol format symbol
211+
Kind = SymbolKind.fromSymbol symbol
212+
Location = loc
203213
ContainerName = None
204214
Deprecated = None
205-
Tags = None })
215+
Tags = None }
216+
217+
symbol.Locations
218+
|> Seq.map Location.fromRoslynLocation
219+
|> Seq.filter _.IsSome
220+
|> Seq.map _.Value
221+
|> Seq.map toSymbolInformation
206222
|> Seq.toList
207223

208224

‎src/CSharpLanguageServer/Handlers/CallHierarchy.fs

+5-1
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,13 @@ module CallHierarchy =
7171
info.Locations
7272
|> Seq.map (fun l -> l.GetLineSpan().Span |> Range.fromLinePositionSpan)
7373
|> Seq.toArray
74+
7475
info.CallingSymbol.Locations
76+
|> Seq.map Location.fromRoslynLocation
77+
|> Seq.filter _.IsSome
78+
|> Seq.map _.Value
7579
|> Seq.map (fun loc ->
76-
{ From = CallHierarchyItem.fromSymbolAndLocation (info.CallingSymbol) (loc |> Location.fromRoslynLocation)
80+
{ From = CallHierarchyItem.fromSymbolAndLocation (info.CallingSymbol) loc
7781
FromRanges = fromRanges })
7882

7983
match! context.FindSymbol p.Item.Uri p.Item.Range.Start with

‎src/CSharpLanguageServer/Handlers/CodeLens.fs

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ module CodeLens =
167167
// (l.SourceTree.FilePath, l.SourceSpan)
168168
let refNum =
169169
locations
170-
|> Seq.distinctBy (fun l -> (l.SourceTree.FilePath, l.SourceSpan))
170+
|> Seq.distinctBy (fun l -> (l.GetMappedLineSpan().Path, l.SourceSpan))
171171
|> Seq.length
172172

173173
let title = sprintf "%d Reference(s)" refNum

‎src/CSharpLanguageServer/Handlers/DocumentHighlight.fs

+5-2
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,16 @@ module DocumentHighlight =
6060
refs
6161
|> Seq.collect (fun r -> r.Locations)
6262
|> Seq.map (fun rl -> rl.Location)
63-
|> Seq.filter (fun l -> l.IsInSource && l.SourceTree.FilePath = filePath)
63+
|> Seq.filter (fun l -> l.IsInSource && l.GetMappedLineSpan().Path = filePath)
6464
|> Seq.append (def |> Option.ofObj |> Option.toList |> Seq.collect (fun sym -> sym.Locations))
6565

6666
return
6767
locations
68+
|> Seq.map Location.fromRoslynLocation
69+
|> Seq.filter _.IsSome
70+
|> Seq.map _.Value
6871
|> Seq.map (fun l ->
69-
{ Range = (Location.fromRoslynLocation l).Range
72+
{ Range = l.Range
7073
Kind = Some DocumentHighlightKind.Read })
7174
}
7275

‎src/CSharpLanguageServer/Handlers/References.fs

+2
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ module References =
4747
return
4848
locations
4949
|> Seq.map Location.fromRoslynLocation
50+
|> Seq.filter _.IsSome
51+
|> Seq.map _.Value
5052
|> Seq.distinct
5153
|> Seq.toArray
5254
|> Some

‎src/CSharpLanguageServer/State/ServerRequestContext.fs

+4-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,10 @@ type ServerRequestContext (requestId: int, state: ServerState, emitServerEvent)
9191
| ls -> ls
9292

9393
| false, true, _ ->
94-
return [Location.fromRoslynLocation l]
94+
return
95+
match (Location.fromRoslynLocation l) with
96+
| Some loc -> [loc]
97+
| None -> []
9598

9699
| _, _, _ ->
97100
return []

‎tests/CSharpLanguageServer.Tests/ReferenceTests.fs

+101-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ open CSharpLanguageServer.Tests.Tooling
77

88
[<TestCase>]
99
let testReferenceWorks() =
10-
use client = setupServerClient defaultClientProfile "TestData/testReferenceWorks"
10+
use client = setupServerClient defaultClientProfile
11+
"TestData/testReferenceWorks"
1112
client.StartAndWaitForSolutionLoad()
1213

1314
use classFile = client.Open("Project/Class.cs")
@@ -23,7 +24,9 @@ let testReferenceWorks() =
2324
Context = { IncludeDeclaration = false }
2425
}
2526

26-
let locations0: Location[] option = classFile.Request("textDocument/references", referenceParams0)
27+
let locations0: Location[] option =
28+
classFile.Request("textDocument/references", referenceParams0)
29+
2730
Assert.IsTrue(locations0.IsNone)
2831

2932
//
@@ -37,7 +40,8 @@ let testReferenceWorks() =
3740
Context = { IncludeDeclaration = false }
3841
}
3942

40-
let locations1: Location[] option = classFile.Request("textDocument/references", referenceParams1)
43+
let locations1: Location[] option =
44+
classFile.Request("textDocument/references", referenceParams1)
4145

4246
let expectedLocations1: Location array =
4347
[|
@@ -63,7 +67,8 @@ let testReferenceWorks() =
6367
Context = { IncludeDeclaration = true }
6468
}
6569

66-
let locations2: Location[] option = classFile.Request("textDocument/references", referenceParams2)
70+
let locations2: Location[] option =
71+
classFile.Request("textDocument/references", referenceParams2)
6772

6873
let expectedLocations2: Location array =
6974
[|
@@ -83,3 +88,95 @@ let testReferenceWorks() =
8388
|]
8489

8590
Assert.AreEqual(expectedLocations2, locations2.Value)
91+
92+
93+
[<TestCase>]
94+
let testReferenceWorksToAspNetRazorPageReferencedValue() =
95+
use client = setupServerClient defaultClientProfile
96+
"TestData/testReferenceWorksToAspNetRazorPageReferencedValue"
97+
client.StartAndWaitForSolutionLoad()
98+
99+
use testIndexViewModelCsFile = client.Open("Project/Models/Test/IndexViewModel.cs")
100+
101+
let referenceParams0: ReferenceParams =
102+
{ TextDocument = { Uri = testIndexViewModelCsFile.Uri }
103+
Position = { Line = 3u; Character = 20u }
104+
WorkDoneToken = None
105+
PartialResultToken = None
106+
Context = { IncludeDeclaration = false }
107+
}
108+
109+
let locations0: Location[] option =
110+
testIndexViewModelCsFile.Request("textDocument/references", referenceParams0)
111+
112+
Assert.IsTrue(locations0.IsSome)
113+
Assert.AreEqual(2, locations0.Value.Length)
114+
115+
use testControllerCsFile = client.Open("Project/Controllers/TestController.cs")
116+
use viewsTestIndexCshtmlFile = client.Open("Project/Views/Test/Index.cshtml")
117+
118+
let expectedLocations0: Location array =
119+
[|
120+
{ Uri = testControllerCsFile.Uri
121+
Range = { Start = { Line = 11u; Character = 12u }
122+
End = { Line = 11u; Character = 18u } }
123+
}
124+
125+
{ Uri = viewsTestIndexCshtmlFile.Uri
126+
Range = { Start = { Line = 1u; Character = 7u }
127+
End = { Line = 1u; Character = 13u } }
128+
}
129+
|]
130+
131+
Assert.AreEqual(expectedLocations0, locations0.Value)
132+
133+
//
134+
// do same but with IncludeDeclaration=true
135+
//
136+
let referenceParams1: ReferenceParams =
137+
{ TextDocument = { Uri = testIndexViewModelCsFile.Uri }
138+
Position = { Line = 3u; Character = 20u }
139+
WorkDoneToken = None
140+
PartialResultToken = None
141+
Context = { IncludeDeclaration = true }
142+
}
143+
144+
let locations1: Location[] option =
145+
testIndexViewModelCsFile.Request("textDocument/references", referenceParams1)
146+
147+
Assert.IsTrue(locations1.IsSome)
148+
Assert.AreEqual(5, locations1.Value.Length)
149+
150+
let expectedLocations1: Location array =
151+
[|
152+
{ Uri = viewsTestIndexCshtmlFile.Uri
153+
Range = { Start = { Line = 1u; Character = 7u }
154+
End = { Line = 1u; Character = 13u } }
155+
}
156+
157+
{ Uri = testIndexViewModelCsFile.Uri
158+
Range = { Start = { Line = 3u; Character = 19u }
159+
End = { Line = 3u; Character = 25u } }
160+
}
161+
162+
{ Uri = testIndexViewModelCsFile.Uri
163+
Range = { Start = { Line = 3u; Character = 28u }
164+
End = { Line = 3u; Character = 31u } }
165+
}
166+
167+
{ Uri = testIndexViewModelCsFile.Uri
168+
Range = { Start = { Line = 3u; Character = 33u }
169+
End = { Line = 3u; Character = 36u } }
170+
}
171+
172+
{ Uri = testControllerCsFile.Uri
173+
Range = { Start = { Line = 11u; Character = 12u }
174+
End = { Line = 11u; Character = 18u } }
175+
}
176+
|]
177+
178+
let sortedLocations1 =
179+
locations1.Value
180+
|> Array.sortBy (fun f -> (f.Range.Start.Line, f.Range.Start.Character))
181+
182+
Assert.AreEqual(expectedLocations1, sortedLocations1)

‎tests/CSharpLanguageServer.Tests/TestData/testReferenceWorksToAspNetRazorPageReferencedValue/Project/Controllers/TestController.cs

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
using Microsoft.AspNetCore.Mvc;
2+
using Project.Models.Test;
3+
4+
namespace Printlog.Web.ClientPart.Controllers;
5+
6+
public class TestController : Controller
7+
{
8+
public IActionResult Index()
9+
{
10+
var model = new IndexViewModel()
11+
{
12+
Output = "test"
13+
};
14+
15+
return View(model);
16+
}
17+
}

‎tests/CSharpLanguageServer.Tests/TestData/testReferenceWorksToAspNetRazorPageReferencedValue/Project/Models/Test/IndexViewModel.cs

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
namespace Project.Models.Test;
2+
public class IndexViewModel
3+
{
4+
public string? Output { get; set; }
5+
}

‎tests/CSharpLanguageServer.Tests/TestData/testReferenceWorksToAspNetRazorPageReferencedValue/Project/Program.cs

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
using Microsoft.AspNetCore;
2+
using System.Threading.Tasks;
3+
using Microsoft.AspNetCore.Hosting;
4+
5+
namespace Project;
6+
7+
public class Program
8+
{
9+
public static async Task Main(string[] args)
10+
{
11+
await BuildWebHost(args).RunAsync();
12+
}
13+
14+
public static IWebHost BuildWebHost(string[] args)
15+
{
16+
var builder = WebHost.CreateDefaultBuilder(args);
17+
builder = builder.UseKestrel().UseStartup<Startup>();
18+
return builder.Build();
19+
}
20+
}

‎tests/CSharpLanguageServer.Tests/TestData/testReferenceWorksToAspNetRazorPageReferencedValue/Project/Project.csproj

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<Project Sdk="Microsoft.NET.Sdk.Web">
2+
<PropertyGroup>
3+
<TargetFramework>net8.0</TargetFramework>
4+
<Nullable>enable</Nullable>
5+
</PropertyGroup>
6+
7+
<ItemGroup>
8+
<PackageReference Include="Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation" Version="8.0.11" />
9+
</ItemGroup>
10+
</Project>

‎tests/CSharpLanguageServer.Tests/TestData/testReferenceWorksToAspNetRazorPageReferencedValue/Project/Startup.cs

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
using Microsoft.AspNetCore.Builder;
2+
using Microsoft.AspNetCore.Hosting;
3+
using Microsoft.Extensions.Configuration;
4+
using Microsoft.Extensions.DependencyInjection;
5+
6+
namespace Project;
7+
8+
public class Startup
9+
{
10+
public Startup(IConfiguration configuration, IWebHostEnvironment env)
11+
{
12+
}
13+
14+
public void ConfigureServices(IServiceCollection services)
15+
{
16+
services.AddOptions();
17+
}
18+
19+
public void Configure(
20+
IApplicationBuilder app,
21+
IWebHostEnvironment env)
22+
{
23+
app.UseAuthentication();
24+
app.UseAuthorization();
25+
26+
app.UseEndpoints(endpoints => {
27+
endpoints.MapControllers();
28+
});
29+
}
30+
}

‎tests/CSharpLanguageServer.Tests/TestData/testReferenceWorksToAspNetRazorPageReferencedValue/Project/Views/Test/Index.cshtml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
@model Project.Models.Test.IndexViewModel
2+
@Model.Output

‎tests/CSharpLanguageServer.Tests/TestData/testReferenceWorksToAspNetRazorPageReferencedValue/Project/Views/_ViewImports.cshtml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers

‎tests/CSharpLanguageServer.Tests/TestData/testReferenceWorksToAspNetRazorPageReferencedValue/Project/Views/_ViewStart.cshtml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@{
2+
Layout = "_Layout";
3+
}

0 commit comments

Comments
 (0)