new-log-viewer: Define interface for filtering by log level and add support (internally) to JsonlDecoder; Move timestamp field extraction from LogbackFormatter to JsonlDecoder. (#79)

Author: davemarco

new-log-viewer/src/services/LogFileManager/index.ts

@@ -1,7 +1,6 @@
 import {
     Decoder,
     DecoderOptionsType,
-    LOG_EVENT_FILE_END_IDX,
 } from "../../typings/decoders";
 import {MAX_V8_STRING_LENGTH} from "../../typings/js";
 import {
@@ -52,10 +51,10 @@ class LogFileManager {
         this.#pageSize = pageSize;
         this.#decoder = decoder;
 
-        // Build index for the entire file
-        const buildIdxResult = decoder.buildIdx(0, LOG_EVENT_FILE_END_IDX);
-        if (null !== buildIdxResult && 0 < buildIdxResult.numInvalidEvents) {
-            console.error("Invalid events found in decoder.buildIdx():", buildIdxResult);
+        // Build index for the entire file.
+        const buildResult = decoder.build();
+        if (0 < buildResult.numInvalidEvents) {
+            console.error("Invalid events found in decoder.build():", buildResult);
         }
 
         this.#numEvents = decoder.getEstimatedNumEvents();
@@ -122,13 +121,11 @@ class LogFileManager {
         return decoder;
     }
 
-    /**
-     * Sets options for the decoder.
-     *
+    /* Sets any formatter options that exist in the decoder's options.
      * @param options
      */
-    setDecoderOptions (options: DecoderOptionsType) {
-        this.#decoder.setDecoderOptions(options);
+    setFormatterOptions (options: DecoderOptionsType) {
+        this.#decoder.setFormatterOptions(options);
     }
 
     /**
@@ -144,9 +141,10 @@ class LogFileManager {
         logs: string,
     } {
         const endLogEventIdx = Math.min(beginLogEventIdx + EXPORT_LOGS_CHUNK_SIZE, this.#numEvents);
-        const results = this.#decoder.decode(
+        const results = this.#decoder.decodeRange(
             beginLogEventIdx,
-            endLogEventIdx
+            endLogEventIdx,
+            false,
         );
 
         if (null === results) {
@@ -185,7 +183,12 @@ class LogFileManager {
             matchingLogEventNum,
         } = this.#getCursorData(cursor);
 
-        const results = this.#decoder.decode(pageBeginLogEventNum - 1, pageEndLogEventNum - 1);
+        const results = this.#decoder.decodeRange(
+            pageBeginLogEventNum - 1,
+            pageEndLogEventNum - 1,
+            false
+        );
+
         if (null === results) {
             throw new Error("Error occurred during decoding. " +
                 `pageBeginLogEventNum=${pageBeginLogEventNum}, ` +

new-log-viewer/src/services/MainWorker.ts

@@ -50,7 +50,7 @@ onmessage = async (ev: MessageEvent<MainWorkerReqMessage>) => {
                     throw new Error("Log file manager hasn't been initialized");
                 }
                 if ("undefined" !== typeof args.decoderOptions) {
-                    LOG_FILE_MANAGER.setDecoderOptions(args.decoderOptions);
+                    LOG_FILE_MANAGER.setFormatterOptions(args.decoderOptions);
                 }
 
                 let decodedEventIdx = 0;
@@ -85,7 +85,7 @@ onmessage = async (ev: MessageEvent<MainWorkerReqMessage>) => {
                     throw new Error("Log file manager hasn't been initialized");
                 }
                 if ("undefined" !== typeof args.decoderOptions) {
-                    LOG_FILE_MANAGER.setDecoderOptions(args.decoderOptions);
+                    LOG_FILE_MANAGER.setFormatterOptions(args.decoderOptions);
                 }
                 postResp(
                     WORKER_RESP_CODE.PAGE_DATA,

new-log-viewer/src/services/decoders/ClpIrDecoder.ts

@@ -4,8 +4,11 @@ import {Nullable} from "../../typings/common";
 import {
     Decoder,
     DecodeResultType,
+    FilteredLogEventMap,
+    LOG_EVENT_FILE_END_IDX,
     LogEventCount,
 } from "../../typings/decoders";
+import {LogLevelFilter} from "../../typings/logs";
 
 
 class ClpIrDecoder implements Decoder {
@@ -31,19 +34,42 @@ class ClpIrDecoder implements Decoder {
         return this.#streamReader.getNumEventsBuffered();
     }
 
-    buildIdx (beginIdx: number, endIdx: number): Nullable<LogEventCount> {
+    // eslint-disable-next-line class-methods-use-this
+    getFilteredLogEventMap (): FilteredLogEventMap {
+        // eslint-disable-next-line no-warning-comments
+        // TODO: Update this after log level filtering is implemented in clp-ffi-js
+        console.error("Not implemented.");
+
+        return null;
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars, class-methods-use-this
+    setLogLevelFilter (logLevelFilter: LogLevelFilter): boolean {
+        // eslint-disable-next-line no-warning-comments
+        // TODO: Update this after log level filtering is implemented in clp-ffi-js
+        console.error("Not implemented.");
+
+        return false;
+    }
+
+    build (): LogEventCount {
         return {
             numInvalidEvents: 0,
-            numValidEvents: this.#streamReader.deserializeRange(beginIdx, endIdx),
+            numValidEvents: this.#streamReader.deserializeRange(0, LOG_EVENT_FILE_END_IDX),
         };
     }
 
     // eslint-disable-next-line class-methods-use-this
-    setDecoderOptions (): boolean {
+    setFormatterOptions (): boolean {
         return true;
     }
 
-    decode (beginIdx: number, endIdx: number): Nullable<DecodeResultType[]> {
+    decodeRange (
+        beginIdx: number,
+        endIdx: number,
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        useFilter: boolean
+    ): Nullable<DecodeResultType[]> {
         return this.#streamReader.decodeRange(beginIdx, endIdx);
     }
 }