Execution logger

package.json

@@ -72,10 +72,9 @@
     "chromium-bidi": "^0.12.0",
     "dotenv": "^16.0.0",
     "html2canvas": "^1.4.1",
+    "loglevel": "^1.9.2",
     "openai": "^4.77.0",
     "playwright": "^1.49.1",
-    "rotating-file-stream": "^3.2.6",
-    "tslog": "^4.9.3",
     "uuid": "^11.0.3",
     "zod": "^3.22.4"
   },

src/common/chrome/proxy.ts

@@ -21,9 +21,10 @@
  * ```
  * In this example, `tabs_get` is a mock implementation that logs the `tabId` before calling the original `chrome.tabs.get` method, and the same as `chrome.windows.create` method.
  */
+import { logger } from '../log';
 export function createChromeApiProxy(mockClass: any): any {
-  console.log("debug mockClass:");
-  console.log(mockClass);
+  logger.debug("debug mockClass:");
+  logger.debug(mockClass);
 
   return new Proxy(chrome, {
     get(target: any, prop: string | symbol) {

src/common/log.ts

@@ -1,47 +1,43 @@
-import { Logger, ILogObj } from 'tslog';
-import { join } from 'path';
-import { tmpdir } from 'os';
+import log from 'loglevel';
 
 export class EkoLogger {
-  private logger: Logger<ILogObj>;
-  private logFilePath: string;
+  private logger: log.Logger;
+  private logStorage: string[] = [];
 
   constructor() {
-    const now = new Date();
-    const timestamp = now.toISOString().replace(/[-:.TZ]/g, '').slice(0, 14);
-
-    const logFileName = `Eko-${timestamp}.log`;
-    this.logFilePath = join(tmpdir(), logFileName);
-
-    this.logger = new Logger({
-      name: "EkoLog",
-      overwrite: {
-        mask: (...args: any[]): unknown[] => {
-          return args.map((arg) => {
-            return this.toReadableString(arg);
-          });
-        },
-      },
-    });
-
-    // log file path
-    this.logger.info(`log file path at: ${this.logFilePath}`);
-  }
+    this.logger = log.getLogger('EkoLogger');
+    this.logger.setLevel(log.levels.TRACE);
+
+    const originalFactory = this.logger.methodFactory;
+
+    this.logger.methodFactory = (methodName, logLevel, loggerName) => {
+      const rawMethod = originalFactory(methodName, logLevel, loggerName);
+      return (...args: any[]) => {
+        const truncatedArgs = args.map(arg => this.toReadableString(arg));
+        this.logStorage.push(`[${methodName.toUpperCase()}] ${truncatedArgs.join(' ')}`);
+        rawMethod(...truncatedArgs);
+      };
+    };
 
+  }
   // truncate content if it exceeds 2048 characters
   private toReadableString(content: any): string {
     const contentString = JSON.stringify(content);
     const maxLength = 2048;
     if (contentString.length > maxLength) {
-      return contentString.substring(0, maxLength) + '...';
+      return contentString.substring(0, maxLength - 3) + '...';
     } else {
       return contentString;
     }
   }
 
-  public getLogger(): Logger<ILogObj> {
+  public getLoggerInstance(): log.Logger {
     return this.logger;
   }
+
+  public getAllLogs(): string[] {
+    return this.logStorage;
+  }
 }
 
-export const logger = new EkoLogger().getLogger();
+export const logger = new EkoLogger().getLoggerInstance();

src/common/tools/summary_workflow.ts

@@ -1,5 +1,6 @@
 import { SummaryWorkflowInput } from '../../types/tools.types';
 import { Tool, InputSchema, ExecutionContext } from '../../types/action.types';
+import { logger } from '../log';
 
 export class SummaryWorkflow implements Tool<SummaryWorkflowInput, any> {
   name: string;
@@ -29,8 +30,8 @@ export class SummaryWorkflow implements Tool<SummaryWorkflowInput, any> {
     if (typeof params !== 'object' || params === null || !params.summary) {
       throw new Error('Invalid parameters. Expected an object with a "summary" property.');
     }
-    console.log("isSuccessful: " + params.isSuccessful);
-    console.log("summary: " + params.summary);
+    logger.debug("isSuccessful: " + params.isSuccessful);
+    logger.debug("summary: " + params.summary);
     context.variables.set("workflow_is_successful", params.isSuccessful);
     context.variables.set("workflow_summary", params.summary);
     await context.callback?.hooks.onSummaryWorkflow?.(params.summary);

src/core/eko.ts

@@ -27,15 +27,15 @@ export class Eko {
   private workflowGeneratorMap = new Map<Workflow, WorkflowGenerator>();
 
   constructor(llmConfig: LLMConfig, ekoConfig?: EkoConfig) {
-    console.info("using Eko@" + process.env.COMMIT_HASH);
+    logger.info("using Eko@" + process.env.COMMIT_HASH);
     this.llmProvider = LLMProviderFactory.buildLLMProvider(llmConfig);
     this.ekoConfig = this.buildEkoConfig(ekoConfig);
     this.registerTools();
   }
 
   private buildEkoConfig(ekoConfig: Partial<EkoConfig> | undefined): EkoConfig {
     if (!ekoConfig) {
-      console.warn("`ekoConfig` is missing when construct `Eko` instance");
+      logger.warn("`ekoConfig` is missing when construct `Eko` instance");
     }
     return {
       ...DefaultEkoConfig,
@@ -113,7 +113,7 @@ export class Eko {
     }
 
     const result = await workflow.execute(this.ekoConfig.callback);
-    console.log(result);
+    logger.debug(result);
     return result;
   }
 

src/extension/script/build_dom_tree.js

@@ -643,7 +643,7 @@ function build_dom_tree(doHighlightElements) {
           nodeData.children.push(...iframeChildren);
         }
       } catch (e) {
-        console.warn('Unable to access iframe:', node);
+        logger.warn('Unable to access iframe:', node);
       }
     } else {
       const children = Array.from(node.childNodes).map((child) =>

src/extension/tools/browser.ts

@@ -51,7 +51,7 @@ export async function type_by(
 }
 
 export async function clear_input(chromeProxy: any, tabId: number, coordinate?: [number, number]): Promise<any> {
-  console.log('Sending clear_input message to tab:', tabId, { coordinate });
+  logger.debug('Sending clear_input message to tab:', tabId, { coordinate });
   try {
     if (!coordinate) {
       coordinate = (await cursor_position(chromeProxy, tabId)).coordinate;
@@ -93,7 +93,7 @@ export async function clear_input_by(
 }
 
 export async function mouse_move(chromeProxy: any, tabId: number, coordinate: [number, number]): Promise<any> {
-  console.log('Sending mouse_move message to tab:', tabId, { coordinate });
+  logger.debug('Sending mouse_move message to tab:', tabId, { coordinate });
   try {
     const response = await chromeProxy.tabs.sendMessage(tabId, {
       type: 'computer:mouse_move',
@@ -108,7 +108,7 @@ export async function mouse_move(chromeProxy: any, tabId: number, coordinate: [n
 }
 
 export async function left_click(chromeProxy: any, tabId: number, coordinate?: [number, number]): Promise<any> {
-  console.log('Sending left_click message to tab:', tabId, { coordinate });
+  logger.debug('Sending left_click message to tab:', tabId, { coordinate });
   try {
     if (!coordinate) {
       coordinate = (await cursor_position(chromeProxy, tabId)).coordinate;
@@ -147,7 +147,7 @@ export async function left_click_by(
 }
 
 export async function right_click(chromeProxy: any, tabId: number, coordinate?: [number, number]): Promise<any> {
-  console.log('Sending right_click message to tab:', tabId, { coordinate });
+  logger.debug('Sending right_click message to tab:', tabId, { coordinate });
   try {
     if (!coordinate) {
       coordinate = (await cursor_position(chromeProxy, tabId)).coordinate;
@@ -186,7 +186,7 @@ export async function right_click_by(
 }
 
 export async function double_click(chromeProxy: any, tabId: number, coordinate?: [number, number]): Promise<any> {
-  console.log('Sending double_click message to tab:', tabId, { coordinate });
+  logger.debug('Sending double_click message to tab:', tabId, { coordinate });
   try {
     if (!coordinate) {
       coordinate = (await cursor_position(chromeProxy, tabId)).coordinate;
@@ -225,7 +225,7 @@ export async function double_click_by(
 }
 
 export async function screenshot(chromeProxy: any, windowId: number, compress?: boolean): Promise<ScreenshotResult> {
-  console.log('Taking screenshot of window:', windowId, { compress });
+  logger.debug('Taking screenshot of window:', windowId, { compress });
   try {
     let dataUrl;
     if (compress) {
@@ -289,7 +289,7 @@ export async function compress_image(
 }
 
 export async function scroll_to(chromeProxy: any, tabId: number, coordinate: [number, number]): Promise<any> {
-  console.log('Sending scroll_to message to tab:', tabId, { coordinate });
+  logger.debug('Sending scroll_to message to tab:', tabId, { coordinate });
   try {
     let from_coordinate = (await cursor_position(chromeProxy, tabId)).coordinate;
     const response = await chromeProxy.tabs.sendMessage(tabId, {
@@ -387,10 +387,10 @@ export async function cursor_position(chromeProxy: any, tabId: number): Promise<
 }
 
 export async function size(chromeProxy: any, tabId?: number): Promise<[number, number]> {
-  console.log('Getting page size for tab:', tabId);
+  logger.debug('Getting page size for tab:', tabId);
   try {
     const pageSize = await getPageSize(chromeProxy, tabId);
-    console.log('Got page size:', pageSize);
+    logger.debug('Got page size:', pageSize);
     return pageSize;
   } catch (e) {
     logger.error('Failed to get page size:', e);

src/extension/tools/browser_use.ts

@@ -77,7 +77,7 @@ export class BrowserUse implements Tool<BrowserUseParam, BrowserUseResult> {
    * @returns > { success: true, image?: { type: 'base64', media_type: 'image/jpeg', data: '/9j...' }, text?: string }
    */
   async execute(context: ExecutionContext, params: BrowserUseParam): Promise<BrowserUseResult> {
-    console.log("execute 'browser_use'...");
+    logger.debug("execute 'browser_use'...");
     try {
       if (params === null || !params.action) {
         throw new Error('Invalid parameters. Expected an object with a "action" property.');
@@ -177,32 +177,32 @@ export class BrowserUse implements Tool<BrowserUseParam, BrowserUseResult> {
           );
           break;
         case 'screenshot_extract_element':
-          console.log("execute 'screenshot_extract_element'...");
+          logger.debug("execute 'screenshot_extract_element'...");
           await sleep(100);
-          console.log("injectScript...");
+          logger.debug("injectScript...");
           await injectScript(context.ekoConfig.chromeProxy, tabId, 'build_dom_tree.js');
           await sleep(100);
-          console.log("executeScript...");
+          logger.debug("executeScript...");
           let element_result = await executeScript(context.ekoConfig.chromeProxy, tabId, () => {
             return (window as any).get_clickable_elements(true);
           }, []);
           context.selector_map = element_result.selector_map;
-          console.log("browser.screenshot...");
+          logger.debug("browser.screenshot...");
           let screenshot = await browser.screenshot(context.ekoConfig.chromeProxy, windowId, true);
-          console.log("executeScript #2...");
+          logger.debug("executeScript #2...");
           await executeScript(context.ekoConfig.chromeProxy, tabId, () => {
             return (window as any).remove_highlight();
           }, []);
           result = { image: screenshot.image, text: element_result.element_str };
-          console.log("execute 'screenshot_extract_element'...done");
+          logger.debug("execute 'screenshot_extract_element'...done");
           break;
         default:
           throw Error(
             `Invalid parameters. The "${params.action}" value is not included in the "action" enumeration.`
           );
       }
-      console.log("execute 'browser_use'...done, result=");
-      console.log(result);
+      logger.debug("execute 'browser_use'...done, result=");
+      logger.debug(result);
       if (result) {
         return { success: true, ...result };
       } else {

src/extension/utils.ts

@@ -32,7 +32,7 @@ export async function getWindowId(context: ExecutionContext): Promise<number> {
   }
 
   if (!windowId) {
-    console.warn("`getWindowId()` returns " + windowId);
+    logger.warn("`getWindowId()` returns " + windowId);
   }
 
   return windowId as number;
@@ -75,7 +75,7 @@ export function getCurrentTabId(chromeProxy: any, windowId?: number | undefined)
   return new Promise((resolve, reject) => {
     chromeProxy.tabs.query({ windowId, active: true, lastFocusedWindow: true }, function (tabs: any) {
       if (chromeProxy.runtime.lastError) {
-        console.error('Chrome runtime error:', chromeProxy.runtime.lastError);
+        logger.error('Chrome runtime error:', chromeProxy.runtime.lastError);
         reject(chromeProxy.runtime.lastError);
         return;
       }

src/models/workflow.ts

@@ -114,13 +114,13 @@ export class WorkflowImpl implements Workflow {
     let node_outputs = terminalNodes.map(node => node.output);
 
     // Special context variables
-    console.log("debug special context variables...");
+    logger.debug("debug special context variables...");
     const workflowIsSuccessful = this.variables.get("workflow_is_successful");
-    console.log(workflowIsSuccessful);
+    logger.debug(workflowIsSuccessful);
     const workflowSummary = this.variables.get("workflow_summary");
-    console.log(workflowSummary);
+    logger.debug(workflowSummary);
     const workflowTranscript = this.variables.get("workflow_transcript");
-    console.log(workflowTranscript);
+    logger.debug(workflowTranscript);
 
     return {
       isSuccessful: workflowIsSuccessful as boolean,

src/nodejs/script/build_dom_tree.js

@@ -1,3 +1,5 @@
+import { logger } from "@/common/log";
+
 export function run_build_dom_tree() {
   /**
    * Get clickable elements on the page
@@ -644,7 +646,7 @@ export function run_build_dom_tree() {
             nodeData.children.push(...iframeChildren);
           }
         } catch (e) {
-          console.warn('Unable to access iframe:', node);
+          logger.warn('Unable to access iframe:', node);
         }
       } else {
         const children = Array.from(node.childNodes).map((child) =>

src/services/workflow/generator.ts

@@ -93,8 +93,8 @@ export class WorkflowGenerator {
     const workflowData = response.toolCalls[0].input.workflow as any;
 
     // debug
-    console.log("Debug the workflow...")
-    console.log({ ...workflowData});
+    logger.debug("Debug the workflow...")
+    logger.debug({ ...workflowData});
 
     // Add workflow summary subtask
     (workflowData.nodes as any[]).push({
@@ -110,7 +110,7 @@ export class WorkflowGenerator {
         ]
       },
     })
-    console.log("Debug the workflow...Done")    
+    logger.debug("Debug the workflow...Done")    
 
     // Validate all tools exist
     for (const node of workflowData.nodes) {

src/web/script/build_dom_tree.js

@@ -1,3 +1,4 @@
+import { logger } from "@/common/log";
 /**
  * Get clickable elements on the page
  *
@@ -643,7 +644,7 @@ function build_dom_tree(doHighlightElements) {
           nodeData.children.push(...iframeChildren);
         }
       } catch (e) {
-        console.warn('Unable to access iframe:', node);
+        logger.warn('Unable to access iframe:', node);
       }
     } else {
       const children = Array.from(node.childNodes).map((child) =>