Merge pull request #143 from opcodesio/bug/incorrect-indices-when-searching

fix how entry indices are generated, so that it also works properly when searching

Author: arukompas

src/LogIndex.php

@@ -18,6 +18,8 @@ class LogIndex
 
     protected int $lastScannedFilePosition;
 
+    protected int $lastScannedIndex;
+
     public function __construct(
         protected LogFile $file,
         protected ?string $query = null
@@ -67,9 +69,9 @@ public function clearCache(): void
         $this->loadMetadata();
     }
 
-    public function addToIndex(int $filePosition, int|Carbon $timestamp, string $severity): int
+    public function addToIndex(int $filePosition, int|Carbon $timestamp, string $severity, int $index = null): int
     {
-        $logIndex = $this->nextLogIndexToCreate ?? 0;
+        $logIndex = $index ?? $this->nextLogIndexToCreate ?? 0;
 
         if ($timestamp instanceof Carbon) {
             $timestamp = $timestamp->timestamp;
@@ -291,6 +293,20 @@ public function getLastScannedFilePosition(): int
         return $this->lastScannedFilePosition;
     }
 
+    public function setLastScannedIndex(int $index): void
+    {
+        $this->lastScannedIndex = $index;
+    }
+
+    public function getLastScannedIndex(): int
+    {
+        if (! isset($this->lastScannedIndex)) {
+            $this->loadMetadata();
+        }
+
+        return $this->lastScannedIndex;
+    }
+
     public function incomplete(): bool
     {
         return $this->file->size() !== $this->getLastScannedFilePosition();
@@ -436,6 +452,7 @@ public function getMetadata(): array
             'query' => $this->getQuery(),
             'identifier' => $this->identifier(),
             'last_scanned_file_position' => $this->lastScannedFilePosition,
+            'last_scanned_index' => $this->lastScannedIndex,
             'next_log_index_to_create' => $this->nextLogIndexToCreate,
             'max_chunk_size' => $this->maxChunkSize,
             'current_chunk_index' => $this->getCurrentChunk()->index,
@@ -454,6 +471,7 @@ protected function loadMetadata(): void
         $data = Cache::get($this->metaCacheKey(), []);
 
         $this->lastScannedFilePosition = $data['last_scanned_file_position'] ?? 0;
+        $this->lastScannedIndex = $data['last_scanned_index'] ?? 0;
         $this->nextLogIndexToCreate = $data['next_log_index_to_create'] ?? 0;
         $this->maxChunkSize = $data['max_chunk_size'] ?? self::DEFAULT_CHUNK_SIZE;
         $this->chunkDefinitions = $data['chunk_definitions'] ?? [];

src/LogReader.php

@@ -308,6 +308,7 @@ public function scan(int $maxBytesToScan = null, bool $force = false): self
         $currentLog = '';
         $currentLogLevel = '';
         $currentTimestamp = null;
+        $currentIndex = $this->index()->getLastScannedIndex();
         fseek($this->fileHandle, $this->index()->getLastScannedFilePosition());
         $currentLogPosition = ftell($this->fileHandle);
         $lastPositionToScan = isset($maxBytesToScan) ? ($currentLogPosition + $maxBytesToScan) : null;
@@ -327,10 +328,11 @@ public function scan(int $maxBytesToScan = null, bool $force = false): self
             if (preg_match($logMatchPattern, $line, $matches) === 1) {
                 if ($currentLog !== '') {
                     if (is_null($this->query) || preg_match($this->query, $currentLog)) {
-                        $logIndex->addToIndex($currentLogPosition, $currentTimestamp, $currentLogLevel);
+                        $logIndex->addToIndex($currentLogPosition, $currentTimestamp, $currentLogLevel, $currentIndex);
                     }
 
                     $currentLog = '';
+                    $currentIndex++;
                 }
 
                 $currentTimestamp = strtotime($matches[1] ?? '');
@@ -361,12 +363,11 @@ public function scan(int $maxBytesToScan = null, bool $force = false): self
 
         if ($currentLog !== '' && preg_match($logMatchPattern, $currentLog) === 1) {
             if ((is_null($this->query) || preg_match($this->query, $currentLog))) {
-                $logIndex->addToIndex($currentLogPosition, $currentTimestamp, $currentLogLevel);
+                $logIndex->addToIndex($currentLogPosition, $currentTimestamp, $currentLogLevel, $currentIndex);
             }
-
-            $currentLog = '';
         }
 
+        $logIndex->setLastScannedIndex($currentIndex);
         $logIndex->setLastScannedFilePosition(ftell($this->fileHandle));
         $logIndex->save();
 

tests/Unit/LogIndex/LogIndexTest.php

@@ -49,6 +49,19 @@
         ]);
 });
 
+it('can optionally provide a specific index', function () {
+    $logIndex = createLogIndex();
+
+    $indexGenerated = $logIndex->addToIndex(
+        100,
+        now()->subMinute(),
+        'info',
+        $indexProvided = 10
+    );
+
+    expect($indexGenerated)->toBe($indexProvided);
+});
+
 it('can get a flat index/position array', function () {
     $logIndex = createLogIndex();
     $firstIndexGenerated = $logIndex->addToIndex(