Skip to content

Avoid error when exclude entry is a clause #1726

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 3 commits into from
Feb 24, 2022
Merged

Avoid error when exclude entry is a clause #1726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb47061
Clean up `LanguageServerSettings.cs`
andyleejordan Feb 23, 2022
d061bcf
Clean up `ConfigurationHandler.cs`
andyleejordan Feb 23, 2022
8d0eba2
Avoid error when `exclude` entry is a clause
andyleejordan Feb 24, 2022
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
58 changes: 33 additions & 25 deletions src/PowerShellEditorServices/Services/Workspace/Handlers/ConfigurationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,13 @@
using Microsoft.PowerShell.EditorServices.Logging;
using Microsoft.PowerShell.EditorServices.Services;
using Microsoft.PowerShell.EditorServices.Services.Configuration;
using Microsoft.PowerShell.EditorServices.Services.Extension;
using Microsoft.PowerShell.EditorServices.Services.PowerShell.Host;
using Newtonsoft.Json.Linq;
using OmniSharp.Extensions.LanguageServer.Protocol.Models;
using OmniSharp.Extensions.LanguageServer.Protocol.Server;
using OmniSharp.Extensions.LanguageServer.Protocol.Window;
using OmniSharp.Extensions.LanguageServer.Protocol.Workspace;
using Microsoft.PowerShell.EditorServices.Services.PowerShell.Host;
using Microsoft.PowerShell.EditorServices.Services.Extension;


namespace Microsoft.PowerShell.EditorServices.Handlers
{
Expand All @@ -31,7 +30,7 @@ internal class PsesConfigurationHandler : DidChangeConfigurationHandlerBase
private readonly PsesInternalHost _psesHost;
private readonly ILanguageServerFacade _languageServer;
private bool _profilesLoaded;
private bool _extensionServiceInitialized;
private readonly bool _extensionServiceInitialized;
private bool _cwdSet;

public PsesConfigurationHandler(
Expand All @@ -56,10 +55,10 @@ public PsesConfigurationHandler(
public override async Task<Unit> Handle(DidChangeConfigurationParams request, CancellationToken cancellationToken)
{
LanguageServerSettingsWrapper incomingSettings = request.Settings.ToObject<LanguageServerSettingsWrapper>();
this._logger.LogTrace("Handling DidChangeConfiguration");
_logger.LogTrace("Handling DidChangeConfiguration");
if (incomingSettings is null || incomingSettings.Powershell is null)
{
this._logger.LogTrace("Incoming settings were null");
_logger.LogTrace("Incoming settings were null");
return await Unit.Task.ConfigureAwait(false);
}

Expand Down Expand Up @@ -102,32 +101,30 @@ public override async Task<Unit> Handle(DidChangeConfigurationParams request, Ca
}

// TODO: Load profiles when the host is already running

if (!this._cwdSet)
if (!_cwdSet)
{
if (!string.IsNullOrEmpty(_configurationService.CurrentSettings.Cwd)
&& Directory.Exists(_configurationService.CurrentSettings.Cwd))
{
this._logger.LogTrace($"Setting CWD (from config) to {_configurationService.CurrentSettings.Cwd}");
_logger.LogTrace($"Setting CWD (from config) to {_configurationService.CurrentSettings.Cwd}");
await _psesHost.SetInitialWorkingDirectoryAsync(
_configurationService.CurrentSettings.Cwd,
CancellationToken.None).ConfigureAwait(false);

}
else if (_workspaceService.WorkspacePath != null
else if (_workspaceService.WorkspacePath is not null
&& Directory.Exists(_workspaceService.WorkspacePath))
{
this._logger.LogTrace($"Setting CWD (from workspace) to {_workspaceService.WorkspacePath}");
_logger.LogTrace($"Setting CWD (from workspace) to {_workspaceService.WorkspacePath}");
await _psesHost.SetInitialWorkingDirectoryAsync(
_workspaceService.WorkspacePath,
CancellationToken.None).ConfigureAwait(false);
}
else
{
this._logger.LogTrace("Tried to set CWD but in bad state");
_logger.LogTrace("Tried to set CWD but in bad state");
}

this._cwdSet = true;
_cwdSet = true;
}

if (!_extensionServiceInitialized)
Expand All @@ -136,35 +133,46 @@ await _psesHost.SetInitialWorkingDirectoryAsync(
}

// Run any events subscribed to configuration updates
this._logger.LogTrace("Running configuration update event handlers");
_logger.LogTrace("Running configuration update event handlers");
ConfigurationUpdated?.Invoke(this, _configurationService.CurrentSettings);

// 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,
// "**/*.js": { "when": "$(basename).ts" },
// "build/*": true
// }
var excludeFilePatterns = new List<string>();
if (incomingSettings.Files?.Exclude != null)
//
// TODO: We only support boolean values. The clause predicates are ignored, but perhaps
// they shouldn't be. At least it doesn't crash!
List<string> excludeFilePatterns = new();
if (incomingSettings.Files?.Exclude is not null)
{
foreach(KeyValuePair<string, bool> patternEntry in incomingSettings.Files.Exclude)
foreach (KeyValuePair<string, object> patternEntry in incomingSettings.Files.Exclude)
{
if (patternEntry.Value) { excludeFilePatterns.Add(patternEntry.Key); }
if (patternEntry.Value is bool v && v)
{
excludeFilePatterns.Add(patternEntry.Key);
}
}
}
if (incomingSettings.Search?.Exclude != null)
if (incomingSettings.Search?.Exclude is not null)
{
foreach(KeyValuePair<string, bool> patternEntry in incomingSettings.Search.Exclude)
foreach (KeyValuePair<string, object> patternEntry in incomingSettings.Search.Exclude)
{
if (patternEntry.Value && !excludeFilePatterns.Contains(patternEntry.Key)) { excludeFilePatterns.Add(patternEntry.Key); }
if (patternEntry.Value is bool v && v && !excludeFilePatterns.Contains(patternEntry.Key))
{
excludeFilePatterns.Add(patternEntry.Key);
}
}
}
_workspaceService.ExcludeFilesGlob = excludeFilePatterns;

// Convert the editor file search options to Workspace properties
if (incomingSettings.Search?.FollowSymlinks != null)
if (incomingSettings.Search?.FollowSymlinks is not null)
{
_workspaceService.FollowSymlinks = incomingSettings.Search.FollowSymlinks;
}
Expand All @@ -176,11 +184,11 @@ private void SendFeatureChangesTelemetry(LanguageServerSettingsWrapper incomingS
{
if (incomingSettings is null)
{
this._logger.LogTrace("Incoming settings were null");
_logger.LogTrace("Incoming settings were null");
return;
}

var configChanges = new Dictionary<string, bool>();
Dictionary<string, bool> configChanges = new();
// Send telemetry if the user opted-out of ScriptAnalysis
if (incomingSettings.Powershell.ScriptAnalysis.Enable == false &&
_configurationService.CurrentSettings.ScriptAnalysis.Enable != incomingSettings.Powershell.ScriptAnalysis.Enable)
Expand Down
Loading