optimize calculating severity

Author: edriouk

src/solutions/solution-converter.test.ts

@@ -18,7 +18,6 @@ import { expect, it, describe } from '@jest/globals';
 import * as path from 'path';
 import * as manifest from '../manifest';
 import { ExtensionContext } from 'vscode';
-import * as vscode from 'vscode';
 import { SolutionConverterImpl } from './solution-converter';
 import { MockOutputChannelProvider, outputChannelProviderFactory } from '../vscode-api/output-channel-provider.factories';
 import { MockConfigurationProvider, configurationProviderFactory } from '../vscode-api/configuration-provider.factories';
@@ -339,6 +338,7 @@ describe('SolutionConverter', () => {
         expect(completedListener).toHaveBeenCalledTimes(1);
         expect(completedListener).toHaveBeenLastCalledWith(
             expect.objectContaining({
+                severity: 'error',
                 toolsOutputMessages: expect.arrayContaining([
                     'warning cbuild: missing ZEPHYR_BASE environment variable',
                     'error cbuild: exec: "west": executable file not found in $PATH',
@@ -429,11 +429,7 @@ describe('SolutionConverter', () => {
         });
     });
 
-    it('creates diagnostic when cpackget fails to download a pack', async () => {
-        const diagnosticCollection = vscode.languages.createDiagnosticCollection();
-        const mockDiagnosticsCollectionSet = jest.spyOn(diagnosticCollection, 'set') as unknown as jest.MockedFunction<
-            (uri: vscode.Uri, diagnostics: readonly vscode.Diagnostic[] | undefined) => void
-        >;
+    it('reports error severity when cpackget fails to download a pack', async () => {
         jest.spyOn(cmsisToolboxManager, 'runCmsisTool').mockImplementation(async (_t, _a, onOutput) => {
             onOutput('W: retry failed');
             onOutput('E: network timeout');
@@ -444,10 +440,16 @@ describe('SolutionConverter', () => {
 
         await fireAndWaitForConversion();
 
-        expect(mockDiagnosticsCollectionSet).toHaveBeenCalledTimes(1);
-        const [[, diagnostics]] = mockDiagnosticsCollectionSet.mock.calls;
-        expect(diagnostics?.[0]?.message).toContain('network timeout');
-        expect(diagnostics?.[0]?.message).toContain('retry failed');
+        expect(completedListener).toHaveBeenCalledWith(
+            expect.objectContaining({
+                severity: 'error',
+                toolsOutputMessages: expect.arrayContaining([
+                    expect.stringContaining("error cpackget: downloading pack 'VendorA::PackA@1.0.0' failed"),
+                    expect.stringContaining('network timeout'),
+                    expect.stringContaining('retry failed'),
+                ]),
+            })
+        );
     });
 
 });

src/solutions/solution-converter.ts

@@ -25,7 +25,7 @@ import { Mutex } from 'async-mutex';
 import * as rpc from '../json-rpc/csolution-rpc-client';
 import { ConvertRequestData, SolutionEventHub } from './solution-event-hub';
 import { Severity } from './constants';
-import { enrichLogMessagesFromToolOutput } from './solution-problems';
+import { toolsPrefixPatterns } from './solution-problems';
 
 
 export interface SolutionConverter {
@@ -188,8 +188,7 @@ export class SolutionConverterImpl implements SolutionConverter {
             return;
         }
         logResult = { errors: [], warnings: [], info: [], ...logResult, success: convertResult.success };
-        await enrichLogMessagesFromToolOutput(logResult, toolsOutputMessages);
-        const severity = this.getSeverity(logResult);
+        const severity = this.getSeverity(logResult, toolsOutputMessages);
 
         // print result to output channel
         outputChannel.append('\n' + (
@@ -261,15 +260,14 @@ export class SolutionConverterImpl implements SolutionConverter {
         return result.success;
     }
 
-    private getSeverity(messages: rpc.LogMessages): Severity {
-        if (!messages.success || (messages.errors && messages.errors.length > 0)) {
+    private getSeverity(messages: rpc.LogMessages, lines?: string[]): Severity {
+        if (!messages.success || (messages.errors && messages.errors.length > 0) || lines?.find(line => toolsPrefixPatterns.error.test(line))) {
             return 'error';
-        } else if (messages.warnings && messages.warnings.length > 0) {
+        } else if ((messages.warnings && messages.warnings.length > 0) || lines?.find(line => toolsPrefixPatterns.warning.test(line))) {
             return 'warning';
         } else if (messages.info && messages.info.length > 0) {
             return 'info';
         }
         return 'success';
     }
-
 }

src/solutions/solution-problems.ts

@@ -25,12 +25,12 @@ import { getWorkspaceFolder } from '../utils/vscode-utils';
 import { SolutionManager } from './solution-manager';
 import { ConvertResultData, SolutionEventHub } from './solution-event-hub';
 
-const toolsPrefixPatterns = {
+export const toolsPrefixPatterns = {
     error: /^.*error (?:cbuild|cbuild2cmake|csolution|cpackget):\s*/,
     warning: /^.*warning (?:cbuild|cbuild2cmake|csolution|cpackget):\s*/,
 };
 
-const envVarWestPatterns = [
+export const envVarWestPatterns = [
     /^missing ([A-Za-z_][A-Za-z0-9_]*) environment variable$/,
     /^([A-Za-z_][A-Za-z0-9_]*) environment variable specifies non-existent directory: .+$/,
     /^exec: "west": executable file not found in .+$/,