Skip to content

Log file reader #429

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

Draft
wants to merge 3 commits into
base: Development
Choose a base branch
from
Draft

Log file reader #429

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
08d76e9
Refactoring and removing warnings
Jun 18, 2025
5bb3251
Need to check this changes
Jun 18, 2025
53d1fb2
Merge branch 'Development' of https://github.com/LogExperts/LogExpert…
Jun 21, 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
165 changes: 110 additions & 55 deletions src/LogExpert.Core/Classes/Log/LogfileReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ public class LogfileReader : IAutoLogLineColumnizerCallback, IDisposable
{
#region Fields

private static readonly ILogger _logger = LogManager.GetCurrentClassLogger();

private readonly GetLogLineFx _logLineFx;
private static readonly Logger _logger = LogManager.GetCurrentClassLogger();

private readonly string _fileName;
private readonly int _max_buffers;
Expand Down Expand Up @@ -68,7 +66,6 @@ public LogfileReader (string fileName, EncodingOptions encodingOptions, bool mul
_maxLinesPerBuffer = linesPerBuffer;
_multiFileOptions = multiFileOptions;
_pluginRegistry = pluginRegistry;
_logLineFx = GetLogLineInternal;
_disposed = false;

InitLruBuffers();
Expand Down Expand Up @@ -108,7 +105,6 @@ public LogfileReader (string[] fileNames, EncodingOptions encodingOptions, int b
_maxLinesPerBuffer = linesPerBuffer;
_multiFileOptions = multiFileOptions;
_pluginRegistry = pluginRegistry;
_logLineFx = GetLogLineInternal;
_disposed = false;

InitLruBuffers();
Expand All @@ -127,12 +123,6 @@ public LogfileReader (string[] fileNames, EncodingOptions encodingOptions, int b

#endregion

#region Delegates

private delegate Task<ILogLine> GetLogLineFx (int lineNum);

#endregion

#region Events

public event EventHandler<LogEventArgs> FileSizeChanged;
Expand Down Expand Up @@ -396,7 +386,7 @@ public int ShiftBuffers ()

public ILogLine GetLogLine (int lineNum)
{
return GetLogLineInternal(lineNum).Result;
return GetLogLineInternal(lineNum, _cts.Token).Result; //TODO: Is this token correct?
}

/// <summary>
Expand All @@ -416,36 +406,70 @@ public ILogLine GetLogLine (int lineNum)
/// <returns></returns>
public async Task<ILogLine> GetLogLineWithWait (int lineNum)
{
const int WAIT_TIME = 1000;

ILogLine result = null;
const int WAIT_MS = 1000;

// If we’re not in fast-fail mode, try once with timeout
if (!_isFastFailOnGetLogLine)
{
var task = Task.Run(() => _logLineFx(lineNum));
if (task.Wait(WAIT_TIME))
using var cts = new CancellationTokenSource();
cts.CancelAfter(WAIT_MS);

try
{
result = task.Result;
// Offload the read so UI never blocks
var line = await GetLogLineInternal(lineNum, cts.Token).ConfigureAwait(false);

// Completed successfully in time
_isFastFailOnGetLogLine = false;
return line;
}
else
catch (OperationCanceledException)
{
// Timed out
_isFastFailOnGetLogLine = true;
_logger.Debug(CultureInfo.InvariantCulture, "No result after {0}ms. Returning <null>.", WAIT_TIME);
_logger.Debug(CultureInfo.InvariantCulture, "Timeout after {0}ms. Returning <null>.", WAIT_MS);
TriggerBackgroundRecovery(lineNum);
return null;
}
}
else
{
_logger.Debug(CultureInfo.InvariantCulture, "Fast failing GetLogLine()");
if (!_isFailModeCheckCallPending)
catch (Exception ex)
{
_isFailModeCheckCallPending = true;
var logLine = await _logLineFx(lineNum);
GetLineFinishedCallback(logLine);
// Real error—flip fast-fail and rethrow
_isFastFailOnGetLogLine = true;
_logger.Error(ex, "Exception in GetLogLineInternal for line {0}.", lineNum);
throw;
}
}

return result;
// Fast-fail path: immediate null, kick off a background refresh
_logger.Debug(CultureInfo.InvariantCulture, "Fast failing GetLogLine()");
TriggerBackgroundRecovery(lineNum);
return null;
}

private void TriggerBackgroundRecovery (int lineNum)
{
if (_isFailModeCheckCallPending)
return;

_isFailModeCheckCallPending = true;

// Fire-and-forget check (no UI thread marshalling needed)
_ = Task.Run(async () =>
{
try
{
var line = await GetLogLineInternal(lineNum, CancellationToken.None).ConfigureAwait(false);
GetLineFinishedCallback(line);
}
catch (Exception ex)
{
_logger.Error(ex, "Deferred GetLogLineInternal failed.");
}
finally
{
_isFailModeCheckCallPending = false;
}
});
}

/// <summary>
Expand Down Expand Up @@ -755,43 +779,74 @@ private ILogFileInfo AddFile (string fileName)
return info;
}

private Task<ILogLine> GetLogLineInternal (int lineNum)
private Task<ILogLine> GetLogLineInternal (int lineNum, CancellationToken ct)
{
// Run all the heavy work off the UI thread,
// and honor the cancellation token
return Task.Run(() => GetLogLineInternalCore(lineNum, ct), ct);
}

private ILogLine GetLogLineInternalCore (int lineNum, CancellationToken ct)
{
ct.ThrowIfCancellationRequested();

if (_isDeleted)
{
_logger.Debug(CultureInfo.InvariantCulture, "Returning null for line {0} because file is deleted.", lineNum);
_logger.Debug(
CultureInfo.InvariantCulture,
"Returning null for line {0} because file is deleted.",
lineNum);

// fast fail if dead file was detected. Prevents repeated lags in GUI thread caused by callbacks from control (e.g. repaint)
return null;
}

AcquireBufferListReaderLock();
LogBuffer logBuffer = GetBufferForLine(lineNum);
if (logBuffer == null)
AcquireBufferListReaderLock(); // blocking call off UI
try
{
ReleaseBufferListReaderLock();
_logger.Error("Cannot find buffer for line {0}, file: {1}{2}", lineNum, _fileName, IsMultiFile ? " (MultiFile)" : "");
return null;
}
ct.ThrowIfCancellationRequested();

// disposeLock prevents that the garbage collector is disposing just in the moment we use the buffer
_disposeLock.AcquireReaderLock(Timeout.Infinite);
if (logBuffer.IsDisposed)
{
LockCookie cookie = _disposeLock.UpgradeToWriterLock(Timeout.Infinite);
lock (logBuffer.FileInfo)
var logBuffer = GetBufferForLine(lineNum);
if (logBuffer == null)
{
ReReadBuffer(logBuffer);
_logger.Error("Cannot find buffer for line {0}, file: {1}{2}", lineNum, _fileName, IsMultiFile ? " (MultiFile)" : "");
return null;
}

_disposeLock.DowngradeFromWriterLock(ref cookie);
}
_disposeLock.AcquireReaderLock(Timeout.Infinite);
try
{
ct.ThrowIfCancellationRequested();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's just a draft, but the try, finally is imo worse then the old design

Also I'm confused why so many ct.ThrowIfCancellationRequested();


ILogLine line = logBuffer.GetLineOfBlock(lineNum - logBuffer.StartLine);
_disposeLock.ReleaseReaderLock();
ReleaseBufferListReaderLock();
if (logBuffer.IsDisposed)
{
var cookie = _disposeLock.UpgradeToWriterLock(Timeout.Infinite);
try
{
lock (logBuffer.FileInfo)
{
ReReadBuffer(logBuffer);
}

ct.ThrowIfCancellationRequested();
}
finally
{
_disposeLock.DowngradeFromWriterLock(ref cookie);
}
}

return Task.FromResult(line);
// Actual line extraction
return logBuffer.GetLineOfBlock(lineNum - logBuffer.StartLine);
}
finally
{
_disposeLock.ReleaseReaderLock();
}
}
finally
{
ReleaseBufferListReaderLock();
}
}

private void InitLruBuffers ()
Expand Down Expand Up @@ -1785,13 +1840,13 @@ private void DumpBufferInfos (LogBuffer buffer)

#endregion

public void Dispose()
public void Dispose ()
{
Dispose(true);
GC.SuppressFinalize(this); // Suppress finalization (not needed but best practice)
}

protected virtual void Dispose(bool disposing)
protected virtual void Dispose (bool disposing)
{
if (!_disposed)
{
Expand All @@ -1808,7 +1863,7 @@ protected virtual void Dispose(bool disposing)
//TODO: Seems that this can be deleted. Need to verify.
~LogfileReader ()
{
Dispose (false);
Dispose(false);
}

protected virtual void OnFileSizeChanged (LogEventArgs e)
Expand Down
2 changes: 1 addition & 1 deletion src/LogExpert.UI/Controls/LogWindow/LogWindowPrivate.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,6 @@ private void LoadingFinished ()
dataGridView.SuspendLayout();
dataGridView.RowCount = _logFileReader.LineCount;
dataGridView.CurrentCellChanged += OnDataGridViewCurrentCellChanged;
dataGridView.Enabled = true;
dataGridView.AutoResizeColumns(DataGridViewAutoSizeColumnsMode.DisplayedCells);
dataGridView.ResumeLayout();
_progressEventArgs.Visible = false;
Expand All @@ -621,6 +620,7 @@ private void LoadingFinished ()

PreferencesChanged(fontName, fontSize, setLastColumnWidth, lastColumnWidth, true, SettingsFlags.All);
//LoadPersistenceData();
dataGridView.Enabled = true;
}

private void LogEventWorker ()
Expand Down
6 changes: 3 additions & 3 deletions src/LogExpert.UI/Controls/LogWindow/LogWindowPublic.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,11 +404,11 @@ public void CellPainting (BufferedDataGridView gridView, int rowIndex, DataGridV
if (rowIndex < 0 || e.ColumnIndex < 0)
{
e.Handled = false;
return;
//return;
}

ILogLine line = _logFileReader.GetLogLineWithWait(rowIndex).Result;

//ILogLine line = _logFileReader.GetLogLineWithWait(rowIndex).Result;
ILogLine line = null;
if (line != null)
{
HighlightEntry entry = FindFirstNoWordMatchHilightEntry(line);
Expand Down
2 changes: 1 addition & 1 deletion src/LogExpert.UI/Dialogs/LogTabWindow/SettingsDialog.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ private void FillDialog ()
FillMultifileSettings();
FillEncodingList();

var temp = Encoding.GetEncoding(Preferences.DefaultEncoding);
//var temp = Encoding.GetEncoding(Preferences.DefaultEncoding);//TODO: Delete

comboBoxEncoding.SelectedItem = Encoding.GetEncoding(Preferences.DefaultEncoding);
checkBoxMaskPrio.Checked = Preferences.MaskPrio;
Expand Down
Loading