electron / electron/devtron

[GSoC] Devtron: Progress, Known Issues, and Next Steps

Open
#272 4 comments 6 reactions 0 assignees View on GitHub
GSoC 2025
Dominant language
TypeScript
Stars
1.8k
Forks
110
Avg merge
1h 54m
Merged PRs (30d)
7

Description

This issue is intended to track the remaining work, current limitations, and future improvements as part of the [GSoC project](https://summerofcode.withgoogle.com/programs/2025/projects/ppdEAKGU).
A personal NPM Package, found [here](https://www.npmjs.com/package/@hitarth-gg/devtron), can be used to check out the progress.

## Progress & Ongoing Tasks

- [x] Initial setup with prototype - #265
- [x] Migrate the prototype to TypeScript - #266
- [x] Use `Session` to track IPC events sent to main process- #268
- [x] Use [`serviceWorker.startTask()`](https://www.electronjs.org/docs/latest/api/service-worker-main#serviceworkerstarttask-experimental) to prevent Devtron's service worker from dying - #268
- [x] Distinguish between `.on`, `.off`, `.addListener`, `.removeListener`, `.once`, and `.removeAllListeners` methods on `ipcRenderer`, - #268
- [x] Optional auto-scroll to newly added event - #268
- [x] Dark Theme - #268
- [x] Add option to dock the Details Panel to the bottom or right - #268
- [x] Fix issues with CommonJS builds - #269
- [x] Remove the need to manually call `monitorRenderer` - #271
- Also fixes an issue where Devtron wouldn't install properly when `sandbox: true` is set in `webPreferences`.
- [x] Add tooltips for buttons like "Toggle Dark Mode", "Clear Events", etc - #274
- [x] Fix type declarations not found - #276
- [x] Use system theme by default in Devtron UI - #277
- [x] Track IPC events sent from main process to the service workers - #273
- [x] Track the time it takes for an IPC message sent via `ipcRenderer.invoke` or `ipcRenderer.sendSync` to receive a response from the main process - #275
- [x] Publish a gist for [Electron Fiddle](https://github.com/electron/fiddle) that shows how to use Devtron (will be updated over time) - [Electron Devtron Fiddle](https://gist.github.com/hitarth-gg/e2c9013968f78002fe73321b05f4e1eb)
- [x] Set up testing environment and add some tests - #279
- [x] Track the responses received by `.sendSync` and `.invoke` methods on `ipcRenderer` - #275
- [x] Implement filtering for tracked IPC events - #284
- [x] Allow users to suppress logs generated by Devtron - #283
- [x] Add pre-commit lint checks and CI test runs ([see comment](https://github.com/electron/devtron/issues/272#issuecomment-3211316330)).

## Known Issues / Limitations
- IPC events sent from the main process to the service workers are not yet tracked.
- IPC events sent before Devtron is installed (during early app startup) might not be captured.
- `ipcRenderer.once` will be tracked as two separate events `ipcRenderer.on` and then `ipcRenderer.removeListener`.

## Next Steps
- [ ] Tracking require and imports
- [ ] Event inspector for core Electron objects

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.