fix: improve Magento project configuration handling and dispose logic

Author: dermatz

src/extension.ts

@@ -2,22 +2,29 @@ import * as vscode from 'vscode';
 import { promptMagentoProjectSelection, showErrorMessage, activateExtension, isValidPath, deleteReportFile } from './helpers';
 import { LogItem, ReportViewerProvider } from './logViewer';
 
+let disposables: vscode.Disposable[] = [];
+
 export function activate(context: vscode.ExtensionContext): void {
-  const config = vscode.workspace.getConfiguration();
-  const isMagentoProject = config.get<string>('magentoLogViewer.isMagentoProject', 'Please select');
+  // Get workspace folders
+  const workspaceFolders = vscode.workspace.workspaceFolders;
+  const workspaceUri = workspaceFolders?.[0]?.uri || null;
+
+  // Get configuration with resource scope
+  const config = vscode.workspace.getConfiguration('magentoLogViewer', workspaceUri);
+  const isMagentoProject = config.get<string>('isMagentoProject', 'Please select');
 
   if (isMagentoProject === 'Please select') {
     promptMagentoProjectSelection(config, context);
   } else if (isMagentoProject === 'Yes') {
-    const magentoRoot = config.get<string>('magentoLogViewer.magentoRoot', '');
+    const magentoRoot = config.get<string>('magentoRoot', '');
     if (!magentoRoot || !isValidPath(magentoRoot)) {
       showErrorMessage('Magento root path is not set or is not a directory.');
       return;
     }
     const reportViewerProvider = new ReportViewerProvider(magentoRoot);
     activateExtension(context, magentoRoot, reportViewerProvider);
 
-    vscode.commands.registerCommand('magento-log-viewer.deleteReportFile', (logItem: LogItem) => {
+    const deleteCommand = vscode.commands.registerCommand('magento-log-viewer.deleteReportFile', (logItem: LogItem) => {
       if (logItem && logItem.command && logItem.command.arguments && logItem.command.arguments[0]) {
         const filePath = logItem.command.arguments[0];
         deleteReportFile(filePath);
@@ -26,7 +33,25 @@ export function activate(context: vscode.ExtensionContext): void {
         showErrorMessage('Failed to delete report file: Invalid file path.');
       }
     });
+
+    disposables.push(deleteCommand);
+    context.subscriptions.push(...disposables);
   }
 }
 
-export function deactivate(): void {}
+export function deactivate(): void {
+  // Clear any context values we set
+  vscode.commands.executeCommand('setContext', 'magentoLogViewer.hasMagentoRoot', undefined);
+
+  // Dispose of all disposables
+  while (disposables.length) {
+    const disposable = disposables.pop();
+    if (disposable) {
+      try {
+        disposable.dispose();
+      } catch (err) {
+        console.error('Error disposing:', err);
+      }
+    }
+  }
+}

src/helpers.ts

@@ -24,9 +24,10 @@ export function selectMagentoRootFolder(config: vscode.WorkspaceConfiguration, c
       const defaultUri = workspaceFolders && workspaceFolders.length > 0 ? workspaceFolders[0].uri : undefined;
       vscode.window.showOpenDialog({ defaultUri, canSelectFolders: true, canSelectMany: false, openLabel: 'Select Magento Root Folder' }).then(folderUri => {
         if (folderUri?.[0]) {
-          updateConfig(config, 'magentoLogViewer.magentoRoot', folderUri[0].fsPath).then(() => {
+          const newConfig = vscode.workspace.getConfiguration('magentoLogViewer', folderUri[0]);
+          updateConfig(newConfig, 'magentoLogViewer.magentoRoot', folderUri[0].fsPath).then(() => {
             showInformationMessage('Magento root folder successfully saved!');
-            updateConfig(config, 'magentoLogViewer.isMagentoProject', 'Yes');
+            updateConfig(newConfig, 'magentoLogViewer.isMagentoProject', 'Yes');
             activateExtension(context, folderUri[0].fsPath, new ReportViewerProvider(folderUri[0].fsPath));
           });
         }

src/logViewer.ts

@@ -8,14 +8,18 @@ export class LogViewerProvider implements vscode.TreeDataProvider<LogItem>, vsco
   readonly onDidChangeTreeData: vscode.Event<LogItem | undefined | void> = this._onDidChangeTreeData.event;
   public static statusBarItem: vscode.StatusBarItem;
   private groupByMessage: boolean;
+  private disposables: vscode.Disposable[] = [];
 
   constructor(private workspaceRoot: string) {
     if (!LogViewerProvider.statusBarItem) {
       LogViewerProvider.statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 100);
       LogViewerProvider.statusBarItem.command = 'magento-log-viewer.refreshLogFiles';
       LogViewerProvider.statusBarItem.show();
     }
-    this.groupByMessage = vscode.workspace.getConfiguration('magentoLogViewer').get<boolean>('groupByMessage', true);
+
+    const workspaceUri = vscode.workspace.workspaceFolders?.[0]?.uri || null;
+    const config = vscode.workspace.getConfiguration('magentoLogViewer', workspaceUri);
+    this.groupByMessage = config.get<boolean>('groupByMessage', true);
     this.updateBadge();
     this.updateRefreshButtonVisibility();
   }
@@ -197,17 +201,30 @@ export class LogViewerProvider implements vscode.TreeDataProvider<LogItem>, vsco
   }
 
   dispose() {
-    // Do not dispose the status bar item here to avoid multiple creations
+    this._onDidChangeTreeData.dispose();
+    if (LogViewerProvider.statusBarItem) {
+      LogViewerProvider.statusBarItem.dispose();
+      LogViewerProvider.statusBarItem = null as any;
+    }
+    while (this.disposables.length) {
+      const disposable = this.disposables.pop();
+      if (disposable) {
+        disposable.dispose();
+      }
+    }
   }
 }
 
 export class ReportViewerProvider implements vscode.TreeDataProvider<LogItem>, vscode.Disposable {
   private _onDidChangeTreeData: vscode.EventEmitter<LogItem | undefined | void> = new vscode.EventEmitter<LogItem | undefined | void>();
   readonly onDidChangeTreeData: vscode.Event<LogItem | undefined | void> = this._onDidChangeTreeData.event;
   private groupByMessage: boolean;
+  private disposables: vscode.Disposable[] = [];
 
   constructor(private workspaceRoot: string) {
-    this.groupByMessage = vscode.workspace.getConfiguration('magentoLogViewer').get<boolean>('groupByMessage', true);
+    const workspaceUri = vscode.workspace.workspaceFolders?.[0]?.uri || null;
+    const config = vscode.workspace.getConfiguration('magentoLogViewer', workspaceUri);
+    this.groupByMessage = config.get<boolean>('groupByMessage', true);
   }
 
   refresh(): void {
@@ -289,7 +306,13 @@ export class ReportViewerProvider implements vscode.TreeDataProvider<LogItem>, v
   }
 
   dispose() {
-    // Implement dispose logic if needed
+    this._onDidChangeTreeData.dispose();
+    while (this.disposables.length) {
+      const disposable = this.disposables.pop();
+      if (disposable) {
+        disposable.dispose();
+      }
+    }
   }
 }