Skip to content

Speed up execution by offloading logging#75

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
jeffhandley merged 9 commits into from
Aug 3, 2021
Merged

Speed up execution by offloading logging #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c983a4b
Move console write to their own thread
Aug 1, 2021
14accfa
Batch console writes
Aug 1, 2021
ccb0a52
Log to a file
Aug 2, 2021
8ab0a15
Update Libraries/Log.cs
Aug 2, 2021
97cf49f
Update Libraries/Log.cs
Aug 2, 2021
4621ab0
Change to Channels
Aug 3, 2021
e96b84b
Update Log.cs
Aug 3, 2021
d97de97
Update Log.cs
Aug 3, 2021
2e5691e
Update DocsPortingTool.cs
Aug 3, 2021
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
98 changes: 74 additions & 24 deletions Libraries/Log.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,97 @@
#nullable enable
using System;
using System.Diagnostics;
using System.IO;
using System.Text;
using System.Threading.Channels;
using System.Threading.Tasks;

namespace Libraries
{
internal class Log
public static class Log
{
private static void WriteLine(string format, params object[]? args)
private static Channel<(ConsoleColor, string, object[]?)> channel = Channel.CreateUnbounded<(ConsoleColor, string, object[]?)>();

public static async Task StartAsync()
{
if (args == null || args.Length == 0)
{
Console.WriteLine(format);
}
else
using FileStream fs = new(Path.GetTempFileName(), FileMode.Open);
using StreamWriter sw = new(fs);

ConsoleColor initialForeground = Console.ForegroundColor;
ConsoleColor foreground = initialForeground; // cheaper than reading it each time

StringBuilder combined = new(65_536);

bool unwrittenBlob = false;
(ConsoleColor color, string msg, object[]? args) blob = new((ConsoleColor)(-1), "", null); // compiler can't figure out we won't use this

Stopwatch stopwatch = Stopwatch.StartNew();

while (await channel.Reader.WaitToReadAsync())
{
Console.WriteLine(format, args);
while (unwrittenBlob || await channel.Reader.WaitToReadAsync())
{
if (unwrittenBlob && foreground != blob.color)
{
Console.ForegroundColor = blob.color;
foreground = blob.color;
}

if (!unwrittenBlob)
{
blob = await channel.Reader.ReadAsync();

if (blob.color != (ConsoleColor)(-1) && foreground != blob.color)
{
unwrittenBlob = true; // New color - emit what we have
break;
}
}

if (blob.args == null)
{
combined.Append(blob.msg);
}
else
{
combined.AppendFormat(blob.msg, blob.args);
}

unwrittenBlob = false;

if (stopwatch.ElapsedMilliseconds > 1000)
break;
}

stopwatch.Restart();

Console.Write(combined);
sw.Write(combined);

combined = combined.Length < 65_536 ? combined.Clear() : new StringBuilder();
}

if (foreground != initialForeground)
Console.ForegroundColor = initialForeground;

Console.WriteLine("Written log to {0}", fs.Name);
}

private static void Write(string format, params object[]? args)
public static void Finished()
{
if (args == null || args.Length == 0)
{
Console.Write(format);
}
else
{
Console.Write(format, args);
}
channel.Writer.Complete();
}

public static void Print(bool endline, ConsoleColor foregroundColor, string format, params object[]? args)
{
ConsoleColor initialColor = Console.ForegroundColor;
Console.ForegroundColor = foregroundColor;
if (endline)
{
WriteLine(format, args);
channel.Writer.WriteAsync((foregroundColor, format + Environment.NewLine, args));
}
else
{
Write(format, args);
channel.Writer.WriteAsync((foregroundColor, format, args));
}
Console.ForegroundColor = initialColor;
}

public static void Info(string format)
Expand DownExpand Up@@ -174,7 +224,7 @@ public static void Assert(bool endline, bool condition, string format, params ob

public static void Line()
{
Console.WriteLine();
Print(endline: true, (ConsoleColor)(-1), "", null);
}

public delegate void PrintHelpFunction();
Expand DownExpand Up@@ -449,4 +499,4 @@ the interface API.
");
}
}
}
}
6 changes: 2 additions & 4 deletions Libraries/ToTripleSlashPorter.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -186,9 +186,8 @@ private void AddSymbolLocationsToResolvedLocations(ProjectInformation projectInf
Log.Info(false, $"Symbol '{symbol.Name}' not found in locations of project '{path}'.");
if (n < symbol.Locations.Count())
{
Log.Info(false, " Trying the next location...");
Log.Info(true, " Trying the next location...");
}
Comment thread
jeffhandley marked this conversation as resolved.
Console.WriteLine();
}
n++;
}
Expand DownExpand Up@@ -245,9 +244,8 @@ private void FindSymbolInReferencedProjects(DocsType docsType, IEnumerable<Proje
Log.Info(false, $"Symbol for '{docsType.FullName}' not found in referenced project '{projectPath}'.");
if (n < projectReferences.Count())
{
Log.Info(false, $" Trying the next project...");
Log.Info(true, $" Trying the next project...");
Comment thread
jeffhandley marked this conversation as resolved.
}
Console.WriteLine();
}
n++;
}
Expand Down
7 changes: 6 additions & 1 deletion Program/DocsPortingTool.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
#nullable enable
using Libraries;
using System;
using System.Threading.Tasks;

namespace DocsPortingTool
{
class DocsPortingTool
{
public static void Main(string[] args)
public static async Task Main(string[] args)
{
Task loggingTask = Log.StartAsync();
Configuration config = Configuration.GetCLIArgumentsForDocsPortingTool(args);
switch (config.Direction)
{
Expand All@@ -25,6 +27,9 @@ public static void Main(string[] args)
default:
throw new ArgumentOutOfRangeException($"Unrecognized porting direction: {config.Direction}");
}

Log.Finished();
await loggingTask;
}
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Speed up execution by offloading logging by danmoseley · Pull Request #75 · dotnet/api-docs-sync · GitHub
Skip to content
Speed up execution by offloading logging#75

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

jeffhandley
merged 9 commits into

from

Aug 3, 2021
 Merged


Speed up execution by offloading logging
#75
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
c983a4b

Move console write to their own thread

Aug 1, 2021
14accfa

Batch console writes

Aug 1, 2021
ccb0a52

Log to a file

Aug 2, 2021
8ab0a15

Update Libraries/Log.cs

Aug 2, 2021
97cf49f

Update Libraries/Log.cs

Aug 2, 2021
4621ab0

Change to Channels

Aug 3, 2021
e96b84b

Update Log.cs

Aug 3, 2021
d97de97

Update Log.cs

Aug 3, 2021
2e5691e

Update DocsPortingTool.cs

Aug 3, 2021

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


98 changes: 74 additions & 24 deletions
Libraries/Log.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,47 +1,97 @@
#nullable enable
using System;
using System.Diagnostics;
using System.IO;
using System.Text;
using System.Threading.Channels;
using System.Threading.Tasks;

namespace Libraries
{
internal class Log
public static class Log
 {
 private static void WriteLine(string format, params object[]? args)
 private static Channel<(ConsoleColor, string, object[]?)> channel = Channel.CreateUnbounded<(ConsoleColor, string, object[]?)>();

 public static async Task StartAsync()
 {
 if (args == null || args.Length == 0)
 {
 Console.WriteLine(format);
 }
 else
 using FileStream fs = new(Path.GetTempFileName(), FileMode.Open);
 using StreamWriter sw = new(fs);

 ConsoleColor initialForeground = Console.ForegroundColor;
 ConsoleColor foreground = initialForeground; // cheaper than reading it each time

 StringBuilder combined = new(65_536);

 bool unwrittenBlob = false;
 (ConsoleColor color, string msg, object[]? args) blob = new((ConsoleColor)(-1), "", null); // compiler can't figure out we won't use this

 Stopwatch stopwatch = Stopwatch.StartNew();

 while (await channel.Reader.WaitToReadAsync())
 {
 Console.WriteLine(format, args);
 while (unwrittenBlob || await channel.Reader.WaitToReadAsync())
 {
 if (unwrittenBlob && foreground != blob.color)
 {
 Console.ForegroundColor = blob.color;
 foreground = blob.color;
 }

 if (!unwrittenBlob)
 {
 blob = await channel.Reader.ReadAsync();

 if (blob.color != (ConsoleColor)(-1) && foreground != blob.color)
 {
 unwrittenBlob = true; // New color - emit what we have
 break;
 }
 }

 if (blob.args == null)
 {
 combined.Append(blob.msg);
 }
 else
 {
 combined.AppendFormat(blob.msg, blob.args);
 }

 unwrittenBlob = false;

 if (stopwatch.ElapsedMilliseconds > 1000)
 break;
 }

 stopwatch.Restart();

 Console.Write(combined);
 sw.Write(combined);

 combined = combined.Length < 65_536 ? combined.Clear() : new StringBuilder();
 }

 if (foreground != initialForeground)
 Console.ForegroundColor = initialForeground;

 Console.WriteLine("Written log to {0}", fs.Name);
 }

private static void Write(string format, params object[]? args)
public static void Finished()
 {
 if (args == null || args.Length == 0)
 {
 Console.Write(format);
 }
 else
 {
 Console.Write(format, args);
 }
 channel.Writer.Complete();
 }

 public static void Print(bool endline, ConsoleColor foregroundColor, string format, params object[]? args)
 {
 ConsoleColor initialColor = Console.ForegroundColor;
 Console.ForegroundColor = foregroundColor;
 if (endline)
 {
WriteLine(format, args);
channel.Writer.WriteAsync((foregroundColor, format + Environment.NewLine, args));
 }
 else
 {
Write(format, args);
channel.Writer.WriteAsync((foregroundColor, format, args));
 }
 Console.ForegroundColor = initialColor;
 }

 public static void Info(string format)
Expand DownExpand Up@@ -174,7 +224,7 @@ public static void Assert(bool endline, bool condition, string format, params ob

 public static void Line()
 {
Console.WriteLine();
Print(endline: true, (ConsoleColor)(-1), "", null);
 }

 public delegate void PrintHelpFunction();
Expand DownExpand Up@@ -449,4 +499,4 @@ the interface API.
 ");
 }
 }
}
}

6 changes: 2 additions & 4 deletions
Libraries/ToTripleSlashPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -186,9 +186,8 @@ private void AddSymbolLocationsToResolvedLocations(ProjectInformation projectInf
 Log.Info(false, $"Symbol '{symbol.Name}' not found in locations of project '{path}'.");
 if (n < symbol.Locations.Count())
 {
 Log.Info(false, " Trying the next location...");
 Log.Info(true, " Trying the next location...");
 }
Comment thread
jeffhandley marked this conversation as resolved.

 Console.WriteLine();
 }
 n++;
 }
Expand DownExpand Up@@ -245,9 +244,8 @@ private void FindSymbolInReferencedProjects(DocsType docsType, IEnumerable<Proje
 Log.Info(false, $"Symbol for '{docsType.FullName}' not found in referenced project '{projectPath}'.");
 if (n < projectReferences.Count())
 {
 Log.Info(false, $" Trying the next project...");
 Log.Info(true, $" Trying the next project...");
Comment thread
jeffhandley marked this conversation as resolved.

 }
 Console.WriteLine();
 }
 n++;
 }
Expand Down

7 changes: 6 additions & 1 deletion
Program/DocsPortingTool.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
#nullable enable
using Libraries;
using System;
using System.Threading.Tasks;

namespace DocsPortingTool
{
 class DocsPortingTool
 {
 public static void Main(string[] args)
 public static async Task Main(string[] args)
 {
 Task loggingTask = Log.StartAsync();
 Configuration config = Configuration.GetCLIArgumentsForDocsPortingTool(args);
 switch (config.Direction)
 {
Expand All@@ -25,6 +27,9 @@ public static void Main(string[] args)
 default:
 throw new ArgumentOutOfRangeException($"Unrecognized porting direction: {config.Direction}");
 }

 Log.Finished();
 await loggingTask;
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Speed up execution by offloading logging by danmoseley · Pull Request #75 · dotnet/api-docs-sync · GitHub
Skip to content
Speed up execution by offloading logging#75

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

jeffhandley
merged 9 commits into

from

Aug 3, 2021
 Merged


Speed up execution by offloading logging
#75
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
c983a4b

Move console write to their own thread

Aug 1, 2021
14accfa

Batch console writes

Aug 1, 2021
ccb0a52

Log to a file

Aug 2, 2021
8ab0a15

Update Libraries/Log.cs

Aug 2, 2021
97cf49f

Update Libraries/Log.cs

Aug 2, 2021
4621ab0

Change to Channels

Aug 3, 2021
e96b84b

Update Log.cs

Aug 3, 2021
d97de97

Update Log.cs

Aug 3, 2021
2e5691e

Update DocsPortingTool.cs

Aug 3, 2021

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


98 changes: 74 additions & 24 deletions
Libraries/Log.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,47 +1,97 @@
#nullable enable
using System;
using System.Diagnostics;
using System.IO;
using System.Text;
using System.Threading.Channels;
using System.Threading.Tasks;

namespace Libraries
{
internal class Log
public static class Log
 {
 private static void WriteLine(string format, params object[]? args)
 private static Channel<(ConsoleColor, string, object[]?)> channel = Channel.CreateUnbounded<(ConsoleColor, string, object[]?)>();

 public static async Task StartAsync()
 {
 if (args == null || args.Length == 0)
 {
 Console.WriteLine(format);
 }
 else
 using FileStream fs = new(Path.GetTempFileName(), FileMode.Open);
 using StreamWriter sw = new(fs);

 ConsoleColor initialForeground = Console.ForegroundColor;
 ConsoleColor foreground = initialForeground; // cheaper than reading it each time

 StringBuilder combined = new(65_536);

 bool unwrittenBlob = false;
 (ConsoleColor color, string msg, object[]? args) blob = new((ConsoleColor)(-1), "", null); // compiler can't figure out we won't use this

 Stopwatch stopwatch = Stopwatch.StartNew();

 while (await channel.Reader.WaitToReadAsync())
 {
 Console.WriteLine(format, args);
 while (unwrittenBlob || await channel.Reader.WaitToReadAsync())
 {
 if (unwrittenBlob && foreground != blob.color)
 {
 Console.ForegroundColor = blob.color;
 foreground = blob.color;
 }

 if (!unwrittenBlob)
 {
 blob = await channel.Reader.ReadAsync();

 if (blob.color != (ConsoleColor)(-1) && foreground != blob.color)
 {
 unwrittenBlob = true; // New color - emit what we have
 break;
 }
 }

 if (blob.args == null)
 {
 combined.Append(blob.msg);
 }
 else
 {
 combined.AppendFormat(blob.msg, blob.args);
 }

 unwrittenBlob = false;

 if (stopwatch.ElapsedMilliseconds > 1000)
 break;
 }

 stopwatch.Restart();

 Console.Write(combined);
 sw.Write(combined);

 combined = combined.Length < 65_536 ? combined.Clear() : new StringBuilder();
 }

 if (foreground != initialForeground)
 Console.ForegroundColor = initialForeground;

 Console.WriteLine("Written log to {0}", fs.Name);
 }

private static void Write(string format, params object[]? args)
public static void Finished()
 {
 if (args == null || args.Length == 0)
 {
 Console.Write(format);
 }
 else
 {
 Console.Write(format, args);
 }
 channel.Writer.Complete();
 }

 public static void Print(bool endline, ConsoleColor foregroundColor, string format, params object[]? args)
 {
 ConsoleColor initialColor = Console.ForegroundColor;
 Console.ForegroundColor = foregroundColor;
 if (endline)
 {
WriteLine(format, args);
channel.Writer.WriteAsync((foregroundColor, format + Environment.NewLine, args));
 }
 else
 {
Write(format, args);
channel.Writer.WriteAsync((foregroundColor, format, args));
 }
 Console.ForegroundColor = initialColor;
 }

 public static void Info(string format)
Expand DownExpand Up@@ -174,7 +224,7 @@ public static void Assert(bool endline, bool condition, string format, params ob

 public static void Line()
 {
Console.WriteLine();
Print(endline: true, (ConsoleColor)(-1), "", null);
 }

 public delegate void PrintHelpFunction();
Expand DownExpand Up@@ -449,4 +499,4 @@ the interface API.
 ");
 }
 }
}
}

6 changes: 2 additions & 4 deletions
Libraries/ToTripleSlashPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -186,9 +186,8 @@ private void AddSymbolLocationsToResolvedLocations(ProjectInformation projectInf
 Log.Info(false, $"Symbol '{symbol.Name}' not found in locations of project '{path}'.");
 if (n < symbol.Locations.Count())
 {
 Log.Info(false, " Trying the next location...");
 Log.Info(true, " Trying the next location...");
 }
Comment thread
jeffhandley marked this conversation as resolved.

 Console.WriteLine();
 }
 n++;
 }
Expand DownExpand Up@@ -245,9 +244,8 @@ private void FindSymbolInReferencedProjects(DocsType docsType, IEnumerable<Proje
 Log.Info(false, $"Symbol for '{docsType.FullName}' not found in referenced project '{projectPath}'.");
 if (n < projectReferences.Count())
 {
 Log.Info(false, $" Trying the next project...");
 Log.Info(true, $" Trying the next project...");
Comment thread
jeffhandley marked this conversation as resolved.

 }
 Console.WriteLine();
 }
 n++;
 }
Expand Down

7 changes: 6 additions & 1 deletion
Program/DocsPortingTool.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
#nullable enable
using Libraries;
using System;
using System.Threading.Tasks;

namespace DocsPortingTool
{
 class DocsPortingTool
 {
 public static void Main(string[] args)
 public static async Task Main(string[] args)
 {
 Task loggingTask = Log.StartAsync();
 Configuration config = Configuration.GetCLIArgumentsForDocsPortingTool(args);
 switch (config.Direction)
 {
Expand All@@ -25,6 +27,9 @@ public static void Main(string[] args)
 default:
 throw new ArgumentOutOfRangeException($"Unrecognized porting direction: {config.Direction}");
 }

 Log.Finished();
 await loggingTask;
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Speed up execution by offloading logging by danmoseley · Pull Request #75 · dotnet/api-docs-sync · GitHub
Skip to content
Speed up execution by offloading logging#75

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

jeffhandley
merged 9 commits into

from

Aug 3, 2021
 Merged


Speed up execution by offloading logging
#75
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
c983a4b

Move console write to their own thread

Aug 1, 2021
14accfa

Batch console writes

Aug 1, 2021
ccb0a52

Log to a file

Aug 2, 2021
8ab0a15

Update Libraries/Log.cs

Aug 2, 2021
97cf49f

Update Libraries/Log.cs

Aug 2, 2021
4621ab0

Change to Channels

Aug 3, 2021
e96b84b

Update Log.cs

Aug 3, 2021
d97de97

Update Log.cs

Aug 3, 2021
2e5691e

Update DocsPortingTool.cs

Aug 3, 2021

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


98 changes: 74 additions & 24 deletions
Libraries/Log.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,47 +1,97 @@
#nullable enable
using System;
using System.Diagnostics;
using System.IO;
using System.Text;
using System.Threading.Channels;
using System.Threading.Tasks;

namespace Libraries
{
internal class Log
public static class Log
 {
 private static void WriteLine(string format, params object[]? args)
 private static Channel<(ConsoleColor, string, object[]?)> channel = Channel.CreateUnbounded<(ConsoleColor, string, object[]?)>();

 public static async Task StartAsync()
 {
 if (args == null || args.Length == 0)
 {
 Console.WriteLine(format);
 }
 else
 using FileStream fs = new(Path.GetTempFileName(), FileMode.Open);
 using StreamWriter sw = new(fs);

 ConsoleColor initialForeground = Console.ForegroundColor;
 ConsoleColor foreground = initialForeground; // cheaper than reading it each time

 StringBuilder combined = new(65_536);

 bool unwrittenBlob = false;
 (ConsoleColor color, string msg, object[]? args) blob = new((ConsoleColor)(-1), "", null); // compiler can't figure out we won't use this

 Stopwatch stopwatch = Stopwatch.StartNew();

 while (await channel.Reader.WaitToReadAsync())
 {
 Console.WriteLine(format, args);
 while (unwrittenBlob || await channel.Reader.WaitToReadAsync())
 {
 if (unwrittenBlob && foreground != blob.color)
 {
 Console.ForegroundColor = blob.color;
 foreground = blob.color;
 }

 if (!unwrittenBlob)
 {
 blob = await channel.Reader.ReadAsync();

 if (blob.color != (ConsoleColor)(-1) && foreground != blob.color)
 {
 unwrittenBlob = true; // New color - emit what we have
 break;
 }
 }

 if (blob.args == null)
 {
 combined.Append(blob.msg);
 }
 else
 {
 combined.AppendFormat(blob.msg, blob.args);
 }

 unwrittenBlob = false;

 if (stopwatch.ElapsedMilliseconds > 1000)
 break;
 }

 stopwatch.Restart();

 Console.Write(combined);
 sw.Write(combined);

 combined = combined.Length < 65_536 ? combined.Clear() : new StringBuilder();
 }

 if (foreground != initialForeground)
 Console.ForegroundColor = initialForeground;

 Console.WriteLine("Written log to {0}", fs.Name);
 }

private static void Write(string format, params object[]? args)
public static void Finished()
 {
 if (args == null || args.Length == 0)
 {
 Console.Write(format);
 }
 else
 {
 Console.Write(format, args);
 }
 channel.Writer.Complete();
 }

 public static void Print(bool endline, ConsoleColor foregroundColor, string format, params object[]? args)
 {
 ConsoleColor initialColor = Console.ForegroundColor;
 Console.ForegroundColor = foregroundColor;
 if (endline)
 {
WriteLine(format, args);
channel.Writer.WriteAsync((foregroundColor, format + Environment.NewLine, args));
 }
 else
 {
Write(format, args);
channel.Writer.WriteAsync((foregroundColor, format, args));
 }
 Console.ForegroundColor = initialColor;
 }

 public static void Info(string format)
Expand DownExpand Up@@ -174,7 +224,7 @@ public static void Assert(bool endline, bool condition, string format, params ob

 public static void Line()
 {
Console.WriteLine();
Print(endline: true, (ConsoleColor)(-1), "", null);
 }

 public delegate void PrintHelpFunction();
Expand DownExpand Up@@ -449,4 +499,4 @@ the interface API.
 ");
 }
 }
}
}

6 changes: 2 additions & 4 deletions
Libraries/ToTripleSlashPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -186,9 +186,8 @@ private void AddSymbolLocationsToResolvedLocations(ProjectInformation projectInf
 Log.Info(false, $"Symbol '{symbol.Name}' not found in locations of project '{path}'.");
 if (n < symbol.Locations.Count())
 {
 Log.Info(false, " Trying the next location...");
 Log.Info(true, " Trying the next location...");
 }
Comment thread
jeffhandley marked this conversation as resolved.

 Console.WriteLine();
 }
 n++;
 }
Expand DownExpand Up@@ -245,9 +244,8 @@ private void FindSymbolInReferencedProjects(DocsType docsType, IEnumerable<Proje
 Log.Info(false, $"Symbol for '{docsType.FullName}' not found in referenced project '{projectPath}'.");
 if (n < projectReferences.Count())
 {
 Log.Info(false, $" Trying the next project...");
 Log.Info(true, $" Trying the next project...");
Comment thread
jeffhandley marked this conversation as resolved.

 }
 Console.WriteLine();
 }
 n++;
 }
Expand Down

7 changes: 6 additions & 1 deletion
Program/DocsPortingTool.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
#nullable enable
using Libraries;
using System;
using System.Threading.Tasks;

namespace DocsPortingTool
{
 class DocsPortingTool
 {
 public static void Main(string[] args)
 public static async Task Main(string[] args)
 {
 Task loggingTask = Log.StartAsync();
 Configuration config = Configuration.GetCLIArgumentsForDocsPortingTool(args);
 switch (config.Direction)
 {
Expand All@@ -25,6 +27,9 @@ public static void Main(string[] args)
 default:
 throw new ArgumentOutOfRangeException($"Unrecognized porting direction: {config.Direction}");
 }

 Log.Finished();
 await loggingTask;
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Speed up execution by offloading logging by danmoseley · Pull Request #75 · dotnet/api-docs-sync · GitHub
Skip to content
Speed up execution by offloading logging#75

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

jeffhandley
merged 9 commits into

from

Aug 3, 2021
 Merged


Speed up execution by offloading logging
#75
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
c983a4b

Move console write to their own thread

Aug 1, 2021
14accfa

Batch console writes

Aug 1, 2021
ccb0a52

Log to a file

Aug 2, 2021
8ab0a15

Update Libraries/Log.cs

Aug 2, 2021
97cf49f

Update Libraries/Log.cs

Aug 2, 2021
4621ab0

Change to Channels

Aug 3, 2021
e96b84b

Update Log.cs

Aug 3, 2021
d97de97

Update Log.cs

Aug 3, 2021
2e5691e

Update DocsPortingTool.cs

Aug 3, 2021

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


98 changes: 74 additions & 24 deletions
Libraries/Log.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,47 +1,97 @@
#nullable enable
using System;
using System.Diagnostics;
using System.IO;
using System.Text;
using System.Threading.Channels;
using System.Threading.Tasks;

namespace Libraries
{
internal class Log
public static class Log
 {
 private static void WriteLine(string format, params object[]? args)
 private static Channel<(ConsoleColor, string, object[]?)> channel = Channel.CreateUnbounded<(ConsoleColor, string, object[]?)>();

 public static async Task StartAsync()
 {
 if (args == null || args.Length == 0)
 {
 Console.WriteLine(format);
 }
 else
 using FileStream fs = new(Path.GetTempFileName(), FileMode.Open);
 using StreamWriter sw = new(fs);

 ConsoleColor initialForeground = Console.ForegroundColor;
 ConsoleColor foreground = initialForeground; // cheaper than reading it each time

 StringBuilder combined = new(65_536);

 bool unwrittenBlob = false;
 (ConsoleColor color, string msg, object[]? args) blob = new((ConsoleColor)(-1), "", null); // compiler can't figure out we won't use this

 Stopwatch stopwatch = Stopwatch.StartNew();

 while (await channel.Reader.WaitToReadAsync())
 {
 Console.WriteLine(format, args);
 while (unwrittenBlob || await channel.Reader.WaitToReadAsync())
 {
 if (unwrittenBlob && foreground != blob.color)
 {
 Console.ForegroundColor = blob.color;
 foreground = blob.color;
 }

 if (!unwrittenBlob)
 {
 blob = await channel.Reader.ReadAsync();

 if (blob.color != (ConsoleColor)(-1) && foreground != blob.color)
 {
 unwrittenBlob = true; // New color - emit what we have
 break;
 }
 }

 if (blob.args == null)
 {
 combined.Append(blob.msg);
 }
 else
 {
 combined.AppendFormat(blob.msg, blob.args);
 }

 unwrittenBlob = false;

 if (stopwatch.ElapsedMilliseconds > 1000)
 break;
 }

 stopwatch.Restart();

 Console.Write(combined);
 sw.Write(combined);

 combined = combined.Length < 65_536 ? combined.Clear() : new StringBuilder();
 }

 if (foreground != initialForeground)
 Console.ForegroundColor = initialForeground;

 Console.WriteLine("Written log to {0}", fs.Name);
 }

private static void Write(string format, params object[]? args)
public static void Finished()
 {
 if (args == null || args.Length == 0)
 {
 Console.Write(format);
 }
 else
 {
 Console.Write(format, args);
 }
 channel.Writer.Complete();
 }

 public static void Print(bool endline, ConsoleColor foregroundColor, string format, params object[]? args)
 {
 ConsoleColor initialColor = Console.ForegroundColor;
 Console.ForegroundColor = foregroundColor;
 if (endline)
 {
WriteLine(format, args);
channel.Writer.WriteAsync((foregroundColor, format + Environment.NewLine, args));
 }
 else
 {
Write(format, args);
channel.Writer.WriteAsync((foregroundColor, format, args));
 }
 Console.ForegroundColor = initialColor;
 }

 public static void Info(string format)
Expand DownExpand Up@@ -174,7 +224,7 @@ public static void Assert(bool endline, bool condition, string format, params ob

 public static void Line()
 {
Console.WriteLine();
Print(endline: true, (ConsoleColor)(-1), "", null);
 }

 public delegate void PrintHelpFunction();
Expand DownExpand Up@@ -449,4 +499,4 @@ the interface API.
 ");
 }
 }
}
}

6 changes: 2 additions & 4 deletions
Libraries/ToTripleSlashPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -186,9 +186,8 @@ private void AddSymbolLocationsToResolvedLocations(ProjectInformation projectInf
 Log.Info(false, $"Symbol '{symbol.Name}' not found in locations of project '{path}'.");
 if (n < symbol.Locations.Count())
 {
 Log.Info(false, " Trying the next location...");
 Log.Info(true, " Trying the next location...");
 }
Comment thread
jeffhandley marked this conversation as resolved.

 Console.WriteLine();
 }
 n++;
 }
Expand DownExpand Up@@ -245,9 +244,8 @@ private void FindSymbolInReferencedProjects(DocsType docsType, IEnumerable<Proje
 Log.Info(false, $"Symbol for '{docsType.FullName}' not found in referenced project '{projectPath}'.");
 if (n < projectReferences.Count())
 {
 Log.Info(false, $" Trying the next project...");
 Log.Info(true, $" Trying the next project...");
Comment thread
jeffhandley marked this conversation as resolved.

 }
 Console.WriteLine();
 }
 n++;
 }
Expand Down

7 changes: 6 additions & 1 deletion
Program/DocsPortingTool.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
#nullable enable
using Libraries;
using System;
using System.Threading.Tasks;

namespace DocsPortingTool
{
 class DocsPortingTool
 {
 public static void Main(string[] args)
 public static async Task Main(string[] args)
 {
 Task loggingTask = Log.StartAsync();
 Configuration config = Configuration.GetCLIArgumentsForDocsPortingTool(args);
 switch (config.Direction)
 {
Expand All@@ -25,6 +27,9 @@ public static void Main(string[] args)
 default:
 throw new ArgumentOutOfRangeException($"Unrecognized porting direction: {config.Direction}");
 }

 Log.Finished();
 await loggingTask;
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Speed up execution by offloading logging by danmoseley · Pull Request #75 · dotnet/api-docs-sync · GitHub
Skip to content
Speed up execution by offloading logging#75

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

jeffhandley
merged 9 commits into

from

Aug 3, 2021
 Merged


Speed up execution by offloading logging
#75
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
c983a4b

Move console write to their own thread

Aug 1, 2021
14accfa

Batch console writes

Aug 1, 2021
ccb0a52

Log to a file

Aug 2, 2021
8ab0a15

Update Libraries/Log.cs

Aug 2, 2021
97cf49f

Update Libraries/Log.cs

Aug 2, 2021
4621ab0

Change to Channels

Aug 3, 2021
e96b84b

Update Log.cs

Aug 3, 2021
d97de97

Update Log.cs

Aug 3, 2021
2e5691e

Update DocsPortingTool.cs

Aug 3, 2021

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


98 changes: 74 additions & 24 deletions
Libraries/Log.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,47 +1,97 @@
#nullable enable
using System;
using System.Diagnostics;
using System.IO;
using System.Text;
using System.Threading.Channels;
using System.Threading.Tasks;

namespace Libraries
{
internal class Log
public static class Log
 {
 private static void WriteLine(string format, params object[]? args)
 private static Channel<(ConsoleColor, string, object[]?)> channel = Channel.CreateUnbounded<(ConsoleColor, string, object[]?)>();

 public static async Task StartAsync()
 {
 if (args == null || args.Length == 0)
 {
 Console.WriteLine(format);
 }
 else
 using FileStream fs = new(Path.GetTempFileName(), FileMode.Open);
 using StreamWriter sw = new(fs);

 ConsoleColor initialForeground = Console.ForegroundColor;
 ConsoleColor foreground = initialForeground; // cheaper than reading it each time

 StringBuilder combined = new(65_536);

 bool unwrittenBlob = false;
 (ConsoleColor color, string msg, object[]? args) blob = new((ConsoleColor)(-1), "", null); // compiler can't figure out we won't use this

 Stopwatch stopwatch = Stopwatch.StartNew();

 while (await channel.Reader.WaitToReadAsync())
 {
 Console.WriteLine(format, args);
 while (unwrittenBlob || await channel.Reader.WaitToReadAsync())
 {
 if (unwrittenBlob && foreground != blob.color)
 {
 Console.ForegroundColor = blob.color;
 foreground = blob.color;
 }

 if (!unwrittenBlob)
 {
 blob = await channel.Reader.ReadAsync();

 if (blob.color != (ConsoleColor)(-1) && foreground != blob.color)
 {
 unwrittenBlob = true; // New color - emit what we have
 break;
 }
 }

 if (blob.args == null)
 {
 combined.Append(blob.msg);
 }
 else
 {
 combined.AppendFormat(blob.msg, blob.args);
 }

 unwrittenBlob = false;

 if (stopwatch.ElapsedMilliseconds > 1000)
 break;
 }

 stopwatch.Restart();

 Console.Write(combined);
 sw.Write(combined);

 combined = combined.Length < 65_536 ? combined.Clear() : new StringBuilder();
 }

 if (foreground != initialForeground)
 Console.ForegroundColor = initialForeground;

 Console.WriteLine("Written log to {0}", fs.Name);
 }

private static void Write(string format, params object[]? args)
public static void Finished()
 {
 if (args == null || args.Length == 0)
 {
 Console.Write(format);
 }
 else
 {
 Console.Write(format, args);
 }
 channel.Writer.Complete();
 }

 public static void Print(bool endline, ConsoleColor foregroundColor, string format, params object[]? args)
 {
 ConsoleColor initialColor = Console.ForegroundColor;
 Console.ForegroundColor = foregroundColor;
 if (endline)
 {
WriteLine(format, args);
channel.Writer.WriteAsync((foregroundColor, format + Environment.NewLine, args));
 }
 else
 {
Write(format, args);
channel.Writer.WriteAsync((foregroundColor, format, args));
 }
 Console.ForegroundColor = initialColor;
 }

 public static void Info(string format)
Expand DownExpand Up@@ -174,7 +224,7 @@ public static void Assert(bool endline, bool condition, string format, params ob

 public static void Line()
 {
Console.WriteLine();
Print(endline: true, (ConsoleColor)(-1), "", null);
 }

 public delegate void PrintHelpFunction();
Expand DownExpand Up@@ -449,4 +499,4 @@ the interface API.
 ");
 }
 }
}
}

6 changes: 2 additions & 4 deletions
Libraries/ToTripleSlashPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -186,9 +186,8 @@ private void AddSymbolLocationsToResolvedLocations(ProjectInformation projectInf
 Log.Info(false, $"Symbol '{symbol.Name}' not found in locations of project '{path}'.");
 if (n < symbol.Locations.Count())
 {
 Log.Info(false, " Trying the next location...");
 Log.Info(true, " Trying the next location...");
 }
Comment thread
jeffhandley marked this conversation as resolved.

 Console.WriteLine();
 }
 n++;
 }
Expand DownExpand Up@@ -245,9 +244,8 @@ private void FindSymbolInReferencedProjects(DocsType docsType, IEnumerable<Proje
 Log.Info(false, $"Symbol for '{docsType.FullName}' not found in referenced project '{projectPath}'.");
 if (n < projectReferences.Count())
 {
 Log.Info(false, $" Trying the next project...");
 Log.Info(true, $" Trying the next project...");
Comment thread
jeffhandley marked this conversation as resolved.

 }
 Console.WriteLine();
 }
 n++;
 }
Expand Down

7 changes: 6 additions & 1 deletion
Program/DocsPortingTool.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
#nullable enable
using Libraries;
using System;
using System.Threading.Tasks;

namespace DocsPortingTool
{
 class DocsPortingTool
 {
 public static void Main(string[] args)
 public static async Task Main(string[] args)
 {
 Task loggingTask = Log.StartAsync();
 Configuration config = Configuration.GetCLIArgumentsForDocsPortingTool(args);
 switch (config.Direction)
 {
Expand All@@ -25,6 +27,9 @@ public static void Main(string[] args)
 default:
 throw new ArgumentOutOfRangeException($"Unrecognized porting direction: {config.Direction}");
 }

 Log.Finished();
 await loggingTask;
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
Speed up execution by offloading logging by danmoseley · Pull Request #75 · dotnet/api-docs-sync · GitHub
Skip to content
Speed up execution by offloading logging#75

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

jeffhandley
merged 9 commits into

from

Aug 3, 2021
 Merged


Speed up execution by offloading logging
#75
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
c983a4b

Move console write to their own thread

Aug 1, 2021
14accfa

Batch console writes

Aug 1, 2021
ccb0a52

Log to a file

Aug 2, 2021
8ab0a15

Update Libraries/Log.cs

Aug 2, 2021
97cf49f

Update Libraries/Log.cs

Aug 2, 2021
4621ab0

Change to Channels

Aug 3, 2021
e96b84b

Update Log.cs

Aug 3, 2021
d97de97

Update Log.cs

Aug 3, 2021
2e5691e

Update DocsPortingTool.cs

Aug 3, 2021

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


98 changes: 74 additions & 24 deletions
Libraries/Log.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,47 +1,97 @@
#nullable enable
using System;
using System.Diagnostics;
using System.IO;
using System.Text;
using System.Threading.Channels;
using System.Threading.Tasks;

namespace Libraries
{
internal class Log
public static class Log
 {
 private static void WriteLine(string format, params object[]? args)
 private static Channel<(ConsoleColor, string, object[]?)> channel = Channel.CreateUnbounded<(ConsoleColor, string, object[]?)>();

 public static async Task StartAsync()
 {
 if (args == null || args.Length == 0)
 {
 Console.WriteLine(format);
 }
 else
 using FileStream fs = new(Path.GetTempFileName(), FileMode.Open);
 using StreamWriter sw = new(fs);

 ConsoleColor initialForeground = Console.ForegroundColor;
 ConsoleColor foreground = initialForeground; // cheaper than reading it each time

 StringBuilder combined = new(65_536);

 bool unwrittenBlob = false;
 (ConsoleColor color, string msg, object[]? args) blob = new((ConsoleColor)(-1), "", null); // compiler can't figure out we won't use this

 Stopwatch stopwatch = Stopwatch.StartNew();

 while (await channel.Reader.WaitToReadAsync())
 {
 Console.WriteLine(format, args);
 while (unwrittenBlob || await channel.Reader.WaitToReadAsync())
 {
 if (unwrittenBlob && foreground != blob.color)
 {
 Console.ForegroundColor = blob.color;
 foreground = blob.color;
 }

 if (!unwrittenBlob)
 {
 blob = await channel.Reader.ReadAsync();

 if (blob.color != (ConsoleColor)(-1) && foreground != blob.color)
 {
 unwrittenBlob = true; // New color - emit what we have
 break;
 }
 }

 if (blob.args == null)
 {
 combined.Append(blob.msg);
 }
 else
 {
 combined.AppendFormat(blob.msg, blob.args);
 }

 unwrittenBlob = false;

 if (stopwatch.ElapsedMilliseconds > 1000)
 break;
 }

 stopwatch.Restart();

 Console.Write(combined);
 sw.Write(combined);

 combined = combined.Length < 65_536 ? combined.Clear() : new StringBuilder();
 }

 if (foreground != initialForeground)
 Console.ForegroundColor = initialForeground;

 Console.WriteLine("Written log to {0}", fs.Name);
 }

private static void Write(string format, params object[]? args)
public static void Finished()
 {
 if (args == null || args.Length == 0)
 {
 Console.Write(format);
 }
 else
 {
 Console.Write(format, args);
 }
 channel.Writer.Complete();
 }

 public static void Print(bool endline, ConsoleColor foregroundColor, string format, params object[]? args)
 {
 ConsoleColor initialColor = Console.ForegroundColor;
 Console.ForegroundColor = foregroundColor;
 if (endline)
 {
WriteLine(format, args);
channel.Writer.WriteAsync((foregroundColor, format + Environment.NewLine, args));
 }
 else
 {
Write(format, args);
channel.Writer.WriteAsync((foregroundColor, format, args));
 }
 Console.ForegroundColor = initialColor;
 }

 public static void Info(string format)
Expand DownExpand Up@@ -174,7 +224,7 @@ public static void Assert(bool endline, bool condition, string format, params ob

 public static void Line()
 {
Console.WriteLine();
Print(endline: true, (ConsoleColor)(-1), "", null);
 }

 public delegate void PrintHelpFunction();
Expand DownExpand Up@@ -449,4 +499,4 @@ the interface API.
 ");
 }
 }
}
}

6 changes: 2 additions & 4 deletions
Libraries/ToTripleSlashPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -186,9 +186,8 @@ private void AddSymbolLocationsToResolvedLocations(ProjectInformation projectInf
 Log.Info(false, $"Symbol '{symbol.Name}' not found in locations of project '{path}'.");
 if (n < symbol.Locations.Count())
 {
 Log.Info(false, " Trying the next location...");
 Log.Info(true, " Trying the next location...");
 }
Comment thread
jeffhandley marked this conversation as resolved.

 Console.WriteLine();
 }
 n++;
 }
Expand DownExpand Up@@ -245,9 +244,8 @@ private void FindSymbolInReferencedProjects(DocsType docsType, IEnumerable<Proje
 Log.Info(false, $"Symbol for '{docsType.FullName}' not found in referenced project '{projectPath}'.");
 if (n < projectReferences.Count())
 {
 Log.Info(false, $" Trying the next project...");
 Log.Info(true, $" Trying the next project...");
Comment thread
jeffhandley marked this conversation as resolved.

 }
 Console.WriteLine();
 }
 n++;
 }
Expand Down

7 changes: 6 additions & 1 deletion
Program/DocsPortingTool.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
#nullable enable
using Libraries;
using System;
using System.Threading.Tasks;

namespace DocsPortingTool
{
 class DocsPortingTool
 {
 public static void Main(string[] args)
 public static async Task Main(string[] args)
 {
 Task loggingTask = Log.StartAsync();
 Configuration config = Configuration.GetCLIArgumentsForDocsPortingTool(args);
 switch (config.Direction)
 {
Expand All@@ -25,6 +27,9 @@ public static void Main(string[] args)
 default:
 throw new ArgumentOutOfRangeException($"Unrecognized porting direction: {config.Direction}");
 }

 Log.Finished();
 await loggingTask;
 }
 }
}