feat: Add structured logging throughout core for plugin developer debuggability by Copilot · Pull Request #368 · objectstack-ai/objectstack

Copilot · 2026-01-29T23:23:43Z

Plugin developers lacked visibility into runtime behavior. Most packages used console.log or had no logging at all.

Changes

Logging Infrastructure

Replaced console.log with structured logger (Pino for Node.js, console fallback for browser)
Added logger to packages: objectql, driver-memory, runtime, client, plugin-hono-server, plugin-msw

ObjectQL Engine (packages/objectql/src/engine.ts)

Data operations: find, insert, update, delete with query details and result counts
Driver registration and resolution
Hook execution with handler counts and error tracking

Driver & Plugins

Memory driver: CRUD operations with table statistics
Runtime plugins: Lifecycle events (init, start, destroy)
HTTP plugins: Request/response logging with status codes
Client: HTTP calls with configurable debug mode

Example

Before:

console.log(`[ObjectQL] Registered driver: ${driver.name}`);

After:

this.logger.info('Registered driver', { 
  driverName: driver.name, 
  version: driver.version
});
this.logger.debug('Find operation starting', { object, query });
this.logger.debug('Find operation completed', { object, resultCount: 5 });

Log levels: debug (operations), info (lifecycle), warn (issues), error (failures with stack traces)

Dependencies

Added @objectstack/core to client and examples/basic packages (required for logger import).

Original prompt

完善整个内核的日志，添加必要的调试日志，让插件开发者更容易融入生态。

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

vercel · 2026-01-29T23:23:47Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
spec	Ready	Preview, Comment	Jan 29, 2026 11:41pm

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot

Pull request overview

This PR adds comprehensive structured logging throughout the ObjectStack core packages to improve debuggability for plugin developers. The implementation replaces ad-hoc console.log statements with a structured logger (Pino for Node.js, console fallback for browsers) that provides consistent logging with proper log levels, structured metadata, and contextual information.

Changes:

Introduced structured logging infrastructure with Logger interface and createLogger factory function that works in both Node.js and browser environments
Added detailed logging to core packages (objectql, driver-memory, runtime, client, plugin-hono-server, plugin-msw) covering lifecycle events, data operations, HTTP requests, and error conditions
Added logger dependencies to client and examples/basic packages to support the new logging infrastructure

Reviewed changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
pnpm-lock.yaml	Added @objectstack/core dependency to client and examples/basic packages
packages/runtime/src/driver-plugin.ts	Replaced console.log with structured logging for driver registration and lifecycle
packages/runtime/src/app-plugin.ts	Added detailed logging for app plugin initialization and runtime execution
packages/plugins/plugin-msw/src/msw-plugin.ts	Replaced console.log with structured logging for MSW operations and request handling
packages/plugins/plugin-hono-server/src/hono-plugin.ts	Added comprehensive logging for HTTP server operations and API route handling
packages/plugins/driver-memory/src/memory-driver.ts	Added structured logging for all CRUD operations with statistics
packages/objectql/src/plugin.ts	Converted console.log to structured logging for ObjectQL plugin lifecycle
packages/objectql/src/engine.ts	Added comprehensive logging for engine initialization, driver operations, and data operations with error tracking
packages/client/src/index.ts	Added HTTP request/response logging with optional debug mode
packages/client/package.json	Added @objectstack/core dependency
examples/basic/package.json	Added @objectstack/core dependency
examples/basic/logger-example.ts	Fixed type annotation for service retrieval

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

Copilot · 2026-01-30T00:01:39Z

        return hookContext.result;
    } catch (e) {
-        // hookContext.error = e;
+        this.logger.error('Find operation failed', e as Error, { object });


Using type assertion e as Error doesn't guarantee that e is actually an Error instance. In JavaScript, catch blocks can catch any value (string, number, object, etc.).

Consider checking the error type:

catch (e) { const error = e instanceof Error ? e : new Error(String(e)); this.logger.error('Find operation failed', error, { object }); throw error; }

This pattern appears throughout this file in multiple catch blocks (lines 367, 402, 453, 491, 529).

Copilot · 2026-01-30T00:01:39Z

+      this.logger.debug('FindOne operation completed', { object, found: !!result });
+      return result;
+    } catch (e) {
+      this.logger.error('FindOne operation failed', e as Error, { object });


Using type assertion e as Error doesn't guarantee that e is actually an Error instance. Same issue as line 367.

Copilot · 2026-01-30T00:01:40Z

-    return hookContext.result;
+      return hookContext.result;
+    } catch (e) {
+      this.logger.error('Insert operation failed', e as Error, { object });


Using type assertion e as Error doesn't guarantee that e is actually an Error instance. Same issue as line 367.

Copilot · 2026-01-30T00:01:40Z

+                    res.json(result);
+                }
+                catch(e:any) { 
+                    ctx.logger.error('Data update failed', e, { object: req.params.object, id: req.params.id });


The caught error e (typed as any) is passed directly to the logger without ensuring it's an Error object. This is the same issue as line 100.

Copilot · 2026-01-30T00:01:40Z

+
+      return hookContext.result;
+    } catch (e) {
+      this.logger.error('Update operation failed', e as Error, { object, id });


Using type assertion e as Error doesn't guarantee that e is actually an Error instance. Same issue as line 367.

Copilot · 2026-01-30T00:01:42Z

                data: result
            };
        } catch (error) {
+            this.logger?.error?.('MSW: Create failed', error, { object });


The caught error is passed directly to the logger without ensuring it's an Error object. In JavaScript, catch blocks can catch any value (string, number, object, etc.), not just Error instances. This could cause issues if the logger expects an Error object.

Consider checking the error type before passing it to the logger:

catch (error) { const err = error instanceof Error ? error : new Error(String(error)); this.logger?.error?.('MSW: Create failed', err, { object }); // ... rest of the code }

Copilot · 2026-01-30T00:01:42Z

                data: result
            };
        } catch (error) {
+            this.logger?.error?.('MSW: Delete failed', error, { object, id });


The caught error is passed directly to the logger without ensuring it's an Error object. In JavaScript, catch blocks can catch any value (string, number, object, etc.), not just Error instances.

Consider checking the error type before passing it to the logger:

catch (error) { const err = error instanceof Error ? error : new Error(String(error)); this.logger?.error?.('MSW: Delete failed', err, { object, id }); // ... rest of the code }

Copilot · 2026-01-30T00:01:42Z

+                    res.status(201).json(result);
+                }
+                catch(e:any) { 
+                    ctx.logger.error('Data create failed', e, { object: req.params.object });


The caught error e (typed as any) is passed directly to the logger without ensuring it's an Error object. This is the same issue as line 100.

Copilot · 2026-01-30T00:01:43Z

+                    res.json(result);
+                }
+                catch(e:any) { 
+                    ctx.logger.error('Data delete failed', e, { object: req.params.object, id: req.params.id });


The caught error e (typed as any) is passed directly to the logger without ensuring it's an Error object. This is the same issue as line 100.

Copilot · 2026-01-30T00:01:43Z

+        this.logger = logger || { 
+            info: console.log, 
+            debug: console.debug, 
+            warn: console.warn, 
+            error: console.error 
+        };


The fallback logger maps info to console.log, but this is inconsistent with the typical console API where console.info exists. While this works, it's semantically confusing.

Consider using console.info for consistency:

this.logger = logger || { info: console.info, debug: console.debug, warn: console.warn, error: console.error };

Initial plan

bb9ff57

Copilot AI assigned Copilot and hotlong Jan 29, 2026

Copilot started work on behalf of hotlong January 29, 2026 23:24

View session

vercel Bot deployed to Preview January 29, 2026 23:28

View deployment

Copilot AI and others added 2 commits January 29, 2026 23:29

Add comprehensive logging to ObjectQL engine and drivers

21d4614

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Add logging to HTTP plugins and client

8ed86de

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot deployed to Preview January 29, 2026 23:37

View deployment

Fix package dependencies and TypeScript errors

bab3d28

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot deployed to Preview January 29, 2026 23:41

View deployment

Copilot AI changed the title ~~[WIP] Add comprehensive logging to kernel for debugging~~ feat: Add structured logging throughout core for plugin developer debuggability Jan 29, 2026

Copilot AI requested a review from hotlong January 29, 2026 23:47

Copilot finished work on behalf of hotlong January 29, 2026 23:47

hotlong marked this pull request as ready for review January 29, 2026 23:56

Copilot AI review requested due to automatic review settings January 29, 2026 23:56

hotlong merged commit f56c419 into main Jan 29, 2026
4 checks passed

Copilot started reviewing on behalf of hotlong January 29, 2026 23:56

View session

Copilot AI reviewed Jan 30, 2026

View reviewed changes

Navigation Menu

Repository navigation

feat: Add structured logging throughout core for plugin developer debuggability - #368

feat: Add structured logging throughout core for plugin developer debuggability#368
hotlong merged 4 commits into
mainfrom
copilot/add-debug-logs-to-kernel

Copilot AI commented Jan 29, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jan 29, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Example

Dependencies

Uh oh!

vercel Bot commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 29, 2026 •

edited

Loading

vercel Bot commented Jan 29, 2026 •

edited

Loading