Merge pull request #8 from OpenForgeProject/add-reports-logger

feat: add support for refreshing report files and update badge count in LogViewer

Author: dermatz

CHANGELOG.md

@@ -6,6 +6,20 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
+## [1.6.0] - 2023-10-07
+
+### Added
+
+- Improved report file titles by parsing content for better readability.
+- Added icons for different report types based on content.
+- Included folder names in titles for files in the "api" subdirectory.
+- Refactored code to improve performance
+- Extend badge counter to include report files
+
+### Fixed
+
+- Fixed issue with empty directories being included in the report list.
+
 ## [1.5.1] - 2024-12-05
 
 ### Fixed

package.json

@@ -2,7 +2,7 @@
   "name": "magento-log-viewer",
   "displayName": "Magento Log Viewer",
   "description": "A Visual Studio Code extension to view and manage Magento log files.",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "publisher": "MathiasElle",
   "icon": "resources/logo.png",
   "repository": {
@@ -34,6 +34,11 @@
         "command": "magento-log-viewer.refreshLogFiles",
         "title": "Refresh Log Files",
         "icon": "$(refresh)"
+      },
+      {
+        "command": "magento-log-viewer.refreshReportFiles",
+        "title": "Refresh Report Files",
+        "icon": "$(refresh)"
       }
     ],
     "configuration": {
@@ -83,6 +88,11 @@
               "group": "navigation"
             }
           ]
+        },
+        {
+          "id": "reportFiles",
+          "name": "Report Files",
+          "contextualTitle": "Magento Reports"
         }
       ]
     },
@@ -97,6 +107,11 @@
           "command": "magento-log-viewer.refreshLogFiles",
           "when": "view == logFiles && magentoLogViewer.hasMagentoRoot",
           "group": "navigation"
+        },
+        {
+          "command": "magento-log-viewer.refreshReportFiles",
+          "when": "view == reportFiles && magentoLogViewer.hasMagentoRoot",
+          "group": "navigation"
         }
       ]
     }

src/helpers.ts

@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 import * as path from 'path';
 import * as fs from 'fs';
-import { LogViewerProvider } from './logViewer';
+import { LogViewerProvider, ReportViewerProvider, LogItem } from './logViewer';
 
 // Prompts the user to confirm if the current project is a Magento project.
 export function promptMagentoProjectSelection(config: vscode.WorkspaceConfiguration, context: vscode.ExtensionContext): void {
@@ -59,25 +59,36 @@ export function showErrorMessage(message: string): void {
 // Activates the extension by setting up the log viewer and file system watcher.
 export function activateExtension(context: vscode.ExtensionContext, magentoRoot: string): void {
   const logViewerProvider = new LogViewerProvider(magentoRoot);
-  const treeView = vscode.window.createTreeView('logFiles', { treeDataProvider: logViewerProvider });
+  const reportViewerProvider = new ReportViewerProvider(magentoRoot);
 
-  registerCommands(context, logViewerProvider, magentoRoot);
-  context.subscriptions.push(treeView);
+  const logTreeView = vscode.window.createTreeView('logFiles', { treeDataProvider: logViewerProvider });
+  const reportTreeView = vscode.window.createTreeView('reportFiles', { treeDataProvider: reportViewerProvider });
 
-  updateBadge(treeView, logViewerProvider, magentoRoot);
+  registerCommands(context, logViewerProvider, reportViewerProvider, magentoRoot);
+  context.subscriptions.push(logTreeView, reportTreeView);
+
+  updateBadge(logTreeView, logViewerProvider, reportViewerProvider, magentoRoot);
 
   const logPath = path.join(magentoRoot, 'var', 'log');
-  const watcher = vscode.workspace.createFileSystemWatcher(new vscode.RelativePattern(logPath, '*'));
-  watcher.onDidChange(() => logViewerProvider.refresh());
-  watcher.onDidCreate(() => logViewerProvider.refresh());
-  watcher.onDidDelete(() => logViewerProvider.refresh());
+  const reportPath = path.join(magentoRoot, 'var', 'report');
+
+  const logWatcher = vscode.workspace.createFileSystemWatcher(new vscode.RelativePattern(logPath, '*'));
+  logWatcher.onDidChange(() => logViewerProvider.refresh());
+  logWatcher.onDidCreate(() => logViewerProvider.refresh());
+  logWatcher.onDidDelete(() => logViewerProvider.refresh());
+
+  const reportWatcher = vscode.workspace.createFileSystemWatcher(new vscode.RelativePattern(reportPath, '*'));
+  reportWatcher.onDidChange(() => reportViewerProvider.refresh());
+  reportWatcher.onDidCreate(() => reportViewerProvider.refresh());
+  reportWatcher.onDidDelete(() => reportViewerProvider.refresh());
 
-  context.subscriptions.push(watcher);
+  context.subscriptions.push(logWatcher, reportWatcher);
 }
 
 // Registers commands for the extension.
-export function registerCommands(context: vscode.ExtensionContext, logViewerProvider: LogViewerProvider, magentoRoot: string): void {
+export function registerCommands(context: vscode.ExtensionContext, logViewerProvider: LogViewerProvider, reportViewerProvider: ReportViewerProvider, magentoRoot: string): void {
   vscode.commands.registerCommand('magento-log-viewer.refreshLogFiles', () => logViewerProvider.refresh());
+  vscode.commands.registerCommand('magento-log-viewer.refreshReportFiles', () => reportViewerProvider.refresh());
   vscode.commands.registerCommand('magento-log-viewer.openFile', (filePath: string, lineNumber?: number) => {
     openFile(filePath, lineNumber);
   });
@@ -117,21 +128,56 @@ export function clearAllLogFiles(logViewerProvider: LogViewerProvider, magentoRo
 }
 
 // Updates the badge count for the tree view based on the number of log entries.
-export function updateBadge(treeView: vscode.TreeView<unknown>, logViewerProvider: LogViewerProvider, magentoRoot: string): void {
-    const updateBadgeCount = () => {
+export function updateBadge(treeView: vscode.TreeView<unknown>, logViewerProvider: LogViewerProvider, reportViewerProvider: ReportViewerProvider, magentoRoot: string): void {
+  const updateBadgeCount = () => {
     const logFiles = logViewerProvider.getLogFilesWithoutUpdatingBadge(path.join(magentoRoot, 'var', 'log'));
-    const totalEntries = logFiles.reduce((count, file) => count + parseInt(file.description?.match(/\d+/)?.[0] || '0', 10), 0);
-    treeView.badge = { value: totalEntries, tooltip: `${totalEntries} log entries` };
+    const reportFiles = getAllReportFiles(path.join(magentoRoot, 'var', 'report'));
+
+    const totalLogEntries = logFiles.reduce((count, file) => count + parseInt(file.description?.match(/\d+/)?.[0] || '0', 10), 0);
+    const totalReportFiles = reportFiles.length;
+
+    const totalEntries = totalLogEntries + totalReportFiles;
+    treeView.badge = { value: totalEntries, tooltip: `${totalEntries} log and report entries` };
 
     vscode.commands.executeCommand('setContext', 'magentoLogViewer.hasLogFiles', totalEntries > 0);
+
+    // Update status bar item
+    const statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 100);
+    statusBarItem.text = `Magento Log-Entries: ${totalEntries}`;
+    statusBarItem.show();
   };
 
   logViewerProvider.onDidChangeTreeData(updateBadgeCount);
+  reportViewerProvider.onDidChangeTreeData(updateBadgeCount);
   updateBadgeCount();
 
   vscode.commands.executeCommand('setContext', 'magentoLogViewerBadge', 0);
 }
 
+function getAllReportFiles(dir: string): LogItem[] {
+  if (!pathExists(dir)) {
+    return [];
+  }
+
+  const items: LogItem[] = [];
+  const files = fs.readdirSync(dir);
+
+  files.forEach(file => {
+    const filePath = path.join(dir, file);
+    if (fs.lstatSync(filePath).isDirectory()) {
+      items.push(...getAllReportFiles(filePath));
+    } else if (fs.lstatSync(filePath).isFile()) {
+      items.push(new LogItem(file, vscode.TreeItemCollapsibleState.None, {
+        command: 'magento-log-viewer.openFile',
+        title: 'Open Log File',
+        arguments: [filePath]
+      }));
+    }
+  });
+
+  return items;
+}
+
 // Checks if the given path is a valid directory.
 export function isValidPath(filePath: string): boolean {
   try {
@@ -167,3 +213,69 @@ export function getIconForLogLevel(level: string): vscode.ThemeIcon {
     default: return new vscode.ThemeIcon('circle-outline');
   }
 }
+
+export function getLogItems(dir: string, parseTitle: (filePath: string) => string, getIcon: (filePath: string) => vscode.ThemeIcon): LogItem[] {
+  if (!pathExists(dir)) {
+    return [];
+  }
+
+  const items: LogItem[] = [];
+  const files = fs.readdirSync(dir);
+
+  files.forEach(file => {
+    const filePath = path.join(dir, file);
+    if (fs.lstatSync(filePath).isDirectory()) {
+      const subItems = getLogItems(filePath, parseTitle, getIcon);
+      if (subItems.length > 0) {
+        items.push(...subItems);
+      }
+    } else if (fs.lstatSync(filePath).isFile()) {
+      const title = parseTitle(filePath);
+      const logFile = new LogItem(title, vscode.TreeItemCollapsibleState.None, {
+        command: 'magento-log-viewer.openFile',
+        title: 'Open Log File',
+        arguments: [filePath]
+      });
+      logFile.iconPath = getIcon(filePath);
+      items.push(logFile);
+    }
+  });
+
+  return items;
+}
+
+export function parseReportTitle(filePath: string): string {
+  try {
+    const fileContent = fs.readFileSync(filePath, 'utf-8');
+    const report = JSON.parse(fileContent);
+
+    if (filePath.includes('/api/')) {
+      const folderName = path.basename(path.dirname(filePath));
+      const capitalizedFolderName = folderName.charAt(0).toUpperCase() + folderName.slice(1);
+      return `${capitalizedFolderName}: ${report}`;
+    }
+
+    return report['0'] || path.basename(filePath);
+  } catch (error) {
+    return path.basename(filePath);
+  }
+}
+
+export function getIconForReport(filePath: string): vscode.ThemeIcon {
+  try {
+    const fileContent = fs.readFileSync(filePath, 'utf-8');
+    const report = JSON.parse(fileContent);
+
+    if (filePath.includes('/api/')) {
+      return new vscode.ThemeIcon('warning');
+    }
+
+    if (report['0'] && report['0'].toLowerCase().includes('error')) {
+      return new vscode.ThemeIcon('error');
+    }
+
+    return new vscode.ThemeIcon('file');
+  } catch (error) {
+    return new vscode.ThemeIcon('file');
+  }
+}