Skip to content

fix: cleaner startup logs #309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 18, 2025
+21 −7
Merged

fix: cleaner startup logs #309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
efeb44e
fix: cleaner startup logs
erickzhao Nov 14, 2025
7c8a327
Merge branch 'main' into cleaner-debug-logs
erickzhao Nov 17, 2025
069b4ae
fix linting issue
erickzhao Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ Installs Devtron into the Electron app. Refer to [Configuring an Electron App to

#### `Options`

| Option | Type | Default | Description |
| ---------- | -------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `logLevel` | `'debug' \| 'info' \| 'warn' \| 'error' \| 'none'` | `'debug'` | Sets the minimum log level for the logger. Messages below this level are ignored. <br><br> **Levels:** <br>• `debug` — logs: debug, info, warn, error <br>• `info` — logs: info, warn, error <br>• `warn` — logs: warn, error <br>• `error` — logs: error only <br>• `none` — disables all logging |
| Option | Type | Default | Description |
| ---------- | -------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `logLevel` | `'debug' \| 'info' \| 'warn' \| 'error' \| 'none'` | `'warn'` | Sets the minimum log level for the logger. Messages below this level are ignored. <br><br> **Levels:** <br>• `debug` — logs: debug, info, warn, error <br>• `info` — logs: info, warn, error <br>• `warn` — logs: warn, error <br>• `error` — logs: error only <br>• `none` — disables all logging |

Examples:

Expand Down
20 changes: 17 additions & 3 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ let isInstalled = false;
let isInstalledToDefaultSession = false;
let devtronSW: Electron.ServiceWorkerMain;

/**
* Count the number of IPC calls that were made before the service worker was ready.
* Used for logging purposes.
*/
let untrackedIpcCalls = 0;

const isPayloadWithUuid = (payload: any[]): boolean => {
// If the first argument is an object with __uuid__devtron then it is a custom payload
return (
Expand Down Expand Up @@ -67,7 +73,10 @@ function trackIpcEvent({
if (excludedIpcChannels.includes(channel)) return;

if (!devtronSW) {
logger.warn('The service-worker for Devtron is not registered yet. Cannot track IPC event.');
logger.info(
`The service worker for Devtron is not registered yet. Cannot track ${direction} IPC event for channel ${channel}.`,
);
untrackedIpcCalls++;
return;
}

Expand Down Expand Up @@ -415,7 +424,12 @@ async function install(options: InstallOptions = {}) {
const extensionPath = path.resolve(serviceWorkerPreloadPath, '..', '..', 'extension');
devtron = await ses.extensions.loadExtension(extensionPath, { allowFileAccess: true });
await startServiceWorker(ses, devtron);
logger.info('Devtron loaded successfully');
if (untrackedIpcCalls > 0) {
logger.warn(
`${untrackedIpcCalls} untracked IPC events were dispatched before the service worker was ready.`,
);
}
logger.info('Devtron service worker loaded successfully');
} catch (error) {
logger.error('Failed to load Devtron:', error);
}
Expand All @@ -440,7 +454,7 @@ async function getEvents(): Promise<IpcEventDataIndexed[]> {
}

if (!devtronSW) {
logger.warn('Devtron service-worker is not registered yet. Cannot get IPC events.');
logger.warn('Devtron service worker is not registered yet. Cannot get IPC events.');
return [];
}

Expand Down
2 changes: 1 addition & 1 deletion src/utils/Logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { LogLevelString } from '../types/shared';
import { LogLevel } from '../types/shared';

class Logger {
private currentLogLevel = LogLevel.debug;
private currentLogLevel = LogLevel.warn;

setLogLevel(level: LogLevelString) {
if (LogLevel[level] === undefined) {
Expand Down