File size: 20,396 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 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 | import mongoose from 'mongoose';
import { MongoMemoryServer } from 'mongodb-memory-server';
import { logger, balanceSchema } from '@librechat/data-schemas';
import type { NextFunction, Request as ServerRequest, Response as ServerResponse } from 'express';
import type { IBalance } from '@librechat/data-schemas';
import { createSetBalanceConfig } from './balance';
jest.mock('@librechat/data-schemas', () => ({
...jest.requireActual('@librechat/data-schemas'),
logger: {
error: jest.fn(),
},
}));
let mongoServer: MongoMemoryServer;
let Balance: mongoose.Model<IBalance>;
beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
const mongoUri = mongoServer.getUri();
Balance = mongoose.models.Balance || mongoose.model('Balance', balanceSchema);
await mongoose.connect(mongoUri);
});
afterAll(async () => {
await mongoose.disconnect();
await mongoServer.stop();
});
beforeEach(async () => {
await mongoose.connection.dropDatabase();
jest.clearAllMocks();
jest.restoreAllMocks();
});
describe('createSetBalanceConfig', () => {
const createMockRequest = (userId: string | mongoose.Types.ObjectId): Partial<ServerRequest> => ({
user: {
_id: userId,
id: userId.toString(),
email: 'test@example.com',
},
});
const createMockResponse = (): Partial<ServerResponse> => ({
status: jest.fn().mockReturnThis(),
json: jest.fn().mockReturnThis(),
});
const mockNext: NextFunction = jest.fn();
describe('Basic Functionality', () => {
test('should create balance record for new user with start balance', async () => {
const userId = new mongoose.Types.ObjectId();
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(getAppConfig).toHaveBeenCalled();
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord).toBeTruthy();
expect(balanceRecord?.tokenCredits).toBe(1000);
expect(balanceRecord?.autoRefillEnabled).toBe(true);
expect(balanceRecord?.refillIntervalValue).toBe(30);
expect(balanceRecord?.refillIntervalUnit).toBe('days');
expect(balanceRecord?.refillAmount).toBe(500);
expect(balanceRecord?.lastRefill).toBeInstanceOf(Date);
});
test('should skip if balance config is not enabled', async () => {
const userId = new mongoose.Types.ObjectId();
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: false,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord).toBeNull();
});
test('should skip if startBalance is null', async () => {
const userId = new mongoose.Types.ObjectId();
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: null,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord).toBeNull();
});
test('should handle user._id as string', async () => {
const userId = new mongoose.Types.ObjectId().toString();
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord).toBeTruthy();
expect(balanceRecord?.tokenCredits).toBe(1000);
});
test('should skip if user is not present in request', async () => {
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = {} as ServerRequest;
const res = createMockResponse();
await middleware(req, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
expect(getAppConfig).toHaveBeenCalled();
});
});
describe('Edge Case: Auto-refill without lastRefill', () => {
test('should initialize lastRefill when enabling auto-refill for existing user without lastRefill', async () => {
const userId = new mongoose.Types.ObjectId();
// Create existing balance record without lastRefill
// Note: We need to unset lastRefill after creation since the schema has a default
const doc = await Balance.create({
user: userId,
tokenCredits: 500,
autoRefillEnabled: false,
});
// Remove lastRefill to simulate existing user without it
await Balance.updateOne({ _id: doc._id }, { $unset: { lastRefill: 1 } });
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
const beforeTime = new Date();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
const afterTime = new Date();
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord).toBeTruthy();
expect(balanceRecord?.tokenCredits).toBe(500); // Should not change existing credits
expect(balanceRecord?.autoRefillEnabled).toBe(true);
expect(balanceRecord?.lastRefill).toBeInstanceOf(Date);
// Verify lastRefill was set to current time
const lastRefillTime = balanceRecord?.lastRefill?.getTime() || 0;
expect(lastRefillTime).toBeGreaterThanOrEqual(beforeTime.getTime());
expect(lastRefillTime).toBeLessThanOrEqual(afterTime.getTime());
});
test('should not update lastRefill if it already exists', async () => {
const userId = new mongoose.Types.ObjectId();
const existingLastRefill = new Date('2024-01-01');
// Create existing balance record with lastRefill
await Balance.create({
user: userId,
tokenCredits: 500,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
lastRefill: existingLastRefill,
});
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord?.lastRefill?.getTime()).toBe(existingLastRefill.getTime());
});
test('should handle existing user with auto-refill enabled but missing lastRefill', async () => {
const userId = new mongoose.Types.ObjectId();
// Create a balance record with auto-refill enabled but missing lastRefill
// This simulates the exact edge case reported by the user
const doc = await Balance.create({
user: userId,
tokenCredits: 500,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
});
// Remove lastRefill to simulate the edge case
await Balance.updateOne({ _id: doc._id }, { $unset: { lastRefill: 1 } });
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord).toBeTruthy();
expect(balanceRecord?.autoRefillEnabled).toBe(true);
expect(balanceRecord?.lastRefill).toBeInstanceOf(Date);
// This should have fixed the issue - user should no longer get the error
});
test('should not set lastRefill when auto-refill is disabled', async () => {
const userId = new mongoose.Types.ObjectId();
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: false,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord).toBeTruthy();
expect(balanceRecord?.tokenCredits).toBe(1000);
expect(balanceRecord?.autoRefillEnabled).toBe(false);
// lastRefill should have default value from schema
expect(balanceRecord?.lastRefill).toBeInstanceOf(Date);
});
});
describe('Update Scenarios', () => {
test('should update auto-refill settings for existing user', async () => {
const userId = new mongoose.Types.ObjectId();
// Create existing balance record
await Balance.create({
user: userId,
tokenCredits: 500,
autoRefillEnabled: false,
refillIntervalValue: 7,
refillIntervalUnit: 'days',
refillAmount: 100,
});
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord?.tokenCredits).toBe(500); // Should not change
expect(balanceRecord?.autoRefillEnabled).toBe(true);
expect(balanceRecord?.refillIntervalValue).toBe(30);
expect(balanceRecord?.refillIntervalUnit).toBe('days');
expect(balanceRecord?.refillAmount).toBe(500);
});
test('should not update if values are already the same', async () => {
const userId = new mongoose.Types.ObjectId();
const lastRefillTime = new Date();
// Create existing balance record with same values
await Balance.create({
user: userId,
tokenCredits: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
lastRefill: lastRefillTime,
});
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
// Spy on Balance.findOneAndUpdate to verify it's not called
const updateSpy = jest.spyOn(Balance, 'findOneAndUpdate');
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
expect(updateSpy).not.toHaveBeenCalled();
});
test('should set tokenCredits for user with null tokenCredits', async () => {
const userId = new mongoose.Types.ObjectId();
// Create balance record with null tokenCredits
await Balance.create({
user: userId,
tokenCredits: null,
});
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 2000,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord?.tokenCredits).toBe(2000);
});
});
describe('Error Handling', () => {
test('should handle database errors gracefully', async () => {
const userId = new mongoose.Types.ObjectId();
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const dbError = new Error('Database error');
// Mock Balance.findOne to throw an error
jest.spyOn(Balance, 'findOne').mockImplementationOnce((() => {
return {
lean: jest.fn().mockRejectedValue(dbError),
};
}) as unknown as mongoose.Model<IBalance>['findOne']);
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(logger.error).toHaveBeenCalledWith('Error setting user balance:', dbError);
expect(mockNext).toHaveBeenCalledWith(dbError);
});
test('should handle getAppConfig errors', async () => {
const userId = new mongoose.Types.ObjectId();
const configError = new Error('Config error');
const getAppConfig = jest.fn().mockRejectedValue(configError);
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(logger.error).toHaveBeenCalledWith('Error setting user balance:', configError);
expect(mockNext).toHaveBeenCalledWith(configError);
});
test('should handle invalid auto-refill configuration', async () => {
const userId = new mongoose.Types.ObjectId();
// Missing required auto-refill fields
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: null, // Invalid
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord).toBeTruthy();
expect(balanceRecord?.tokenCredits).toBe(1000);
// Auto-refill fields should not be updated due to invalid config
expect(balanceRecord?.autoRefillEnabled).toBe(false);
});
});
describe('Concurrent Updates', () => {
test('should handle concurrent middleware calls for same user', async () => {
const userId = new mongoose.Types.ObjectId();
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 30,
refillIntervalUnit: 'days',
refillAmount: 500,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res1 = createMockResponse();
const res2 = createMockResponse();
const mockNext1 = jest.fn();
const mockNext2 = jest.fn();
// Run middleware concurrently
await Promise.all([
middleware(req as ServerRequest, res1 as ServerResponse, mockNext1),
middleware(req as ServerRequest, res2 as ServerResponse, mockNext2),
]);
expect(mockNext1).toHaveBeenCalled();
expect(mockNext2).toHaveBeenCalled();
// Should only have one balance record
const balanceRecords = await Balance.find({ user: userId });
expect(balanceRecords).toHaveLength(1);
expect(balanceRecords[0].tokenCredits).toBe(1000);
});
});
describe('Integration with Different refillIntervalUnits', () => {
test.each(['seconds', 'minutes', 'hours', 'days', 'weeks', 'months'])(
'should handle refillIntervalUnit: %s',
async (unit) => {
const userId = new mongoose.Types.ObjectId();
const getAppConfig = jest.fn().mockResolvedValue({
balance: {
enabled: true,
startBalance: 1000,
autoRefillEnabled: true,
refillIntervalValue: 10,
refillIntervalUnit: unit,
refillAmount: 100,
},
});
const middleware = createSetBalanceConfig({
getAppConfig,
Balance,
});
const req = createMockRequest(userId);
const res = createMockResponse();
await middleware(req as ServerRequest, res as ServerResponse, mockNext);
const balanceRecord = await Balance.findOne({ user: userId });
expect(balanceRecord?.refillIntervalUnit).toBe(unit);
expect(balanceRecord?.refillIntervalValue).toBe(10);
expect(balanceRecord?.lastRefill).toBeInstanceOf(Date);
},
);
});
});
|