Rename SymbolReference fields

andyleejordan · andyleejordan · commit 301006554ba9 · 2023-01-30T18:00:44.000-08:00
diff --git a/src/PowerShellEditorServices/Services/CodeLens/ReferencesCodeLensProvider.cs b/src/PowerShellEditorServices/Services/CodeLens/ReferencesCodeLensProvider.cs
@@ -62,7 +62,7 @@ public CodeLens[] ProvideCodeLenses(ScriptFile scriptFile, CancellationToken can
                 cancellationToken.ThrowIfCancellationRequested();
                 // TODO: Can we support more here?
                 if (symbol.IsDeclaration &&
-                    symbol.SymbolType is
+                    symbol.Type is
                     SymbolType.Function or
                     SymbolType.Class or
                     SymbolType.Enum)
diff --git a/src/PowerShellEditorServices/Services/Symbols/ReferenceTable.cs b/src/PowerShellEditorServices/Services/Symbols/ReferenceTable.cs
@@ -46,8 +46,8 @@ internal IEnumerable<SymbolReference> TryGetReferences(SymbolReference? symbol)
     {
         EnsureInitialized();
         return symbol is not null
-            && _symbolReferences.TryGetValue(symbol.SymbolName, out ConcurrentBag<SymbolReference>? bag)
-                ? bag.Where(i => SymbolTypeUtils.SymbolTypeMatches(symbol.SymbolType, i.SymbolType))
+            && _symbolReferences.TryGetValue(symbol.Id, out ConcurrentBag<SymbolReference>? bag)
+                ? bag.Where(i => SymbolTypeUtils.SymbolTypeMatches(symbol.Type, i.Type))
                 : Enumerable.Empty<SymbolReference>();
     }
 
@@ -90,7 +90,7 @@ private AstVisitAction AddReference(SymbolReference symbol)
         }
 
         _symbolReferences.AddOrUpdate(
-            symbol.SymbolName,
+            symbol.Id,
             _ => new ConcurrentBag<SymbolReference> { symbol },
             (_, existing) =>
             {
diff --git a/src/PowerShellEditorServices/Services/Symbols/SymbolDetails.cs b/src/PowerShellEditorServices/Services/Symbols/SymbolDetails.cs
@@ -44,10 +44,10 @@ internal static async Task<SymbolDetails> CreateAsync(
                 SymbolReference = symbolReference
             };
 
-            if (symbolReference.SymbolType is SymbolType.Function)
+            if (symbolReference.Type is SymbolType.Function)
             {
                 CommandInfo commandInfo = await CommandHelpers.GetCommandInfoAsync(
-                    symbolReference.SymbolName,
+                    symbolReference.Id,
                     currentRunspace,
                     executionService).ConfigureAwait(false);
 
@@ -60,7 +60,7 @@ await CommandHelpers.GetCommandSynopsisAsync(
 
                     if (commandInfo.CommandType == CommandTypes.Application)
                     {
-                        symbolDetails.SymbolReference = symbolReference with { DisplayString = $"(application) ${symbolReference.DisplayString}" };
+                        symbolDetails.SymbolReference = symbolReference with { Name = $"(application) ${symbolReference.Name}" };
                     }
                 }
             }
diff --git a/src/PowerShellEditorServices/Services/Symbols/SymbolReference.cs b/src/PowerShellEditorServices/Services/Symbols/SymbolReference.cs
@@ -12,14 +12,14 @@ namespace Microsoft.PowerShell.EditorServices.Services.Symbols
     /// <summary>
     /// A class that holds the type, name, script extent, and source line of a symbol
     /// </summary>
-    [DebuggerDisplay("SymbolType = {SymbolType}, SymbolName = {SymbolName}")]
+    [DebuggerDisplay("Type = {Type}, Id = {Id}, Name = {Name}")]
     internal record SymbolReference
     {
-        public SymbolType SymbolType { get; init; }
+        public SymbolType Type { get; init; }
 
-        public string SymbolName { get; init; }
+        public string Id { get; init; }
 
-        public string DisplayString { get; init; }
+        public string Name { get; init; }
 
         public ScriptRegion NameRegion { get; init; }
 
@@ -34,25 +34,25 @@ internal record SymbolReference
         /// <summary>
         /// Constructs and instance of a SymbolReference
         /// </summary>
-        /// <param name="symbolType">The higher level type of the symbol</param>
-        /// <param name="symbolName">The name of the symbol</param>
-        /// <param name="displayString">The string used by outline, hover, etc.</param>
+        /// <param name="type">The higher level type of the symbol</param>
+        /// <param name="id">The name of the symbol</param>
+        /// <param name="name">The string used by outline, hover, etc.</param>
         /// <param name="nameExtent">The extent of the symbol's name</param>
         /// <param name="scriptExtent">The script extent of the symbol</param>
         /// <param name="file">The script file that has the symbol</param>
         /// <param name="isDeclaration">True if this reference is the definition of the symbol</param>
         public SymbolReference(
-            SymbolType symbolType,
-            string symbolName,
-            string displayString,
+            SymbolType type,
+            string id,
+            string name,
             IScriptExtent nameExtent,
             IScriptExtent scriptExtent,
             ScriptFile file,
             bool isDeclaration)
         {
-            SymbolType = symbolType;
-            SymbolName = symbolName;
-            DisplayString = displayString;
+            Type = type;
+            Id = id;
+            Name = name;
             NameRegion = new(nameExtent);
             ScriptRegion = new(scriptExtent);
             FilePath = file.FilePath;
diff --git a/src/PowerShellEditorServices/Services/Symbols/SymbolsService.cs b/src/PowerShellEditorServices/Services/Symbols/SymbolsService.cs
@@ -170,25 +170,25 @@ public async Task<IEnumerable<SymbolReference>> ScanForReferencesOfSymbolAsync(
                 _executionService,
                 cancellationToken).ConfigureAwait(false);
 
-            string targetName = symbol.SymbolName;
-            if (symbol.SymbolType is SymbolType.Function
-                && aliases.AliasToCmdlets.TryGetValue(symbol.SymbolName, out string aliasDefinition))
+            string targetName = symbol.Id;
+            if (symbol.Type is SymbolType.Function
+                && aliases.AliasToCmdlets.TryGetValue(symbol.Id, out string aliasDefinition))
             {
                 targetName = aliasDefinition;
             }
 
             await ScanWorkspacePSFiles(cancellationToken).ConfigureAwait(false);
 
             List<SymbolReference> symbols = new();
-            string[] allIdentifiers = GetIdentifiers(targetName, symbol.SymbolType, aliases);
+            string[] allIdentifiers = GetIdentifiers(targetName, symbol.Type, aliases);
 
             foreach (ScriptFile file in _workspaceService.GetOpenedFiles())
             {
                 foreach (string targetIdentifier in allIdentifiers)
                 {
                     await Task.Yield();
                     cancellationToken.ThrowIfCancellationRequested();
-                    symbols.AddRange(file.References.TryGetReferences(symbol with { SymbolName = targetIdentifier }));
+                    symbols.AddRange(file.References.TryGetReferences(symbol with { Id = targetIdentifier }));
                 }
             }
 
@@ -239,15 +239,15 @@ public static IEnumerable<SymbolReference> FindOccurrencesInFile(
             // If we are not possibly looking at a Function, we don't
             // need to continue because we won't be able to get the
             // CommandInfo object.
-            if (symbol?.SymbolType is not SymbolType.Function
+            if (symbol?.Type is not SymbolType.Function
                 and not SymbolType.Unknown)
             {
                 return null;
             }
 
             CommandInfo commandInfo =
                 await CommandHelpers.GetCommandInfoAsync(
-                    symbol.SymbolName,
+                    symbol.Id,
                     _runspaceContext.CurrentRunspace,
                     _executionService).ConfigureAwait(false);
 
diff --git a/src/PowerShellEditorServices/Services/TextDocument/Handlers/DocumentSymbolHandler.cs b/src/PowerShellEditorServices/Services/TextDocument/Handlers/DocumentSymbolHandler.cs
@@ -69,7 +69,7 @@ public override async Task<SymbolInformationOrDocumentSymbolContainer> Handle(Do
                 //
                 // TODO: We should also include function invocations that are part of DSLs (like
                 // Invoke-Build etc.).
-                if (!r.IsDeclaration || r.SymbolType is SymbolType.Parameter)
+                if (!r.IsDeclaration || r.Type is SymbolType.Parameter)
                 {
                     continue;
                 }
@@ -88,13 +88,13 @@ public override async Task<SymbolInformationOrDocumentSymbolContainer> Handle(Do
                 symbols.Add(new SymbolInformationOrDocumentSymbol(new SymbolInformation
                 {
                     ContainerName = containerName,
-                    Kind = SymbolTypeUtils.GetSymbolKind(r.SymbolType),
+                    Kind = SymbolTypeUtils.GetSymbolKind(r.Type),
                     Location = new Location
                     {
                         Uri = DocumentUri.From(r.FilePath),
                         Range = new Range(r.NameRegion.ToRange().Start, r.ScriptRegion.ToRange().End) // Jump to name start, but keep whole range to support symbol tree in outline
                     },
-                    Name = r.DisplayString
+                    Name = r.Name
                 }));
             }
 
diff --git a/src/PowerShellEditorServices/Services/TextDocument/Handlers/HoverHandler.cs b/src/PowerShellEditorServices/Services/TextDocument/Handlers/HoverHandler.cs
@@ -59,7 +59,7 @@ await _symbolsService.FindSymbolDetailsAtLocationAsync(
 
             List<MarkedString> symbolInfo = new()
             {
-                new MarkedString("PowerShell", symbolDetails.SymbolReference.DisplayString)
+                new MarkedString("PowerShell", symbolDetails.SymbolReference.Name)
             };
 
             if (!string.IsNullOrEmpty(symbolDetails.Documentation))
diff --git a/src/PowerShellEditorServices/Services/Workspace/Handlers/WorkspaceSymbolsHandler.cs b/src/PowerShellEditorServices/Services/Workspace/Handlers/WorkspaceSymbolsHandler.cs
@@ -44,48 +44,48 @@ public override async Task<Container<SymbolInformation>> Handle(WorkspaceSymbolP
                 // TODO: Need to compute a relative path that is based on common path for all workspace files
                 string containerName = Path.GetFileNameWithoutExtension(scriptFile.FilePath);
 
-                foreach (SymbolReference foundOccurrence in foundSymbols)
+                foreach (SymbolReference symbol in foundSymbols)
                 {
                     // This async method is pretty dense with synchronous code
                     // so it's helpful to add some yields.
                     await Task.Yield();
                     cancellationToken.ThrowIfCancellationRequested();
 
-                    if (!foundOccurrence.IsDeclaration)
+                    if (!symbol.IsDeclaration)
                     {
                         continue;
                     }
 
-                    if (foundOccurrence.SymbolType is SymbolType.Parameter)
+                    if (symbol.Type is SymbolType.Parameter)
                     {
                         continue;
                     }
 
-                    if (!IsQueryMatch(request.Query, foundOccurrence.SymbolName))
+                    if (!IsQueryMatch(request.Query, symbol.Id))
                     {
                         continue;
                     }
 
                     // Exclude Pester setup/teardown symbols as they're unnamed
-                    if (foundOccurrence is PesterSymbolReference pesterSymbol &&
+                    if (symbol is PesterSymbolReference pesterSymbol &&
                         !PesterSymbolReference.IsPesterTestCommand(pesterSymbol.Command))
                     {
                         continue;
                     }
 
                     Location location = new()
                     {
-                        Uri = DocumentUri.From(foundOccurrence.FilePath),
-                        Range = foundOccurrence.NameRegion.ToRange()
+                        Uri = DocumentUri.From(symbol.FilePath),
+                        Range = symbol.NameRegion.ToRange()
                     };
 
                     // TODO: This should be a WorkplaceSymbol now as SymbolInformation is deprecated.
                     symbols.Add(new SymbolInformation
                     {
                         ContainerName = containerName,
-                        Kind = SymbolTypeUtils.GetSymbolKind(foundOccurrence.SymbolType),
+                        Kind = SymbolTypeUtils.GetSymbolKind(symbol.Type),
                         Location = location,
-                        Name = foundOccurrence.DisplayString
+                        Name = symbol.Name
                     });
                 }
             }
diff --git a/test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs b/test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs
diff --git a/test/PowerShellEditorServices.Test/Services/Symbols/AstOperationsTests.cs b/test/PowerShellEditorServices.Test/Services/Symbols/AstOperationsTests.cs

Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,8 @@ internal IEnumerable<SymbolReference> TryGetReferences(SymbolReference? symbol)`
`46`	`46`	`{`
`47`	`47`	`EnsureInitialized();`
`48`	`48`	`return symbol is not null`
`49`		`- && _symbolReferences.TryGetValue(symbol.SymbolName, out ConcurrentBag<SymbolReference>? bag)`
`50`		`- ? bag.Where(i => SymbolTypeUtils.SymbolTypeMatches(symbol.SymbolType, i.SymbolType))`
	`49`	`+ && _symbolReferences.TryGetValue(symbol.Id, out ConcurrentBag<SymbolReference>? bag)`
	`50`	`+ ? bag.Where(i => SymbolTypeUtils.SymbolTypeMatches(symbol.Type, i.Type))`
`51`	`51`	`: Enumerable.Empty<SymbolReference>();`
`52`	`52`	`}`
`53`	`53`
`@@ -90,7 +90,7 @@ private AstVisitAction AddReference(SymbolReference symbol)`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`_symbolReferences.AddOrUpdate(`
`93`		`- symbol.SymbolName,`
	`93`	`+ symbol.Id,`
`94`	`94`	`_ => new ConcurrentBag<SymbolReference> { symbol },`
`95`	`95`	`(_, existing) =>`
`96`	`96`	`{`
Original file line number	Diff line number	Diff line change
`@@ -44,10 +44,10 @@ internal static async Task<SymbolDetails> CreateAsync(`
`44`	`44`	`SymbolReference = symbolReference`
`45`	`45`	`};`
`46`	`46`
`47`		`- if (symbolReference.SymbolType is SymbolType.Function)`
	`47`	`+ if (symbolReference.Type is SymbolType.Function)`
`48`	`48`	`{`
`49`	`49`	`CommandInfo commandInfo = await CommandHelpers.GetCommandInfoAsync(`
`50`		`- symbolReference.SymbolName,`
	`50`	`+ symbolReference.Id,`
`51`	`51`	`currentRunspace,`
`52`	`52`	`executionService).ConfigureAwait(false);`
`53`	`53`
`@@ -60,7 +60,7 @@ await CommandHelpers.GetCommandSynopsisAsync(`
`60`	`60`
`61`	`61`	`if (commandInfo.CommandType == CommandTypes.Application)`
`62`	`62`	`{`
`63`		`- symbolDetails.SymbolReference = symbolReference with { DisplayString = $"(application) ${symbolReference.DisplayString}" };`
	`63`	`+ symbolDetails.SymbolReference = symbolReference with { Name = $"(application) ${symbolReference.Name}" };`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -170,25 +170,25 @@ public async Task<IEnumerable<SymbolReference>> ScanForReferencesOfSymbolAsync(`
`170`	`170`	`_executionService,`
`171`	`171`	`cancellationToken).ConfigureAwait(false);`
`172`	`172`
`173`		`- string targetName = symbol.SymbolName;`
`174`		`- if (symbol.SymbolType is SymbolType.Function`
`175`		`- && aliases.AliasToCmdlets.TryGetValue(symbol.SymbolName, out string aliasDefinition))`
	`173`	`+ string targetName = symbol.Id;`
	`174`	`+ if (symbol.Type is SymbolType.Function`
	`175`	`+ && aliases.AliasToCmdlets.TryGetValue(symbol.Id, out string aliasDefinition))`
`176`	`176`	`{`
`177`	`177`	`targetName = aliasDefinition;`
`178`	`178`	`}`
`179`	`179`
`180`	`180`	`await ScanWorkspacePSFiles(cancellationToken).ConfigureAwait(false);`
`181`	`181`
`182`	`182`	`List<SymbolReference> symbols = new();`
`183`		`- string[] allIdentifiers = GetIdentifiers(targetName, symbol.SymbolType, aliases);`
	`183`	`+ string[] allIdentifiers = GetIdentifiers(targetName, symbol.Type, aliases);`
`184`	`184`
`185`	`185`	`foreach (ScriptFile file in _workspaceService.GetOpenedFiles())`
`186`	`186`	`{`
`187`	`187`	`foreach (string targetIdentifier in allIdentifiers)`
`188`	`188`	`{`
`189`	`189`	`await Task.Yield();`
`190`	`190`	`cancellationToken.ThrowIfCancellationRequested();`
`191`		`- symbols.AddRange(file.References.TryGetReferences(symbol with { SymbolName = targetIdentifier }));`
	`191`	`+ symbols.AddRange(file.References.TryGetReferences(symbol with { Id = targetIdentifier }));`
`192`	`192`	`}`
`193`	`193`	`}`
`194`	`194`
`@@ -239,15 +239,15 @@ public static IEnumerable<SymbolReference> FindOccurrencesInFile(`
`239`	`239`	`// If we are not possibly looking at a Function, we don't`
`240`	`240`	`// need to continue because we won't be able to get the`
`241`	`241`	`// CommandInfo object.`
`242`		`- if (symbol?.SymbolType is not SymbolType.Function`
	`242`	`+ if (symbol?.Type is not SymbolType.Function`
`243`	`243`	`and not SymbolType.Unknown)`
`244`	`244`	`{`
`245`	`245`	`return null;`
`246`	`246`	`}`
`247`	`247`
`248`	`248`	`CommandInfo commandInfo =`
`249`	`249`	`await CommandHelpers.GetCommandInfoAsync(`
`250`		`- symbol.SymbolName,`
	`250`	`+ symbol.Id,`
`251`	`251`	`_runspaceContext.CurrentRunspace,`
`252`	`252`	`_executionService).ConfigureAwait(false);`
`253`	`253`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public override async Task<SymbolInformationOrDocumentSymbolContainer> Handle(Do`
`69`	`69`	`//`
`70`	`70`	`// TODO: We should also include function invocations that are part of DSLs (like`
`71`	`71`	`// Invoke-Build etc.).`
`72`		`- if (!r.IsDeclaration \|\| r.SymbolType is SymbolType.Parameter)`
	`72`	`+ if (!r.IsDeclaration \|\| r.Type is SymbolType.Parameter)`
`73`	`73`	`{`
`74`	`74`	`continue;`
`75`	`75`	`}`
`@@ -88,13 +88,13 @@ public override async Task<SymbolInformationOrDocumentSymbolContainer> Handle(Do`
`88`	`88`	`symbols.Add(new SymbolInformationOrDocumentSymbol(new SymbolInformation`
`89`	`89`	`{`
`90`	`90`	`ContainerName = containerName,`
`91`		`- Kind = SymbolTypeUtils.GetSymbolKind(r.SymbolType),`
	`91`	`+ Kind = SymbolTypeUtils.GetSymbolKind(r.Type),`
`92`	`92`	`Location = new Location`
`93`	`93`	`{`
`94`	`94`	`Uri = DocumentUri.From(r.FilePath),`
`95`	`95`	`Range = new Range(r.NameRegion.ToRange().Start, r.ScriptRegion.ToRange().End) // Jump to name start, but keep whole range to support symbol tree in outline`
`96`	`96`	`},`
`97`		`- Name = r.DisplayString`
	`97`	`+ Name = r.Name`
`98`	`98`	`}));`
`99`	`99`	`}`
`100`	`100`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ await _symbolsService.FindSymbolDetailsAtLocationAsync(`
`59`	`59`
`60`	`60`	`List<MarkedString> symbolInfo = new()`
`61`	`61`	`{`
`62`		`- new MarkedString("PowerShell", symbolDetails.SymbolReference.DisplayString)`
	`62`	`+ new MarkedString("PowerShell", symbolDetails.SymbolReference.Name)`
`63`	`63`	`};`
`64`	`64`
`65`	`65`	`if (!string.IsNullOrEmpty(symbolDetails.Documentation))`
Original file line number	Diff line number	Diff line change
`@@ -44,48 +44,48 @@ public override async Task<Container<SymbolInformation>> Handle(WorkspaceSymbolP`
`44`	`44`	`// TODO: Need to compute a relative path that is based on common path for all workspace files`
`45`	`45`	`string containerName = Path.GetFileNameWithoutExtension(scriptFile.FilePath);`
`46`	`46`
`47`		`- foreach (SymbolReference foundOccurrence in foundSymbols)`
	`47`	`+ foreach (SymbolReference symbol in foundSymbols)`
`48`	`48`	`{`
`49`	`49`	`// This async method is pretty dense with synchronous code`
`50`	`50`	`// so it's helpful to add some yields.`
`51`	`51`	`await Task.Yield();`
`52`	`52`	`cancellationToken.ThrowIfCancellationRequested();`
`53`	`53`
`54`		`- if (!foundOccurrence.IsDeclaration)`
	`54`	`+ if (!symbol.IsDeclaration)`
`55`	`55`	`{`
`56`	`56`	`continue;`
`57`	`57`	`}`
`58`	`58`
`59`		`- if (foundOccurrence.SymbolType is SymbolType.Parameter)`
	`59`	`+ if (symbol.Type is SymbolType.Parameter)`
`60`	`60`	`{`
`61`	`61`	`continue;`
`62`	`62`	`}`
`63`	`63`
`64`		`- if (!IsQueryMatch(request.Query, foundOccurrence.SymbolName))`
	`64`	`+ if (!IsQueryMatch(request.Query, symbol.Id))`
`65`	`65`	`{`
`66`	`66`	`continue;`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`// Exclude Pester setup/teardown symbols as they're unnamed`
`70`		`- if (foundOccurrence is PesterSymbolReference pesterSymbol &&`
	`70`	`+ if (symbol is PesterSymbolReference pesterSymbol &&`
`71`	`71`	`!PesterSymbolReference.IsPesterTestCommand(pesterSymbol.Command))`
`72`	`72`	`{`
`73`	`73`	`continue;`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`Location location = new()`
`77`	`77`	`{`
`78`		`- Uri = DocumentUri.From(foundOccurrence.FilePath),`
`79`		`- Range = foundOccurrence.NameRegion.ToRange()`
	`78`	`+ Uri = DocumentUri.From(symbol.FilePath),`
	`79`	`+ Range = symbol.NameRegion.ToRange()`
`80`	`80`	`};`
`81`	`81`
`82`	`82`	`// TODO: This should be a WorkplaceSymbol now as SymbolInformation is deprecated.`
`83`	`83`	`symbols.Add(new SymbolInformation`
`84`	`84`	`{`
`85`	`85`	`ContainerName = containerName,`
`86`		`- Kind = SymbolTypeUtils.GetSymbolKind(foundOccurrence.SymbolType),`
	`86`	`+ Kind = SymbolTypeUtils.GetSymbolKind(symbol.Type),`
`87`	`87`	`Location = location,`
`88`		`- Name = foundOccurrence.DisplayString`
	`88`	`+ Name = symbol.Name`
`89`	`89`	`});`
`90`	`90`	`}`
`91`	`91`	`}`