@tyvm/knowhow 0.0.108-dev.4a8ba55 → 0.0.108-dev.501f36f

package/src/logger.ts

@@ -0,0 +1,197 @@
+import type { LogLevel } from "./services/EventService";
+
+/**
+ * App-wide logger utility.
+ *
+ * Features:
+ * 1. `logger.info/warn/error(source, message)` — routes through EventService
+ * 2. `Logger.of("ClassName")` — creates a bound logger so you don't repeat the source
+ * 3. `logger.installConsoleOverload()` — replaces console.log/warn/error/info with
+ *    our closure, so ALL output (including third-party modules) goes through us
+ * 4. `logger.silence()` / `logger.unsilence()` — suppress all output, useful for
+ *    commands that need clean stdout (e.g. github-credentials)
+ *
+ * Usage (module-level):
+ *   import { logger } from "../logger";
+ *   logger.info("MyService", "Something happened");
+ *
+ * Usage (class-level):
+ *   import { Logger } from "../logger";
+ *   class MyClass {
+ *     private logger = Logger.of("MyClass");
+ *     doThing() { this.logger.info("Something happened"); }
+ *   }
+ *
+ * Silence mode (for clean-stdout commands):
+ *   logger.silence();   // suppress everything
+ *   // ... do work that must produce clean stdout ...
+ *   logger.unsilence(); // restore
+ */
+
+// ---- Internal state ---------------------------------------------------------
+
+let silenced = false;
+
+// Original console methods — saved before any overload is installed
+const _originalConsole = {
+  log: console.log.bind(console),
+  warn: console.warn.bind(console),
+  error: console.error.bind(console),
+  info: console.info.bind(console),
+};
+
+let consoleOverloadInstalled = false;
+
+// ---- EventService lazy accessor ---------------------------------------------
+
+function getEvents() {
+  try {
+    const { services } = require("./services") as typeof import("./services");
+    return services().Events;
+  } catch {
+    return null;
+  }
+}
+
+// ---- Core emit logic --------------------------------------------------------
+
+function emit(source: string, message: string, level: LogLevel): void {
+  if (silenced) return;
+
+  try {
+    const events = getEvents();
+    if (events) {
+      events.log(source, message, level);
+      return;
+    }
+  } catch {
+    // fall through to direct console output
+  }
+
+  // Fallback: use original console methods (bypasses any overload we installed)
+  const prefix = source ? `[${source}] ` : "";
+  if (level === "warn") _originalConsole.warn(`${prefix}${message}`);
+  else if (level === "error") _originalConsole.error(`${prefix}${message}`);
+  else _originalConsole.log(`${prefix}${message}`);
+}
+
+// ---- Bound logger (returned by Logger.of) -----------------------------------
+
+export interface BoundLogger {
+  log(message: string, level?: LogLevel): void;
+  info(message: string): void;
+  warn(message: string): void;
+  error(message: string): void;
+}
+
+function makeBoundLogger(source: string): BoundLogger {
+  return {
+    log(message: string, level: LogLevel = "info"): void {
+      emit(source, message, level);
+    },
+    info(message: string): void {
+      emit(source, message, "info");
+    },
+    warn(message: string): void {
+      emit(source, message, "warn");
+    },
+    error(message: string): void {
+      emit(source, message, "error");
+    },
+  };
+}
+
+// ---- Public API -------------------------------------------------------------
+
+export const logger = {
+  log(source: string, message: string, level: LogLevel = "info"): void {
+    emit(source, message, level);
+  },
+
+  info(source: string, message: string): void {
+    emit(source, message, "info");
+  },
+
+  warn(source: string, message: string): void {
+    emit(source, message, "warn");
+  },
+
+  error(source: string, message: string): void {
+    emit(source, message, "error");
+  },
+
+  /**
+   * Suppress all log output. Useful for commands that need clean stdout
+   * (e.g. git credential helpers). All logger.* calls and overloaded
+   * console.* calls become no-ops until unsilence() is called.
+   */
+  silence(): void {
+    silenced = true;
+  },
+
+  /**
+   * Restore log output after a silence() call.
+   */
+  unsilence(): void {
+    silenced = false;
+  },
+
+  /**
+   * Returns true if the logger is currently silenced.
+   */
+  isSilenced(): boolean {
+    return silenced;
+  },
+
+  /**
+   * Install console overload. After this call, console.log/warn/error/info
+   * all route through our closure (respecting silence mode).
+   * Safe to call multiple times — only installs once.
+   *
+   * Call this early in CLI startup (before any modules are loaded) to ensure
+   * third-party module logs don't bypass the silence mechanism.
+   */
+  installConsoleOverload(): void {
+    if (consoleOverloadInstalled) return;
+    consoleOverloadInstalled = true;
+
+    const route = (originalFn: (...args: any[]) => void, args: any[]) => {
+      if (silenced) return;
+      originalFn(...args);
+    };
+
+    console.log = (...args: any[]) => route(_originalConsole.log, args);
+    console.info = (...args: any[]) => route(_originalConsole.info, args);
+    console.warn = (...args: any[]) => route(_originalConsole.warn, args);
+    // Note: console.error is intentionally NOT overloaded — real errors (stack
+    // traces, crash reports) should always be visible. Only suppress via silence().
+    // If you want to suppress errors too, call logger.silence() which checks the flag
+    // before the overloaded console.warn/log routes reach here anyway.
+  },
+
+  /**
+   * Remove the console overload and restore original console methods.
+   */
+  uninstallConsoleOverload(): void {
+    if (!consoleOverloadInstalled) return;
+    console.log = _originalConsole.log;
+    console.info = _originalConsole.info;
+    console.warn = _originalConsole.warn;
+    consoleOverloadInstalled = false;
+  },
+};
+
+/**
+ * Factory for creating a bound logger with a fixed source name.
+ * Ideal for class-level loggers:
+ *
+ *   class MyClass {
+ *     private logger = Logger.of("MyClass");
+ *     doThing() { this.logger.info("hello"); }
+ *   }
+ */
+export const Logger = {
+  of(source: string): BoundLogger {
+    return makeBoundLogger(source);
+  },
+};

package/src/services/EventService.ts

@@ -1,6 +1,8 @@
 import { EventEmitter } from "events";
 import { IAgent } from "../agents/interface";
 
+export type LogLevel = "info" | "warn" | "error";
+
 export type EventHandlerFn = (...args: any[]) => any;
 
 export interface EventHandler {
@@ -31,9 +33,38 @@ type ManagedListenerRecord = {
   blocking: boolean;
 };
 
+/**
+ * Default console handler for plugin:log events.
+ * Active when no renderer has taken over (e.g. worker mode, CLI before chat starts).
+ * Can be suppressed by calling suppressDefaultLogger() when a renderer is active.
+ *
+ * IMPORTANT: Uses process.stdout/stderr directly to avoid infinite recursion
+ * with logger.installConsoleOverload() which overrides console.log/warn.
+ */
+function defaultConsoleLogHandler(event: {
+  source: string;
+  message: string;
+  level: LogLevel;
+}): void {
+  const prefix = event.source ? `[${event.source}] ` : "";
+  const line = `${prefix}${event.message}\n`;
+  switch (event.level) {
+    case "warn":
+      process.stderr.write(line);
+      break;
+    case "error":
+      process.stderr.write(line);
+      break;
+    default:
+      process.stdout.write(line);
+  }
+}
+
 export class EventService extends EventEmitter {
   private blockingHandlers: Map<string, EventHandler[]> = new Map();
   private managedListeners: Map<string, ManagedListenerRecord> = new Map();
+  private defaultLoggerActive = true;
+  private boundDefaultLogHandler = defaultConsoleLogHandler;
 
   eventTypes = {
     agentMsg: "agent:msg",
@@ -45,6 +76,35 @@ export class EventService extends EventEmitter {
   constructor() {
     super();
     this.setMaxListeners(100);
+    // Register the default console logger so Events.log() always produces output
+    // even before a renderer is attached (worker mode, module loading, etc.)
+    this.on(this.eventTypes.pluginLog, this.boundDefaultLogHandler);
+  }
+
+  /**
+   * Suppress the default console logger.
+   * Call this when a renderer has taken over and will handle plugin:log events.
+   * This prevents double-printing when both the renderer and the default handler fire.
+   */
+  suppressDefaultLogger(): void {
+    if (this.defaultLoggerActive) {
+      this.removeListener(
+        this.eventTypes.pluginLog,
+        this.boundDefaultLogHandler
+      );
+      this.defaultLoggerActive = false;
+    }
+  }
+
+  /**
+   * Restore the default console logger.
+   * Call this when the renderer is torn down.
+   */
+  restoreDefaultLogger(): void {
+    if (!this.defaultLoggerActive) {
+      this.on(this.eventTypes.pluginLog, this.boundDefaultLogHandler);
+      this.defaultLoggerActive = true;
+    }
   }
 
   /**
@@ -232,7 +292,7 @@ export class EventService extends EventEmitter {
   log(
     source: string,
     message: string,
-    level: "info" | "warn" | "error" = "info"
+    level: LogLevel = "info"
   ): void {
     this.emit(this.eventTypes.pluginLog, {
       source,

package/src/services/KnowhowClient.ts

@@ -1,3 +1,4 @@
+import { createHash } from "crypto";
 import http from "../utils/http";
 import fs from "fs";
 import { Message } from "../clients/types";
@@ -663,8 +664,10 @@ export class KnowhowSimpleClient {
   /**
    * Get presigned S3 URL for uploading a file to Knowhow FS.
    * First finds or creates the file by path, then gets its upload URL.
+   * Computes SHA256 hash of the file content and stores it as S3 metadata
+   * so any client can determine if they already have this version without downloading.
    */
-  async getOrgFilePresignedUploadUrl(filePath: string): Promise<string> {
+  async getOrgFilePresignedUploadUrl(filePath: string, localFilePath?: string): Promise<string> {
     await this.checkJwt();
 
     // Find or create the file by path
@@ -675,10 +678,17 @@ export class KnowhowSimpleClient {
     const fileName =
       lastSlash >= 0 ? filePath.substring(lastSlash + 1) : filePath;
 
+    // Compute SHA256 hash if we have the local file path, so S3 stores it as metadata
+    let sha256Hash: string | undefined;
+    if (localFilePath) {
+      const fileContent = fs.readFileSync(localFilePath);
+      sha256Hash = createHash("sha256").update(fileContent).digest("base64");
+    }
+
     // Get upload URL using the file ID
     const response = await http.post<{ uploadUrl: string }>(
       `${this.baseUrl}/api/org-files/upload/${file.id}`,
-      { fileName },
+      { fileName, sha256Hash },
       { headers: this.headers }
     );
     return response.data.uploadUrl;

package/src/services/S3.ts

@@ -1,6 +1,5 @@
 import * as fs from "fs";
 import { createWriteStream, createReadStream } from "fs";
-import * as crypto from "crypto";
 import { pipeline, Readable } from "stream";
 import * as util from "util";
 
@@ -15,19 +14,10 @@ export class S3Service {
       const fileContent = fs.readFileSync(filePath);
       const fileStats = await fs.promises.stat(filePath);
 
-      // Compute SHA-256 checksum (base64) — required when presigned URL was
-      // generated with ChecksumAlgorithm: SHA256
-      const sha256Base64 = crypto
-        .createHash("sha256")
-        .update(fileContent)
-        .digest("base64");
-
       const response = await fetch(presignedUrl, {
         method: "PUT",
         headers: {
           "Content-Length": String(fileStats.size),
-          "x-amz-checksum-sha256": sha256Base64,
-          "x-amz-sdk-checksum-algorithm": "SHA256",
         },
         body: fileContent,
         // @ts-ignore

package/src/services/modules/index.ts

@@ -1,7 +1,9 @@
+import * as path from "path";
+
 import { getConfig, getGlobalConfig } from "../../config";
 import { KnowhowModule, ModuleContext } from "./types";
 import { services } from "../";
-import * as path from "path";
+import { toUniqueArray } from "../../utils";
 
 export class ModulesService {
   async getDefaultContext() {
@@ -33,11 +35,17 @@ export class ModulesService {
         : modulePath;
       const rawModule = require(resolvedPath);
       const importedModule = (rawModule.default || rawModule) as KnowhowModule;
-      console.log(
+      context.Events?.log(
+        "ModulesService",
         `🔌 Loading module: ${modulePath} (resolved: ${resolvedPath})`
       );
-      await importedModule.init({ config, cwd: process.cwd(), context: context as ModuleContext });
-      console.log(
+      await importedModule.init({
+        config,
+        cwd: process.cwd(),
+        context: context as ModuleContext,
+      });
+      context.Events?.log(
+        "ModulesService",
         `✅ Module initialized: ${modulePath} (tools: ${importedModule.tools.length}, agents: ${importedModule.agents.length}, plugins: ${importedModule.plugins.length}, clients: ${importedModule.clients.length})`
       );
 
@@ -52,7 +60,10 @@ export class ModulesService {
       if (context.Tools) {
         for (const tool of importedModule.tools) {
           context.Tools.addTool(tool.definition);
-          context.Tools.setFunction(tool.definition.function.name, tool.handler);
+          context.Tools.setFunction(
+            tool.definition.function.name,
+            tool.handler
+          );
         }
       }
 
@@ -84,7 +95,7 @@ export class ModulesService {
     ];
 
     return this.loadModulesFrom(
-      { ...config, modules: allModulePaths },
+      { ...config, modules: toUniqueArray(allModulePaths) },
       context
     );
   }

package/src/services/modules/types.ts

@@ -11,6 +11,7 @@ import { AIClient } from "../../clients";
 import { ToolsService } from "../Tools";
 import { MediaProcessorService } from "../MediaProcessorService";
 import { TunnelHandler } from "@tyvm/knowhow-tunnel";
+import { EventService } from "../EventService";
 
 /*
  *
@@ -54,6 +55,7 @@ export interface ModuleContext {
   Plugins: PluginService;
   Clients: AIClient;
   Tools: ToolsService;
+  Events: EventService;
   MediaProcessor?: MediaProcessorService;
   Tunnel?: TunnelHandler;
   Program?: Command;

package/tests/unit/commands/github-credentials.test.ts

@@ -0,0 +1,211 @@
+/**
+ * Unit tests for the github-credentials command.
+ *
+ * Key invariant: running `github-credentials` must NEVER write anything other than
+ * the credential lines to stdout. Module loading logs, warnings, etc. must be
+ * silenced so the git credential helper protocol is not corrupted.
+ */
+
+// Mock config before any imports that depend on it
+jest.mock("../../../src/config", () => ({
+  getConfig: jest.fn().mockResolvedValue({ modules: [] }),
+  getGlobalConfig: jest.fn().mockResolvedValue({ modules: [] }),
+  getConfigSync: jest.fn().mockReturnValue({}),
+  migrateConfig: jest.fn().mockResolvedValue(undefined),
+}));
+
+// Mock clients to avoid openai.ts side-effects
+jest.mock("../../../src/clients", () => ({
+  AIClient: jest.fn(),
+  Clients: { registerClient: jest.fn(), registerModels: jest.fn() },
+}));
+
+// Mock KnowhowSimpleClient so we control what getGitCredential returns
+// without needing a real JWT or network connection
+jest.mock("../../../src/services/KnowhowClient", () => ({
+  KnowhowSimpleClient: jest.fn().mockImplementation(() => ({
+    getGitCredential: jest.fn().mockResolvedValue({
+      protocol: "https",
+      host: "github.com",
+      username: "x-access-token",
+      password: "ghu_TESTTOKEN123",
+    }),
+  })),
+}));
+
+// Mock readline so the 'get' action doesn't hang waiting for stdin
+jest.mock("readline", () => ({
+  createInterface: jest.fn().mockReturnValue({
+    on: jest.fn().mockImplementation(function (event: string, cb: Function) {
+      // Immediately fire 'close' so the readline promise resolves
+      if (event === "close") {
+        setImmediate(() => cb());
+      }
+      return this;
+    }),
+  }),
+}));
+
+import { Command } from "commander";
+import { addGithubCredentialsCommand } from "../../../src/commands/misc";
+import { logger } from "../../../src/logger";
+
+describe("github-credentials command", () => {
+  /**
+   * This test verifies the EARLY silencing logic in cli.ts main().
+   * The problem: modules load BEFORE parseAsync, so any module that emits
+   * warnings (e.g. Terminal module: no TunnelHandler) does so before the
+   * action's logger.silence() call can stop it.
+   *
+   * The fix: cli.ts checks process.argv before module loading and silences early.
+   * This test simulates that logic directly.
+   */
+  describe("early silencing (pre-module-load)", () => {
+    beforeEach(() => {
+      logger.unsilence();
+      logger.installConsoleOverload();
+    });
+
+    afterEach(() => {
+      logger.unsilence();
+      logger.uninstallConsoleOverload();
+    });
+
+    it("silences before module loading when github-credentials is in argv", () => {
+      const originalArgv = process.argv;
+      process.argv = ["node", "knowhow", "github-credentials", "get"];
+
+      // Simulate the exact early-detection logic from cli.ts main()
+      const rawArgs = process.argv.slice(2);
+      const SILENT_COMMANDS = ["github-credentials"];
+      if (rawArgs.some((a) => SILENT_COMMANDS.includes(a))) {
+        logger.silence();
+      }
+
+      // Now any module-load-time console.log/warn should be suppressed
+      const consoleSpy = jest.spyOn(process.stdout, "write");
+      console.warn("⚠️  Terminal module: no TunnelHandler in context — terminal addon not registered");
+      console.log("some other module loading noise");
+
+      expect(consoleSpy).not.toHaveBeenCalled();
+      consoleSpy.mockRestore();
+      process.argv = originalArgv;
+    });
+
+    it("does NOT silence for other commands", () => {
+      const originalArgv = process.argv;
+      process.argv = ["node", "knowhow", "chat"];
+
+      const rawArgs = process.argv.slice(2);
+      const SILENT_COMMANDS = ["github-credentials"];
+      if (rawArgs.some((a) => SILENT_COMMANDS.includes(a))) {
+        logger.silence();
+      }
+
+      expect(logger.isSilenced()).toBe(false);
+      process.argv = originalArgv;
+    });
+  });
+
+  let program: Command;
+  let stdoutSpy: jest.SpyInstance;
+  let writtenToStdout: string[];
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+
+    // Reset logger silence state between tests
+    logger.unsilence();
+
+    // Capture process.stdout.write — this is what the credential helper uses
+    writtenToStdout = [];
+    stdoutSpy = jest
+      .spyOn(process.stdout, "write")
+      .mockImplementation((chunk: any) => {
+        writtenToStdout.push(typeof chunk === "string" ? chunk : chunk.toString());
+        return true;
+      });
+
+    program = new Command();
+    program.exitOverride(); // prevent process.exit during tests
+    addGithubCredentialsCommand(program);
+  });
+
+  afterEach(() => {
+    stdoutSpy.mockRestore();
+    logger.unsilence();
+  });
+
+  it("outputs only credential lines to stdout for 'get' action", async () => {
+    await program.parseAsync([
+      "node", "knowhow", "github-credentials", "get", "--repo", "myorg/myrepo",
+    ]);
+
+    expect(writtenToStdout).toHaveLength(1);
+    expect(writtenToStdout[0]).toBe(
+      "protocol=https\nhost=github.com\nusername=x-access-token\npassword=ghu_TESTTOKEN123\n"
+    );
+  });
+
+  it("silences the logger immediately so module logs don't pollute stdout", async () => {
+    await program.parseAsync([
+      "node", "knowhow", "github-credentials", "get", "--repo", "myorg/myrepo",
+    ]);
+
+    // The action must have called logger.silence() — state persists after action
+    expect(logger.isSilenced()).toBe(true);
+  });
+
+  it("produces exactly 4 credential field lines and nothing else", async () => {
+    await program.parseAsync([
+      "node", "knowhow", "github-credentials", "get", "--repo", "myorg/myrepo",
+    ]);
+
+    const allOutput = writtenToStdout.join("");
+    const lines = allOutput.trim().split("\n");
+
+    expect(lines).toHaveLength(4);
+    expect(lines[0]).toMatch(/^protocol=/);
+    expect(lines[1]).toMatch(/^host=/);
+    expect(lines[2]).toMatch(/^username=/);
+    expect(lines[3]).toMatch(/^password=/);
+  });
+
+  it("exits cleanly for 'store' action without writing credentials", async () => {
+    let exitCode: number | undefined;
+    // Throw to stop execution after exit() is called — otherwise the mock
+    // just sets a flag and the action continues to fetch credentials.
+    const exitSpy = jest
+      .spyOn(process, "exit")
+      .mockImplementation(((code?: number) => {
+        exitCode = code ?? 0;
+        throw new Error(`process.exit(${exitCode})`);
+      }) as any);
+
+    await expect(
+      program.parseAsync(["node", "knowhow", "github-credentials", "store"])
+    ).rejects.toThrow("process.exit(0)");
+
+    expect(exitCode).toBe(0);
+    expect(writtenToStdout).toHaveLength(0);
+    exitSpy.mockRestore();
+  });
+
+  it("exits cleanly for 'erase' action without writing credentials", async () => {
+    let exitCode: number | undefined;
+    const exitSpy = jest
+      .spyOn(process, "exit")
+      .mockImplementation(((code?: number) => {
+        exitCode = code ?? 0;
+        throw new Error(`process.exit(${exitCode})`);
+      }) as any);
+
+    await expect(
+      program.parseAsync(["node", "knowhow", "github-credentials", "erase"])
+    ).rejects.toThrow("process.exit(0)");
+
+    expect(exitCode).toBe(0);
+    expect(writtenToStdout).toHaveLength(0);
+    exitSpy.mockRestore();
+  });
+});