Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active
TypeScript aianthropicartifactsawsazurechatgptchatgpt-cloneclaudeclonedeepseekgeminigooglegpt-5librechatmcpo1openairesponses-apivisionwebui
🔧 refactor: Centralize Collection Checks for Permissions Migration (#9565)
Danny Avila85aa3e7d9cfe
diff --git a/config/migrate-agent-permissions.js b/config/migrate-agent-permissions.jsindex ac7ca5b76f..b206c648ca 100644--- a/config/migrate-agent-permissions.js+++ b/config/migrate-agent-permissions.js@@ -1,5 +1,6 @@const path = require('path');const { logger } = require('@librechat/data-schemas');+const { ensureRequiredCollectionsExist } = require('@librechat/api');const { AccessRoleIds, ResourceType, PrincipalType } = require('librechat-data-provider');const { GLOBAL_PROJECT_NAME } = require('librechat-data-provider').Constants;@@ -16,36 +17,11 @@ async function migrateAgentPermissionsEnhanced({ dryRun = true, batchSize = 100logger.info('Starting Enhanced Agent Permissions Migration', { dryRun, batchSize });- /** Ensurse `aclentries` collection exists for DocumentDB compatibility- * @param {import('mongoose').mongo.Db} db- * @param {string} collectionName- */- async function ensureCollectionExists(db, collectionName) {- try {- const collections = await db.listCollections({ name: collectionName }).toArray();- if (collections.length === 0) {- await db.createCollection(collectionName);- logger.info(`Created collection: ${collectionName}`);- } else {- logger.info(`Collection already exists: ${collectionName}`);- }- } catch (error) {- logger.error(`'Failed to check/create "${collectionName}" collection:`, error);- // If listCollections fails, try alternative approach- try {- // Try to access the collection directly - this will create it in MongoDB if it doesn't exist- await db.collection(collectionName).findOne({}, { projection: { _id: 1 } });- } catch (createError) {- logger.error(`Could not ensure collection ${collectionName} exists:`, createError);- }- }- }-const mongoose = require('mongoose');/** @type {import('mongoose').mongo.Db | undefined} */const db = mongoose.connection.db;if (db) {- await ensureCollectionExists(db, 'aclentries');+ await ensureRequiredCollectionsExist(db);}// Verify required roles existdiff --git a/config/migrate-prompt-permissions.js b/config/migrate-prompt-permissions.jsindex e1df481cd0..6018b16631 100644--- a/config/migrate-prompt-permissions.js+++ b/config/migrate-prompt-permissions.js@@ -1,5 +1,6 @@const path = require('path');const { logger } = require('@librechat/data-schemas');+const { ensureRequiredCollectionsExist } = require('@librechat/api');const { AccessRoleIds, ResourceType, PrincipalType } = require('librechat-data-provider');const { GLOBAL_PROJECT_NAME } = require('librechat-data-provider').Constants;@@ -16,36 +17,11 @@ async function migrateToPromptGroupPermissions({ dryRun = true, batchSize = 100logger.info('Starting PromptGroup Permissions Migration', { dryRun, batchSize });- /** Ensurse `aclentries` collection exists for DocumentDB compatibility- * @param {import('mongoose').mongo.Db} db- * @param {string} collectionName- */- async function ensureCollectionExists(db, collectionName) {- try {- const collections = await db.listCollections({ name: collectionName }).toArray();- if (collections.length === 0) {- await db.createCollection(collectionName);- logger.info(`Created collection: ${collectionName}`);- } else {- logger.info(`Collection already exists: ${collectionName}`);- }- } catch (error) {- logger.error(`'Failed to check/create "${collectionName}" collection:`, error);- // If listCollections fails, try alternative approach- try {- // Try to access the collection directly - this will create it in MongoDB if it doesn't exist- await db.collection(collectionName).findOne({}, { projection: { _id: 1 } });- } catch (createError) {- logger.error(`Could not ensure collection ${collectionName} exists:`, createError);- }- }- }-const mongoose = require('mongoose');/** @type {import('mongoose').mongo.Db | undefined} */const db = mongoose.connection.db;if (db) {- await ensureCollectionExists(db, 'aclentries');+ await ensureRequiredCollectionsExist(db);}// Verify required roles existdiff --git a/packages/api/src/agents/migration.ts b/packages/api/src/agents/migration.tsindex e9b76c3b9b..f8cad88b66 100644--- a/packages/api/src/agents/migration.ts+++ b/packages/api/src/agents/migration.ts@@ -1,7 +1,8 @@import { logger } from '@librechat/data-schemas';import { AccessRoleIds, ResourceType, PrincipalType, Constants } from 'librechat-data-provider';+import { ensureRequiredCollectionsExist } from '../db/utils';import type { AccessRoleMethods, IAgent } from '@librechat/data-schemas';-import type { Model, Mongoose, mongo } from 'mongoose';+import type { Model, Mongoose } from 'mongoose';const { GLOBAL_PROJECT_NAME } = Constants;@@ -54,31 +55,9 @@ export async function checkAgentPermissionsMigration({logger.debug('Checking if agent permissions migration is needed');try {- /** Ensurse `aclentries` collection exists for DocumentDB compatibility */- async function ensureCollectionExists(db: mongo.Db, collectionName: string) {- try {- const collections = await db.listCollections({ name: collectionName }).toArray();- if (collections.length === 0) {- await db.createCollection(collectionName);- logger.info(`Created collection: ${collectionName}`);- } else {- logger.debug(`Collection already exists: ${collectionName}`);- }- } catch (error) {- logger.error(`'Failed to check/create "${collectionName}" collection:`, error);- // If listCollections fails, try alternative approach- try {- // Try to access the collection directly - this will create it in MongoDB if it doesn't exist- await db.collection(collectionName).findOne({}, { projection: { _id: 1 } });- } catch (createError) {- logger.error(`Could not ensure collection ${collectionName} exists:`, createError);- }- }- }-const db = mongoose.connection.db;if (db) {- await ensureCollectionExists(db, 'aclentries');+ await ensureRequiredCollectionsExist(db);}// Verify required roles existdiff --git a/packages/api/src/db/utils.ts b/packages/api/src/db/utils.tsnew file mode 100644index 0000000000..b53478d045--- /dev/null+++ b/packages/api/src/db/utils.ts@@ -0,0 +1,54 @@+import { logger } from '@librechat/data-schemas';+import type { mongo } from 'mongoose';++/**+ * Ensures that a collection exists in the database.+ * For DocumentDB compatibility, it tries multiple approaches.+ * @param db - The MongoDB database instance+ * @param collectionName - The name of the collection to ensure exists+ */+export async function ensureCollectionExists(db: mongo.Db, collectionName: string): Promise<void> {+ try {+ const collections = await db.listCollections({ name: collectionName }).toArray();+ if (collections.length === 0) {+ await db.createCollection(collectionName);+ logger.info(`Created collection: ${collectionName}`);+ } else {+ logger.debug(`Collection already exists: ${collectionName}`);+ }+ } catch (error) {+ logger.error(`Failed to check/create "${collectionName}" collection:`, error);+ // If listCollections fails, try alternative approach+ try {+ // Try to access the collection directly - this will create it in MongoDB if it doesn't exist+ await db.collection(collectionName).findOne({}, { projection: { _id: 1 } });+ } catch (createError) {+ logger.error(`Could not ensure collection ${collectionName} exists:`, createError);+ }+ }+}++/**+ * Ensures that all required collections exist for the permission system.+ * This includes aclentries, groups, accessroles, and any other collections+ * needed for migrations and permission checks.+ * @param db - The MongoDB database instance+ */+export async function ensureRequiredCollectionsExist(db: mongo.Db): Promise<void> {+ const requiredCollections = [+ 'aclentries', // ACL permission entries+ 'groups', // User groups+ 'accessroles', // Access roles for permissions+ 'agents', // Agents collection+ 'promptgroups', // Prompt groups collection+ 'projects', // Projects collection+ ];++ logger.debug('Ensuring required collections exist for permission system');++ for (const collectionName of requiredCollections) {+ await ensureCollectionExists(db, collectionName);+ }++ logger.debug('All required collections have been checked/created');+}diff --git a/packages/api/src/index.ts b/packages/api/src/index.tsindex d0c797abaf..e9cbfd1ff6 100644--- a/packages/api/src/index.ts+++ b/packages/api/src/index.ts@@ -11,6 +11,7 @@ export * from './mcp/zod';export * from './format';export * from './mcp/utils';export * from './utils';+export * from './db/utils';/* OAuth */export * from './oauth';/* Crypto */diff --git a/packages/api/src/prompts/migration.ts b/packages/api/src/prompts/migration.tsindex 938d8ca8f5..40f0a585d7 100644--- a/packages/api/src/prompts/migration.ts+++ b/packages/api/src/prompts/migration.ts@@ -1,7 +1,8 @@import { logger } from '@librechat/data-schemas';import { AccessRoleIds, ResourceType, PrincipalType, Constants } from 'librechat-data-provider';+import { ensureRequiredCollectionsExist } from '../db/utils';import type { AccessRoleMethods, IPromptGroupDocument } from '@librechat/data-schemas';-import type { Model, Mongoose, mongo } from 'mongoose';+import type { Model, Mongoose } from 'mongoose';const { GLOBAL_PROJECT_NAME } = Constants;@@ -52,32 +53,10 @@ export async function checkPromptPermissionsMigration({logger.debug('Checking if prompt permissions migration is needed');try {- /** Ensurse `aclentries` collection exists for DocumentDB compatibility */- async function ensureCollectionExists(db: mongo.Db, collectionName: string) {- try {- const collections = await db.listCollections({ name: collectionName }).toArray();- if (collections.length === 0) {- await db.createCollection(collectionName);- logger.info(`Created collection: ${collectionName}`);- } else {- logger.debug(`Collection already exists: ${collectionName}`);- }- } catch (error) {- logger.error(`'Failed to check/create "${collectionName}" collection:`, error);- // If listCollections fails, try alternative approach- try {- // Try to access the collection directly - this will create it in MongoDB if it doesn't exist- await db.collection(collectionName).findOne({}, { projection: { _id: 1 } });- } catch (createError) {- logger.error(`Could not ensure collection ${collectionName} exists:`, createError);- }- }- }-/** Native MongoDB database instance */const db = mongoose.connection.db;if (db) {- await ensureCollectionExists(db, 'aclentries');+ await ensureRequiredCollectionsExist(db);}// Verify required roles existdiff --git a/packages/data-schemas/src/methods/token.spec.ts b/packages/data-schemas/src/methods/token.spec.tsindex bb9824187d..2480619984 100644--- a/packages/data-schemas/src/methods/token.spec.ts+++ b/packages/data-schemas/src/methods/token.spec.ts@@ -118,7 +118,7 @@ describe('Token Methods - Detailed Tests', () => {{token: 'token-3',userId: user1Id,- email: '[email protected]',+ email: '[email protected]', // Different email for realistic scenariocreatedAt: new Date(),expiresAt: new Date(Date.now() + 3600000),},@@ -164,7 +164,7 @@ describe('Token Methods - Detailed Tests', () => {});expect(found).toBeDefined();- expect(found?.token).toBe('token-1'); // Should find first matching+ expect(found?.token).toBe('token-1'); // Should find the only token matching both criteria});test('should return null for non-existent token', async () => {