Skip to content

(GH-879) Add filtering for CodeLens and References #877

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
merged 4 commits into from
May 11, 2019
Merged

(GH-879) Add filtering for CodeLens and References #877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c6976f
(GH-879) Add characterisation tests for Workspace.EnumeratePSFiles
glennsarti Mar 8, 2019
c508720
(GH-879) Use globbing when enumerating workspace files
glennsarti Mar 10, 2019
ed33575
(GH-879) Capture the editor settings and enforce file exclusions
glennsarti Mar 16, 2019
19b2703
(GH-879) Do not normalise paths from EnumeratePSFiles
glennsarti May 2, 2019
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
1 change: 1 addition & 0 deletions PowerShellEditorServices.build.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ $script:RequiredBuildAssets = @{
'publish/Serilog.Sinks.Async.dll',
'publish/Serilog.Sinks.Console.dll',
'publish/Serilog.Sinks.File.dll',
'publish/Microsoft.Extensions.FileSystemGlobbing.dll',
'Microsoft.PowerShell.EditorServices.dll',
'Microsoft.PowerShell.EditorServices.pdb'
)
Expand Down
30 changes: 30 additions & 0 deletions src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,36 @@ await this.RunScriptDiagnosticsAsync(
this.editorSession,
eventContext);
}

// Convert the editor file glob patterns into an array for the Workspace
// Both the files.exclude and search.exclude hash tables look like (glob-text, is-enabled):
// "files.exclude" : {
// "Makefile": true,
// "*.html": true,
// "build/*": true
// }
var excludeFilePatterns = new List<string>();
if (configChangeParams.Settings.Files?.Exclude != null)
{
foreach(KeyValuePair<string, bool> patternEntry in configChangeParams.Settings.Files.Exclude)
{
if (patternEntry.Value) { excludeFilePatterns.Add(patternEntry.Key); }
}
}
if (configChangeParams.Settings.Search?.Exclude != null)
{
foreach(KeyValuePair<string, bool> patternEntry in configChangeParams.Settings.Files.Exclude)
{
if (patternEntry.Value && !excludeFilePatterns.Contains(patternEntry.Key)) { excludeFilePatterns.Add(patternEntry.Key); }
}
}
editorSession.Workspace.ExcludeFilesGlob = excludeFilePatterns;

// Convert the editor file search options to Workspace properties
if (configChangeParams.Settings.Search?.FollowSymlinks != null)
{
editorSession.Workspace.FollowSymlinks = configChangeParams.Settings.Search.FollowSymlinks;
}
}

protected async Task HandleDefinitionRequestAsync(
Expand Down
54 changes: 47 additions & 7 deletions src/PowerShellEditorServices.Protocol/Server/LanguageServerSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using Microsoft.PowerShell.EditorServices.Utility;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using System.Security;
Expand Down Expand Up @@ -331,12 +332,51 @@ public void Update(
}
}

public class LanguageServerSettingsWrapper
{
// NOTE: This property is capitalized as 'Powershell' because the
// mode name sent from the client is written as 'powershell' and
// JSON.net is using camelCasing.
/// <summary>
/// Additional settings from the Language Client that affect Language Server operations but
/// do not exist under the 'powershell' section
/// </summary>
public class EditorFileSettings
{
/// <summary>
/// Exclude files globs consists of hashtable with the key as the glob and a boolean value to indicate if the
/// the glob is in effect.
/// </summary>
public Dictionary<string, bool> Exclude { get; set; }
}

public LanguageServerSettings Powershell { get; set; }
}
/// <summary>
/// Additional settings from the Language Client that affect Language Server operations but
/// do not exist under the 'powershell' section
/// </summary>
public class EditorSearchSettings
{
/// <summary>
/// Exclude files globs consists of hashtable with the key as the glob and a boolean value to indicate if the
/// the glob is in effect.
/// </summary>
public Dictionary<string, bool> Exclude { get; set; }
/// <summary>
/// Whether to follow symlinks when searching
/// </summary>
public bool FollowSymlinks { get; set; } = true;
}

public class LanguageServerSettingsWrapper
{
// NOTE: This property is capitalized as 'Powershell' because the
// mode name sent from the client is written as 'powershell' and
// JSON.net is using camelCasing.
public LanguageServerSettings Powershell { get; set; }

// NOTE: This property is capitalized as 'Files' because the
// mode name sent from the client is written as 'files' and
// JSON.net is using camelCasing.
public EditorFileSettings Files { get; set; }

// NOTE: This property is capitalized as 'Search' because the
// mode name sent from the client is written as 'search' and
// JSON.net is using camelCasing.
public EditorSearchSettings Search { get; set; }
}
}
1 change: 1 addition & 0 deletions src/PowerShellEditorServices/PowerShellEditorServices.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
<PackageReference Include="Serilog.Sinks.File" Version="4.0.0" />
<PackageReference Include="Serilog.Sinks.Async" Version="1.3.0" />
<PackageReference Include="System.Runtime.Extensions" Version="4.3.1" />
<PackageReference Include="Microsoft.Extensions.FileSystemGlobbing" Version="2.2.0" />
<PackageReference Include="System.Runtime.InteropServices.RuntimeInformation" Version="4.3.0" />
</ItemGroup>
<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
Expand Down
189 changes: 71 additions & 118 deletions src/PowerShellEditorServices/Workspace/Workspace.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
using System.Security;
using System.Text;
using System.Runtime.InteropServices;
using Microsoft.Extensions.FileSystemGlobbing;
using Microsoft.Extensions.FileSystemGlobbing.Abstractions;

namespace Microsoft.PowerShell.EditorServices
{
Expand All @@ -22,11 +24,29 @@ public class Workspace
{
#region Private Fields

private static readonly string[] s_psFilePatterns = new []
// List of all file extensions considered PowerShell files in the .Net Core Framework.
private static readonly string[] s_psFileExtensionsCoreFramework =
{
"*.ps1",
"*.psm1",
"*.psd1"
".ps1",
".psm1",
".psd1"
};

// .Net Core doesn't appear to use the same three letter pattern matching rule although the docs
// suggest it should be find the '.ps1xml' files because we search for the pattern '*.ps1'.
// ref https://docs.microsoft.com/en-us/dotnet/api/system.io.directory.getfiles?view=netcore-2.1#System_IO_Directory_GetFiles_System_String_System_String_System_IO_EnumerationOptions_
private static readonly string[] s_psFileExtensionsFullFramework =
{
".ps1",
".psm1",
".psd1",
".ps1xml"
};

// An array of globs which includes everything.
private static readonly string[] s_psIncludeAllGlob = new []
{
"**/*"
};

private ILogger logger;
Expand All @@ -42,6 +62,16 @@ public class Workspace
/// </summary>
public string WorkspacePath { get; set; }

/// <summary>
/// Gets or sets the default list of file globs to exclude during workspace searches.
/// </summary>
public List<string> ExcludeFilesGlob { get; set; }

/// <summary>
/// Gets or sets whether the workspace should follow symlinks in search operations.
/// </summary>
public bool FollowSymlinks { get; set; }

#endregion

#region Constructors
Expand All @@ -55,6 +85,8 @@ public Workspace(Version powerShellVersion, ILogger logger)
{
this.powerShellVersion = powerShellVersion;
this.logger = logger;
this.ExcludeFilesGlob = new List<string>();
this.FollowSymlinks = true;
}

#endregion
Expand Down Expand Up @@ -282,135 +314,56 @@ public string GetRelativePath(string filePath)
}

/// <summary>
/// Enumerate all the PowerShell (ps1, psm1, psd1) files in the workspace in a recursive manner
/// Enumerate all the PowerShell (ps1, psm1, psd1) files in the workspace in a recursive manner, using default values.
/// </summary>
/// <returns>An enumerator over the PowerShell files found in the workspace</returns>
/// <returns>An enumerator over the PowerShell files found in the workspace.</returns>
public IEnumerable<string> EnumeratePSFiles()
{
if (WorkspacePath == null || !Directory.Exists(WorkspacePath))
{
return Enumerable.Empty<string>();
}

var foundFiles = new List<string>();
this.RecursivelyEnumerateFiles(WorkspacePath, ref foundFiles);
return foundFiles;
return EnumeratePSFiles(
ExcludeFilesGlob.ToArray(),
s_psIncludeAllGlob,
maxDepth: 64,
ignoreReparsePoints: !FollowSymlinks
);
}

#endregion

#region Private Methods

/// <summary>
/// Find PowerShell files recursively down from a given directory path.
/// Currently collects files in depth-first order.
/// Directory.GetFiles(folderPath, pattern, SearchOption.AllDirectories) would provide this,
/// but a cycle in the filesystem will cause that to enter an infinite loop.
/// Enumerate all the PowerShell (ps1, psm1, psd1) files in the workspace in a recursive manner.
/// </summary>
/// <param name="folderPath">The path of the current directory to find files in</param>
/// <param name="foundFiles">The accumulator for files found so far.</param>
/// <param name="currDepth">The current depth of the recursion from the original base directory.</param>
private void RecursivelyEnumerateFiles(string folderPath, ref List<string> foundFiles, int currDepth = 0)
/// <returns>An enumerator over the PowerShell files found in the workspace.</returns>
public IEnumerable<string> EnumeratePSFiles(
string[] excludeGlobs,
string[] includeGlobs,
int maxDepth,
bool ignoreReparsePoints
)
{
const int recursionDepthLimit = 64;

// Look for any PowerShell files in the current directory
foreach (string pattern in s_psFilePatterns)
{
string[] psFiles;
try
{
psFiles = Directory.GetFiles(folderPath, pattern, SearchOption.TopDirectoryOnly);
}
catch (DirectoryNotFoundException e)
{
this.logger.WriteHandledException(
$"Could not enumerate files in the path '{folderPath}' due to it being an invalid path",
e);

continue;
}
catch (PathTooLongException e)
{
this.logger.WriteHandledException(
$"Could not enumerate files in the path '{folderPath}' due to the path being too long",
e);

continue;
}
catch (Exception e) when (e is SecurityException || e is UnauthorizedAccessException)
{
this.logger.WriteHandledException(
$"Could not enumerate files in the path '{folderPath}' due to the path not being accessible",
e);

continue;
}
catch (Exception e)
{
this.logger.WriteHandledException(
$"Could not enumerate files in the path '{folderPath}' due to an exception",
e);

continue;
}

foundFiles.AddRange(psFiles);
}

// Prevent unbounded recursion here
if (currDepth >= recursionDepthLimit)
{
this.logger.Write(LogLevel.Warning, $"Recursion depth limit hit for path {folderPath}");
return;
}

// Add the recursive directories to search next
string[] subDirs;
try
{
subDirs = Directory.GetDirectories(folderPath);
}
catch (DirectoryNotFoundException e)
{
this.logger.WriteHandledException(
$"Could not enumerate directories in the path '{folderPath}' due to it being an invalid path",
e);

return;
}
catch (PathTooLongException e)
{
this.logger.WriteHandledException(
$"Could not enumerate directories in the path '{folderPath}' due to the path being too long",
e);

return;
}
catch (Exception e) when (e is SecurityException || e is UnauthorizedAccessException)
{
this.logger.WriteHandledException(
$"Could not enumerate directories in the path '{folderPath}' due to the path not being accessible",
e);

return;
}
catch (Exception e)
if (WorkspacePath == null || !Directory.Exists(WorkspacePath))
{
this.logger.WriteHandledException(
$"Could not enumerate directories in the path '{folderPath}' due to an exception",
e);

return;
yield break;
}


foreach (string subDir in subDirs)
var matcher = new Microsoft.Extensions.FileSystemGlobbing.Matcher();
foreach (string pattern in includeGlobs) { matcher.AddInclude(pattern); }
foreach (string pattern in excludeGlobs) { matcher.AddExclude(pattern); }

var fsFactory = new WorkspaceFileSystemWrapperFactory(
WorkspacePath,
maxDepth,
Utils.IsNetCore ? s_psFileExtensionsCoreFramework : s_psFileExtensionsFullFramework,
ignoreReparsePoints,
logger
);
var fileMatchResult = matcher.Execute(fsFactory.RootDirectory);
foreach (FilePatternMatch item in fileMatchResult.Files)
{
RecursivelyEnumerateFiles(subDir, ref foundFiles, currDepth: currDepth + 1);
yield return Path.Combine(WorkspacePath, item.Path);
}
}

#endregion

#region Private Methods
/// <summary>
/// Recusrively searches through referencedFiles in scriptFiles
/// and builds a Dictonary of the file references
Expand Down
Loading