File size: 9,283 Bytes
f0743f4 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | import { AuthType, EToolResources } from 'librechat-data-provider';
import type { TPlugin } from 'librechat-data-provider';
import { filterUniquePlugins, checkPluginAuth, getToolkitKey } from './format';
describe('format.ts helper functions', () => {
describe('filterUniquePlugins', () => {
it('should return empty array when plugins is undefined', () => {
const result = filterUniquePlugins(undefined);
expect(result).toEqual([]);
});
it('should return empty array when plugins is empty', () => {
const result = filterUniquePlugins([]);
expect(result).toEqual([]);
});
it('should filter out duplicate plugins based on pluginKey', () => {
const plugins: TPlugin[] = [
{ name: 'Plugin1', pluginKey: 'key1', description: 'First plugin' },
{ name: 'Plugin2', pluginKey: 'key2', description: 'Second plugin' },
{ name: 'Plugin1 Duplicate', pluginKey: 'key1', description: 'Duplicate of first' },
{ name: 'Plugin3', pluginKey: 'key3', description: 'Third plugin' },
];
const result = filterUniquePlugins(plugins);
expect(result).toHaveLength(3);
expect(result[0].pluginKey).toBe('key1');
expect(result[1].pluginKey).toBe('key2');
expect(result[2].pluginKey).toBe('key3');
// The first occurrence should be kept
expect(result[0].name).toBe('Plugin1');
});
it('should handle plugins with identical data', () => {
const plugin: TPlugin = { name: 'Plugin', pluginKey: 'key', description: 'Test' };
const plugins: TPlugin[] = [plugin, plugin, plugin];
const result = filterUniquePlugins(plugins);
expect(result).toHaveLength(1);
expect(result[0]).toEqual(plugin);
});
});
describe('checkPluginAuth', () => {
const originalEnv = process.env;
beforeEach(() => {
process.env = { ...originalEnv };
});
afterEach(() => {
process.env = originalEnv;
});
it('should return false when plugin is undefined', () => {
const result = checkPluginAuth(undefined);
expect(result).toBe(false);
});
it('should return false when authConfig is undefined', () => {
const plugin: TPlugin = { name: 'Test', pluginKey: 'test', description: 'Test plugin' };
const result = checkPluginAuth(plugin);
expect(result).toBe(false);
});
it('should return false when authConfig is empty array', () => {
const plugin: TPlugin = {
name: 'Test',
pluginKey: 'test',
description: 'Test plugin',
authConfig: [],
};
const result = checkPluginAuth(plugin);
expect(result).toBe(false);
});
it('should return true when all required auth fields have valid env values', () => {
process.env.API_KEY = 'valid-key';
process.env.SECRET_KEY = 'valid-secret';
const plugin: TPlugin = {
name: 'Test',
pluginKey: 'test',
description: 'Test plugin',
authConfig: [
{ authField: 'API_KEY', label: 'API Key', description: 'API Key' },
{ authField: 'SECRET_KEY', label: 'Secret Key', description: 'Secret Key' },
],
};
const result = checkPluginAuth(plugin);
expect(result).toBe(true);
});
it('should return false when any required auth field is missing', () => {
process.env.API_KEY = 'valid-key';
// SECRET_KEY is not set
const plugin: TPlugin = {
name: 'Test',
pluginKey: 'test',
description: 'Test plugin',
authConfig: [
{ authField: 'API_KEY', label: 'API Key', description: 'API Key' },
{ authField: 'SECRET_KEY', label: 'Secret Key', description: 'Secret Key' },
],
};
const result = checkPluginAuth(plugin);
expect(result).toBe(false);
});
it('should return false when auth field value is empty string', () => {
process.env.API_KEY = '';
const plugin: TPlugin = {
name: 'Test',
pluginKey: 'test',
description: 'Test plugin',
authConfig: [{ authField: 'API_KEY', label: 'API Key', description: 'API Key' }],
};
const result = checkPluginAuth(plugin);
expect(result).toBe(false);
});
it('should return false when auth field value is whitespace only', () => {
process.env.API_KEY = ' ';
const plugin: TPlugin = {
name: 'Test',
pluginKey: 'test',
description: 'Test plugin',
authConfig: [{ authField: 'API_KEY', label: 'API Key', description: 'API Key' }],
};
const result = checkPluginAuth(plugin);
expect(result).toBe(false);
});
it('should return false when auth field value is USER_PROVIDED', () => {
process.env.API_KEY = AuthType.USER_PROVIDED;
const plugin: TPlugin = {
name: 'Test',
pluginKey: 'test',
description: 'Test plugin',
authConfig: [{ authField: 'API_KEY', label: 'API Key', description: 'API Key' }],
};
const result = checkPluginAuth(plugin);
expect(result).toBe(false);
});
it('should handle alternate auth fields with || separator', () => {
process.env.ALTERNATE_KEY = 'valid-key';
const plugin: TPlugin = {
name: 'Test',
pluginKey: 'test',
description: 'Test plugin',
authConfig: [
{ authField: 'PRIMARY_KEY||ALTERNATE_KEY', label: 'API Key', description: 'API Key' },
],
};
const result = checkPluginAuth(plugin);
expect(result).toBe(true);
});
it('should return true when at least one alternate auth field is valid', () => {
process.env.PRIMARY_KEY = '';
process.env.ALTERNATE_KEY = 'valid-key';
process.env.THIRD_KEY = AuthType.USER_PROVIDED;
const plugin: TPlugin = {
name: 'Test',
pluginKey: 'test',
description: 'Test plugin',
authConfig: [
{
authField: 'PRIMARY_KEY||ALTERNATE_KEY||THIRD_KEY',
label: 'API Key',
description: 'API Key',
},
],
};
const result = checkPluginAuth(plugin);
expect(result).toBe(true);
});
});
describe('getToolkitKey', () => {
it('should return undefined when toolName is undefined', () => {
const toolkits: TPlugin[] = [
{ name: 'Toolkit1', pluginKey: 'toolkit1', description: 'Test toolkit' },
];
const result = getToolkitKey({ toolkits, toolName: undefined });
expect(result).toBeUndefined();
});
it('should return undefined when toolName is empty string', () => {
const toolkits: TPlugin[] = [
{ name: 'Toolkit1', pluginKey: 'toolkit1', description: 'Test toolkit' },
];
const result = getToolkitKey({ toolkits, toolName: '' });
expect(result).toBeUndefined();
});
it('should return undefined when no matching toolkit is found', () => {
const toolkits: TPlugin[] = [
{ name: 'Toolkit1', pluginKey: 'toolkit1', description: 'Test toolkit' },
{ name: 'Toolkit2', pluginKey: 'toolkit2', description: 'Test toolkit' },
];
const result = getToolkitKey({ toolkits, toolName: 'nonexistent_tool' });
expect(result).toBeUndefined();
});
it('should match toolkit when toolName starts with pluginKey', () => {
const toolkits: TPlugin[] = [
{ name: 'Toolkit1', pluginKey: 'toolkit1', description: 'Test toolkit' },
{ name: 'Toolkit2', pluginKey: 'toolkit2', description: 'Test toolkit' },
];
const result = getToolkitKey({ toolkits, toolName: 'toolkit2_function' });
expect(result).toBe('toolkit2');
});
it('should handle image_edit tools with suffix matching', () => {
const toolkits: TPlugin[] = [
{ name: 'Image Editor', pluginKey: 'image_edit_v1', description: 'Image editing' },
{ name: 'Image Editor 2', pluginKey: 'image_edit_v2', description: 'Image editing v2' },
];
const result = getToolkitKey({
toolkits,
toolName: `${EToolResources.image_edit}_function_v2`,
});
expect(result).toBe('image_edit_v2');
});
it('should match the first toolkit when multiple matches are possible', () => {
const toolkits: TPlugin[] = [
{ name: 'Toolkit', pluginKey: 'toolkit', description: 'Base toolkit' },
{ name: 'Toolkit Extended', pluginKey: 'toolkit_extended', description: 'Extended' },
];
const result = getToolkitKey({ toolkits, toolName: 'toolkit_function' });
expect(result).toBe('toolkit');
});
it('should handle empty toolkits array', () => {
const toolkits: TPlugin[] = [];
const result = getToolkitKey({ toolkits, toolName: 'any_tool' });
expect(result).toBeUndefined();
});
it('should handle complex plugin keys with underscores', () => {
const toolkits: TPlugin[] = [
{
name: 'Complex Toolkit',
pluginKey: 'complex_toolkit_with_underscores',
description: 'Complex',
},
];
const result = getToolkitKey({
toolkits,
toolName: 'complex_toolkit_with_underscores_function',
});
expect(result).toBe('complex_toolkit_with_underscores');
});
});
});
|