Skip to content

Commit 864fe3d

Browse files
committed
net-logger: rename NetLogWriter to NetLogFileWriter
1 parent bba5669 commit 864fe3d

3 files changed

Lines changed: 17 additions & 17 deletions

File tree

BrowserGuard.Tests/NetLogger/NetLogWriterTests.cs renamed to BrowserGuard.Tests/NetLogger/NetLogFileWriterTests.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99

1010
namespace BrowserGuard.Tests.NetLogger
1111
{
12-
public class NetLogWriterTests : IDisposable
12+
public class NetLogFileWriterTests : IDisposable
1313
{
1414
readonly string tempDir;
1515

16-
public NetLogWriterTests()
16+
public NetLogFileWriterTests()
1717
{
1818
tempDir = Path.Combine(Path.GetTempPath(), "browserguard-netlog-" + Guid.NewGuid().ToString("N"));
1919
// Several tests put a day's file in place before the writer runs.
@@ -25,7 +25,7 @@ public void Dispose()
2525
try { Directory.Delete(tempDir, true); } catch { }
2626
}
2727

28-
NetLogWriter Writer(int maxDays = 30, int maxSizeMB = 0) =>
28+
NetLogFileWriter Writer(int maxDays = 30, int maxSizeMB = 0) =>
2929
new(new NetLogFileConfig
3030
{
3131
Enabled = true,
@@ -76,7 +76,7 @@ public void WritesOneLinePerEntry()
7676
[Fact]
7777
public void CreatesTheDirectory()
7878
{
79-
var writer = new NetLogWriter(new NetLogFileConfig
79+
var writer = new NetLogFileWriter(new NetLogFileConfig
8080
{
8181
Enabled = true,
8282
Directory = Path.Combine(tempDir, "nested"),
@@ -372,7 +372,7 @@ public void ReportsAFailureRatherThanThrowing()
372372
Directory.CreateDirectory(tempDir);
373373
var blocked = Path.Combine(tempDir, "blocked");
374374
File.WriteAllText(blocked, "x");
375-
var writer = new NetLogWriter(new NetLogFileConfig
375+
var writer = new NetLogFileWriter(new NetLogFileConfig
376376
{
377377
Enabled = true,
378378
Directory = blocked,
@@ -388,7 +388,7 @@ public void ExpandsTheMacrosInTheDirectory()
388388
{
389389
var configured = Path.Combine(tempDir, "%PCNAME%", "%DATE%");
390390

391-
var resolved = NetLogWriter.ResolveDirectory(configured, new DateTime(2026, 8, 20));
391+
var resolved = NetLogFileWriter.ResolveDirectory(configured, new DateTime(2026, 8, 20));
392392

393393
Assert.Equal(
394394
Path.Combine(tempDir, Environment.MachineName, "2026-08-20"),
@@ -404,7 +404,7 @@ public void ExpandsAnEnvironmentVariableInTheDirectory()
404404
{
405405
Assert.Equal(
406406
Path.Combine(tempDir, "netlog"),
407-
NetLogWriter.ResolveDirectory(Path.Combine("%BROWSERGUARD_LOGS%", "netlog")));
407+
NetLogFileWriter.ResolveDirectory(Path.Combine("%BROWSERGUARD_LOGS%", "netlog")));
408408
}
409409
finally
410410
{
@@ -422,7 +422,7 @@ public void WritesIntoTheDirectoryTheMacrosNamed()
422422
Directory = Path.Combine(tempDir, "%PCNAME%"),
423423
};
424424

425-
var writer = new NetLogWriter(config);
425+
var writer = new NetLogFileWriter(config);
426426
writer.Write("""{"operation":"browsing"}""");
427427

428428
var expected = Path.Combine(tempDir, Environment.MachineName, "netlog.jsonl");
@@ -432,7 +432,7 @@ public void WritesIntoTheDirectoryTheMacrosNamed()
432432
[Fact]
433433
public void FallsBackToProgramDataWhenNoDirectoryIsGiven()
434434
{
435-
var writer = new NetLogWriter(new NetLogFileConfig { Enabled = true });
435+
var writer = new NetLogFileWriter(new NetLogFileConfig { Enabled = true });
436436

437437
var expected = Path.Combine(
438438
Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData),

BrowserGuard/NetLogger/NetLogWriter.cs renamed to BrowserGuard/NetLogger/NetLogFileWriter.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ namespace BrowserGuard.NetLogger
2424
// Only the process holding the browser's native messaging port writes here,
2525
// which is why a lock is enough where the diagnostic Logger needs a named
2626
// mutex across processes.
27-
internal sealed class NetLogWriter
27+
internal sealed class NetLogFileWriter
2828
{
2929
internal const string FileNameBase = "netlog";
3030
internal const string FileExtension = ".jsonl";
@@ -41,7 +41,7 @@ internal sealed class NetLogWriter
4141
private readonly long maxSize;
4242
private readonly Logger? logger;
4343

44-
internal NetLogWriter(NetLogFileConfig config, Logger? logger = null)
44+
internal NetLogFileWriter(NetLogFileConfig config, Logger? logger = null)
4545
{
4646
directory = ResolveDirectory(config.Directory);
4747
maxDays = Math.Max(0, config.MaxDays);
@@ -91,7 +91,7 @@ internal string PathForDay(DateTime day, int segment = 1)
9191
}
9292
catch (Exception ex)
9393
{
94-
logger?.Log($"NetLogWriter: {ex.Message}");
94+
logger?.Log($"NetLogFileWriter: {ex.Message}");
9595
return ex.Message;
9696
}
9797

@@ -116,7 +116,7 @@ internal string PathForDay(DateTime day, int segment = 1)
116116
}
117117
catch (Exception ex)
118118
{
119-
logger?.Log($"NetLogWriter: {ex.Message}");
119+
logger?.Log($"NetLogFileWriter: {ex.Message}");
120120
return ex.Message;
121121
}
122122
}
@@ -179,7 +179,7 @@ private void Purge()
179179
}
180180
catch (Exception ex)
181181
{
182-
logger?.Log($"NetLogWriter: {ex.Message}");
182+
logger?.Log($"NetLogFileWriter: {ex.Message}");
183183
}
184184
}
185185
}

‎BrowserGuard/NetLogger/NetLogRecorder.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ internal sealed class NetLogRecorder : IDisposable
1313
private readonly Func<NetLoggerConfig> readConfig;
1414
private readonly Logger? logger;
1515

16-
private NetLogWriter? file;
16+
private NetLogFileWriter? file;
1717
private NetLogSender? sender;
1818
private bool resolved;
1919

@@ -68,7 +68,7 @@ private void Resolve()
6868

6969
if (config.LocalFile.Enabled)
7070
{
71-
file = new NetLogWriter(config.LocalFile, logger);
71+
file = new NetLogFileWriter(config.LocalFile, logger);
7272
logger?.Log($"Command: log entry, writing to {file.FilePath}");
7373
}
7474
if (!string.IsNullOrWhiteSpace(config.Endpoint))
@@ -91,7 +91,7 @@ private void Resolve()
9191
return null;
9292
}
9393
var spool = new NetLogSpool(
94-
NetLogWriter.ResolveDirectory(config.LocalFile.Directory),
94+
NetLogFileWriter.ResolveDirectory(config.LocalFile.Directory),
9595
// 0 asks for no limit, and travels as 0.
9696
Math.Max(0, failure.MaxSizeMB) * 1024L * 1024L,
9797
logger);

0 commit comments

Comments
 (0)