Adapt logging (#818)

* added logging
* code refactor due to logging cleanup
* added detailed log for target access
* adapted tests

Author: thorstendb-ARM

src/views/component-viewer/component-viewer-instance.ts

@@ -165,7 +165,7 @@ export class ComponentViewerInstance {
         this._guiTree.setId(this._fileKey);
         this._guiTree.setGuiName('component-viewer-root');
 
-        console.log('ComponentViewerInstance readModel stats:\n' + stats.join('\n  '));
+        componentViewerLogger.debug(`ComponentViewerInstance readModel stats:\n  ${stats.join('\n  ')}`);
     }
 
     public async update(): Promise<void> {
@@ -177,7 +177,7 @@ export class ComponentViewerInstance {
         this._guiTree.clear();
         await this.executeStatements(this._guiTree);
         stats.push(this.getStats('end'));
-        console.log('ComponentViewerInstance update stats:\n' + stats.join('\n  '));
+        componentViewerLogger.debug(`ComponentViewerInstance update stats:\n  ${stats.join('\n  ')}`);
     }
 
     private async readFileToBuffer(filePath: URI): Promise<Buffer> {
@@ -193,7 +193,6 @@ export class ComponentViewerInstance {
     private async parseXml(text: string) {
         try {
             const json = await parseStringPromise(text, xmlOpts);
-            //console.log(JSON.stringify(json, null, 2));
             return json;
         } catch (err) {
             componentViewerLogger.error('Error parsing XML:', err);

src/views/component-viewer/component-viewer-main.ts

@@ -129,7 +129,7 @@ export class ComponentViewer {
 
     private async loadCbuildRunInstances(session: GDBTargetDebugSession, tracker: GDBTargetDebugTracker) : Promise<void | undefined> {
         this._loadingCounter++;
-        console.log(`Loading SCVD files from cbuild-run, attempt #${this._loadingCounter}`);
+        componentViewerLogger.debug(`Loading SCVD files from cbuild-run, attempt #${this._loadingCounter}`);
         // Try to read SCVD files from cbuild-run file first
         await this.readScvdFiles(tracker, session);
         // Are there any SCVD files found in cbuild-run?

src/views/component-viewer/model/scvd-expression.ts

@@ -118,7 +118,7 @@ export class ScvdExpression extends ScvdNode {
             }
             const parser = executionContext?.parser;
             if (!parser) {
-                console.error(this.getLineInfoStr(), 'Expression parsing missing execution context or parser');
+                componentViewerLogger.error(`${this.getLineInfoStr()} Expression parsing missing execution context or parser`);
                 return false;
             }
             const expressionAst = parser.parseExpression(expression, this.isPrintExpression);

src/views/component-viewer/model/scvd-readlist.ts

@@ -118,7 +118,7 @@ export class ScvdReadList extends ScvdRead {
             const typedef = resolveFunc(this._next, ResolveType.localType);
             const member = typedef ? resolveFunc(this._next, ResolveType.localMember, typedef) : undefined;
             if (member === undefined && typedef) {
-                componentViewerLogger.error(`${this.getLineNoStr()}: Resolving readlist .next: could not find member '${this._next}' in typedef '${typedef.name}'`);
+                componentViewerLogger.error(`Line: ${this.getLineNoStr()}: Resolving readlist .next: could not find member '${this._next}' in typedef '${typedef.name}'`);
             }
         }
         return super.resolveAndLink(resolveFunc);

src/views/component-viewer/parse-perf-stats.ts

@@ -17,6 +17,7 @@
 
 import { performance } from 'node:perf_hooks';
 import type { ASTNode, AssignmentExpression, BinaryExpression, CallExpression, ConditionalExpression, EvalPointCall, FormatSegment, PrintfExpression, UnaryExpression, UpdateExpression } from './parser-evaluator/parser';
+import { componentViewerLogger } from '../../logger';
 
 export class ParsePerfStats {
     private enabled = true;
@@ -170,13 +171,13 @@ export class ParsePerfStats {
         const optKindsOut = this.formatTop(this.optimizeKindOutCounts);
         const optOpsOut = this.formatTop(this.optimizeOpOutCounts);
         const callees = this.formatTop(this.calleeCounts);
-        return `[SCVD][parse-perf] parseMs=${ms(this.parseMs)} parseCalls=${this.parseCalls} parseNodes=${this.parseNodes} parseAvgNodes=${parseAvg.toFixed(1)} parseMaxNodes=${this.parseMaxNodes} parseMaxNodesKind=${this.parseMaxNodesKind} parseMaxDepth=${this.parseMaxDepth} parseMaxDepthKind=${this.parseMaxDepthKind} optimizeMs=${ms(this.optimizeMs)} optimizeCalls=${this.optimizeCalls} optimizeNodesIn=${this.optimizeNodesIn} optimizeAvgNodesIn=${optimizeAvgIn.toFixed(1)} optimizeMaxNodesIn=${this.optimizeMaxNodesIn} optimizeMaxNodesInKind=${this.optimizeMaxNodesInKind} optimizeMaxDepthIn=${this.optimizeMaxDepthIn} optimizeMaxDepthInKind=${this.optimizeMaxDepthInKind} optimizeNodesOut=${this.optimizeNodesOut} optimizeAvgNodesOut=${optimizeAvgOut.toFixed(1)} optimizeMaxNodesOut=${this.optimizeMaxNodesOut} optimizeMaxNodesOutKind=${this.optimizeMaxNodesOutKind} optimizeMaxDepthOut=${this.optimizeMaxDepthOut} optimizeMaxDepthOutKind=${this.optimizeMaxDepthOutKind} foldFull=${this.foldFull} foldFullRate=${fullRate.toFixed(1)}% foldPartial=${this.foldPartial} foldPartialRate=${partialRate.toFixed(1)}% parseKinds=${parseKinds} parseOps=${parseOps} optKindsIn=${optKindsIn} optOpsIn=${optOpsIn} optKindsOut=${optKindsOut} optOpsOut=${optOpsOut} callees=${callees}`;
+        return `[parse-perf] parseMs=${ms(this.parseMs)} parseCalls=${this.parseCalls} parseNodes=${this.parseNodes} parseAvgNodes=${parseAvg.toFixed(1)} parseMaxNodes=${this.parseMaxNodes} parseMaxNodesKind=${this.parseMaxNodesKind} parseMaxDepth=${this.parseMaxDepth} parseMaxDepthKind=${this.parseMaxDepthKind} optimizeMs=${ms(this.optimizeMs)} optimizeCalls=${this.optimizeCalls} optimizeNodesIn=${this.optimizeNodesIn} optimizeAvgNodesIn=${optimizeAvgIn.toFixed(1)} optimizeMaxNodesIn=${this.optimizeMaxNodesIn} optimizeMaxNodesInKind=${this.optimizeMaxNodesInKind} optimizeMaxDepthIn=${this.optimizeMaxDepthIn} optimizeMaxDepthInKind=${this.optimizeMaxDepthInKind} optimizeNodesOut=${this.optimizeNodesOut} optimizeAvgNodesOut=${optimizeAvgOut.toFixed(1)} optimizeMaxNodesOut=${this.optimizeMaxNodesOut} optimizeMaxNodesOutKind=${this.optimizeMaxNodesOutKind} optimizeMaxDepthOut=${this.optimizeMaxDepthOut} optimizeMaxDepthOutKind=${this.optimizeMaxDepthOutKind} foldFull=${this.foldFull} foldFullRate=${fullRate.toFixed(1)}% foldPartial=${this.foldPartial} foldPartialRate=${partialRate.toFixed(1)}% parseKinds=${parseKinds} parseOps=${parseOps} optKindsIn=${optKindsIn} optOpsIn=${optOpsIn} optKindsOut=${optKindsOut} optOpsOut=${optOpsOut} callees=${callees}`;
     }
 
     public logSummary(): void {
         const summary = this.formatSummary();
         if (summary) {
-            console.log(summary);
+            componentViewerLogger.trace(summary);
         }
     }
 

src/views/component-viewer/parser-evaluator/expression-optimizer.ts

@@ -49,6 +49,7 @@ import type {
     UnaryExpression,
     UpdateExpression,
 } from './parser';
+import { componentViewerLogger } from '../../../logger';
 
 const startOf = (n: ASTNode) => (n as { start: number }).start;
 const endOf = (n: ASTNode) => (n as { end: number }).end;
@@ -254,7 +255,7 @@ export class ExpressionOptimizer {
         const cMap = new WeakMap<ASTNode, CValue>();
         const ast = this.fold(parsed.ast, diagnostics, stats, cMap);
         if (diagnostics.some((d) => d.type === 'error')) {
-            console.error(`[SCVD][expression-optimizer][fold] full=${stats.full} partial=${stats.partial} identity=${stats.identity}`);
+            componentViewerLogger.error(`[expression-optimizer][fold] full=${stats.full} partial=${stats.partial} identity=${stats.identity}`);
         }
         const constValue = parsed.isPrintf ? undefined : ast.constValue;
         return {