Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 packages/insomnia/src/entry.plugin-window-preload.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ window.app = {
// Bridge plugin UI calls to the main renderer window via IPC.
// The plugin window has no visible DOM; these methods forward to the main renderer.
window.showAlert = (options?: Record<string, any>) => {
ipcRenderer.send('plugin-ui-alert', options ?? {});
ipcRenderer.send('plugins.uiAlert', options ?? {});
};

window.showWrapper = (options?: Record<string, any>) => {
ipcRenderer.send('plugin-ui-dialog', options ?? {});
ipcRenderer.send('plugins.uiDialog', options ?? {});
};

window.showPrompt = (options?: Record<string, any>) => {
const { onComplete, onHide, ...serializableOptions } = options ?? {};
ipcRenderer.invoke('plugin-ui-prompt', serializableOptions).then((value: string | null) => {
ipcRenderer.invoke('plugins.uiPrompt', serializableOptions).then((value: string | null) => {
if (value !== null && value !== undefined) {
onComplete?.(value);
}
Expand Down
12 changes: 6 additions & 6 deletions packages/insomnia/src/entry.plugin-window.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
import { ipcRenderer } from 'electron';

import { initDatabase, initServices } from '~/insomnia-data';
import { servicesNodeImpl } from '~/insomnia-data/node';

import { pluginWindowDatabase } from './main/database.plugin-window';
import { invokePluginMethod } from './plugins/invoke-method';
import { servicesProxy } from './ui/renderer-services-proxy';

interface PluginInvokeMessage {
id: string;
method: Parameters<typeof invokePluginMethod>[0];
args: unknown;
}

ipcRenderer.on('plugin-invoke', async (_event, { id, method, args }: PluginInvokeMessage) => {
ipcRenderer.on('plugins.invoke', async (_event, { id, method, args }: PluginInvokeMessage) => {
try {
const result = await invokePluginMethod(method, args);
ipcRenderer.send('plugin-invoke-result', { id, result });
ipcRenderer.send('plugins.invokeResult', { id, result });
} catch (error) {
const errMsg = error instanceof Error ? error.message : String(error);
console.error(`[plugin-window] Error in ${(error as any)?.method ?? method}: ${errMsg}`);
ipcRenderer.send('plugin-invoke-result', { id, error: errMsg });
ipcRenderer.send('plugins.invokeResult', { id, error: errMsg });
}
});

Expand All @@ -28,8 +28,8 @@ ipcRenderer.on('plugin-invoke', async (_event, { id, method, args }: PluginInvok
(async () => {
try {
await initDatabase(pluginWindowDatabase);
initServices(servicesNodeImpl);
ipcRenderer.send('plugin-window-ready');
initServices(servicesProxy);
ipcRenderer.send('plugins.windowReady');
} catch (err) {
console.error('[plugin-window] Initialization failed:', err);
}
Expand Down
10 changes: 7 additions & 3 deletions packages/insomnia/src/entry.preload.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@ type PluginMethodResult<T extends PluginInvokeMethod> = T extends keyof PluginsB
? Awaited<ReturnType<PluginsBridgeAPI[T]>>
: never;

const invokePluginBridgeMethod = <T extends PluginInvokeMethod>(method: T, args?: unknown): Promise<PluginMethodResult<T>> => {
const invokePluginBridgeMethod = <T extends PluginInvokeMethod>(
method: T,
args?: unknown,
): Promise<PluginMethodResult<T>> => {
return invokeWithNormalizedError(`plugins.${method}`, args) as Promise<PluginMethodResult<T>>;
};

Expand Down Expand Up @@ -374,15 +377,16 @@ const main: Window['main'] = {
getTemplateTags: () => invokePluginBridgeMethod('getTemplateTags'),
runTemplateTagAction: (args: RunTemplateTagActionArgs) => invokePluginBridgeMethod('runTemplateTagAction', args),
getBundlePlugins: () => invokePluginBridgeMethod('getBundlePlugins'),
executePluginMainAction: (args: ExecutePluginMainActionArgs) => invokePluginBridgeMethod('executePluginMainAction', args),
executePluginMainAction: (args: ExecutePluginMainActionArgs) =>
invokePluginBridgeMethod('executePluginMainAction', args),
hasRequestHooks: () => invokePluginBridgeMethod('hasRequestHooks'),
hasResponseHooks: () => invokePluginBridgeMethod('hasResponseHooks'),
applyRequestHooks: (args: ApplyRequestHooksArgs) => invokePluginBridgeMethod('applyRequestHooks', args),
applyResponseHooks: (args: ApplyResponseHooksArgs) => invokePluginBridgeMethod('applyResponseHooks', args),
getBridgeMetrics: () => invokeWithNormalizedError('plugins.getBridgeMetrics'),
},
notifyPluginPromptResult: (id: string, value: string | null) =>
ipcRenderer.send('plugin-ui-prompt-result', { id, value }),
ipcRenderer.send('plugins.uiPromptResult', { id, value }),
};

ipcRenderer.on('hidden-browser-window-response-listener', event => {
Expand Down
35 changes: 19 additions & 16 deletions packages/insomnia/src/main/ipc/electron.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@ import { app, BrowserWindow, clipboard, dialog, ipcMain, Menu, shell } from 'ele
import { localTemplateTags } from 'insomnia/src/templating/local-template-tags';

import { fnOrString } from '../../common/misc';
import {
type NunjucksParsedTagArg,
type NunjucksTagContextMenuAction,
} from '../../templating/types';
import { type NunjucksParsedTagArg, type NunjucksTagContextMenuAction } from '../../templating/types';
import type { extractNunjucksTagFromCoords } from '../../templating/utils';
import { invariant } from '../../utils/invariant';

Expand Down Expand Up @@ -119,20 +116,25 @@ export type HandleChannels =
| 'multipartBufferToArray'
| 'onDefaultBrowserOAuthRedirect'
| 'open-channel-to-hidden-browser-window'
| 'plugins.applyRequestHooks'
| 'plugins.applyResponseHooks'
| 'plugins.executeAction'
| 'plugins.getBundlePlugins'
| 'plugins.executePluginMainAction'
| 'plugins.getTemplateTags'
| 'plugins.runTemplateTagAction'
| 'plugins.getActivePlugins'
| 'plugins.getBridgeMetrics'
| 'plugins.getBundlePlugins'
| 'plugins.getDocumentActions'
| 'plugins.getPlugins'
| 'plugins.getRequestActions'
| 'plugins.getRequestGroupActions'
| 'plugins.getTemplateTags'
| 'plugins.getThemes'
| 'plugins.getWorkspaceActions'
| 'plugins.hasRequestHooks'
| 'plugins.hasResponseHooks'
| 'plugins.reloadPlugins'
| 'plugin-ui-prompt'
| 'plugins.runTemplateTagAction'
| 'plugins.uiPrompt'
| 'openPath'
| 'parseImport'
| 'readCurlResponse'
Expand Down Expand Up @@ -192,8 +194,8 @@ export type MainOnChannels =
| 'path.resolve'
| 'readText'
| 'restart'
| 'plugin-invoke-result'
| 'plugin-window-ready'
| 'plugins.invokeResult'
| 'plugins.windowReady'
| 'set-hidden-window-busy-status'
| 'setMenuBarVisibility'
| 'show-nunjucks-context-menu'
Expand All @@ -217,15 +219,15 @@ export type MainOnChannels =
| 'sync.cancelConflict'
| 'sync.resolveConflict'
| 'mcp.sendMCPRequest'
| 'plugin-ui-prompt-result'
| 'plugins.uiPromptResult'
| 'writeText';

export type RendererOnChannels =
| 'contextMenuCommand'
| 'db.changes'
| 'plugin-ui-alert'
| 'plugin-ui-dialog'
| 'plugin-ui-prompt'
| 'plugins.uiAlert'
| 'plugins.uiDialog'
| 'plugins.uiPrompt'
| 'grpc.data'
| 'grpc.end'
| 'grpc.error'
Expand Down Expand Up @@ -268,7 +270,6 @@ interface ContextMenuTag {
};
}


const getTemplateValue = (arg: NunjucksParsedTagArg) => {
if (arg.defaultValue === undefined) {
return "''";
Expand Down Expand Up @@ -332,7 +333,9 @@ export function registerElectronHandlers() {
},
{ type: 'separator' },
];
const localTemplate: MenuItemConstructorOptions[] = ([...localTemplateTags, ...pluginTemplateTags] as ContextMenuTag[])
const localTemplate: MenuItemConstructorOptions[] = (
[...localTemplateTags, ...pluginTemplateTags] as ContextMenuTag[]
)
// sort alphabetically
.sort((a, b) => fnOrString(a.templateTag.displayName).localeCompare(fnOrString(b.templateTag.displayName)))
.map(l => {
Expand Down
74 changes: 43 additions & 31 deletions packages/insomnia/src/main/plugin-window.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ import { app, BrowserWindow, ipcMain } from 'electron';

let pluginWindow: BrowserWindow | null = null;
let windowReady = false;
const pendingRequests = new Map<string, { resolve: (v: unknown) => void; reject: (e: Error) => void; method: string; startedAt: number }>();
const pendingRequests = new Map<
string,
{ resolve: (v: unknown) => void; reject: (e: Error) => void; method: string; startedAt: number }
>();

let cachedHasRequestHooks: boolean | null = null;
let cachedHasResponseHooks: boolean | null = null;
Expand Down Expand Up @@ -77,7 +80,7 @@ function ensureIpcListeners() {
}
ipcListenersRegistered = true;

ipcMain.on('plugin-window-ready', event => {
ipcMain.on('plugins.windowReady', event => {
if (event.sender !== pluginWindow?.webContents) {
return;
}
Expand All @@ -88,21 +91,21 @@ function ensureIpcListeners() {
console.log(`[plugin-bridge] window_ready startup_ms=${startupMs}`);
});

ipcMain.on('plugin-ui-alert', (event, options: Record<string, unknown>) => {
ipcMain.on('plugins.uiAlert', (event, options: Record<string, unknown>) => {
if (event.sender !== pluginWindow?.webContents) {
return;
}
getMainWindow()?.webContents.send('plugin-ui-alert', options);
getMainWindow()?.webContents.send('plugins.uiAlert', options);
});

ipcMain.on('plugin-ui-dialog', (event, options: Record<string, unknown>) => {
ipcMain.on('plugins.uiDialog', (event, options: Record<string, unknown>) => {
if (event.sender !== pluginWindow?.webContents) {
return;
}
getMainWindow()?.webContents.send('plugin-ui-dialog', options);
getMainWindow()?.webContents.send('plugins.uiDialog', options);
});

ipcMain.handle('plugin-ui-prompt', async (event, options: Record<string, unknown>) => {
ipcMain.handle('plugins.uiPrompt', async (event, options: Record<string, unknown>) => {
if (event.sender !== pluginWindow?.webContents) {
return null;
}
Expand All @@ -120,11 +123,15 @@ function ensureIpcListeners() {
clearTimeout(timeout);
resolve(value);
});
mainWindow.webContents.send('plugin-ui-prompt', id, options);
mainWindow.webContents.send('plugins.uiPrompt', id, options);
});
});

ipcMain.on('plugin-ui-prompt-result', (_event, { id, value }: { id: string; value: string | null }) => {
ipcMain.on('plugins.uiPromptResult', (event, { id, value }: { id: string; value: string | null }) => {
const mainWindow = getMainWindow();
if (!mainWindow || event.sender !== mainWindow.webContents) {
return;
}
const resolve = promptPendingRequests.get(id);
if (!resolve) {
return;
Expand All @@ -133,24 +140,27 @@ function ensureIpcListeners() {
resolve(value);
});

ipcMain.on('plugin-invoke-result', (event, { id, result, error }: { id: string; result?: unknown; error?: string }) => {
if (event.sender !== pluginWindow?.webContents) {
return;
}
const pending = pendingRequests.get(id);
if (!pending) {
return;
}
pendingRequests.delete(id);
const duration = Date.now() - pending.startedAt;
if (error) {
recordInvocation(pending.method, 'error', duration);
pending.reject(new Error(error));
} else {
recordInvocation(pending.method, 'ok', duration);
pending.resolve(result);
}
});
ipcMain.on(
'plugins.invokeResult',
(event, { id, result, error }: { id: string; result?: unknown; error?: string }) => {
if (event.sender !== pluginWindow?.webContents) {
return;
}
const pending = pendingRequests.get(id);
if (!pending) {
return;
}
pendingRequests.delete(id);
const duration = Date.now() - pending.startedAt;
if (error) {
recordInvocation(pending.method, 'error', duration);
pending.reject(new Error(error));
} else {
recordInvocation(pending.method, 'ok', duration);
pending.resolve(result);
}
},
);
}

export function getPluginWindow() {
Expand Down Expand Up @@ -259,7 +269,7 @@ export async function invokeInPluginWindow(method: string, args?: unknown): Prom
},
});

pluginWindow!.webContents.send('plugin-invoke', { id, method, args });
pluginWindow!.webContents.send('plugins.invoke', { id, method, args });
});
}

Expand Down Expand Up @@ -293,16 +303,18 @@ export function registerPluginIpcHandlers() {
ipcMain.handle('plugins.getTemplateTags', () => invokeInPluginWindow('getTemplateTags'));
ipcMain.handle('plugins.runTemplateTagAction', (_event, args) => invokeInPluginWindow('runTemplateTagAction', args));
ipcMain.handle('plugins.getBundlePlugins', () => invokeInPluginWindow('getBundlePlugins'));
ipcMain.handle('plugins.executePluginMainAction', (_event, args) => invokeInPluginWindow('executePluginMainAction', args));
ipcMain.handle('plugins.executePluginMainAction', (_event, args) =>
invokeInPluginWindow('executePluginMainAction', args),
);
ipcMain.handle('plugins.hasRequestHooks', async () => {
if (cachedHasRequestHooks === null) {
cachedHasRequestHooks = await invokeInPluginWindow('hasRequestHooks') as boolean;
cachedHasRequestHooks = (await invokeInPluginWindow('hasRequestHooks')) as boolean;
}
return cachedHasRequestHooks;
});
ipcMain.handle('plugins.hasResponseHooks', async () => {
if (cachedHasResponseHooks === null) {
cachedHasResponseHooks = await invokeInPluginWindow('hasResponseHooks') as boolean;
cachedHasResponseHooks = (await invokeInPluginWindow('hasResponseHooks')) as boolean;
}
return cachedHasResponseHooks;
});
Expand Down
5 changes: 2 additions & 3 deletions packages/insomnia/src/root.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import { useLatest } from 'react-use';
import { EXTERNAL_VAULT_PLUGIN_NAME, isDevelopment } from '~/common/constants';
import type { Settings, UserSession } from '~/insomnia-data';
import { models, services } from '~/insomnia-data';
import { executePluginMainAction } from '~/plugins';
import { createPlugin } from '~/plugins/create';
import { setTheme } from '~/plugins/misc';
import { plugins } from '~/plugins/renderer-bridge';
Expand Down Expand Up @@ -544,11 +543,11 @@ const Root = () => {
if (urlWithoutParams === 'insomnia://oauth/azure/authenticate') {
const { code, ...restParams } = params;
if (code && typeof code === 'string') {
const authResult = await executePluginMainAction({
const authResult = await plugins.executePluginMainAction({
pluginName: EXTERNAL_VAULT_PLUGIN_NAME,
actionName: 'exchangeCode',
params: { provider: 'azure', code },
});
}) as any;
const { success, result, error } = authResult;
if (success) {
const { account, uniqueId } = result!;
Expand Down
6 changes: 3 additions & 3 deletions packages/insomnia/src/ui/renderer-listeners.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ window.main.on('show-toast', (_, options: { content: RAToastContent; options?: {
showToast(options.content, options.options);
});

window.main.on('plugin-ui-alert', (_, options: Record<string, any>) => {
window.main.on('plugins.uiAlert', (_, options: Record<string, any>) => {
window.showAlert?.(options);
});

window.main.on('plugin-ui-dialog', (_, options: Record<string, any>) => {
window.main.on('plugins.uiDialog', (_, options: Record<string, any>) => {
window.showWrapper?.(options);
});

window.main.on('plugin-ui-prompt', (_, id: string, options: Record<string, any>) => {
window.main.on('plugins.uiPrompt', (_, id: string, options: Record<string, any>) => {
window.showPrompt?.({
...options,
onComplete: (value: string) => {
Expand Down
Loading