imcp 0.1.1 → 0.1.3

package/memory-bank/decisionLog.md

@@ -26,3 +26,66 @@ Update this file with a timestamped entry whenever a major decision is made.
 - Fix: Modified duplicateServer() to temporarily enable ALL disabled fields before form submission
 - Impact: Ensures complete server data is captured regardless of position in list
 - Files affected: src/web/public/js/onboard/uiHandlers.js
+[2025-05-16 13:27:43] - Refactored requirement management logic from `InstallationService` into a new dedicated `RequirementService`. `InstallationService` now delegates requirement-related tasks (checking status, installing, updating) to `RequirementService`. This improves separation of concerns and modularity.
+
+[2025-05-16 16:07:20] - Redesigned the operation status and polling mechanism for Installation in both frontend and backend. This involved creating a new InstallOperationManager, new types for operation details, an API endpoint for status retrieval, and integrating step recording into InstallationService, RequirementService, and BaseClientInstaller. This provides more granular tracking of installation progress.
+
+[2025-05-16 16:50:05] - Added 'overallStatus' to InstallOperationDetails and updated InstallOperationManager to manage it. Modified frontend polling in 'src/web/public/js/modal/installation.js' to use the new installation status API and display detailed steps.
+
+[2025-05-16 17:03:17] - Enhanced the display of installation steps in the loading modal. Modified 'messageQueue.js' to support step-specific formatting (icons, success/failure states) and updated 'installation.js' to pass these options. Added CSS in 'modal.css' for the new step display styles.
+
+[2025-05-16 17:08:31] - Refined installation step display: made fonts smaller, increased compactness, and added timestamps for each step. Updated 'modal.css' and 'messageQueue.js' accordingly. 'installation.js' now passes the timestamp.
+
+[2025-05-16 17:19:37] - Overhauled the installation loading modal UI. 'loadingModal.js' now dynamically creates a new structure with an overall status (icon + text) and a detailed steps list. 'installation.js' was updated to use new functions in 'loadingModal.js' for status and step updates. 'messageQueue.js' was simplified as direct DOM manipulation for steps is now in 'loadingModal.js'. Added extensive CSS in 'modal.css' for the new layout and styling.
+
+[2025-05-16 17:23:42] - Fixed error caused by removed 'delayedAppendInstallLoadingMessage'. Updated 'modalSetup.js' and 'installation.js' (uninstallTools function) to use the new 'updateOverallInstallStatus' from 'loadingModal.js' for general status messages during uninstallation.
+
+[2025-05-16 17:26:13] - Final fix for 'delayedAppendInstallLoadingMessage' error: removed unused import from 'installModal.js'.
+
+[2025-05-16 17:29:59] - Corrected 'src/web/public/js/modal/index.js' barrel file: removed imports and re-exports of 'delayedAppendInstallLoadingMessage' and 'appendInstallLoadingMessage' as they no longer exist. Added new exports for 'updateOverallInstallStatus' and 'addInstallationStep'.
+
+[2025-05-16 17:31:35] - Corrected 'src/web/public/js/modal.js' (another barrel file): removed import and global assignment of 'appendInstallLoadingMessage'. Added missing exports for 'showInstallLoadingModal' and 'hideInstallLoadingModal'.
+
+[2025-05-16 17:46:59] - Implemented reset of installation operation status. Added `resetOperation` method to `InstallOperationManager.ts` to delete existing status for a server. Called this method at the beginning of `InstallationService.ts#install` to ensure a clean state for new installations.
+
+[2025-05-16 17:51:01] - UI adjustments for installation loading modal:
+  - Added a close button (X) to the top-right corner with functionality to hide the modal.
+  - Ensured installation steps are explicitly left-aligned using `justify-content: flex-start`.
+  - Modified the 'completed' status icon to be a checkmark within a green circle.
+  - Reviewed and confirmed the 'in-progress' spinner icon.
+
+[2025-05-16 17:53:42] - Refined step message alignment in installation loading modal: Added `align-items: flex-start` and `text-align: left` to `.step-info`, and `text-align: left` with `width: 100%` to `.step-message` in `modal.css` to ensure text content is fully left-aligned.
+
+[2025-05-16 17:55:32] - UI adjustment for installation loading modal: Removed the "Details" header text from above the steps list in `loadingModal.js`.
+
+[2025-05-16 17:57:02] - Corrected removal of "Details" header in installation loading modal: Entire line `<div class="steps-list-header">Details</div>` was removed from `loadingModal.js` instead of being commented out with an invalid HTML comment.
+
+[2025-05-17 00:26:02] - Refactored InstallOperationManager to require categoryName and serverName in the constructor, removed singleton/static pattern, and changed status file storage to per-category/server at Settings_Dir/InstallOperationStatus/CategoryName/ServerName.json. This enables instance-based management and more granular status persistence.
+
+[2025-05-17 15:02:27] - Refactored `RequirementService.ts` to use instance-based `InstallOperationManager`.
+- The `processRequirementUpdates` and `checkAndInstallRequirements` (including its helper `installRequirementsInBackground`) methods in [`src/services/RequirementService.ts`](src/services/RequirementService.ts:0) were updated.
+- They now obtain an `InstallOperationManager` instance using `InstallOperationManager.getInstance(categoryName, serverName)`.
+- The core logic within these methods, and the individual requirement processing loops, are now wrapped with `iom.recording()` or `iom.recordingAsync()` for robust step tracking and error handling.
+- This change aligns `RequirementService.ts` with the new instance-based, per-category/server architecture of `InstallOperationManager` introduced in [2025-05-17 00:26:02].
+- Rationale: Simplifies step recording, centralizes status management within the `InstallOperationManager` instance, and improves consistency across services.
+- Implications: Removed direct calls to the deprecated global `installOperationManager.recordStep` and adopted the more structured `recording` pattern.
+
+[2025-05-17 15:26:09] - Updated all requirement installer classes and interface to support step recording via InstallOperationManager. All install methods now accept an optional recorder and record critical steps using recordStep/recording.
+
+[2025-05-18 13:21:30] - Implemented main modal refresh on loading modal close, replacing page reload.
+- Rationale: Improve UX by maintaining main modal context and avoiding disruptive page reloads after installation/uninstallation operations shown in the loading modal.
+- Implementation Details:
+  - `src/web/public/js/modal/loadingModal.js`: Modified `hideInstallLoadingModal` to dispatch a custom event `refreshMainModalContent` instead of causing a page reload.
+  - `src/web/public/js/modal/installation.js`: Modified `handleBulkClientInstall` to store `categoryName` as `lastSelectedCategory` and `serverName` as `lastSelectedServerName` in `localStorage` when an installation process begins. This ensures the context is available for the refresh.
+  - `src/web/public/js/modal.js`: Added an event listener for `refreshMainModalContent`. This listener retrieves `lastSelectedCategory` and `lastSelectedServerName` from `localStorage`. If both are valid, it calls `window.showInstallModal(lastSelectedCategory, lastSelectedServerName)` to refresh the content of the main installation modal.
+- Debugging: Iteratively refined the logic in `modal.js` to correctly handle and validate `lastSelectedCategory` and `lastSelectedServerName` to prevent errors when calling `showInstallModal`. This was crucial for ensuring `showInstallModal` received the necessary `serverName` argument, resolving "Server configuration not found" errors.
+[2025-05-18 11:33:12] - Added `src/core/metadatas/recordingConstants.ts` as the canonical source for all step recording names used in installation and onboarding operations. This file centralizes all static step names as constants and documents dynamic step name patterns, improving consistency and discoverability for step-based operation tracking across backend and frontend.
+
+[2025-05-18 20:46:46] - Reduced the height and key size in the System Environment Variables section of the settings UI for a more compact and modern appearance. This involved decreasing row padding, shrinking the key column width, and reducing the key font size in `src/web/public/js/settings.js`.
+
+[2025-05-18 21:00:26] - Macro resolution logic updated: Now resolves macro values (${PYTHON_PACKAGE}, ${NPMPATH}, ${BROWSER_PATH}) by first checking SystemSettingsManager (system settings), and only falls back to previous behavior if not found. This centralizes macro configuration and improves consistency across the system.
+
+[2025-05-19 00:14:06] - Updated settings page UI and functionality:
+  - Removed "NPM Global Package Path" field from `src/web/public/settings.html` and `src/web/public/js/settings.js`.
+  - Added a descriptive prompt "Stored and used for mcp server installation environments." with a question icon (`bx-help-circle`) on the same line as the "User Configurations" title in `src/web/public/settings.html`.
+  - Modified `src/web/public/js/settings.js` to render user configuration values as `type="password"` if the key contains "key". Added an eye icon button *inside* the value input field to toggle visibility for these password fields, maintaining original input box sizes.

package/memory-bank/progress.md

@@ -3,3 +3,33 @@
 - [YYYY-MM-DD HH:MM:SS] - Initializing Memory Bank.
 
 - [2025-05-16 09:22:36] - Completed: Made "IMCP Server Manager" title clickable in `src/web/public/index.html`.
+- [2025-05-16 13:28:10] - Completed: Refactored requirement management from `InstallationService` to `RequirementService`. Fixed `reqConfig` scoping and type fallbacks in `RequirementService.processRequirementUpdates`.
+
+[2025-05-16 16:07:34] - Completed: Redesign installation operation status and polling mechanism.
+  - Added `InstallOperationDetails` type to `src/core/metadatas/types.ts`.
+  - Created `InstallOperationManager` in `src/core/loaders/InstallOperationManager.ts`.
+  - Added API endpoint for installation status in `src/web/server.ts`.
+  - Integrated `recordStep` in `InstallationService`, `RequirementService`, and `BaseClientInstaller`.
+
+[2025-05-16 16:50:21] - Enhanced installation status:
+  - Added `overallStatus` to `InstallOperationDetails` in `src/core/metadatas/types.ts`.
+  - Updated `InstallOperationManager` in `src/core/loaders/InstallOperationManager.ts` to manage `overallStatus`.
+  - Modified frontend polling in `src/web/public/js/modal/installation.js` to use the new API `/api/categories/:categoryName/servers/:serverName/installation/status` and display detailed steps.
+
+[2025-05-17 00:26:16] - Began refactoring InstallOperationManager to be instance-based per category/server, with new file structure for status. Memory bank updated to reflect architectural and pattern changes.
+
+[2025-05-17 15:02:44] - Completed: Refactored `RequirementService.ts` to use instance-based `InstallOperationManager` and its `recording`/`recordingAsync` methods. This involved updating `processRequirementUpdates`, `checkAndInstallRequirements`, and `installRequirementsInBackground`.
+
+[2025-05-18 11:33:23] - Completed: Standardized step recording names by creating `src/core/metadatas/recordingConstants.ts`. This centralizes static step names and documents dynamic patterns for installation/onboarding operations.
+
+[2025-05-18 13:21:30] - Completed: Implemented main modal refresh logic to replace page reload.
+  - `loadingModal.js`: Dispatches `refreshMainModalContent` event on close.
+  - `installation.js`: Stores `categoryName` and `serverName` in `localStorage`.
+  - `modal.js`: Listens for event, retrieves context from `localStorage`, and calls `showInstallModal` with both `categoryName` and `serverName`.
+  - This resolves "Server configuration not found" errors and improves UX.
+[2025-05-17 15:26:15] - Refactored all requirement installer classes and factory to support InstallOperationManager step recording. All install methods now accept a recorder and log critical steps.
+
+[2025-05-19 00:14:13] - Completed: Updated settings page (`src/web/public/settings.html` and `src/web/public/js/settings.js`):
+  - Removed "NPM Global Package Path" display.
+  - Added prompt with a question icon for User Configurations, displayed on the same line as the section title.
+  - Implemented secret input type for keys containing "key" in User Configurations, with an eye icon button *inside* the value input field to toggle visibility (maintaining original input box sizes).

package/memory-bank/systemPatterns.md

@@ -1,3 +1,10 @@
 # System Patterns
 
 - [YYYY-MM-DD HH:MM:SS] - Initializing Memory Bank.
+
+[2025-05-18 13:21:30] - Implemented an event-driven modal refresh pattern for the installation UI.
+  - Pattern: Instead of page reloads, the loading modal (`loadingModal.js`) dispatches a custom DOM event (`refreshMainModalContent`) upon closing.
+  - Context Persistence: The initiating action (e.g., in `installation.js`) stores necessary context (like `lastSelectedCategory` and `lastSelectedServerName`) in `localStorage`.
+  - Event Handling: The main modal controller (`modal.js`) listens for this event, retrieves context from `localStorage`, and re-initializes/refreshes its content (`showInstallModal`) with the persisted context.
+  - Benefit: This decouples the loading modal from the main modal, allows for non-disruptive UI updates, and maintains user context effectively.
+[2025-05-17 00:26:06] - Changed InstallOperationManager from singleton/static to instance-based, with per-category/server file storage pattern: Settings_Dir/InstallOperationStatus/CategoryName/ServerName.json. This introduces a more granular, object-oriented persistence and management pattern for install operation status.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imcp",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Node.js SDK for Model Context Protocol (MCP)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/cli/index.ts

@@ -8,19 +8,9 @@ import { createUninstallCommand } from './commands/uninstall.js';
 import { createPullCommand } from './commands/pull.js';
 import { mcpManager } from '../services/MCPManager.js';
 import { Logger } from '../utils/logger.js';
-import axios from 'axios';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import fs from 'fs';
-import { compareVersions } from '../utils/versionUtils.js';
+import { checkForUpdates } from '../utils/versionUtils.js';
 
 // Custom error interface for Commander.js errors
-// ANSI color codes
-const COLORS = {
-  reset: '\x1b[0m',
-  yellow: '\x1b[33m'
-};
-
 interface CommanderError extends Error {
   code?: string;
 }
@@ -81,43 +71,6 @@ process.on('unhandledRejection', (error: unknown) => {
   process.exit(1);
 });
 
-/**
- * Check if there's a newer version of the package available
- */
-
-async function checkForUpdates(): Promise<void> {
-  try {
-    // Get the current package version
-    const __filename = fileURLToPath(import.meta.url);
-    const __dirname = path.dirname(__filename);
-    const packagePath = path.resolve(__dirname, '../../package.json');
-    const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
-    const currentVersion = packageJson.name && packageJson.version ? packageJson.version : '0.0.0';
-    const packageName = packageJson.name || 'imcp';
-
-    try {
-      // Get the latest version from npm registry (only for published packages)
-      const npmResponse = await axios.get(`https://registry.npmjs.org/${packageName}`);
-
-      if (npmResponse.data && npmResponse.data['dist-tags'] && npmResponse.data['dist-tags'].latest) {
-        const latestVersion = npmResponse.data['dist-tags'].latest;
-
-        // Compare versions properly to ensure we're only notifying for newer versions
-        if (latestVersion && compareVersions(latestVersion, currentVersion) > 0) {
-          console.log(`${COLORS.yellow}Update available for ${packageName}: ${currentVersion} → ${latestVersion}${COLORS.reset}`);
-          console.log(`${COLORS.yellow}Run \`npm install -g ${packageName}@latest\` to update${COLORS.reset}`);
-        }
-      }
-    } catch (npmError) {
-      // Log the npm error
-      Logger.debug(`Failed to check npm registry: ${npmError instanceof Error ? npmError.message : String(npmError)}`);
-    }
-  } catch (error) {
-    // Silently fail - don't interrupt the command if update check fails
-    Logger.debug(`Failed to check for updates: ${error instanceof Error ? error.message : String(error)}`);
-  }
-}
-
 // Start the CLI
 main().catch((error: unknown) => {
   if (error instanceof Error) {

package/src/core/installers/clients/BaseClientInstaller.ts

@@ -1,7 +1,7 @@
 import { Logger } from '../../../utils/logger.js';
 import { exec } from 'child_process';
 import { promisify } from 'util';
-import { isCommandAvailable } from '../../../utils/osUtils.js';
+import { isCommandAvailable, getNpmExecutablePath } from '../../../utils/osUtils.js';
 import { ExtensionInstaller } from './ExtensionInstaller.js';
 import { SUPPORTED_CLIENTS } from '../../metadatas/constants.js';
 import {
@@ -13,6 +13,8 @@ import {
     MACRO_EXPRESSIONS,
     MacroResolverFunctions
 } from '../../../utils/macroExpressionUtils.js';
+import { InstallOperationManager } from '../../loaders/InstallOperationManager.js';
+import * as RecordingConstants from '../../metadatas/recordingConstants.js';
 
 const execAsync = promisify(exec);
 
@@ -123,7 +125,7 @@ export abstract class BaseClientInstaller {
      */
     protected async handleWindowsNpx(config: any): Promise<any> {
         if (process.platform === 'win32' && config.command === 'npx') {
-            const npmPath = await this.getNpmPath();
+            const npmPath = await getNpmExecutablePath();
             return {
                 ...config,
                 command: 'cmd',
@@ -179,19 +181,6 @@ export abstract class BaseClientInstaller {
         };
     }
 
-    /**
-     * Get the NPM path on Windows
-     */
-    private async getNpmPath(): Promise<string> {
-        try {
-            const { stdout } = await execAsync('powershell -Command "get-command npm | Select-Object -ExpandProperty Source"');
-            return stdout.trim().replace(/\\npm\.cmd$/, '');
-        } catch (error) {
-            Logger.error('Error getting npm path:', error);
-            return 'C:\\Program Files\\nodejs';
-        }
-    }
-
     /**
      * Checks if VS Code or VS Code Insiders is installed and installs the client extension.
      * @param operationId The operation ID for tracking.
@@ -276,48 +265,73 @@ export abstract class BaseClientInstaller {
      * @param serverConfig Server configuration
      * @param options Installation options including environment variables and arguments
      */
-    async install(serverConfig: McpConfig, options: ServerInstallOptions): Promise<OperationStatus> {
+    async install(serverConfig: McpConfig, options: ServerInstallOptions, categoryName?: string): Promise<OperationStatus> {
         const operationId = this.generateOperationId();
 
-        try {
-            const vsCodeCheckResult = await this.checkVSCodeAndInstallExtension(operationId);
-            if (vsCodeCheckResult) {
-                return vsCodeCheckResult;
-            }
+        const recorder = InstallOperationManager.getInstance(categoryName || serverConfig.name, serverConfig.name);
+        return await recorder.recording(
+            async () => {
+                await recorder.recording(
+                    () => this.checkVSCodeAndInstallExtension(operationId), {
+                    stepName: RecordingConstants.STEP_CHECK_VSCODE_AND_INSTALL_EXTENSION,
+                    onResult: (result) => result?.status !== 'failed'
+                }
+                )
 
-            const installConfig = await this.setupInstallConfig(serverConfig, options);
-            if (serverConfig.mode) {
-                installConfig.mode = serverConfig.mode;
-            }
+                const installConfig = await recorder.recording(
+                    () => this.setupInstallConfig(serverConfig, options), {
+                    stepName: RecordingConstants.STEP_SETUP_INSTALLATION_CONFIG
+                });
 
-            // Update VS Code settings
-            const results = await this.updateVSCodeSettings(serverConfig.name, installConfig);
+                if (serverConfig.mode) {
+                    installConfig.mode = serverConfig.mode;
+                }
 
-            // Determine overall success
-            const anySuccess = results.some(r => r.success);
-            const successPaths = results.filter(r => r.success).map(r => r.path);
-            const errors = results.filter(r => !r.success).map(r => r.error);
+                const results = await recorder.recording(
+                    () => this.updateVSCodeSettings(serverConfig.name, installConfig), {
+                    stepName: RecordingConstants.STEP_UPDATE_VSCODE_SETTINGS,
+                    onResult: (result) => result?.some(r => r.success)
+                }
+                );
 
-            return {
-                status: anySuccess ? 'completed' : 'failed',
-                type: 'install',
-                target: 'server',
-                message: anySuccess
+                // Determine overall success
+                const anySuccess = results.some(r => r.success);
+                const successPaths = results.filter(r => r.success).map(r => r.path);
+                const errors = results.filter(r => !r.success).map(r => r.error);
+
+                const finalMessage = anySuccess
                     ? `Successfully installed ${this.clientName} client. Updated settings in: ${successPaths.join(', ')}`
-                    : `Failed to install ${this.clientName} client. Errors: ${errors.join('; ')}`,
-                operationId,
-                error: anySuccess ? undefined : errors.join('; ')
-            };
-        } catch (error) {
-            return {
-                status: 'failed',
-                type: 'install',
-                target: 'server',
-                message: `Unexpected error installing ${this.clientName} client: ${error instanceof Error ? error.message : String(error)}`,
-                operationId,
-                error: error instanceof Error ? error.message : String(error)
-            };
-        }
+                    : `Failed to install ${this.clientName} client. Errors: ${errors.join('; ')}`;
+
+                return {
+                    status: anySuccess ? 'completed' : 'failed',
+                    type: 'install',
+                    target: 'server',
+                    message: finalMessage,
+                    operationId,
+                    error: anySuccess ? undefined : errors.join('; ')
+                };
+            },
+            {
+                stepName: RecordingConstants.STEP_INSTALLATION,
+                onResult: (result) => result?.status !== 'failed',
+                endMessage: (result) => (result as OperationStatus)?.message,
+                onError: (error) => {
+                    const errorMsg = `Unexpected error installing ${this.clientName} client: ${error instanceof Error ? error.message : String(error)}`;
+                    return {
+                        result: {
+                            status: 'failed',
+                            type: 'install',
+                            target: 'server',
+                            message: errorMsg,
+                            operationId,
+                            error: error instanceof Error ? error.message : String(error)
+                        }, message: errorMsg
+                    };
+                }
+            }
+        );
+
     }
 
     /**