[ISSUE #4] Addressing infinite loop and undersized default buffer

README.md

@@ -21,7 +21,7 @@ This application only has two configurations and both are set with sensible defa
 | Env Variable      | Description | Default     |
 | :---        |    :----   |          ---: |
 | READ_LOCATION      | Where on the filesystem the API should be looking for logs       | `/var/logs`   |
-| BUFFER_SIZE   | The size of the file chunk to read into memory for processing at a time        | 4096 (bytes) |
+| BUFFER_SIZE   | The size of the file chunk to read into memory for processing at a time        | 8192 (bytes) |
 
 ### Running in a Container
 
@@ -46,7 +46,7 @@ This will expose the service running on port 8000. The root endpoint redirects t
 This will expose the service running locally on port 8000. The root endpoint redirects to a Swagger UI which documents the API.
 
 #### Notes about local run mode
-- The default read buffer size is 4096. This can be changed by setting an environment variable locally.
+- The default read buffer size is 8192. This can be changed by setting an environment variable locally.
 - The logs are read from `/var/logs` on the underlying system.
 - If the code changes, the changes will be redeployed automatically as long as the server is still running.
 

app/core/parser.py

@@ -6,7 +6,7 @@ def parse_file(
     file_name: str,
     line_count: int,
     search_term: Union[str | None] = None,
-    buffer_size: int = 4096,
+    buffer_size: int = 8192,
 ) -> List[str]:
 
     """Opens and parses a file object from the bottom up by manipulating the file read pointer.
@@ -48,8 +48,11 @@ def parse_file(
             # Split the data at line breaks
             log_chunk = binary_data.splitlines(True)
 
+            # [ISSUE #4] scrollback != buffer check ensures that if the scrollback is the size of the buffer
+            # The program does not get stuck in an endless loop.
+
             # If this is not the last read before EOF, we want to pop off a piece to use to size where the cursor should move.
-            if current_position - buffer_size > 0:
+            if current_position - buffer_size > 0 and scrollback != buffer_size:
                 scrollback = len(log_chunk.pop(0))
             else:
                 scrollback = 0

app/main.py

@@ -18,7 +18,7 @@
 
 READ_LOCATION = "READ_LOCATION"
 log_dir = os.getenv(READ_LOCATION, "/var/log")
-buffer = int(os.getenv("BUFFER_SIZE", 4096))
+buffer = int(os.getenv("BUFFER_SIZE", 8192))
 
 
 @app.get("/", include_in_schema=False)