feat(logging): refactor logging system to use a centralized file logger and remove old logger implementations

Author: ErcinDedeoglu

src/logging/file-logger.ts

@@ -0,0 +1,96 @@
+/**
+ * File Logger Adapter
+ *
+ * Implements the Logger interface writing to a local file.
+ * This is the adapter layer - contains actual I/O operations.
+ */
+
+import { homedir } from 'node:os';
+import { appendFileSync } from 'node:fs';
+import { join } from 'node:path';
+import type { Logger, LogCategory } from '../types/index.js';
+
+const LOG_PREFIX = '[opencode-sync]';
+const LOG_DIR = join(homedir(), '.local/share/opencode/log');
+const LOG_FILE = join(LOG_DIR, 'opencode-sync.log');
+
+/** Format a log message with timestamp and optional category */
+function formatMessage(message: string, category?: LogCategory): string {
+  const timestamp = new Date().toISOString();
+  const categoryTag = category ? `[${category}] ` : '';
+  return `${timestamp} ${LOG_PREFIX} ${categoryTag}${message}`;
+}
+
+/** Write a message to the log file */
+function writeToFile(message: string): void {
+  try {
+    appendFileSync(LOG_FILE, message + '\n');
+  } catch {
+    // Fallback to console if file write fails
+    console.error(message);
+  }
+}
+
+/** File-based logger implementation */
+export const fileLogger: Logger = {
+  log(message: string, category?: LogCategory): void {
+    writeToFile(formatMessage(message, category));
+  },
+
+  debug(message: string, category?: LogCategory): void {
+    writeToFile(formatMessage(`[DEBUG] ${message}`, category));
+  },
+
+  info(message: string, category?: LogCategory): void {
+    writeToFile(formatMessage(`[INFO] ${message}`, category));
+  },
+
+  warn(message: string, category?: LogCategory): void {
+    writeToFile(formatMessage(`[WARN] ${message}`, category));
+  },
+
+  error(message: string, category?: LogCategory): void {
+    writeToFile(formatMessage(`[ERROR] ${message}`, category));
+  },
+
+  startOperation(name: string): (result?: string) => void {
+    const start = Date.now();
+    writeToFile(formatMessage(`Starting: ${name}`, 'SYNC'));
+    return (result?: string): void => {
+      const duration = Date.now() - start;
+      const suffix = result ? ` - ${result}` : '';
+      writeToFile(formatMessage(`Completed: ${name} (${String(duration)}ms)${suffix}`, 'SYNC'));
+    };
+  },
+};
+
+/**
+ * Convenience exports for direct use (backwards compatibility).
+ * Prefer injecting the Logger interface when possible.
+ */
+export function log(message: string, category?: LogCategory): void {
+  fileLogger.log(message, category);
+}
+
+export function syncLog(message: string): void {
+  fileLogger.log(message, 'SYNC');
+}
+
+export function logProgress(message: string): void {
+  fileLogger.log(message, 'REPO');
+}
+
+export function syncDebug(message: string): void {
+  fileLogger.debug(message, 'SYNC');
+}
+
+export function startOperation(name: string): (result?: string) => void {
+  return fileLogger.startOperation(name);
+}
+
+/** Log setup instructions when configuration is missing */
+export function logSetupInstructions(): void {
+  log('To configure, either:', 'PLUGIN');
+  log('  1. Set GITHUB_TOKEN environment variable (with repo scope)', 'PLUGIN');
+  log('  2. Create ~/.config/opencode/opencode-sync.json with token', 'PLUGIN');
+}

src/logging/index.ts

@@ -0,0 +1,15 @@
+/**
+ * Logging Module
+ *
+ * Exports the logger adapter and convenience functions.
+ */
+
+export {
+  fileLogger,
+  log,
+  syncLog,
+  logProgress,
+  syncDebug,
+  startOperation,
+  logSetupInstructions,
+} from './file-logger.js';

src/plugin/background-sync.ts

@@ -13,9 +13,8 @@ import {
   deleteTombstonedItems,
 } from '../data/index.js';
 import { FileWatcher } from '../sync/watcher/index.js';
-import { syncLog } from '../sync/engine/logger.js';
+import { syncLog, log } from '../logging/index.js';
 import { getPluginState } from './state-manager.js';
-import { log } from './logger.js';
 
 /** Active file watcher instance */
 let activeWatcher: FileWatcher | null = null;

src/plugin/logger.ts

@@ -17,7 +17,7 @@ import {
 import { getTokenSource, loadLocalData } from '../data/index.js';
 import { RepoStorageBackend } from '../storage/index.js';
 import type { PluginState } from './types.js';
-import { log, logSetupInstructions } from './logger.js';
+import { log, logSetupInstructions } from '../logging/index.js';
 import { getGitHubUsername, repoExists, createRepo } from './github-api.js';
 import {
   writePulledData,

src/plugin/plugin.ts

@@ -14,7 +14,7 @@ import {
   deleteTombstonedItems,
 } from '../data/index.js';
 import { getPluginState } from './state-manager.js';
-import { syncLog } from '../sync/engine/logger.js';
+import { syncLog } from '../logging/index.js';
 
 type LogLevel = 'error' | 'info' | 'debug' | 'warn';
 

src/plugin/sync-handler.ts

@@ -5,7 +5,7 @@
 import { fetchWithRetry } from './fetch.js';
 import { GRAPHQL_BATCH_SIZE } from './constants.js';
 import type { GraphQLRepositoryResponse, TruncatedFile } from './types.js';
-import { logProgress } from './logger.js';
+import { logProgress } from '../../logging/index.js';
 import { buildBatchQuery, parseGraphQLResponse } from './graphql-query.js';
 
 /** GraphQL client configuration */

src/storage/repo/graphql-client.ts

@@ -15,6 +15,6 @@ export {
 export { GitHubHttpClient } from './http-client.js';
 export { GitOperations } from './git-operations.js';
 export { GraphQLClient } from './graphql-client.js';
-export { logProgress } from './logger.js';
+export { logProgress } from '../../logging/index.js';
 export * from './constants.js';
 export type * from './types.js';

src/storage/repo/index.ts

@@ -9,7 +9,7 @@ import type { StorageBackend, StorageFile } from '../interface.js';
 import { SYNC_DIR, DEFAULT_MAX_RETRIES, DEFAULT_RETRY_DELAY_MS } from './constants.js';
 import { GitOperations } from './git-operations.js';
 import { GraphQLClient } from './graphql-client.js';
-import { logProgress } from './logger.js';
+import { logProgress } from '../../logging/index.js';
 import type { RepoClientConfig, GitTreeEntry } from './types.js';
 
 // Re-export for backward compatibility