Skip to content

Fix PSSA settings discovery + pick up changes to settings file #1206

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 11 commits into from
Feb 26, 2020
Merged

Fix PSSA settings discovery + pick up changes to settings file #1206

Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
43a0ed4
Add FS watcher for settings file
Feb 25, 2020
1a53202
Check for existence of settings file
Feb 25, 2020
b7bbb2e
Watch for more fs events
Feb 25, 2020
a25d6bc
Fix filesystem watcher logic
Feb 25, 2020
bba0664
Improve file watcher disposal
Feb 25, 2020
71c56b3
Remove unused import
Feb 25, 2020
7e53410
Update src/PowerShellEditorServices/Services/Analysis/AnalysisService.cs
rjmholt Feb 25, 2020
7ac5c95
Remove unnecessary filesystemwatcher
Feb 25, 2020
ac1f1d5
Remove now unused string comparison
Feb 25, 2020
e182703
Poll for settings file
Feb 25, 2020
a99fc69
Fix placement of settings file check
Feb 25, 2020
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: 35 additions & 11 deletions src/PowerShellEditorServices/Services/Analysis/AnalysisService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
using System.Collections;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
Expand Down Expand Up @@ -93,6 +94,8 @@ internal static string GetUniqueIdFromDiagnostic(Diagnostic diagnostic)

private Lazy<PssaCmdletAnalysisEngine> _analysisEngine;

private FileSystemWatcher _pssaSettingsFileWatcher;

private CancellationTokenSource _diagnosticsCancellationTokenSource;

/// <summary>
Expand Down Expand Up @@ -253,13 +256,29 @@ public void ClearMarkers(ScriptFile file)
/// <param name="sender">The sender of the configuration update event.</param>
/// <param name="settings">The new language server settings.</param>
public void OnConfigurationUpdated(object sender, LanguageServerSettings settings)
{
ReinitializeAnalysisEngine();
}

private void OnSettingsFileUpdated(object sender, FileSystemEventArgs args)
{
ReinitializeAnalysisEngine();
}

private void ReinitializeAnalysisEngine()
{
ClearOpenFileMarkers();
_analysisEngine = new Lazy<PssaCmdletAnalysisEngine>(InstantiateAnalysisEngine);
}

private PssaCmdletAnalysisEngine InstantiateAnalysisEngine()
{
if (_pssaSettingsFileWatcher != null)
{
_pssaSettingsFileWatcher.Dispose();
_pssaSettingsFileWatcher = null;
}

if (!(_configurationService.CurrentSettings.ScriptAnalysis.Enable ?? false))
{
return null;
Expand All @@ -271,6 +290,11 @@ private PssaCmdletAnalysisEngine InstantiateAnalysisEngine()
if (TryFindSettingsFile(out string settingsFilePath))
{
_logger.LogInformation($"Configuring PSScriptAnalyzer with rules at '{settingsFilePath}'");
_pssaSettingsFileWatcher = new FileSystemWatcher(settingsFilePath)
{
EnableRaisingEvents = true,
};
_pssaSettingsFileWatcher.Changed += OnSettingsFileUpdated;
pssaCmdletEngineBuilder.WithSettingsFile(settingsFilePath);
}
else
Expand All @@ -286,22 +310,22 @@ private bool TryFindSettingsFile(out string settingsFilePath)
{
string configuredPath = _configurationService.CurrentSettings.ScriptAnalysis.SettingsPath;

if (!string.IsNullOrEmpty(configuredPath))
if (string.IsNullOrEmpty(configuredPath))
{
settingsFilePath = _workplaceService.ResolveWorkspacePath(configuredPath);
settingsFilePath = null;
return false;
}

if (settingsFilePath == null)
{
_logger.LogError($"Unable to find PSSA settings file at '{configuredPath}'. Loading default rules.");
}
settingsFilePath = _workplaceService.ResolveWorkspacePath(configuredPath);

return settingsFilePath != null;
if (settingsFilePath == null
|| !File.Exists(settingsFilePath))
{
_logger.LogError($"Unable to find PSSA settings file at '{configuredPath}'. Loading default rules.");
return false;
}

// TODO: Could search for a default here

settingsFilePath = null;
return false;
return true;
}

private void ClearOpenFileMarkers()
Expand Down