🐘 feat: FerretDB Compatibility (#11769)

* feat: replace unsupported MongoDB aggregation operators for FerretDB compatibility

Replace $lookup, $unwind, $sample, $replaceRoot, and $addFields aggregation
stages which are unsupported on FerretDB v2.x (postgres-documentdb backend).

- Prompt.js: Replace $lookup/$unwind/$project pipelines with find().select().lean()
  + attachProductionPrompts() batch helper. Replace $group/$replaceRoot/$sample
  in getRandomPromptGroups with distinct() + Fisher-Yates shuffle.
- Agent/Prompt migration scripts: Replace $lookup anti-join pattern with
  distinct() + $nin two-step queries for finding un-migrated resources.

All replacement patterns verified against FerretDB v2.7.0.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix: use $pullAll for simple array removals, fix memberIds type mismatches

Replace $pull with $pullAll for exact-value scalar array removals. Both
operators work on MongoDB and FerretDB, but $pullAll is more explicit for
exact matching (no condition expressions).

Fix critical type mismatch bugs where ObjectId values were used against
String[] memberIds arrays in Group queries:
- config/delete-user.js: use string uid instead of ObjectId user._id
- e2e/setup/cleanupUser.ts: convert userId.toString() before query

Harden PermissionService.bulkUpdateResourcePermissions abort handling to
prevent crash when abortTransaction is called after commitTransaction.

All changes verified against FerretDB v2.7.0 and MongoDB Memory Server.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix: harden transaction support probe for FerretDB compatibility

Commit the transaction before aborting in supportsTransactions probe, and
wrap abortTransaction in try-catch to prevent crashes when abort is called
after a successful commit (observed behavior on FerretDB).

Co-authored-by: Cursor <cursoragent@cursor.com>

* feat: add FerretDB compatibility test suite, retry utilities, and CI config

Add comprehensive FerretDB integration test suite covering:
- $pullAll scalar array operations
- $pull with subdocument conditions
- $lookup replacement (find + manual join)
- $sample replacement (distinct + Fisher-Yates)
- $bit and $bitsAllSet operations
- Migration anti-join pattern
- Multi-tenancy (useDb, scaling, write amplification)
- Sharding proof-of-concept
- Production operations (backup/restore, schema migration, deadlock retry)

Add production retryWithBackoff utility for deadlock recovery during
concurrent index creation on FerretDB/DocumentDB backends.

Add UserController.spec.js tests for deleteUserController (runs in CI).

Configure jest and eslint to isolate FerretDB tests from CI pipelines:
- packages/data-schemas/jest.config.mjs: ignore misc/ directory
- eslint.config.mjs: ignore packages/data-schemas/misc/

Include Docker Compose config for local FerretDB v2.7 + postgres-documentdb,
dedicated jest/tsconfig for the test files, and multi-tenancy findings doc.

Co-authored-by: Cursor <cursoragent@cursor.com>

* style: brace formatting in aclEntry.ts modifyPermissionBits

Co-authored-by: Cursor <cursoragent@cursor.com>

* refactor: reorganize retry utilities and update imports

- Moved retryWithBackoff utility to a new file `retry.ts` for better structure.
- Updated imports in `orgOperations.ferretdb.spec.ts` to reflect the new location of retry utilities.
- Removed old import statement for retryWithBackoff from index.ts to streamline exports.

* test: add $pullAll coverage for ConversationTag and PermissionService

Add integration tests for deleteConversationTag verifying $pullAll
removes tags from conversations correctly, and for
syncUserEntraGroupMemberships verifying $pullAll removes user from
non-matching Entra groups while preserving local group membership.

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Danny Avila 2026-02-13 02:14:34 -05:00
parent dc489e7b25
commit 3398f6a17a
No known key found for this signature in database
GPG key ID: BF31EEB2C5CA0956
35 changed files with 4727 additions and 347 deletions

View file

@ -536,7 +536,7 @@ const syncUserEntraGroupMemberships = async (user, accessToken, session = null)
memberIds: user.idOnTheSource,
idOnTheSource: { $nin: allGroupIds },
},
{ $pull: { memberIds: user.idOnTheSource } },
{ $pullAll: { memberIds: [user.idOnTheSource] } },
sessionOptions,
);
} catch (error) {
@ -788,7 +788,15 @@ const bulkUpdateResourcePermissions = async ({
return results;
} catch (error) {
if (shouldEndSession && supportsTransactions) {
await localSession.abortTransaction();
try {
await localSession.abortTransaction();
} catch (transactionError) {
/** best-effort abort; may fail if commit already succeeded */
logger.error(
`[PermissionService.bulkUpdateResourcePermissions] Error aborting transaction:`,
transactionError,
);
}
}
logger.error(`[PermissionService.bulkUpdateResourcePermissions] Error: ${error.message}`);
throw error;

View file

@ -9,6 +9,7 @@ const {
} = require('librechat-data-provider');
const {
bulkUpdateResourcePermissions,
syncUserEntraGroupMemberships,
getEffectivePermissions,
findAccessibleResources,
getAvailableRoles,
@ -26,7 +27,11 @@ jest.mock('@librechat/data-schemas', () => ({
// Mock GraphApiService to prevent config loading issues
jest.mock('~/server/services/GraphApiService', () => ({
entraIdPrincipalFeatureEnabled: jest.fn().mockReturnValue(false),
getUserOwnedEntraGroups: jest.fn().mockResolvedValue([]),
getUserEntraGroups: jest.fn().mockResolvedValue([]),
getGroupMembers: jest.fn().mockResolvedValue([]),
getGroupOwners: jest.fn().mockResolvedValue([]),
}));
// Mock the logger
@ -1933,3 +1938,134 @@ describe('PermissionService', () => {
});
});
});
describe('syncUserEntraGroupMemberships - $pullAll on Group.memberIds', () => {
const {
entraIdPrincipalFeatureEnabled,
getUserEntraGroups,
} = require('~/server/services/GraphApiService');
const { Group } = require('~/db/models');
const userEntraId = 'entra-user-001';
const user = {
openidId: 'openid-sub-001',
idOnTheSource: userEntraId,
provider: 'openid',
};
beforeEach(async () => {
await Group.deleteMany({});
entraIdPrincipalFeatureEnabled.mockReturnValue(true);
});
afterEach(() => {
entraIdPrincipalFeatureEnabled.mockReturnValue(false);
getUserEntraGroups.mockResolvedValue([]);
});
it('should add user to matching Entra groups and remove from non-matching ones', async () => {
await Group.create([
{ name: 'Group A', source: 'entra', idOnTheSource: 'entra-group-a', memberIds: [] },
{
name: 'Group B',
source: 'entra',
idOnTheSource: 'entra-group-b',
memberIds: [userEntraId],
},
{
name: 'Group C',
source: 'entra',
idOnTheSource: 'entra-group-c',
memberIds: [userEntraId],
},
]);
getUserEntraGroups.mockResolvedValue(['entra-group-a', 'entra-group-c']);
await syncUserEntraGroupMemberships(user, 'fake-access-token');
const groups = await Group.find({ source: 'entra' }).sort({ name: 1 }).lean();
expect(groups[0].memberIds).toContain(userEntraId);
expect(groups[1].memberIds).not.toContain(userEntraId);
expect(groups[2].memberIds).toContain(userEntraId);
});
it('should not modify groups when API returns empty list (early return)', async () => {
await Group.create([
{
name: 'Group X',
source: 'entra',
idOnTheSource: 'entra-x',
memberIds: [userEntraId, 'other-user'],
},
{ name: 'Group Y', source: 'entra', idOnTheSource: 'entra-y', memberIds: [userEntraId] },
]);
getUserEntraGroups.mockResolvedValue([]);
await syncUserEntraGroupMemberships(user, 'fake-token');
const groups = await Group.find({ source: 'entra' }).sort({ name: 1 }).lean();
expect(groups[0].memberIds).toContain(userEntraId);
expect(groups[0].memberIds).toContain('other-user');
expect(groups[1].memberIds).toContain(userEntraId);
});
it('should remove user from groups not in the API response via $pullAll', async () => {
await Group.create([
{ name: 'Keep', source: 'entra', idOnTheSource: 'entra-keep', memberIds: [userEntraId] },
{
name: 'Remove',
source: 'entra',
idOnTheSource: 'entra-remove',
memberIds: [userEntraId, 'other-user'],
},
]);
getUserEntraGroups.mockResolvedValue(['entra-keep']);
await syncUserEntraGroupMemberships(user, 'fake-token');
const keep = await Group.findOne({ idOnTheSource: 'entra-keep' }).lean();
const remove = await Group.findOne({ idOnTheSource: 'entra-remove' }).lean();
expect(keep.memberIds).toContain(userEntraId);
expect(remove.memberIds).not.toContain(userEntraId);
expect(remove.memberIds).toContain('other-user');
});
it('should not modify local groups', async () => {
await Group.create([
{ name: 'Local Group', source: 'local', memberIds: [userEntraId] },
{
name: 'Entra Group',
source: 'entra',
idOnTheSource: 'entra-only',
memberIds: [userEntraId],
},
]);
getUserEntraGroups.mockResolvedValue([]);
await syncUserEntraGroupMemberships(user, 'fake-token');
const localGroup = await Group.findOne({ source: 'local' }).lean();
expect(localGroup.memberIds).toContain(userEntraId);
});
it('should early-return when feature is disabled', async () => {
entraIdPrincipalFeatureEnabled.mockReturnValue(false);
await Group.create({
name: 'Should Not Touch',
source: 'entra',
idOnTheSource: 'entra-safe',
memberIds: [userEntraId],
});
getUserEntraGroups.mockResolvedValue([]);
await syncUserEntraGroupMemberships(user, 'fake-token');
const group = await Group.findOne({ idOnTheSource: 'entra-safe' }).lean();
expect(group.memberIds).toContain(userEntraId);
});
});