Skip to content

feat: Add Phase 2 Activity-based logging to FileSystem operations #1694

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
thomhurst merged 3 commits into from
Jan 1, 2026
Merged

feat: Add Phase 2 Activity-based logging to FileSystem operations #1694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5127a46
feat: Enhance Folder.Clean() and CopyTo() methods with additional opt…
thomhurst Dec 30, 2025
bf06434
fix: Address PR review feedback for Folder enhancements
thomhurst Dec 30, 2025
38443f6
feat: Add Phase 2 Activity-based logging to FileSystem operations
thomhurst Dec 30, 2025
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
64 changes: 46 additions & 18 deletions src/ModularPipelines/FileSystem/File.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Text.Json.Serialization;
using Microsoft.Extensions.Logging;
using ModularPipelines.Logging;
using ModularPipelines.Tracing;

namespace ModularPipelines.FileSystem;

Expand Down Expand Up @@ -35,22 +37,22 @@ internal File(FileInfo fileInfo)
/// <inheritdoc cref="System.IO.File.ReadAllTextAsync(string,System.Text.Encoding,System.Threading.CancellationToken)"/>>
public Task<string> ReadAsync(CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Reading File: {Path}", this);
LogFileOperation("Reading File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

return System.IO.File.ReadAllTextAsync(Path, cancellationToken);
}

/// <inheritdoc cref="System.IO.File.ReadLinesAsync(string,System.Threading.CancellationToken)"/>
public IAsyncEnumerable<string> ReadLinesAsync(CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Reading File: {Path}", this);
LogFileOperation("Reading File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

return System.IO.File.ReadLinesAsync(Path, cancellationToken);
}

public Task<byte[]> ReadBytesAsync(CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Reading File: {Path}", this);
LogFileOperation("Reading File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

return System.IO.File.ReadAllBytesAsync(Path, cancellationToken);
}
Expand All @@ -62,28 +64,28 @@ public FileStream GetStream(FileAccess fileAccess = FileAccess.ReadWrite)

public Task WriteAsync(string contents, CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Writing to File: {Path}", this);
LogFileOperation("Writing to File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

return System.IO.File.WriteAllTextAsync(Path, contents, cancellationToken);
}

public Task WriteAsync(byte[] contents, CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Writing to File: {Path}", this);
LogFileOperation("Writing to File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

return System.IO.File.WriteAllBytesAsync(Path, contents, cancellationToken);
}

public Task WriteAsync(IEnumerable<string> contents, CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Writing to File: {Path}", this);
LogFileOperation("Writing to File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

return System.IO.File.WriteAllLinesAsync(Path, contents, cancellationToken);
}

public async Task WriteAsync(ReadOnlyMemory<byte> contents, CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Writing to File: {Path}", this);
LogFileOperation("Writing to File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

var fileStream = System.IO.File.Create(Path);
await using (fileStream.ConfigureAwait(false))
Expand All @@ -94,7 +96,7 @@ public async Task WriteAsync(ReadOnlyMemory<byte> contents, CancellationToken ca

public async Task WriteAsync(Stream contents, CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Writing to File: {Path}", this);
LogFileOperation("Writing to File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

var fileStream = System.IO.File.Create(Path);
await using (fileStream.ConfigureAwait(false))
Expand All @@ -110,14 +112,14 @@ public async Task WriteAsync(Stream contents, CancellationToken cancellationToke

public Task AppendAsync(string contents, CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Writing to File: {Path}", this);
LogFileOperation("Appending to File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

return System.IO.File.AppendAllTextAsync(Path, contents, cancellationToken);
}

public Task AppendAsync(IEnumerable<string> contents, CancellationToken cancellationToken = default)
{
ModuleLogger.Current.LogInformation("Writing to File: {Path}", this);
LogFileOperation("Appending to File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

return System.IO.File.AppendAllLinesAsync(Path, contents, cancellationToken);
}
Expand All @@ -143,7 +145,7 @@ public Task AppendAsync(IEnumerable<string> contents, CancellationToken cancella

public File Create()
{
ModuleLogger.Current.LogInformation("Creating File: {Path}", this);
LogFileOperation("Creating File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

var fileStream = System.IO.File.Create(Path);
fileStream.Dispose();
Expand Down Expand Up @@ -174,15 +176,15 @@ public FileAttributes Attributes
/// <inheritdoc cref="FileInfo.Delete"/>>
public void Delete()
{
ModuleLogger.Current.LogInformation("Deleting File: {File}", this);
LogFileOperation("Deleting File: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", this);

FileInfo.Delete();
}

/// <inheritdoc cref="FileInfo.MoveTo(string)"/>>
public File MoveTo(string path)
{
ModuleLogger.Current.LogInformation("Moving File: {Source} > {Destination}", this, path);
LogFileOperationWithDestination("Moving File: {Source} > {Destination} [Module: {ModuleName}, Activity: {ActivityId}]", this, path);

FileInfo.MoveTo(path);
return this;
Expand All @@ -191,7 +193,7 @@ public File MoveTo(string path)
/// <inheritdoc cref="FileInfo.MoveTo(string)"/>>
public File MoveTo(Folder folder)
{
ModuleLogger.Current.LogInformation("Moving File: {Source} > {Destination}", this, folder);
LogFileOperationWithDestination("Moving File: {Source} > {Destination} [Module: {ModuleName}, Activity: {ActivityId}]", this, folder);

folder.Create();
return MoveTo(System.IO.Path.Combine(folder.Path, Name));
Expand All @@ -200,14 +202,14 @@ public File MoveTo(Folder folder)
/// <inheritdoc cref="FileInfo.CopyTo(string)"/>>
public File CopyTo(string path)
{
ModuleLogger.Current.LogInformation("Copying File: {Source} > {Destination}", this, path);
LogFileOperationWithDestination("Copying File: {Source} > {Destination} [Module: {ModuleName}, Activity: {ActivityId}]", this, path);

return FileInfo.CopyTo(path);
}

public File CopyTo(Folder folder)
{
ModuleLogger.Current.LogInformation("Copying File: {Source} > {Destination}", this, folder);
LogFileOperationWithDestination("Copying File: {Source} > {Destination} [Module: {ModuleName}, Activity: {ActivityId}]", this, folder);

folder.Create();
return CopyTo(System.IO.Path.Combine(folder.Path, Name));
Expand All @@ -217,7 +219,7 @@ public static File GetNewTemporaryFilePath()
{
var path = System.IO.Path.Combine(System.IO.Path.GetTempPath(), System.IO.Path.GetRandomFileName());

ModuleLogger.Current.LogInformation("Temporary File Path: {Path}", path);
LogFileOperation("Temporary File Path: {Path} [Module: {ModuleName}, Activity: {ActivityId}]", path);

return path!;
}
Expand Down Expand Up @@ -301,4 +303,30 @@ public override int GetHashCode()
{
return !Equals(left, right);
}
}

/// <summary>
/// Logs a file operation with Activity context information.
/// </summary>
/// <remarks>
/// Phase 2: Uses Activity.Current for context alongside AsyncLocal for backward compatibility.
/// The log message includes the current module name and activity ID when available.
/// </remarks>
private static void LogFileOperation(string messageTemplate, object? arg1)
{
var moduleName = ModuleActivityTracing.GetCurrentModuleName() ?? "Unknown";
var activityId = ModuleActivityTracing.GetCurrentActivityId();

ModuleLogger.Current.LogInformation(messageTemplate, arg1, moduleName, activityId);
}

/// <summary>
/// Logs a file operation with Activity context information for operations with source and destination.
/// </summary>
private static void LogFileOperationWithDestination(string messageTemplate, object? source, object? destination)
{
var moduleName = ModuleActivityTracing.GetCurrentModuleName() ?? "Unknown";
var activityId = ModuleActivityTracing.GetCurrentActivityId();

ModuleLogger.Current.LogInformation(messageTemplate, source, destination, moduleName, activityId);
}
}
Loading
Loading