Plain Text Logs Normalizer (#2)

* normalize non-json logs

* add tests

* update Readme.md

Author: vish9812

README.md

@@ -10,26 +10,28 @@ Analog is a powerful tool designed for analyzing and visualizing log files. It p
 
   - **Filter by Timestamp**: Specify a start and end timestamp to narrow down your log analysis.
   - **Regex Search**: Perform regular expression searches to find specific log entries.
+  - **Search Combinations**: Perform normal searches with advanced combination of `Contains/Not Contains` and `AND/OR` operators.
   - **Top Logs**: Select entries in the Top Logs to view all the related logs together.
   - **Errors Only**: Isolate and focus on error log entries.
 
+- **Logs Context**: Even when a filter is applied, you can access the context around the current log entry.
+
 - **Log File Comparison**:
+
   - **Compare Two Log Files**: Compare two log files and see newly added or removed log entries.
+
 - **Create and Download a Filtered Subset**: Define filtering criteria to extract a specific subset of logs. You can also compare two subsets of a single log file to track changes.
 
 - **Time Jumps**: Navigate through log data in subsets repeating after every few minutes.
 
-- **See Data for Specific Fields/Keys**: Easily access and view log entries based on specific fields.
-
 - **Highlighted JSON Syntax**: Log entries with JSON data are automatically highlighted for improved readability.
 
 - **Highlighted Errors**: Errors in log entries are highlighted, making them stand out for quick identification.
 
-## Things to remember
+## Prerequisite
 
-- Currently supports only `json` logs.
-- Ensure you have Python 3 installed on your system to simply run via executing the `analog.sh`.
-- Or you can use any server of your preference to run the `index.html`
+- Ensure you have Python 3 installed on your system then you can simply execute `analog.sh` to run the app.
+- Otherwise run the `index.html` manually on any server of your preference.
 
 ## Getting Started
 

package.json

@@ -22,7 +22,7 @@
     "@suid/vite-plugin": "^0.1.4",
     "@vitest/coverage-v8": "^0.34.6",
     "jsdom": "^22.1.0",
-    "solid-devtools": "^0.27.7",
+    "solid-devtools": "^0.28.1",
     "typescript": "^5.2.2",
     "vite": "^4.4.9",
     "vite-plugin-solid": "^2.7.0",

pnpm-lock.yaml

@@ -1,5 +1,5 @@
-import stringsUtils from "../utils/strings";
-import LogData, { GroupedMsg } from "./logData";
+import stringsUtils from "@al/utils/strings";
+import LogData, { GroupedMsg, JSONLog, LogsGenerator } from "./logData";
 
 describe("isErrorLog", () => {
   it.each([
@@ -40,18 +40,18 @@ describe("isErrorLog", () => {
 describe("init", () => {
   const cutOffLen = LogData["msgCutOffLen"];
 
-  it("init", async () => {
+  it("init", () => {
     const log0 = {
       [LogData.logKeys.error]: "some error",
       [LogData.logKeys.msg]: "has errors",
       parentKey1: "k1",
-    };
+    } as JSONLog;
     const log0String = getJSONString(log0);
     const log1 = {
       [LogData.logKeys.level]: "error",
       [LogData.logKeys.msg]: "dbg msg",
       parentKey1: "k1",
-    };
+    } as JSONLog;
     const log1String = getJSONString(log1);
     const log2 = {
       [LogData.logKeys.level]: "info",
@@ -60,23 +60,23 @@ describe("init", () => {
         childKey1: 11,
         childKey2: 12,
       },
-    };
+    } as JSONLog;
     const log2String = getJSONString(log2);
     const log3 = {
       [LogData.logKeys.level]: "error",
       [LogData.logKeys.msg]: "abc ".repeat(cutOffLen) + "group 1",
       parentKey1: "k1",
-    };
+    } as JSONLog;
     const log3String = getJSONString(log3);
     const log4 = {
       [LogData.logKeys.level]: "info",
       [LogData.logKeys.msg]: "qwe ".repeat(cutOffLen) + "group 2",
-    };
+    } as JSONLog;
     const log4String = getJSONString(log4);
     const log5 = {
       [LogData.logKeys.level]: "info",
       [LogData.logKeys.msg]: "qwe ".repeat(cutOffLen) + "group 2",
-    };
+    } as JSONLog;
     const log5String = getJSONString(log5);
 
     function getJSONString(obj: any) {
@@ -86,24 +86,21 @@ describe("init", () => {
     const file = {
       name: "my-file.txt",
       size: "1024",
-      text: () =>
-        Promise.resolve(
-          `
-        ${log0String}
-        ${log1String}
-        "non-json log"
-        ${log2String}
-  
-        ${log3String}
-        
-        ${log4String}
-        ${log5String}
-      `
-        ),
     };
 
+    function* logsIterator(): LogsGenerator {
+      yield log0;
+      yield log1;
+      yield null;
+      yield log2;
+      yield null;
+      yield log3;
+      yield log4;
+      yield log5;
+    }
+
     const logData = new LogData();
-    await logData.init(file as any);
+    logData.init(file as any, logsIterator);
 
     expect(logData.fileInfo.name, "file name").toEqual(file.name);
     expect(logData.fileInfo.size, "file size").toEqual(file.size);