@hitarth-gg/devtron
Version:
Electron DevTools Extension to track IPC events
273 lines (258 loc) • 11.2 kB
JavaScript
import * as __WEBPACK_EXTERNAL_MODULE_electron__ from "electron";
/******/ var __webpack_modules__ = ([
/* 0 */,
/* 1 */
/***/ ((module) => {
module.exports = __WEBPACK_EXTERNAL_MODULE_electron__;
/***/ }),
/* 2 */,
/* 3 */,
/* 4 */
/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
__webpack_require__.r(__webpack_exports__);
/* harmony export */ __webpack_require__.d(__webpack_exports__, {
/* harmony export */ MSG_TYPE: () => (/* binding */ MSG_TYPE),
/* harmony export */ PORT_NAME: () => (/* binding */ PORT_NAME),
/* harmony export */ excludedIpcChannels: () => (/* binding */ excludedIpcChannels)
/* harmony export */ });
const PORT_NAME = {
PANEL: 'devt-panel',
CONTENT_SCRIPT: 'devt-content-script',
};
const MSG_TYPE = {
PING: 'ping',
PONG: 'pong',
GET_ALL_EVENTS: 'get-all-events',
RENDER_EVENT: 'render-event',
CLEAR_EVENTS: 'clear-events',
EVENTS_CLEARED_ACK: 'events-cleared-ack',
ADD_IPC_EVENT: 'add-ipc-event',
SEND_TO_PANEL: 'send-to-panel',
};
/**
* These channels are used internally by Devtron, and tracking them may lead to unnecessary noise.
* Hence, they are ignored by Devtron.
*/
const excludedIpcChannels = ['devtron-ipc-events'];
/***/ }),
/* 5 */,
/* 6 */,
/* 7 */
/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
__webpack_require__.r(__webpack_exports__);
/* harmony export */ __webpack_require__.d(__webpack_exports__, {
/* harmony export */ monitorRenderer: () => (/* binding */ monitorRenderer)
/* harmony export */ });
/* harmony import */ var electron__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(1);
/* harmony import */ var _common_constants__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(4);
let isInstalled = false;
/**
* Store tracked listeners in a map so that they can be removed later
* if the user calls `removeListener`or `removeAllListeners`.
*/
const listenerMap = new Map(); // channel -> (originalListener -> trackedListener)
function storeTrackedListener(channel, original, tracked) {
if (!listenerMap.has(channel)) {
listenerMap.set(channel, new Map());
}
listenerMap.get(channel).set(original, tracked);
}
function monitorRenderer() {
if (isInstalled) {
return;
}
isInstalled = true;
const originalOn = electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.on.bind(electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer);
const originalOff = electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.off.bind(electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer);
const originalOnce = electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.once.bind(electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer);
const originalAddListener = electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.addListener.bind(electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer);
const originalRemoveListener = electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.removeListener.bind(electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer);
const originalRemoveAllListeners = electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.removeAllListeners.bind(electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer);
const originalSendSync = electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.sendSync.bind(electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer);
const originalInvoke = electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.invoke.bind(electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer);
electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.on = function (channel, listener) {
const trackedListener = (event, ...args) => {
track('main-to-renderer', channel, args, 'on');
listener(event, ...args);
};
storeTrackedListener(channel, listener, trackedListener);
return originalOn(channel, trackedListener);
};
electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.off = function (channel, listener) {
const channelMap = listenerMap.get(channel);
const tracked = channelMap?.get(listener);
if (!tracked)
return electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer;
// Remove the listener from the map
channelMap?.delete(listener);
// If no listeners left for this channel, remove the channel from the map
if (channelMap && channelMap.size === 0) {
listenerMap.delete(channel);
}
track('renderer', channel, [], 'off');
return originalOff(channel, tracked);
};
electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.once = function (channel, listener) {
const trackedListener = (event, ...args) => {
/**
* not useful since `.once` = `.on + removeListener`.
* hence, `.once` will be tracked as `.on` and then `.removeListener`.
*/
// track('main-to-renderer', channel, args, 'once');
listener(event, ...args);
};
return originalOnce(channel, trackedListener);
};
electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.addListener = function (channel, listener) {
const trackedListener = (event, ...args) => {
track('main-to-renderer', channel, args, 'addListener');
listener(event, ...args);
};
storeTrackedListener(channel, listener, trackedListener);
return originalAddListener(channel, trackedListener);
};
electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.removeListener = function (channel, listener) {
const channelMap = listenerMap.get(channel);
const tracked = channelMap?.get(listener);
if (!tracked)
return electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer;
// Remove the listener from the map
channelMap?.delete(listener);
// If no listeners left for this channel, remove the channel from the map
if (channelMap && channelMap.size === 0) {
listenerMap.delete(channel);
}
track('renderer', channel, [], 'removeListener');
return originalRemoveListener(channel, tracked);
};
electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.removeAllListeners = function (channel) {
if (channel) {
listenerMap.delete(channel);
const result = originalRemoveAllListeners(channel);
track('renderer', channel, [], 'removeAllListeners');
return result;
}
else {
listenerMap.clear();
const result = originalRemoveAllListeners();
track('renderer', '', [], 'removeAllListeners');
return result;
}
};
electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.sendSync = function (channel, ...args) {
const uuid = crypto.randomUUID(); // uuid is used to match the response with the request
const payload = {
__uuid__devtron: uuid,
args,
};
const start = performance.now();
const result = originalSendSync(channel, payload);
const duration = performance.now() - start;
track('main-to-renderer', channel, [result], 'sendSync (response)', duration, uuid);
return result;
};
electron__WEBPACK_IMPORTED_MODULE_0__.ipcRenderer.invoke = async function (channel, ...args) {
const uuid = crypto.randomUUID(); // uuid is used to match the response with the request
const payload = {
__uuid__devtron: uuid,
args,
};
const start = performance.now();
const result = await originalInvoke(channel, payload);
const duration = performance.now() - start;
track('main-to-renderer', channel, [result], 'invoke (response)', duration, uuid);
return result;
};
}
function track(direction, channel, args, method, responseTime, uuid) {
const event = {
timestamp: Date.now(),
direction,
channel,
args: copyArgs(args),
uuid,
};
if (method)
event.method = method;
if (responseTime)
event.responseTime = responseTime;
const message = {
source: _common_constants__WEBPACK_IMPORTED_MODULE_1__.MSG_TYPE.SEND_TO_PANEL,
event,
};
window.postMessage(message, '*');
}
function copyArgs(args) {
try {
return structuredClone(args);
}
catch (err) {
const message = err instanceof Error ? err.message : 'Unknown error';
console.error(`Error cloning args: ${message}`);
return [`[Could not clone args: ${message}]`];
}
}
/***/ })
/******/ ]);
/************************************************************************/
/******/ // The module cache
/******/ var __webpack_module_cache__ = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/ // Check if module is in cache
/******/ var cachedModule = __webpack_module_cache__[moduleId];
/******/ if (cachedModule !== undefined) {
/******/ return cachedModule.exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = __webpack_module_cache__[moduleId] = {
/******/ // no module.id needed
/******/ // no module.loaded needed
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/************************************************************************/
/******/ /* webpack/runtime/define property getters */
/******/ (() => {
/******/ // define getter functions for harmony exports
/******/ __webpack_require__.d = (exports, definition) => {
/******/ for(var key in definition) {
/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
/******/ }
/******/ }
/******/ };
/******/ })();
/******/
/******/ /* webpack/runtime/hasOwnProperty shorthand */
/******/ (() => {
/******/ __webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
/******/ })();
/******/
/******/ /* webpack/runtime/make namespace object */
/******/ (() => {
/******/ // define __esModule on exports
/******/ __webpack_require__.r = (exports) => {
/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
/******/ }
/******/ Object.defineProperty(exports, '__esModule', { value: true });
/******/ };
/******/ })();
/******/
/************************************************************************/
var __webpack_exports__ = {};
// This entry needs to be wrapped in an IIFE because it needs to be isolated against other modules in the chunk.
(() => {
__webpack_require__.r(__webpack_exports__);
/* harmony import */ var _electron_renderer_tracker__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(7);
(0,_electron_renderer_tracker__WEBPACK_IMPORTED_MODULE_0__.monitorRenderer)();
})();