Spaces:

Zhitomir
/

chat

Runtime error

chat / api /server /controllers /PluginController.js

chat init

aa2e6af over 2 years ago

4.81 kB

const { promises: fs } = require('fs');
const { CacheKeys } = require('librechat-data-provider');
const { addOpenAPISpecs } = require('~/app/clients/tools/util/addOpenAPISpecs');
const { getLogStores } = require('~/cache');

/**
 * Filters out duplicate plugins from the list of plugins.
 *
 * @param {TPlugin[]} plugins The list of plugins to filter.
 * @returns {TPlugin[]} The list of plugins with duplicates removed.
 */
const filterUniquePlugins = (plugins) => {
  const seen = new Set();
  return plugins.filter((plugin) => {
    const duplicate = seen.has(plugin.pluginKey);
    seen.add(plugin.pluginKey);
    return !duplicate;
  });
};

/**
 * Determines if a plugin is authenticated by checking if all required authentication fields have non-empty values.
 * Supports alternate authentication fields, allowing validation against multiple possible environment variables.
 *
 * @param {TPlugin} plugin The plugin object containing the authentication configuration.
 * @returns {boolean} True if the plugin is authenticated for all required fields, false otherwise.
 */
const isPluginAuthenticated = (plugin) => {
  if (!plugin.authConfig || plugin.authConfig.length === 0) {
    return false;
  }

  return plugin.authConfig.every((authFieldObj) => {
    const authFieldOptions = authFieldObj.authField.split('||');
    let isFieldAuthenticated = false;

    for (const fieldOption of authFieldOptions) {
      const envValue = process.env[fieldOption];
      if (envValue && envValue.trim() !== '' && envValue !== 'user_provided') {
        isFieldAuthenticated = true;
        break;
      }
    }

    return isFieldAuthenticated;
  });
};

const getAvailablePluginsController = async (req, res) => {
  try {
    const cache = getLogStores(CacheKeys.CONFIG_STORE);
    const cachedPlugins = await cache.get(CacheKeys.PLUGINS);
    if (cachedPlugins) {
      res.status(200).json(cachedPlugins);
      return;
    }

    /** @type {{ filteredTools: string[], includedTools: string[] }} */
    const { filteredTools = [], includedTools = [] } = req.app.locals;
    const pluginManifest = await fs.readFile(req.app.locals.paths.pluginManifest, 'utf8');
    const jsonData = JSON.parse(pluginManifest);

    const uniquePlugins = filterUniquePlugins(jsonData);
    let authenticatedPlugins = [];
    for (const plugin of uniquePlugins) {
      authenticatedPlugins.push(
        isPluginAuthenticated(plugin) ? { ...plugin, authenticated: true } : plugin,
      );
    }

    let plugins = await addOpenAPISpecs(authenticatedPlugins);

    if (includedTools.length > 0) {
      plugins = plugins.filter((plugin) => includedTools.includes(plugin.pluginKey));
    } else {
      plugins = plugins.filter((plugin) => !filteredTools.includes(plugin.pluginKey));
    }

    await cache.set(CacheKeys.PLUGINS, plugins);
    res.status(200).json(plugins);
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
};

/**
 * Retrieves and returns a list of available tools, either from a cache or by reading a plugin manifest file.
 *
 * This function first attempts to retrieve the list of tools from a cache. If the tools are not found in the cache,
 * it reads a plugin manifest file, filters for unique plugins, and determines if each plugin is authenticated.
 * Only plugins that are marked as available in the application's local state are included in the final list.
 * The resulting list of tools is then cached and sent to the client.
 *
 * @param {object} req - The request object, containing information about the HTTP request.
 * @param {object} res - The response object, used to send back the desired HTTP response.
 * @returns {Promise<void>} A promise that resolves when the function has completed.
 */
const getAvailableTools = async (req, res) => {
  try {
    const cache = getLogStores(CacheKeys.CONFIG_STORE);
    const cachedTools = await cache.get(CacheKeys.TOOLS);
    if (cachedTools) {
      res.status(200).json(cachedTools);
      return;
    }

    const pluginManifest = await fs.readFile(req.app.locals.paths.pluginManifest, 'utf8');

    const jsonData = JSON.parse(pluginManifest);
    /** @type {TPlugin[]} */
    const uniquePlugins = filterUniquePlugins(jsonData);

    const authenticatedPlugins = uniquePlugins.map((plugin) => {
      if (isPluginAuthenticated(plugin)) {
        return { ...plugin, authenticated: true };
      } else {
        return plugin;
      }
    });

    const tools = authenticatedPlugins.filter(
      (plugin) => req.app.locals.availableTools[plugin.pluginKey] !== undefined,
    );

    await cache.set(CacheKeys.TOOLS, tools);
    res.status(200).json(tools);
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
};

module.exports = {
  getAvailableTools,
  getAvailablePluginsController,
};

	const { promises: fs } = require('fs');
	const { CacheKeys } = require('librechat-data-provider');
	const { addOpenAPISpecs } = require('~/app/clients/tools/util/addOpenAPISpecs');
	const { getLogStores } = require('~/cache');

	/**
	* Filters out duplicate plugins from the list of plugins.
	*
	* @param {TPlugin[]} plugins The list of plugins to filter.
	* @returns {TPlugin[]} The list of plugins with duplicates removed.
	*/
	const filterUniquePlugins = (plugins) => {
	const seen = new Set();
	return plugins.filter((plugin) => {
	const duplicate = seen.has(plugin.pluginKey);
	seen.add(plugin.pluginKey);
	return !duplicate;
	});
	};

	/**
	* Determines if a plugin is authenticated by checking if all required authentication fields have non-empty values.
	* Supports alternate authentication fields, allowing validation against multiple possible environment variables.
	*
	* @param {TPlugin} plugin The plugin object containing the authentication configuration.
	* @returns {boolean} True if the plugin is authenticated for all required fields, false otherwise.
	*/
	const isPluginAuthenticated = (plugin) => {
	if (!plugin.authConfig \|\| plugin.authConfig.length === 0) {
	return false;
	}

	return plugin.authConfig.every((authFieldObj) => {
	const authFieldOptions = authFieldObj.authField.split('\|\|');
	let isFieldAuthenticated = false;

	for (const fieldOption of authFieldOptions) {
	const envValue = process.env[fieldOption];
	if (envValue && envValue.trim() !== '' && envValue !== 'user_provided') {
	isFieldAuthenticated = true;
	break;
	}
	}

	return isFieldAuthenticated;
	});
	};

	const getAvailablePluginsController = async (req, res) => {
	try {
	const cache = getLogStores(CacheKeys.CONFIG_STORE);
	const cachedPlugins = await cache.get(CacheKeys.PLUGINS);
	if (cachedPlugins) {
	res.status(200).json(cachedPlugins);
	return;
	}

	/** @type {{ filteredTools: string[], includedTools: string[] }} */
	const { filteredTools = [], includedTools = [] } = req.app.locals;
	const pluginManifest = await fs.readFile(req.app.locals.paths.pluginManifest, 'utf8');
	const jsonData = JSON.parse(pluginManifest);

	const uniquePlugins = filterUniquePlugins(jsonData);
	let authenticatedPlugins = [];
	for (const plugin of uniquePlugins) {
	authenticatedPlugins.push(
	isPluginAuthenticated(plugin) ? { ...plugin, authenticated: true } : plugin,
	);
	}

	let plugins = await addOpenAPISpecs(authenticatedPlugins);

	if (includedTools.length > 0) {
	plugins = plugins.filter((plugin) => includedTools.includes(plugin.pluginKey));
	} else {
	plugins = plugins.filter((plugin) => !filteredTools.includes(plugin.pluginKey));
	}

	await cache.set(CacheKeys.PLUGINS, plugins);
	res.status(200).json(plugins);
	} catch (error) {
	res.status(500).json({ message: error.message });
	}
	};

	/**
	* Retrieves and returns a list of available tools, either from a cache or by reading a plugin manifest file.
	*
	* This function first attempts to retrieve the list of tools from a cache. If the tools are not found in the cache,
	* it reads a plugin manifest file, filters for unique plugins, and determines if each plugin is authenticated.
	* Only plugins that are marked as available in the application's local state are included in the final list.
	* The resulting list of tools is then cached and sent to the client.
	*
	* @param {object} req - The request object, containing information about the HTTP request.
	* @param {object} res - The response object, used to send back the desired HTTP response.
	* @returns {Promise<void>} A promise that resolves when the function has completed.
	*/
	const getAvailableTools = async (req, res) => {
	try {
	const cache = getLogStores(CacheKeys.CONFIG_STORE);
	const cachedTools = await cache.get(CacheKeys.TOOLS);
	if (cachedTools) {
	res.status(200).json(cachedTools);
	return;
	}

	const pluginManifest = await fs.readFile(req.app.locals.paths.pluginManifest, 'utf8');

	const jsonData = JSON.parse(pluginManifest);
	/** @type {TPlugin[]} */
	const uniquePlugins = filterUniquePlugins(jsonData);

	const authenticatedPlugins = uniquePlugins.map((plugin) => {
	if (isPluginAuthenticated(plugin)) {
	return { ...plugin, authenticated: true };
	} else {
	return plugin;
	}
	});

	const tools = authenticatedPlugins.filter(
	(plugin) => req.app.locals.availableTools[plugin.pluginKey] !== undefined,
	);

	await cache.set(CacheKeys.TOOLS, tools);
	res.status(200).json(tools);
	} catch (error) {
	res.status(500).json({ message: error.message });
	}
	};

	module.exports = {
	getAvailableTools,
	getAvailablePluginsController,
	};