feat: add logging

kitsonk · kitsonk · commit 012345c9dd01 · 2025-05-26T20:36:38.000+10:00
diff --git a/.env.defaults b/.env.defaults
@@ -1,2 +1,5 @@
 # Comma separated set of string keys to use for signing cookies
-KEY_STACK_KEYS=kview
+KEY_STACK_KEYS=kview
+# The logging level for the application
+# Possible values: debug, info, warning, error, fatal
+LOG_LEVEL=info
diff --git a/build.config.ts b/build.config.ts
@@ -1,8 +1,12 @@
+import "@std/dotenv/load";
 import { defineConfig } from "$fresh/server.ts";
 import tailwind from "$fresh/plugins/tailwind.ts";
 import svg_minify from "@kitsonk/svg-minify";
 import zipBuild from "./zip_build.plugin.ts";
 
+const port = Deno.env.has("PORT") ? parseInt(Deno.env.get("PORT")!, 10) : undefined;
+
 export default defineConfig({
+  server: { port },
   plugins: [tailwind(), svg_minify(), zipBuild()],
 });
diff --git a/fresh.config.ts b/fresh.config.ts
@@ -1,6 +1,9 @@
 import { defineConfig } from "$fresh/server.ts";
 import tailwind from "$fresh/plugins/tailwind.ts";
 
+const port = Deno.env.has("PORT") ? parseInt(Deno.env.get("PORT")!, 10) : undefined;
+
 export default defineConfig({
+  server: { port },
   plugins: [tailwind()],
 });
diff --git a/routes/api/blob/download/[id]/[...path].ts b/routes/api/blob/download/[id]/[...path].ts
@@ -1,9 +1,13 @@
 import { type Handlers } from "$fresh/server.ts";
 import { pathToKey } from "$utils/kv.ts";
 import { getKv } from "$utils/kv_state.ts";
+import { getLogger } from "@logtape/logtape";
+
+const logger = getLogger(["kview", "api", "blob", "download"]);
 
 export const handler: Handlers = {
   async GET(_req, { params: { id, path } }) {
+    logger.debug("GET: {id}:{path}", { id, path });
     const key = path === "" ? [] : pathToKey(path);
     const kv = await getKv(id);
     return kv.getAsBlob(key, { response: true, contentDisposition: true });
diff --git a/routes/api/blob/serve/[id]/[...path].ts b/routes/api/blob/serve/[id]/[...path].ts
@@ -1,9 +1,13 @@
 import { type Handlers } from "$fresh/server.ts";
 import { pathToKey } from "$utils/kv.ts";
 import { getKv } from "$utils/kv_state.ts";
+import { getLogger } from "@logtape/logtape";
+
+const logger = getLogger(["kview", "api", "blob", "serve"]);
 
 export const handler: Handlers = {
   async GET(_req, { params: { id, path } }) {
+    logger.debug("GET: {id}:{path}", { id, path });
     const key = path === "" ? [] : pathToKey(path);
     const kv = await getKv(id);
     return kv.getAsBlob(key, { response: true });
diff --git a/routes/api/jobs/[id].ts b/routes/api/jobs/[id].ts
@@ -1,21 +1,28 @@
 import { type Handlers } from "$fresh/server.ts";
 import { abort, getJob } from "$utils/kv_bulk.ts";
+import { getLogger } from "@logtape/logtape";
+
+const logger = getLogger(["kview", "api", "jobs", "id"]);
 
 export const handler: Handlers = {
   GET(_req, { params: { id } }) {
+    logger.debug("GET: {id}", { id });
     const job = getJob(parseInt(id, 10));
     if (job) {
       return Response.json({ status: 200, statusText: "OK", job });
     }
+    logger.info("Not Found: {id}", { id });
     return Response.json({ status: 404, statusText: "Not Found", id }, {
       status: 404,
       statusText: "Not Found",
     });
   },
   DELETE(_req, { params: { id } }) {
+    logger.debug("DELETE: {id}", { id });
     if (abort(parseInt(id, 10))) {
       return Response.json({ status: 200, statusText: "OK", id });
     }
+    logger.info("Not Found: {id}", { id });
     return Response.json({ status: 404, statusText: "Not Found", id }, {
       status: 404,
       statusText: "Not Found",
diff --git a/routes/api/jobs/index.ts b/routes/api/jobs/index.ts
@@ -1,8 +1,12 @@
 import { type Handlers } from "$fresh/server.ts";
 import { getJobs } from "$utils/kv_bulk.ts";
+import { getLogger } from "$utils/logs.ts";
+
+const logger = getLogger(["kview", "api", "jobs"]);
 
 export const handler: Handlers = {
   GET(_req, _ctx) {
+    logger.debug("GET");
     return Response.json({ status: 200, statusText: "OK", jobs: getJobs() });
   },
 };
diff --git a/routes/api/kv/[id]/[...path].ts b/routes/api/kv/[id]/[...path].ts
@@ -73,6 +73,7 @@ export const handler: Handlers = {
     }
   },
   async PUT(req, { params: { id, path = "" } }) {
+    logger.debug("PUT: {id}:{path}", { id, path });
     try {
       const key = pathToKey(path);
       const kv = await getKv(id);
diff --git a/routes/api/kv/[id]/_bulk/[...path].ts b/routes/api/kv/[id]/_bulk/[...path].ts
@@ -45,15 +45,21 @@ export const handler: Handlers = {
     const name = req.headers.get("kview-name");
     const href = req.headers.get("kview-href");
     const data = await req.bytes();
-    logger.debug("Importing: {id}:{path}", { id, path });
+    logger.debug("start: {id}:{path} overwrite: {overwrite}, name: {name}, href: {href}", {
+      id,
+      path,
+      overwrite,
+      name,
+      href,
+    });
     const job = await importNdJson(id, prefix, data, { overwrite, name, href });
     if (!job) {
+      logger.info("Not Found: {id}:{path}, name: {name}, href: {href}", { id, path, name, href });
       return Response.json({ status: 404, statusText: "Not Found" }, {
         status: 404,
         statusText: "Not Found",
       });
     }
-    logger.info("Created job: {id}", { id: job.id });
     return Response.json({ status: 201, statusText: "Created", id: job.id }, {
       status: 201,
       statusText: "Created",
diff --git a/routes/api/local/index.ts b/routes/api/local/index.ts
@@ -2,6 +2,9 @@ import { type Handlers } from "$fresh/server.ts";
 import { keys, mergeHeaders, SecureCookieMap, STORE_NAMES } from "$utils/cookies.ts";
 import { LOCAL_STORES, localStores } from "$utils/kv.ts";
 import { state } from "$utils/state.ts";
+import { getLogger } from "$utils/logs.ts";
+
+const logger = getLogger(["kview", "api", "local"]);
 
 async function setName(
   value: string,
@@ -24,6 +27,7 @@ async function setName(
 export const handler: Handlers = {
   async POST(req) {
     const [id, value]: [string, string] = await req.json();
+    logger.debug("POST: {id} = {value}", { id, value });
     const cookies = await setName(value, id, req);
     return new Response(null, {
       status: 204,
@@ -39,6 +43,12 @@ export const handler: Handlers = {
         previousPath?: string;
         name?: string;
       } = await req.json();
+      logger.debug("PUT: {id} = {name}, path: {path}, previousPath: {previousPath}", {
+        id,
+        name,
+        path,
+        previousPath,
+      });
       if (path) {
         const { isFile } = await Deno.stat(path);
         if (isFile) {
@@ -75,6 +85,7 @@ export const handler: Handlers = {
   async DELETE(req) {
     try {
       const { path }: { path: string } = await req.json();
+      logger.debug("DELETE: {path}", { path });
       const localStoresString = localStorage.getItem(LOCAL_STORES);
       if (localStoresString) {
         const stores: string[] = JSON.parse(localStoresString);
diff --git a/routes/api/remote/check.ts b/routes/api/remote/check.ts
@@ -4,12 +4,16 @@ import { deadline } from "@std/async/deadline";
 import { type RemoteStoreInfo } from "$utils/remoteStores.ts";
 import { state } from "$utils/state.ts";
 import { setAccessToken } from "$utils/dash.ts";
+import { getLogger } from "$utils/logs.ts";
+
+const logger = getLogger(["kview", "remote", "check"]);
 
 export const handler: Handlers = {
   async POST(res) {
     try {
       const storeInfo: RemoteStoreInfo = await res.json();
       assert(storeInfo.url && storeInfo.accessToken);
+      logger.debug("POST: {url}", { url: storeInfo.url });
       let oldValue: string | undefined;
       if (state.accessToken.peek() !== storeInfo.accessToken) {
         oldValue = state.accessToken.peek();
@@ -36,6 +40,9 @@ export const handler: Handlers = {
         }
       });
     } catch (err) {
+      logger.warn("Error checking remote store: {error}", {
+        error: err instanceof Error ? `${err.name}: ${err.message}` : JSON.stringify(err),
+      });
       return Response.json({
         status: 400,
         statusText: "Bad Request",
diff --git a/routes/api/remote/index.ts b/routes/api/remote/index.ts
@@ -1,15 +1,20 @@
 import { type Handlers } from "$fresh/server.ts";
 import { assert } from "@std/assert/assert";
+import { getLogger } from "$utils/logs.ts";
 import { deleteRemoteStore, type RemoteStoreInfo, replaceRemoteStore, upsertRemoteStore } from "$utils/remoteStores.ts";
 import { state } from "$utils/state.ts";
 
+const logger = getLogger(["kview", "remote", "check"]);
+
 export const handler: Handlers = {
   GET() {
+    logger.debug("GET");
     return Response.json(state.remoteStores.value);
   },
   async PUT(req) {
     try {
       const { oldUrl, ...item }: RemoteStoreInfo & { oldUrl?: string } = await req.json();
+      logger.debug("PUT: {url}", { url: item.url });
       assert(
         typeof item === "object" && "url" in item && "accessToken" in item,
       );
@@ -35,6 +40,7 @@ export const handler: Handlers = {
     try {
       const store: RemoteStoreInfo = await req.json();
       assert(typeof store === "object" && "url" in store);
+      logger.debug("DELETE: {url}", { url: store.url });
       state.remoteStores.value = deleteRemoteStore(
         store,
         state.remoteStores.value,
diff --git a/routes/api/watch/index.ts b/routes/api/watch/index.ts
@@ -1,5 +1,6 @@
 import { Handlers } from "$fresh/server.ts";
 import { type KvKeyJSON } from "@deno/kv-utils/json";
+import { getLogger } from "$utils/logs.ts";
 import { state } from "$utils/state.ts";
 import { addWatch, deleteWatch, serialize } from "$utils/watches.ts";
 
@@ -10,6 +11,8 @@ interface WatchBody {
   href?: string;
 }
 
+const logger = getLogger(["kview", "api", "watch"]);
+
 function assertBody(value: unknown): asserts value is WatchBody {
   if (
     !(typeof value === "object" && value && "databaseId" in value &&
@@ -21,13 +24,18 @@ function assertBody(value: unknown): asserts value is WatchBody {
 
 export const handler: Handlers = {
   GET(_req, _ctx) {
+    logger.debug("GET");
     return Response.json(serialize(state.watches.value));
   },
   async PUT(req, _ctx) {
     try {
       const body = await req.json();
       assertBody(body);
       const { databaseId, key, name, href } = body;
+      logger.debug("PUT: {databaseId}:{key}", {
+        databaseId,
+        key: JSON.stringify(key),
+      });
       state.watches.value = addWatch(
         databaseId,
         { key, name, href },
@@ -47,6 +55,10 @@ export const handler: Handlers = {
       const body = await req.json();
       assertBody(body);
       const { databaseId, key } = body;
+      logger.debug("DELETE: {databaseId}:{key}", {
+        databaseId,
+        key: JSON.stringify(key),
+      });
       state.watches.value = deleteWatch(databaseId, key, state.watches.value);
       return Response.json({ status: 200, statusText: "OK" });
     } catch (err) {
diff --git a/routes/api/watch/server.ts b/routes/api/watch/server.ts
@@ -3,6 +3,7 @@ import { entryMaybeToJSON } from "@deno/kv-utils/json";
 import { effect } from "@preact/signals";
 import { setAccessToken } from "$utils/dash.ts";
 import { getKvName, getKvPath } from "$utils/kv_state.ts";
+import { getLogger } from "$utils/logs.ts";
 import { state } from "$utils/state.ts";
 import { type Watches } from "$utils/watches.ts";
 
@@ -18,6 +19,8 @@ interface WatchNotification {
   entries: Deno.KvEntryMaybe<unknown>[];
 }
 
+const logger = getLogger(["kview", "api", "watch"]);
+
 async function watchKv(
   databaseId: string,
   keys: Deno.KvKey[],
@@ -70,6 +73,7 @@ function dispatch(
 
 export const handler: Handlers = {
   GET(req, _ctx) {
+    logger.debug("GET");
     if (req.headers.get("upgrade") != "websocket") {
       return new Response(null, { status: 501 });
     }
@@ -93,6 +97,7 @@ export const handler: Handlers = {
     });
 
     socket.addEventListener("open", async () => {
+      logger.info("WebSocket connection established");
       for await (const { databaseId, entries, name, href } of messages) {
         socket.send(
           JSON.stringify({
@@ -105,6 +110,7 @@ export const handler: Handlers = {
       }
     });
     socket.addEventListener("close", () => {
+      logger.info("WebSocket connection closed");
       dispose?.();
     });
 
diff --git a/utils/logs.ts b/utils/logs.ts
@@ -1,9 +1,12 @@
+import "@std/dotenv/load";
 import { configure, getConsoleSink, getLogger } from "@logtape/logtape";
 
+const lowestLevel = (Deno.env.get("LOG_LEVEL") ?? "debug") as "debug" | "info" | "warning" | "error" | "fatal";
+
 await configure({
   sinks: { console: getConsoleSink() },
   loggers: [
-    { category: "kview", lowestLevel: "debug", sinks: ["console"] },
+    { category: "kview", lowestLevel, sinks: ["console"] },
     // Log meta information at a lower level to avoid spamming the console.
     { category: ["logtape", "meta"], lowestLevel: "warning", sinks: ["console"] },
   ],

Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ export const handler: Handlers = {`
`73`	`73`	`}`
`74`	`74`	`},`
`75`	`75`	`async PUT(req, { params: { id, path = "" } }) {`
	`76`	`+ logger.debug("PUT: {id}:{path}", { id, path });`
`76`	`77`	`try {`
`77`	`78`	`const key = pathToKey(path);`
`78`	`79`	`const kv = await getKv(id);`