feat(decoder): Add support for loading Zstandard-compressed text files (resolves #272).

package.json

@@ -27,6 +27,7 @@
   },
   "homepage": "https://github.com/y-scope/yscope-log-viewer#readme",
   "dependencies": {
+    "@bokuweb/zstd-wasm": "^0.0.27",
     "@emotion/react": "^11.14.0",
     "@emotion/styled": "^11.14.0",
     "@mui/icons-material": "^7.1.0",

src/services/LogFileManager/decodeUtils.ts

@@ -78,7 +78,6 @@ const tryCreateDecoderBySignature = async (
                 };
             } catch (e) {
                 console.warn(`Magic number matches ${entry.name}, but decoder creation failed:`, e);
-                break;
             }
         }
     }

src/services/decoders/PlainTextDecoder/index.ts

@@ -0,0 +1,69 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable class-methods-use-this */
+import {Nullable} from "../../../typings/common";
+import {
+    Decoder,
+    DecodeResult,
+    DecoderOptions,
+    FilteredLogEventMap,
+    LogEventCount,
+    Metadata,
+} from "../../../typings/decoders";
+import {LogLevelFilter} from "../../../typings/logs";
+
+
+class PlainTextDecoder implements Decoder {
+    #logs: string[];
+
+    constructor (dataArray: Uint8Array) {
+        const textDecoder = new TextDecoder();
+        this.#logs = textDecoder.decode(dataArray).split(/\r\n|\r|\n/);
+    }
+
+    static async create (dataArray: Uint8Array, _decoderOptions: DecoderOptions) {
+        return Promise.resolve(new PlainTextDecoder(dataArray));
+    }
+
+    getEstimatedNumEvents (): number {
+        return this.#logs.length;
+    }
+
+    getFilteredLogEventMap (): FilteredLogEventMap {
+        return null;
+    }
+
+    getMetadata (): Metadata {
+        return {};
+    }
+
+    setLogLevelFilter (_logLevelFilter: LogLevelFilter): boolean {
+        return false;
+    }
+
+    build (): LogEventCount {
+        return {
+            numValidEvents: this.#logs.length,
+            numInvalidEvents: 0,
+        };
+    }
+
+    setFormatterOptions (_options: DecoderOptions): boolean {
+        return false;
+    }
+
+    decodeRange (beginIdx: number, endIdx: number, _useFilter: boolean): Nullable<DecodeResult[]> {
+        return this.#logs.slice(beginIdx, endIdx).map((log, i) => ({
+            logEventNum: beginIdx + i,
+            logLevel: 0,
+            message: `${log}\n`,
+            timestamp: BigInt(0),
+            utcOffset: BigInt(0),
+        }));
+    }
+
+    findNearestLogEventByTimestamp (_timestamp: number): Nullable<number> {
+        return null;
+    }
+}
+
+export default PlainTextDecoder;

src/services/decoders/ZstdDecoder/index.ts

@@ -0,0 +1,23 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+    decompress,
+    init,
+} from "@bokuweb/zstd-wasm";
+
+import {DecoderOptions} from "../../../typings/decoders";
+import PlainTextDecoder from "../PlainTextDecoder";
+
+
+class ZstdDecoder extends PlainTextDecoder {
+    private constructor (logArray: Uint8Array) {
+        super(logArray);
+    }
+
+    static override async create (dataArray: Uint8Array, _decoderOptions: DecoderOptions) {
+        await init();
+        const logArrayBuffer = decompress(dataArray);
+        return new ZstdDecoder(logArrayBuffer);
+    }
+}
+
+export default ZstdDecoder;

src/typings/file.ts

@@ -1,6 +1,8 @@
 import ClpIrDecoder from "../services/decoders/ClpIrDecoder";
 import {CLP_IR_STREAM_TYPE} from "../services/decoders/ClpIrDecoder/utils";
 import JsonlDecoder from "../services/decoders/JsonlDecoder";
+import PlainTextDecoder from "../services/decoders/PlainTextDecoder";
+import ZstdDecoder from "../services/decoders/ZstdDecoder";
 import {Decoder} from "./decoders";
 
 
@@ -20,7 +22,8 @@ interface FileTypeInfo {
  * Represents a file type with its identifying properties and decoder.
  */
 interface FileTypeDef {
-    DecoderFactory: typeof ClpIrDecoder | typeof JsonlDecoder;
+    DecoderFactory: typeof ClpIrDecoder | typeof JsonlDecoder |
+        typeof ZstdDecoder | typeof PlainTextDecoder;
 
     checkIsStructured: (decoder: Decoder) => FileTypeInfo["isStructured"];
     extensions: FileTypeInfo["extension"][];
@@ -45,6 +48,20 @@ const FILE_TYPE_DEFINITIONS: FileTypeDef[] = [
         name: "JSON Lines",
         signature: ["{".charCodeAt(0)],
     },
+    {
+        DecoderFactory: ZstdDecoder,
+        checkIsStructured: () => false,
+        extensions: [".zst", ".zstd"],
+        name: "Zstandard",
+        signature: [0x28, 0xb5, 0x2f, 0xfd],
+    },
+    {
+        DecoderFactory: PlainTextDecoder,
+        checkIsStructured: () => false,
+        extensions: [".txt", ".log"],
+        name: "Text",
+        signature: [],
+    },
 ];
 /* eslint-enable @stylistic/array-element-newline, no-magic-numbers */
 

vite.config.ts

@@ -24,7 +24,13 @@ export default defineConfig({
     optimizeDeps: {
         // Exclude the worker or else `ClpFfiJs-worker.wasm` won't be found when served from the
         // debug server (this option only affects debug builds).
-        exclude: ["clp-ffi-js/worker"],
+        exclude: [
+            "clp-ffi-js/worker",
+            "@bokuweb/zstd-wasm",
+        ],
+        esbuildOptions: {
+            target: "es2020",
+        },
     },
     plugins: [react()],
     server: {