[iOS] Fix the mess we had with the logs. #208
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
The initial implementation of the logs, yet usefull, it was wrong. It made it very easy to pass Logs that do have certain missing properties and methods to other classes that used those methods, resulting in runtime issues. We move to have different interfaces that will allow to say which is the minimun amonunt of methods to be implemented (ILog) or the maximun one (IFileBackedLog) so that the compiler will help us to not pass a MemoryLog or a ConsoleLog to those methods that will like to use, for example, the FullPath of the log. This might look like a breaking change for xamarin-macios, but whatever it breaks was a hidden bug.
premun
approved these changes
May 15, 2020
| /// </summary> | ||
| public interface IReadable | ||
| { | ||
| StreamReader GetReader(); |
There was a problem hiding this comment.
Why do we have this IReadable? Why not put GetReader() straight to IReadableLog?
There was a problem hiding this comment.
Seemed to be a good idea at the time, but know that you mention it, I'll remove that, lets see what happens, no the compiler helps :)
There was a problem hiding this comment.
There are classes that just care about this interface. Gives us freedom.
| @@ -8,22 +8,22 @@ | |||
|
|
|||
| namespace Microsoft.DotNet.XHarness.iOS.Shared.Logging | |||
| { | |||
| public interface ILogs : IList<ILog>, IDisposable | |||
| public interface ILogs : IList<IFileBackedLog>, IDisposable | |||
There was a problem hiding this comment.
I guess these are then IFileBackedLogs?
There was a problem hiding this comment.
Also wondering - why not just IFileLog?
There was a problem hiding this comment.
I tried, less freedom :/
src/Microsoft.DotNet.XHarness.iOS.Shared/Logging/ReadableLog.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.DotNet.XHarness.iOS.Shared/Logging/ReadableLog.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Přemek Vysoký <[email protected]>
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.
The initial implementation of the logs, yet useful, it was wrong. It
made it very easy to pass Logs that do have certain missing properties
and methods to other classes that used those methods, resulting in
runtime issues.
We move to have different interfaces that will allow to say which is the
min amount of methods to be implemented (ILog) or the max one
(IFileBackedLog) so that the compiler will help us to not pass a
MemoryLog or a ConsoleLog to those methods that will like to use, for
example, the FullPath of the log.
This might look like a breaking change for xamarin-macios, but whatever
it breaks was a hidden bug.