refactor(setting): Improve settings migration and tool loading (#7445)

Co-authored-by: psinha40898 <pyushsinha20@gmail.com>

packages/cli/src/config/settings.ts

@@ -19,9 +19,31 @@ import stripJsonComments from 'strip-json-comments';
 import { DefaultLight } from '../ui/themes/default-light.js';
 import { DefaultDark } from '../ui/themes/default.js';
 import { isWorkspaceTrusted } from './trustedFolders.js';
-import type { Settings, MemoryImportFormat } from './settingsSchema.js';
+import {
+  type Settings,
+  type MemoryImportFormat,
+  SETTINGS_SCHEMA,
+  type MergeStrategy,
+  type SettingsSchema,
+  type SettingDefinition,
+} from './settingsSchema.js';
 import { resolveEnvVarsInObject } from '../utils/envVarResolver.js';
-import { mergeWith } from 'lodash-es';
+import { customDeepMerge } from '../utils/deepMerge.js';
+
+function getMergeStrategyForPath(path: string[]): MergeStrategy | undefined {
+  let current: SettingDefinition | undefined = undefined;
+  let currentSchema: SettingsSchema | undefined = SETTINGS_SCHEMA;
+
+  for (const key of path) {
+    if (!currentSchema || !currentSchema[key]) {
+      return undefined;
+    }
+    current = currentSchema[key];
+    currentSchema = current.properties;
+  }
+
+  return current?.mergeStrategy;
+}
 
 export type { Settings, MemoryImportFormat };
 
@@ -35,15 +57,32 @@ const MIGRATE_V2_OVERWRITE = false;
 
 // As defined in spec.md
 const MIGRATION_MAP: Record<string, string> = {
-  preferredEditor: 'general.preferredEditor',
-  vimMode: 'general.vimMode',
+  accessibility: 'ui.accessibility',
+  allowedTools: 'tools.allowed',
+  allowMCPServers: 'mcp.allowed',
+  autoAccept: 'tools.autoAccept',
+  autoConfigureMaxOldSpaceSize: 'advanced.autoConfigureMemory',
+  bugCommand: 'advanced.bugCommand',
+  chatCompression: 'model.chatCompression',
+  checkpointing: 'general.checkpointing',
+  coreTools: 'tools.core',
+  contextFileName: 'context.fileName',
+  customThemes: 'ui.customThemes',
+  debugKeystrokeLogging: 'general.debugKeystrokeLogging',
   disableAutoUpdate: 'general.disableAutoUpdate',
   disableUpdateNag: 'general.disableUpdateNag',
-  checkpointing: 'general.checkpointing',
+  dnsResolutionOrder: 'advanced.dnsResolutionOrder',
   enablePromptCompletion: 'general.enablePromptCompletion',
-  debugKeystrokeLogging: 'general.debugKeystrokeLogging',
-  theme: 'ui.theme',
-  customThemes: 'ui.customThemes',
+  enforcedAuthType: 'security.auth.enforcedType',
+  excludeTools: 'tools.exclude',
+  excludeMCPServers: 'mcp.excluded',
+  excludedProjectEnvVars: 'advanced.excludedEnvVars',
+  extensionManagement: 'advanced.extensionManagement',
+  extensions: 'extensions',
+  fileFiltering: 'context.fileFiltering',
+  folderTrustFeature: 'security.folderTrust.featureEnabled',
+  folderTrust: 'security.folderTrust.enabled',
+  hasSeenIdeIntegrationNudge: 'ide.hasSeenNudge',
   hideWindowTitle: 'ui.hideWindowTitle',
   hideTips: 'ui.hideTips',
   hideBanner: 'ui.hideBanner',
@@ -55,44 +94,29 @@ const MIGRATION_MAP: Record<string, string> = {
   showMemoryUsage: 'ui.showMemoryUsage',
   showLineNumbers: 'ui.showLineNumbers',
   showCitations: 'ui.showCitations',
-  accessibility: 'ui.accessibility',
   ideMode: 'ide.enabled',
-  hasSeenIdeIntegrationNudge: 'ide.hasSeenNudge',
-  usageStatisticsEnabled: 'privacy.usageStatisticsEnabled',
-  telemetry: 'telemetry',
-  model: 'model.name',
-  maxSessionTurns: 'model.maxSessionTurns',
-  summarizeToolOutput: 'model.summarizeToolOutput',
-  chatCompression: 'model.chatCompression',
-  skipNextSpeakerCheck: 'model.skipNextSpeakerCheck',
-  contextFileName: 'context.fileName',
-  memoryImportFormat: 'context.importFormat',
-  memoryDiscoveryMaxDirs: 'context.discoveryMaxDirs',
   includeDirectories: 'context.includeDirectories',
   loadMemoryFromIncludeDirectories: 'context.loadFromIncludeDirectories',
-  fileFiltering: 'context.fileFiltering',
-  useRipgrep: 'tools.useRipgrep',
+  maxSessionTurns: 'model.maxSessionTurns',
+  mcpServers: 'mcpServers',
+  mcpServerCommand: 'mcp.serverCommand',
+  memoryImportFormat: 'context.importFormat',
+  memoryDiscoveryMaxDirs: 'context.discoveryMaxDirs',
+  model: 'model.name',
+  preferredEditor: 'general.preferredEditor',
   sandbox: 'tools.sandbox',
+  selectedAuthType: 'security.auth.selectedType',
   shouldUseNodePtyShell: 'tools.usePty',
-  autoAccept: 'tools.autoAccept',
-  allowedTools: 'tools.allowed',
-  coreTools: 'tools.core',
-  excludeTools: 'tools.exclude',
+  skipNextSpeakerCheck: 'model.skipNextSpeakerCheck',
+  summarizeToolOutput: 'model.summarizeToolOutput',
+  telemetry: 'telemetry',
+  theme: 'ui.theme',
   toolDiscoveryCommand: 'tools.discoveryCommand',
   toolCallCommand: 'tools.callCommand',
-  mcpServerCommand: 'mcp.serverCommand',
-  allowMCPServers: 'mcp.allowed',
-  excludeMCPServers: 'mcp.excluded',
-  folderTrust: 'security.folderTrust.enabled',
-  selectedAuthType: 'security.auth.selectedType',
-  enforcedAuthType: 'security.auth.enforcedType',
+  usageStatisticsEnabled: 'privacy.usageStatisticsEnabled',
   useExternalAuth: 'security.auth.useExternal',
-  autoConfigureMaxOldSpaceSize: 'advanced.autoConfigureMemory',
-  dnsResolutionOrder: 'advanced.dnsResolutionOrder',
-  excludedProjectEnvVars: 'advanced.excludedEnvVars',
-  bugCommand: 'advanced.bugCommand',
-  extensionManagement: 'experimental.extensionManagement',
-  extensions: 'extensions',
+  useRipgrep: 'tools.useRipgrep',
+  vimMode: 'general.vimMode',
 };
 
 export function getSystemSettingsPath(): string {
@@ -175,8 +199,27 @@ function setNestedProperty(
   current[lastKey] = value;
 }
 
-function needsMigration(settings: Record<string, unknown>): boolean {
-  return !('general' in settings);
+export function needsMigration(settings: Record<string, unknown>): boolean {
+  // A file needs migration if it contains any top-level key that is moved to a
+  // nested location in V2.
+  const hasV1Keys = Object.entries(MIGRATION_MAP).some(([v1Key, v2Path]) => {
+    if (v1Key === v2Path || !(v1Key in settings)) {
+      return false;
+    }
+    // If a key exists that is both a V1 key and a V2 container (like 'model'),
+    // we need to check the type. If it's an object, it's a V2 container and not
+    // a V1 key that needs migration.
+    if (
+      KNOWN_V2_CONTAINERS.has(v1Key) &&
+      typeof settings[v1Key] === 'object' &&
+      settings[v1Key] !== null
+    ) {
+      return false;
+    }
+    return true;
+  });
+
+  return hasV1Keys;
 }
 
 function migrateSettingsToV2(
@@ -297,7 +340,6 @@ function mergeSettings(
       }
     : {
         ...restOfWorkspace,
-        security: {},
       };
 
   // Settings are merged with the following precedence (last one wins for
@@ -306,112 +348,14 @@ function mergeSettings(
   // 2. User Settings
   // 3. Workspace Settings
   // 4. System Settings (as overrides)
-  //
-  // For properties that are arrays (e.g., includeDirectories), the arrays
-  // are concatenated. For objects (e.g., customThemes), they are merged.
-  return {
-    ...systemDefaults,
-    ...user,
-    ...safeWorkspaceWithoutFolderTrust,
-    ...system,
-    general: {
-      ...(systemDefaults.general || {}),
-      ...(user.general || {}),
-      ...(safeWorkspaceWithoutFolderTrust.general || {}),
-      ...(system.general || {}),
-    },
-    ui: {
-      ...(systemDefaults.ui || {}),
-      ...(user.ui || {}),
-      ...(safeWorkspaceWithoutFolderTrust.ui || {}),
-      ...(system.ui || {}),
-      customThemes: {
-        ...(systemDefaults.ui?.customThemes || {}),
-        ...(user.ui?.customThemes || {}),
-        ...(safeWorkspaceWithoutFolderTrust.ui?.customThemes || {}),
-        ...(system.ui?.customThemes || {}),
-      },
-    },
-    security: {
-      ...(systemDefaults.security || {}),
-      ...(user.security || {}),
-      ...(safeWorkspaceWithoutFolderTrust.security || {}),
-      ...(system.security || {}),
-    },
-    mcp: {
-      ...(systemDefaults.mcp || {}),
-      ...(user.mcp || {}),
-      ...(safeWorkspaceWithoutFolderTrust.mcp || {}),
-      ...(system.mcp || {}),
-    },
-    mcpServers: {
-      ...(systemDefaults.mcpServers || {}),
-      ...(user.mcpServers || {}),
-      ...(safeWorkspaceWithoutFolderTrust.mcpServers || {}),
-      ...(system.mcpServers || {}),
-    },
-    context: {
-      ...(systemDefaults.context || {}),
-      ...(user.context || {}),
-      ...(safeWorkspaceWithoutFolderTrust.context || {}),
-      ...(system.context || {}),
-      includeDirectories: [
-        ...(systemDefaults.context?.includeDirectories || []),
-        ...(user.context?.includeDirectories || []),
-        ...(safeWorkspaceWithoutFolderTrust.context?.includeDirectories || []),
-        ...(system.context?.includeDirectories || []),
-      ],
-    },
-    model: {
-      ...(systemDefaults.model || {}),
-      ...(user.model || {}),
-      ...(safeWorkspaceWithoutFolderTrust.model || {}),
-      ...(system.model || {}),
-      chatCompression: {
-        ...(systemDefaults.model?.chatCompression || {}),
-        ...(user.model?.chatCompression || {}),
-        ...(safeWorkspaceWithoutFolderTrust.model?.chatCompression || {}),
-        ...(system.model?.chatCompression || {}),
-      },
-    },
-    advanced: {
-      ...(systemDefaults.advanced || {}),
-      ...(user.advanced || {}),
-      ...(safeWorkspaceWithoutFolderTrust.advanced || {}),
-      ...(system.advanced || {}),
-      excludedEnvVars: [
-        ...new Set([
-          ...(systemDefaults.advanced?.excludedEnvVars || []),
-          ...(user.advanced?.excludedEnvVars || []),
-          ...(safeWorkspaceWithoutFolderTrust.advanced?.excludedEnvVars || []),
-          ...(system.advanced?.excludedEnvVars || []),
-        ]),
-      ],
-    },
-    extensions: {
-      ...(systemDefaults.extensions || {}),
-      ...(user.extensions || {}),
-      ...(safeWorkspaceWithoutFolderTrust.extensions || {}),
-      ...(system.extensions || {}),
-      disabled: [
-        ...new Set([
-          ...(systemDefaults.extensions?.disabled || []),
-          ...(user.extensions?.disabled || []),
-          ...(safeWorkspaceWithoutFolderTrust.extensions?.disabled || []),
-          ...(system.extensions?.disabled || []),
-        ]),
-      ],
-      workspacesWithMigrationNudge: [
-        ...new Set([
-          ...(systemDefaults.extensions?.workspacesWithMigrationNudge || []),
-          ...(user.extensions?.workspacesWithMigrationNudge || []),
-          ...(safeWorkspaceWithoutFolderTrust.extensions
-            ?.workspacesWithMigrationNudge || []),
-          ...(system.extensions?.workspacesWithMigrationNudge || []),
-        ]),
-      ],
-    },
-  };
+  return customDeepMerge(
+    getMergeStrategyForPath,
+    {}, // Start with an empty object
+    systemDefaults,
+    user,
+    safeWorkspaceWithoutFolderTrust,
+    system,
+  ) as Settings;
 }
 
 export class LoadedSettings {
@@ -687,7 +631,12 @@ export function loadSettings(
   }
 
   // For the initial trust check, we can only use user and system settings.
-  const initialTrustCheckSettings = mergeWith({}, systemSettings, userSettings);
+  const initialTrustCheckSettings = customDeepMerge(
+    getMergeStrategyForPath,
+    {},
+    systemSettings,
+    userSettings,
+  );
   const isTrusted =
     isWorkspaceTrusted(initialTrustCheckSettings as Settings) ?? true;