Fix up to date check & improve logging #2332
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
basoundr
reviewed
May 31, 2017
| public void Info(string message, params object[] values) => Log(LogLevel.Info, message, values); | ||
|
|
||
| public void Verbose(string message, params object[] values) => Log(LogLevel.Verbose, message, values); | ||
| } |
| } | ||
| else | ||
| { | ||
| Log(logger, "One or more outputs do not exist."); | ||
| logger.Info("Output '{0}' does not exist.", earliestOutput.path); | ||
| } | ||
|
|
||
| // We are up to date if the earliest output write happened before the latest input write |
There was a problem hiding this comment.
May be I am not reading this correct.
I would expect the condition to be, we are up to date if the latest input write is before the earliest output write? meaning, we are only update as long as all the outputs are created after last the input write has been made.
| { | ||
| if (level <= _requestedLogLevel) | ||
| { | ||
| _logger?.WriteLine("FastUpToDate: " + string.Format(message, values) + " (" + Path.GetFileNameWithoutExtension(_projectPath) + ")"); |
There was a problem hiding this comment.
Can you interploated string here
| { | ||
| if (level <= _requestedLogLevel) | ||
| { | ||
| _logger?.WriteLine("FastUpToDate: " + string.Format(message, values) + " (" + Path.GetFileNameWithoutExtension(_projectPath) + ")"); |
There was a problem hiding this comment.
Path.GetFileNameWithoutExtension(_projectPath) can be cached
| @@ -18,6 +18,31 @@ namespace Microsoft.VisualStudio.ProjectSystem | |||
| [Export(typeof(IBuildUpToDateCheckProvider))] | |||
| internal sealed class BuildUpToDateCheck : OnceInitializedOnceDisposed, IBuildUpToDateCheckProvider | |||
| { | |||
| private sealed class Logger | |||
srivatsn
approved these changes
May 31, 2017
|
Tagging @MattGertz for approval. |
basoundr
reviewed
May 31, 2017
| } | ||
|
|
||
| private void Log(LogLevel level, string message, params object[] values) | ||
| { | ||
| if (level <= _requestedLogLevel) | ||
| { | ||
| _logger?.WriteLine("FastUpToDate: " + string.Format(message, values) + " (" + Path.GetFileNameWithoutExtension(_projectPath) + ")"); | ||
| _logger?.WriteLine($"FastUpToDate: {string.Format(message, values)} ({Path.GetFileNameWithoutExtension(_fileName)})"); |
There was a problem hiding this comment.
You dont need Path.GetFileNameWithoutExtension(_fileName) instead just _fileName because Path.GetFileNameWithoutExtension is already applied on _fileName
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Customer scenario
The fast up to date check is broken since it erroneously believes all projects have opted out of up to date checks. Also, logging is too verbose and needs to be reined in to be useful in large solutions. This adds levels of logging that allow more terse logging that can be useful to see problems and then more verbose logging to diagnose issues.
Workarounds, if any
None.
Risk
Low, fixes a broken new feature.
Performance impact
Just turned on a broken feature.
Is this a regression from a previous update?
No.
Root cause analysis:
We're currently missing integration tests for fast up to date. Once integration tests are actually running again, I'm going to add tests to prevent breaks like this.
How was the bug found?
Ad hoc testing.