Merge remote-tracking branch 'origin/main' into chore/update-deps-audit

packages/core/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @sap/guided-answers-extension-core
 
+## 1.31.0
+
+### Minor Changes
+
+-   3976fd5: Enhanced output log with log levels
+
+### Patch Changes
+
+-   Updated dependencies [3976fd5]
+    -   @sap/guided-answers-extension-types@1.31.0
+
 ## 1.30.1
 
 ### Patch Changes

packages/core/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@sap/guided-answers-extension-core",
     "description": "Guided Answers extension core module",
-    "version": "1.30.1",
+    "version": "1.31.0",
     "license": "Apache-2.0",
     "private": true,
     "main": "dist/index.js",

packages/core/src/guided-answers-api.ts

@@ -45,11 +45,7 @@ export function getGuidedAnswerApi(options?: APIOptions): GuidedAnswerAPI {
     const apiHost = options?.apiHost ?? API_HOST;
     const ide = options?.ide;
     const extensions = options?.extensions ?? new Set<string>();
-    const logger = options?.logger ?? {
-        logString: (m) => {
-            console.log(m);
-        }
-    };
+    const logger = options?.logger ?? getConsoleLogger();
 
     return {
         getApiInfo: () => ({ host: apiHost, version: VERSION }),
@@ -70,6 +66,21 @@ export function getGuidedAnswerApi(options?: APIOptions): GuidedAnswerAPI {
     };
 }
 
+/**
+ * Return logger for console logging.
+ *
+ * @returns - logger to log to console
+ */
+function getConsoleLogger(): Logger {
+    return {
+        logTrace: console.trace,
+        logDebug: console.debug,
+        logInfo: console.info,
+        logWarn: console.warn,
+        logError: console.error
+    };
+}
+
 /**
  * Convert <img src="...">-tags in body to point to absolute path.
  *
@@ -185,10 +196,9 @@ function convertCommand(command: GuidedAnswersEnhancement['command'], logger: Lo
         try {
             argument = command.exec.args ? JSON.parse(command.exec.args) : undefined;
         } catch (error) {
-            logger.logString(
-                `Error when parsing argument '${
-                    command.exec.args
-                }' for HTML enhancement. Extension id: '${extensionId}', command id: '${commandId}', ${error?.toString()}`
+            logger.logError(
+                `Error when parsing argument '${command.exec.args}' for HTML enhancement. Extension id: '${extensionId}', command id: '${commandId}'.`,
+                error
             );
         }
         return { extensionId, commandId, argument } as VSCodeCommand;
@@ -244,7 +254,7 @@ function getEnhancements(
             }
         }
     } catch (error) {
-        logger.logString(`Error processing enhancements, ${error?.toString()}`);
+        logger.logError('Error processing enhancements', error);
     }
     return { htmlEnhancements, nodeCommands };
 }

packages/core/test/guided-answers-api.test.ts

@@ -5,7 +5,8 @@ import type {
     FeedbackOutcomePayload,
     GuidedAnswerNode,
     GuidedAnswersQueryOptions,
-    GuidedAnswerTreeSearchResult
+    GuidedAnswerTreeSearchResult,
+    Logger
 } from '@sap/guided-answers-extension-types';
 import { getGuidedAnswerApi } from '../src';
 
@@ -632,7 +633,7 @@ describe('Guided Answers Api: getNodeById()', () => {
         const options: APIOptions = {
             ide: 'SBAS',
             extensions: new Set(['sbas.ext']),
-            logger: { logString: jest.fn() }
+            logger: { logError: jest.fn() } as Partial<Logger> as Logger
         };
         mockedAxios.get.mockImplementation(() => Promise.resolve({ data }));
 
@@ -641,7 +642,10 @@ describe('Guided Answers Api: getNodeById()', () => {
 
         // Result check
         expect(result.COMMANDS).toBe(undefined);
-        expect(options.logger?.logString).toBeCalledWith(expect.stringContaining('WRONG'));
+        expect(options.logger?.logError).toBeCalledWith(
+            expect.stringContaining('Error'),
+            expect.objectContaining({ message: expect.stringContaining('WRONG') })
+        );
     });
 
     test('Get node with different images, should add host to src where applicable', async () => {
@@ -935,7 +939,7 @@ describe('Guided Answers Api: getNodePath()', () => {
         const options: APIOptions = {
             ide: 'SBAS',
             extensions: new Set(['my.ext.id']),
-            logger: { logString: jest.fn() }
+            logger: { logError: jest.fn() } as Partial<Logger> as Logger
         };
         mockedAxios.get.mockImplementation((url: string) => {
             const data = nodes.find((n) => url.endsWith(`/${n.NODE_ID}`));
@@ -953,7 +957,10 @@ describe('Guided Answers Api: getNodePath()', () => {
         expect(result.length).toBe(2);
         expect(result[0].BODY).toBe('<p>Should not be modified at all</p>');
         expect(result[1].BODY).toBe('<p>Also should not be modified at all</p>');
-        expect(options.logger?.logString).toBeCalledWith(expect.stringContaining('Error when parsing argument'));
+        expect(options.logger?.logError).toBeCalledWith(
+            expect.stringContaining('Error when parsing argument'),
+            expect.objectContaining({ message: expect.stringContaining('JSON') })
+        );
     });
 
     test('Get node path, error in getEnhancements()', async () => {
@@ -965,15 +972,18 @@ describe('Guided Answers Api: getNodePath()', () => {
         };
         const options: APIOptions = {
             ide: 'SBAS',
-            logger: { logString: jest.fn() }
+            logger: { logError: jest.fn() } as Partial<Logger> as Logger
         };
         mockedAxios.get.mockResolvedValue({ data });
 
         // Test execution
         const result = await getGuidedAnswerApi(options).getNodePath([1]);
 
         // Result check
-        expect(options.logger?.logString).toBeCalledWith(expect.stringContaining('Error'));
+        expect(options.logger?.logError).toBeCalledWith(
+            expect.stringContaining('Error'),
+            expect.objectContaining({ message: expect.stringContaining('enhancements') })
+        );
         expect(result[0]?.BODY).toBe('<p>Should remain</p>');
     });
 
@@ -1158,14 +1168,14 @@ describe('Guided Answers Api: sendFeedbackOutcome()', () => {
 });
 
 describe('Guided Answers Api: console logger', () => {
-    const originalLog = console.log;
+    const originalConsoleError = console.error;
 
     beforeEach(() => {
-        console.log = jest.fn();
+        console.error = jest.fn();
     });
 
     afterEach(() => {
-        console.log = originalLog;
+        console.error = originalConsoleError;
     });
 
     test('Get node by id: Fallback to console logger for erroneous enhancement', async () => {
@@ -1200,6 +1210,9 @@ describe('Guided Answers Api: console logger', () => {
 
         // Result check
         expect(result?.BODY).toMatchSnapshot();
-        expect(console.log).toBeCalledWith(expect.stringContaining(`Error when parsing argument '{'`));
+        expect(console.error).toBeCalledWith(
+            expect.stringContaining(`Error when parsing argument '{'`),
+            expect.objectContaining({ message: expect.stringContaining('JSON') })
+        );
     });
 });

packages/ide-extension/CHANGELOG.md

@@ -1,5 +1,11 @@
 # sap-guided-answer-extension
 
+## 1.31.0
+
+### Minor Changes
+
+-   3976fd5: Enhanced output log with log levels
+
 ## 1.30.1
 
 ## 1.30.0

packages/ide-extension/package.json

@@ -4,7 +4,7 @@
     "description": "%guidedAnswer.description%",
     "publisher": "SAPOSS",
     "license": "Apache-2.0",
-    "version": "1.30.1",
+    "version": "1.31.0",
     "icon": "media/guided-answers-extension.png",
     "categories": [
         "Education"
@@ -22,7 +22,7 @@
         "url": "https://github.com/SAP/guided-answers-extension.git"
     },
     "engines": {
-        "vscode": "^1.73.1"
+        "vscode": "^1.74.1"
     },
     "main": "./dist/extension-min.js",
     "private": false,
@@ -83,7 +83,7 @@
         "@sap/guided-answers-extension-core": "workspace:*",
         "@sap/guided-answers-extension-types": "workspace:*",
         "@types/uuid": "9.0.4",
-        "@types/vscode": "1.73.1",
+        "@types/vscode": "1.74.1",
         "@vscode/vsce": "2.21.0",
         "applicationinsights": "2.5.0",
         "esbuild": "0.19.3",

packages/ide-extension/src/bookmarks/bookmarks.ts

@@ -1,6 +1,6 @@
 import type { Memento } from 'vscode';
 import type { Bookmarks, GuidedAnswerTree } from '@sap/guided-answers-extension-types';
-import { logString } from '../logger/logger';
+import { logError } from '../logger/logger';
 
 let globalStateApi: Memento;
 
@@ -37,6 +37,6 @@ export function updateBookmarks(bookmarks: Bookmarks): void {
         }
         globalStateApi
             .update('bookmark', newBookmarks)
-            .then(undefined, (error) => logString(`Error updating bookmarks.\n${error?.toString()}`));
+            .then(undefined, (error) => logError(`Error updating bookmarks.`, error));
     }
 }

packages/ide-extension/src/enhancement/commandHandler.ts

@@ -1,7 +1,7 @@
 import { commands, window } from 'vscode';
 import type { Command } from '@sap/guided-answers-extension-types';
 import { isTerminalCommand, isVSCodeCommand } from '@sap/guided-answers-extension-types';
-import { logString } from '../logger/logger';
+import { logError, logInfo } from '../logger/logger';
 
 /**
  * Execute command execution requests.
@@ -12,27 +12,17 @@ export function handleCommand(command: Command): void {
     if (isVSCodeCommand(command.exec)) {
         const commandId = command.exec.commandId;
         const argument = command.exec.argument;
-        logString(
-            `Executing VSCode command '${commandId}'. Full command info including arguments:\n${JSON.stringify(
-                command,
-                null,
-                2
-            )} `
-        );
+        logInfo(`Executing VSCode command '${commandId}'. Full command info including arguments:`, command);
         commands
             .executeCommand(commandId, argument)
-            ?.then(undefined, (error) =>
-                logString(`Error while executing command '${commandId}'\n${error?.toString()}`)
-            );
+            ?.then(undefined, (error) => logError(`Error while executing command '${commandId}'`, error));
     }
     if (isTerminalCommand(command.exec)) {
         const terminal = window.createTerminal(`Guided Answers extension by SAP`);
         if (terminal) {
             const commandString = command.exec.arguments.join(' ');
             terminal.show();
-            logString(
-                `Executing terminal command '${commandString}'. Full command info:\n${JSON.stringify(command, null, 2)}`
-            );
+            logInfo(`Executing terminal command '${commandString}'. Full command info:`, command);
             if (command.exec.cwd) {
                 terminal.sendText(`cd "${command.exec.cwd}"`);
             }

packages/ide-extension/src/extension.ts

@@ -1,7 +1,7 @@
 import type { ExtensionContext } from 'vscode';
 import { commands, window, workspace } from 'vscode';
 import { getDevSpace, getIde } from '@sap/guided-answers-extension-core';
-import { logString } from './logger/logger';
+import { logError, logInfo } from './logger/logger';
 import { GuidedAnswersPanel, GuidedAnswersSerializer } from './panel/guidedAnswersPanel';
 import { initTelemetry } from './telemetry';
 import { GuidedAnswersUriHandler } from './links';
@@ -18,15 +18,13 @@ export function activate(context: ExtensionContext): void {
     try {
         context.subscriptions.push(initTelemetry());
     } catch (error) {
-        logString(`Error during initialization of telemetry.\n${error?.toString()}`);
+        logError(`Error during initialization of telemetry.`, error);
     }
     try {
         initBookmarks(context.globalState);
         initLastVisited(context.globalState);
     } catch (error) {
-        logString(
-            `Error during initialization of functionality that relies on VSCode's global state storage.\n${error?.toString()}`
-        );
+        logError(`Error during initialization of functionality that relies on VSCode's global state storage.`, error);
     }
     context.subscriptions.push(
         commands.registerCommand('sap.ux.guidedAnswer.openGuidedAnswer', async (startOptions?: StartOptions) => {
@@ -39,7 +37,7 @@ export function activate(context: ExtensionContext): void {
                     ide: await getIde(),
                     startOptions
                 };
-                logString(`Guided Answers command called. Options: ${JSON.stringify(options)}`);
+                logInfo(`Guided Answers command called. Options:`, options);
                 let guidedAnswersPanel: GuidedAnswersPanel | undefined = GuidedAnswersPanel.getInstance();
                 if (openInNewTab || !guidedAnswersPanel) {
                     guidedAnswersPanel = new GuidedAnswersPanel(options);

packages/ide-extension/src/last-visited/lastVisited.ts

@@ -1,6 +1,6 @@
 import type { Memento } from 'vscode';
 import type { LastVisitedGuide } from '@sap/guided-answers-extension-types';
-import { logString } from '../logger/logger';
+import { logError } from '../logger/logger';
 
 let globalStateApi: Memento;
 
@@ -30,5 +30,5 @@ export function getAllLastVisitedGuides(): LastVisitedGuide[] {
 export function updateLastVisitedGuides(lastVisitedGuides: LastVisitedGuide[]): void {
     globalStateApi
         .update('lastVisitedGuides', lastVisitedGuides)
-        .then(undefined, (error) => logString(`Error updating lastVisitedGuides.\n${error?.toString()}`));
+        .then(undefined, (error) => logError(`Error updating lastVisitedGuides.`, error));
 }

packages/ide-extension/src/links/guided-answers-uri-handler.ts

@@ -1,6 +1,6 @@
 import { commands } from 'vscode';
 import type { ProviderResult, Uri, UriHandler } from 'vscode';
-import { logString } from '../logger/logger';
+import { logError, logInfo } from '../logger/logger';
 import { extractLinkInfo } from './link-info';
 
 /**
@@ -16,16 +16,14 @@ export class GuidedAnswersUriHandler implements UriHandler {
      */
     handleUri(uri: Uri): ProviderResult<void> {
         const link = decodeURIComponent(uri.toString());
-        logString(`Guided Answers extension called from URI: ${link}`);
+        logInfo(`Guided Answers extension called from URI: ${link}`);
         const startOptions = extractLinkInfo(link);
-        logString(`Extracted information from link: ${startOptions ? JSON.stringify(startOptions) : ''}`);
+        logInfo(`Extracted information from link:`, startOptions);
         if (startOptions?.treeId) {
             commands
                 .executeCommand('sap.ux.guidedAnswer.openGuidedAnswer', startOptions)
                 ?.then(undefined, (error) =>
-                    logString(
-                        `Error while executing start command 'sap.ux.guidedAnswer.openGuidedAnswer'.\n${error?.toString()}`
-                    )
+                    logError(`Error while executing start command 'sap.ux.guidedAnswer.openGuidedAnswer'`, error)
                 );
         }
     }