Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

Learnt from: haiqi96
PR: y-scope/clp#651
File: components/clp-package-utils/clp_package_utils/scripts/compress.py:0-0
Timestamp: 2025-01-16T16:58:43.190Z
Learning: In the clp-package compression flow, path validation and error handling is performed at the scheduler level rather than in the compress.py script to maintain simplicity and avoid code duplication.

Learnt from: davemarco
PR: y-scope/clp#1198
File: components/webui/server/src/plugins/app/Presto.ts:38-43
Timestamp: 2025-08-25T16:27:50.549Z
Learning: In the CLP webui Presto configuration, host and port are set via package settings (configurable), while user, catalog, and schema are set via environment variables (environment-specific). This mixed approach is intentional - settings are typically set by package and some values don't need to be package-configurable.

Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.

components/webui/server/src/routes/api/compress/index.ts (3)

26-38: Move hard‑coded compression defaults to settings.json (with sane fallbacks).

Consider keys for level/target sizes so operators can tune without code changes.

---

55-61: Declare 400 for bad requests (validation/runtime checks).

                 response: {
                     [StatusCodes.CREATED]: CompressionJobCreationSchema,
+                    [StatusCodes.BAD_REQUEST]: ErrorSchema,
                     [StatusCodes.INTERNAL_SERVER_ERROR]: ErrorSchema,
                 },

---

70-74: Robust, POSIX‑safe path handling and jail to /mnt/logs.

String concat breaks on missing leading “/” and allows “..” to escape root. Use node:path and validate stays under root.

+import path from "node:path";
@@
-            jobConfig.input.paths_to_compress = paths.map(
-                (path) => CONTAINER_INPUT_LOGS_ROOT_DIR + path
-            );
+            if (0 === paths.length) {
+                return reply.badRequest("At least one path is required.");
+            }
+            try {
+                jobConfig.input.paths_to_compress = paths.map((p) => {
+                    const rel = (p ?? "").trim().replace(/^\/+/, "");
+                    const abs = path.posix.resolve(CONTAINER_INPUT_LOGS_ROOT_DIR, rel);
+                    if (false === abs.startsWith(CONTAINER_INPUT_LOGS_ROOT_DIR + "/")) {
+                        throw new Error(`Path escapes logs root: ${p}`);
+                    }
+                    return abs;
+                });
+            } catch (e) {
+                return reply.badRequest("Invalid path provided.");
+            }

components/webui/client/src/api/compress/index.ts (1)

14-19: Remove payload logging and fix generics; optionally bubble errors.

-const submitCompressionJob = async (payload: CompressionJobSchema): Promise<number> => {
-    console.log("Submitting compression job:", JSON.stringify(payload));
-
-    const response = await axios.post<CompressionJobCreationSchema>("/api/compress", payload);
-    return response.data.jobId;
-};
+const submitCompressionJob = async (payload: CompressionJobSchemaStatic): Promise<number> => {
+    const response = await axios.post<CompressionJobCreationSchemaStatic>("/api/compress", payload);
+    return response.data.jobId;
+};

components/webui/client/src/pages/IngestPage/Compress/index.tsx (4)

84-85: Rename card title to match the feature (“Submit Compression Job”).

-        <DashboardCard title={"Start Ingestion"}>
+        <DashboardCard title={"Submit Compression Job"}>

---

88-93: Inline the submit handler; extra .catch is redundant.

-                onFinish={(values) => {
-                    handleSubmit(values).catch((error: unknown) => {
-                        console.error("Error in handleSubmit:", error);
-                    });
-                }}
+                onFinish={handleSubmit}

---

94-102: Validate at least one non‑empty path and improve placeholder.

                 <Form.Item
                     label={"Paths"}
                     name={"paths"}
-                    rules={[{required: true, message: "Please enter at least one path"}]}
+                    rules={[
+                        {required: true, message: "Please enter at least one path"},
+                        {
+                            validator: async (_, v?: string) => {
+                                const count = (v ?? "").split("\n").map((p) => p.trim()).filter((p) => 0 < p.length).length;
+                                return 0 < count ? Promise.resolve() : Promise.reject(new Error("Please enter at least one non-empty path"));
+                            },
+                        },
+                    ]}
                 >
                     <Input.TextArea
                         autoSize={{minRows: 4, maxRows: 10}}
-                        placeholder={"Enter paths to compress, one per line"}/>
+                        placeholder={"Enter container-relative paths (e.g., /logs/app.log), one per line"}/>
                 </Form.Item>

---

48-59: Send optional fields only when non‑empty; trim values.

-            if ("undefined" !== typeof values.dataset) {
-                payload.dataset = values.dataset;
-            }
+            if ("string" === typeof values.dataset && 0 < values.dataset.trim().length) {
+                payload.dataset = values.dataset.trim();
+            }
 
-            if ("undefined" !== typeof values.timestampKey) {
-                payload.timestampKey = values.timestampKey;
-            }
+            if ("string" === typeof values.timestampKey && 0 < values.timestampKey.trim().length) {
+                payload.timestampKey = values.timestampKey.trim();
+            }

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

Learnt from: junhaoliao
PR: y-scope/clp#596
File: components/log-viewer-webui/client/src/api/query.js:16-23
Timestamp: 2024-11-21T15:51:33.203Z
Learning: In `components/log-viewer-webui/client/src/api/query.js`, the `ExtractJsonResp` type definition is accurate as-is and does not require modification. When suggesting changes to type definitions, ensure they align with the server-side definitions, referencing the source code if necessary.

components/webui/server/src/routes/api/compress/index.ts (3)

26-38: Resolved: defaults now sourced from settings.json.

Good move away from hard‑coded literals; keeps operations tunable without code changes.

---

55-61: Declare 400 responses in the route schema.

Aligns OpenAPI with runtime validation and new bad-request cases.

             schema: {
                 body: CompressionJobSchema,
                 response: {
                     [StatusCodes.CREATED]: CompressionJobCreationSchema,
+                    [StatusCodes.BAD_REQUEST]: ErrorSchema,
                     [StatusCodes.INTERNAL_SERVER_ERROR]: ErrorSchema,
                 },
                 tags: ["Compression"],
             },

---

75-84: Trim and ignore empty optionals; set dataset default only when needed.

Prevents storing empty strings; applies CLP default cleanly.

-            if ("clp-s" === settings.ClpStorageEngine) {
-                if ("string" !== typeof dataset || 0 === dataset.length) {
-                    jobConfig.input.dataset = CLP_DEFAULT_DATASET_NAME;
-                } else {
-                    jobConfig.input.dataset = dataset;
-                }
-                if ("undefined" !== typeof timestampKey) {
-                    jobConfig.input.timestamp_key = timestampKey;
-                }
-            }
+            if ("clp-s" === settings.ClpStorageEngine) {
+                const ds = "string" === typeof dataset ? dataset.trim() : "";
+                jobConfig.input.dataset = 0 < ds.length ? ds : CLP_DEFAULT_DATASET_NAME;
+                if ("string" === typeof timestampKey && 0 < timestampKey.trim().length) {
+                    jobConfig.input.timestamp_key = timestampKey.trim();
+                }
+            }

components/webui/client/src/pages/IngestPage/Compress/index.tsx (4)

52-58: Trim and omit empty optionals before sending.

Avoid persisting empty strings; send only meaningful values.

-            if ("undefined" !== typeof values.dataset) {
-                payload.dataset = values.dataset;
-            }
-
-            if ("undefined" !== typeof values.timestampKey) {
-                payload.timestampKey = values.timestampKey;
-            }
+            if ("string" === typeof values.dataset && 0 < values.dataset.trim().length) {
+                payload.dataset = values.dataset.trim();
+            }
+            if ("string" === typeof values.timestampKey && 0 < values.timestampKey.trim().length) {
+                payload.timestampKey = values.timestampKey.trim();
+            }

---

82-82: Rename card title to reflect the feature.

“Start Ingestion” is misleading here.

-        <DashboardCard title={"Start Ingestion"}>
+        <DashboardCard title={"Submit Compression Job"}>

---

86-90: Inline the submit handler; the extra .catch is redundant.

handleSubmit already handles errors.

-                onFinish={(values) => {
-                    handleSubmit(values).catch((error: unknown) => {
-                        console.error("Error in handleSubmit:", error);
-                    });
-                }}
+                onFinish={handleSubmit}

---

93-100: Validate at least one trimmed, non-empty path; improve placeholder.

Prevents whitespace-only submits and clarifies expected input.

                 <Form.Item
                     label={"Paths"}
                     name={"paths"}
-                    rules={[{required: true, message: "Please enter at least one path"}]}
+                    rules={[
+                        {required: true, message: "Please enter at least one path"},
+                        {
+                            validator: async (_, value?: string) => {
+                                const count = (value ?? "")
+                                    .split("\n")
+                                    .map((p) => p.trim())
+                                    .filter((p) => 0 < p.length).length;
+                                if (0 < count) { return Promise.resolve(); }
+                                return Promise.reject(new Error("Please enter at least one non-empty path"));
+                            },
+                        },
+                    ]}
                 >
                     <Input.TextArea
                         autoSize={{minRows: 4, maxRows: 10}}
-                        placeholder={"Enter paths to compress, one per line"}/>
+                        placeholder={"Enter container-relative paths (e.g., /logs/app.log), one per line"}/>

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro