backend/logger: tighter typing

Author: haraldschilly

src/packages/backend/logger.ts

@@ -12,9 +12,11 @@ process.env.DEBUG_HIDE_DATE = "yes"; // since we supply it ourselves
 // otherwise, maybe stuff like this works: (debug as any).inspectOpts["hideDate"] = true;
 
 import debug, { Debugger } from "debug";
-import { mkdirSync, createWriteStream, statSync, ftruncate } from "fs";
-import { format } from "util";
-import { dirname, join } from "path";
+
+import { createWriteStream, ftruncate, mkdirSync, statSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { format } from "node:util";
+
 import { logs } from "./data";
 
 const MAX_FILE_SIZE_BYTES = 20 * 1024 * 1024; // 20MB
@@ -25,12 +27,12 @@ let _trimLogFileSizePath = "";
 export function trimLogFileSize() {
   // THIS JUST DOESN'T REALLY WORK!
   return;
-  
+
   if (!_trimLogFileSizePath) return;
   let stats;
   try {
     stats = statSync(_trimLogFileSizePath);
-  } catch(_) {
+  } catch (_) {
     // this happens if the file doesn't exist, which is fine since "trimming" it would be a no-op
     return;
   }
@@ -141,27 +143,27 @@ function initTransports() {
 
 initTransports();
 
-const DEBUGGERS = {
-  error: COCALC.extend("error"),
-  warn: COCALC.extend("warn"),
-  info: COCALC.extend("info"),
-  http: COCALC.extend("http"),
-  verbose: COCALC.extend("verbose"),
-  debug: COCALC.extend("debug"),
-  silly: COCALC.extend("silly"),
-};
-
-type Level = keyof typeof DEBUGGERS;
-
-const LEVELS: Level[] = [
+const LEVELS = [
   "error",
   "warn",
   "info",
   "http",
   "verbose",
   "debug",
   "silly",
-];
+] as const;
+
+type Level = (typeof LEVELS)[number];
+
+const DEBUGGERS: { [key in Level]: Debugger } = {
+  error: COCALC.extend("error"),
+  warn: COCALC.extend("warn"),
+  info: COCALC.extend("info"),
+  http: COCALC.extend("http"),
+  verbose: COCALC.extend("verbose"),
+  debug: COCALC.extend("debug"),
+  silly: COCALC.extend("silly"),
+} as const;
 
 class Logger {
   private name: string;
@@ -194,13 +196,13 @@ class Logger {
 }
 
 export interface WinstonLogger {
-  error: Function;
-  warn: Function;
-  info: Function;
-  http: Function;
-  verbose: Function;
-  debug: Function;
-  silly: Function;
+  error: Debugger;
+  warn: Debugger;
+  info: Debugger;
+  http: Debugger;
+  verbose: Debugger;
+  debug: Debugger;
+  silly: Debugger;
   extend: (name: string) => WinstonLogger;
   isEnabled: (level: Level) => boolean;
 }

src/packages/database/postgres/delete-projects.ts

@@ -11,7 +11,7 @@ import { promises as fs } from "node:fs";
 import { join } from "node:path";
 
 import { pathToFiles } from "@cocalc/backend/files/path-to-files";
-import getLogger from "@cocalc/backend/logger";
+import getLogger, { WinstonLogger } from "@cocalc/backend/logger";
 import { newCounter } from "@cocalc/backend/metrics";
 import { homePath } from "@cocalc/backend/misc";
 import getPool from "@cocalc/database/pool";
@@ -22,6 +22,8 @@ import { minutes_ago } from "@cocalc/util/misc";
 import { bulkDelete } from "./bulk-delete";
 import { PostgreSQL } from "./types";
 
+const { F_OK, R_OK, W_OK } = fs.constants;
+
 const log = getLogger("db:delete-projects");
 
 const delete_projects_prom = newCounter(
@@ -197,10 +199,10 @@ export async function cleanup_old_projects_data(
         L2(`delete all project files`);
         await deleteProjectFiles(L2, project_id);
 
-        L2(`deleting all shared files`);
         try {
           // this is something like /shared/projects/${project_id}
           const shared_path = pathToFiles(project_id, "");
+          L2(`deleting all shared files in ${shared_path}`);
           await fs.rm(shared_path, { recursive: true, force: true });
         } catch (err) {
           L2(`Unable to delete shared files: ${err}`);
@@ -233,7 +235,7 @@ export async function cleanup_old_projects_data(
 }
 
 async function delete_associated_project_data(
-  L2,
+  L2: WinstonLogger["debug"],
   project_id: string,
 ): Promise<number> {
   let total = 0;
@@ -295,14 +297,18 @@ async function delete_associated_project_data(
   return total;
 }
 
-async function deleteProjectFiles(L2, project_id: string) {
-  // TODO: this only works on-prem, and requires the project files to be mounted
+async function deleteProjectFiles(
+  L2: WinstonLogger["debug"],
+  project_id: string,
+) {
+  // $MOUNTED_PROJECTS_ROOT is for OnPrem and homePath only works in dev/single-user
   const projects_root =
     process.env["MOUNTED_PROJECTS_ROOT"] ?? homePath(project_id);
   if (!projects_root) return;
   const project_dir = join(projects_root, project_id);
+  L2(`attempting to delete all files in ${project_dir}`);
   try {
-    await fs.access(project_dir, fs.constants.F_OK | fs.constants.R_OK);
+    await fs.access(project_dir, F_OK | R_OK | W_OK);
     const stats = await fs.lstat(project_dir);
     if (stats.isDirectory()) {
       L2(`deleting all files in ${project_dir}`);

src/packages/project/project-status/server.ts

@@ -15,13 +15,10 @@ status updates.
 Hence in particular, information like cpu, memory and disk are smoothed out and throttled.
 */
 
-import { getLogger } from "@cocalc/project/logger";
-import { how_long_ago_m, round1 } from "@cocalc/util/misc";
-import { version as smcVersion } from "@cocalc/util/smc-version";
 import { delay } from "awaiting";
 import { EventEmitter } from "events";
 import { isEqual } from "lodash";
-import { get_ProjectInfoServer, ProjectInfoServer } from "../project-info";
+
 import { ProjectInfo } from "@cocalc/comm/project-info/types";
 import {
   ALERT_DISK_FREE,
@@ -36,6 +33,10 @@ import {
   ProjectStatus,
 } from "@cocalc/comm/project-status/types";
 import { cgroup_stats } from "@cocalc/comm/project-status/utils";
+import { getLogger } from "@cocalc/project/logger";
+import { how_long_ago_m, round1 } from "@cocalc/util/misc";
+import { version as smcVersion } from "@cocalc/util/smc-version";
+import { get_ProjectInfoServer, ProjectInfoServer } from "../project-info";
 
 // TODO: only return the "next" value, if it is significantly different from "prev"
 //function threshold(prev?: number, next?: number): number | undefined {
@@ -83,7 +84,7 @@ export class ProjectStatusServer extends EventEmitter {
   constructor(testing = false) {
     super();
     this.testing = testing;
-    this.dbg = (...msg) => winston.debug(...msg);
+    this.dbg = (...msg) => winston.debug(msg[0], ...msg.slice(1));
     this.project_info = get_ProjectInfoServer();
   }
 

src/packages/project/usage-info/server.ts

@@ -12,17 +12,17 @@ from the ProjectInfoServer (which collects data about everything)
 */
 
 import { delay } from "awaiting";
+import { throttle } from "lodash";
 import { EventEmitter } from "node:events";
 
-import { getLogger } from "../logger";
-import { ProjectInfoServer, get_ProjectInfoServer } from "../project-info";
 import { Process, ProjectInfo } from "@cocalc/comm/project-info/types";
 import type { UsageInfo } from "@cocalc/util/types/project-usage-info";
-import { throttle } from "lodash";
+import { getLogger } from "../logger";
+import { ProjectInfoServer, get_ProjectInfoServer } from "../project-info";
 
 const L = getLogger("usage-info:server").debug;
 
-const throttled_dbg = throttle((...args) => L(...args), 10000);
+const throttled_dbg = throttle(L, 10000);
 
 function is_diff(prev: UsageInfo, next: UsageInfo, key: keyof UsageInfo) {
   // we assume a,b >= 0, hence we leave out Math.abs operations

src/packages/server/software-envs.ts

@@ -65,8 +65,7 @@ async function readConfig(purpose: Purpose): Promise<SoftwareEnvConfig | null> {
   // parse the content of softwareFn as json
   try {
     const software = JSON.parse((await readFile(softwareFn)).toString());
-    const dbg = (...msg) => L(...msg);
-    const sanitized = sanitizeSoftwareEnv({ software, registry, purpose }, dbg);
+    const sanitized = sanitizeSoftwareEnv({ software, registry, purpose }, L);
     return sanitized;
   } catch (err) {
     W(`WARNING: ${softwareFn} is not a valid JSON file -- ${err}`);

src/packages/util/db-schema/site-defaults.ts

@@ -655,7 +655,7 @@ export const site_settings_conf: SiteSettings = {
   },
   delete_project_data: {
     name: "Delete Project Data",
-    desc: "When a project has been marked as deleted, also actually delete associated data from the database and (OnPrem only) also its files.",
+    desc: "When a project has been marked as deleted, also actually delete associated data from the database and – for OnPrem and single-user dev mode only – also its files.",
     default: "no",
     valid: only_booleans,
     to_val: to_bool,