import fs from 'fs'; import mkdirp from 'mkdirp'; import path from 'path'; import appConfig from '../../config/config.json'; import { PLUGIN_PATH } from '../common/constants'; import { resolveHomePath } from '../common/misc'; import * as models from '../models'; import { GrpcRequest } from '../models/grpc-request'; import type { Request } from '../models/request'; import type { RequestGroup } from '../models/request-group'; import type { PluginConfig, PluginConfigMap } from '../models/settings'; import type { Workspace } from '../models/workspace'; import type { PluginTemplateTag } from '../templating/extensions/index'; import { showError } from '../ui/components/modals/index'; import type { PluginTheme } from './misc'; export interface Module { templateTags?: PluginTemplateTag[], requestHooks?: ((requstContext: any) => void)[], responseHooks?: ((responseContext: any) => void)[], themes?: PluginTheme[], requestGroupActions?: OmitInternal[], requestActions?: OmitInternal[], workspaceActions?: OmitInternal[], documentActions?: OmitInternal[], configGenerators?: OmitInternal[], } export interface Plugin { name: string; description: string; version: string; directory: string; config: PluginConfig; module: Module; } interface InternalProperties { plugin: Plugin; } type OmitInternal = Omit; export interface TemplateTag extends InternalProperties { templateTag: PluginTemplateTag; } export interface RequestGroupAction extends InternalProperties { action: ( context: Record, models: { requestGroup: RequestGroup; requests: (Request | GrpcRequest)[]; }, ) => void | Promise; label: string; icon?: string; } export interface RequestAction extends InternalProperties { action: ( context: Record, models: { requestGroup?: RequestGroup; request: Request | GrpcRequest; }, ) => void | Promise; label: string; icon?: string; } export interface WorkspaceAction extends InternalProperties { action: ( context: Record, models: { workspace: Workspace; requestGroups: RequestGroup[]; requests: Request[]; }, ) => void | Promise; label: string; icon?: string; } export interface SpecInfo { contents: Record; rawContents: string; format: string; formatVersion: string; } export interface ConfigGenerator extends InternalProperties { label: string; generate: ( info: SpecInfo, ) => Promise<{ document?: string; error?: string; }>; } export interface DocumentAction extends InternalProperties { action: (context: Record, documents: SpecInfo) => void | Promise; label: string; hideAfterClick?: boolean; } type RequestHookCallback = (context: any) => void; export interface RequestHook extends InternalProperties { hook: RequestHookCallback; } type ResponseHookCallback = (context: any) => void; export interface ResponseHook extends InternalProperties { hook: ResponseHookCallback; } export interface Theme extends InternalProperties { theme: PluginTheme; } export type ColorScheme = 'default' | 'light' | 'dark'; let plugins: Plugin[] | null | undefined = null; let ignorePlugins: string[] = []; export async function init() { clearIgnores(); await reloadPlugins(); } export function ignorePlugin(name: string) { if (!ignorePlugins.includes(name)) { ignorePlugins.push(name); } } export function clearIgnores() { ignorePlugins = []; } async function _traversePluginPath( pluginMap: Record, allPaths: string[], allConfigs: PluginConfigMap, ) { for (const p of allPaths) { if (!fs.existsSync(p)) { continue; } for (const filename of fs.readdirSync(p)) { try { const modulePath = path.join(p, filename); const packageJSONPath = path.join(modulePath, 'package.json'); // Only read directories if (!fs.statSync(modulePath).isDirectory()) { continue; } // Is it a scoped directory? if (filename.startsWith('@')) { await _traversePluginPath(pluginMap, [modulePath], allConfigs); } // Is it a Node module? if (!fs.readdirSync(modulePath).includes('package.json')) { continue; } // Delete `require` cache if plugin has been required before for (const p of Object.keys(global.require.cache)) { if (p.indexOf(modulePath) === 0) { delete global.require.cache[p]; } } // Use global.require() instead of require() because Webpack wraps require() const pluginJson = global.require(packageJSONPath); // Not an Insomnia plugin because it doesn't have the package.json['insomnia'] if (!pluginJson.hasOwnProperty('insomnia')) { continue; } // Delete require cache entry and re-require const module = global.require(modulePath); const pluginName = pluginJson.name; pluginMap[pluginName] = _initPlugin(pluginJson || {}, module, allConfigs, modulePath); console.log(`[plugin] Loaded ${modulePath}`); } catch (err) { showError({ title: 'Plugin Error', message: 'Failed to load plugin ' + filename, error: err, }); } } } } export async function getPlugins(force = false): Promise { if (force) { plugins = null; } if (!plugins) { const settings = await models.settings.getOrCreate(); const allConfigs: PluginConfigMap = settings.pluginConfig; const extraPaths = settings.pluginPath .split(':') .filter(p => p) .map(resolveHomePath); // Make sure the default directories exist mkdirp.sync(PLUGIN_PATH); // Also look in node_modules folder in each directory const basePaths = [PLUGIN_PATH, ...extraPaths]; const extendedPaths = basePaths.map(p => path.join(p, 'node_modules')); const allPaths = [...basePaths, ...extendedPaths]; // Store plugins in a map so that plugins with the same // name only get added once // TODO: Make this more complex and have the latest version always win const pluginMap: Record = { // "name": "module" }; for (const p of appConfig.plugins) { if (ignorePlugins.includes(p)) { continue; } const pluginJson = global.require(`${p}/package.json`); if (ignorePlugins.includes(pluginJson.name)) { continue; } const pluginModule = global.require(p); pluginMap[pluginJson.name] = _initPlugin(pluginJson, pluginModule, allConfigs); } await _traversePluginPath(pluginMap, allPaths, allConfigs); plugins = Object.keys(pluginMap).map(name => pluginMap[name]); } return plugins; } export async function reloadPlugins() { await getPlugins(true); } async function getActivePlugins(): Promise { return (await getPlugins()).filter(p => !p.config.disabled); } export async function getRequestGroupActions(): Promise { let extensions: RequestGroupAction[] = []; for (const plugin of await getActivePlugins()) { const actions = plugin.module.requestGroupActions || []; extensions = [ ...extensions, ...actions.map(p => ({ plugin, ...p, })), ]; } return extensions; } export async function getRequestActions(): Promise { let extensions: RequestAction[] = []; for (const plugin of await getActivePlugins()) { const actions = plugin.module.requestActions || []; extensions = [ ...extensions, ...actions.map(p => ({ plugin, ...p, })), ]; } return extensions; } export async function getWorkspaceActions(): Promise { let extensions: WorkspaceAction[] = []; for (const plugin of await getActivePlugins()) { const actions = plugin.module.workspaceActions || []; extensions = [ ...extensions, ...actions.map(p => ({ plugin, ...p, })), ]; } return extensions; } export async function getDocumentActions(): Promise { let extensions: DocumentAction[] = []; for (const plugin of await getActivePlugins()) { const actions = plugin.module.documentActions || []; extensions = [ ...extensions, ...actions.map(p => ({ plugin, ...p, })), ]; } return extensions; } export async function getTemplateTags(): Promise { let extensions: TemplateTag[] = []; for (const plugin of await getActivePlugins()) { const templateTags = plugin.module.templateTags || []; extensions = [ ...extensions, ...templateTags.map(tt => ({ plugin, templateTag: tt, })), ]; } return extensions; } export async function getRequestHooks(): Promise { let functions: RequestHook[] = []; for (const plugin of await getActivePlugins()) { const moreFunctions = plugin.module.requestHooks || []; functions = [ ...functions, ...moreFunctions.map(hook => ({ plugin, hook, })), ]; } return functions; } export async function getResponseHooks(): Promise { let functions: ResponseHook[] = []; for (const plugin of await getActivePlugins()) { const moreFunctions = plugin.module.responseHooks || []; functions = [ ...functions, ...moreFunctions.map(hook => ({ plugin, hook, })), ]; } return functions; } export async function getThemes(): Promise { let extensions: Theme[] = []; for (const plugin of await getActivePlugins()) { const themes = plugin.module.themes || []; extensions = [ ...extensions, ...themes.map(theme => ({ plugin, theme, })), ]; } return extensions; } export async function getConfigGenerators(): Promise { let functions: ConfigGenerator[] = []; for (const plugin of await getActivePlugins()) { const moreFunctions = plugin.module.configGenerators || []; functions = [ ...functions, ...moreFunctions.map(p => ({ plugin, ...p, })), ]; } return functions; } const _defaultPluginConfig: PluginConfig = { disabled: false, }; function _initPlugin( packageJSON: Record, module: any, allConfigs: PluginConfigMap, path?: string | null, ): Plugin { const meta = packageJSON.insomnia || {}; const name = packageJSON.name || meta.name; // Find config const config: PluginConfig = allConfigs.hasOwnProperty(name) ? allConfigs[name] : _defaultPluginConfig; return { name, description: packageJSON.description || meta.description || '', version: packageJSON.version || 'unknown', directory: path || '', config, module: module, }; }