diff --git a/lib/services/gridfs.js b/lib/services/gridfs.js index d8f2847f9..78eb4eec0 100644 --- a/lib/services/gridfs.js +++ b/lib/services/gridfs.js @@ -14,7 +14,7 @@ class GridFsStorage { * Store an incoming file in GridFS. * @param {object} req - express request object * @param {object} file - multer file descriptor - * @param {Function} cb - callback(error, info) + * @param {(error: Error | null, info?: object) => void} cb - callback(error, info) */ _handleFile(req, file, cb) { const metadata = { @@ -45,10 +45,12 @@ class GridFsStorage { * Remove a file from GridFS. * @param {object} req - express request object * @param {object} file - multer file descriptor with id - * @param {Function} cb - callback(error) + * @param {(error: Error | null) => void} cb - callback(error) */ _removeFile(req, file, cb) { - this.bucket.delete(file.id, cb); + // The driver's `delete(id, options)` returns a promise and never calls a + // callback: settle multer's `cb` from the promise, or the request hangs. + this.bucket.delete(file.id).then(() => cb(null), cb); } } @@ -66,14 +68,14 @@ const getStorage = () => { * Store a buffer in GridFS programmatically (no HTTP upload). * @param {Buffer} buffer - File content * @param {string} filename - Unique filename (e.g., 'snapshot-abc123.jpeg') - * @param {string} contentType - MIME type (e.g., 'image/jpeg') + * @param {string} contentType - MIME type (e.g., 'image/jpeg'), stored as `metadata.contentType` * @param {Object} metadata - GridFS metadata (kind, user, organizationId, etc.) * @returns {Promise} The stored file document */ const createFromBuffer = (buffer, filename, contentType, metadata = {}) => new Promise((resolve, reject) => { const bucket = new mongoose.mongo.GridFSBucket(mongoose.connection.db, { bucketName: 'uploads' }); const id = new mongoose.Types.ObjectId(); - const uploadStream = bucket.openUploadStreamWithId(id, filename, { contentType, metadata }); + const uploadStream = bucket.openUploadStreamWithId(id, filename, { metadata: { ...metadata, contentType } }); const readable = Readable.from([buffer]); readable.on('error', reject); diff --git a/lib/services/tests/gridfs.unit.tests.js b/lib/services/tests/gridfs.unit.tests.js new file mode 100644 index 000000000..c263d1563 --- /dev/null +++ b/lib/services/tests/gridfs.unit.tests.js @@ -0,0 +1,73 @@ +/** + * Module dependencies. + */ +import { jest, describe, test, beforeEach, expect } from '@jest/globals'; +import { PassThrough } from 'stream'; + +/** + * Unit tests for lib/services/gridfs.js + * + * The bucket mock is shaped like the real MongoDB 7 driver: `delete(id, options)` + * returns a promise and never calls a callback passed to it. + */ +describe('gridfs service unit tests:', () => { + let gridfs; + let mockBucket; + let mockModel; + + beforeEach(async () => { + jest.resetModules(); + + mockBucket = { + // Driver-shaped: ignores any extra argument, only settles its promise. + delete: jest.fn(() => Promise.resolve()), + openUploadStreamWithId: jest.fn((id) => Object.assign(new PassThrough(), { id })), + }; + mockModel = { findOne: jest.fn(() => ({ exec: jest.fn().mockResolvedValue({ _id: 'f1' }) })) }; + + jest.unstable_mockModule('mongoose', () => ({ + default: { + connection: { db: {} }, + mongo: { GridFSBucket: jest.fn(() => mockBucket) }, + Types: { ObjectId: jest.fn(() => 'new-id') }, + model: jest.fn(() => mockModel), + }, + })); + + gridfs = (await import('../gridfs.js')).default; + }); + + describe('_removeFile', () => { + test('calls back with no error once the driver delete resolves', async () => { + const cb = jest.fn(); + gridfs.getStorage()._removeFile({}, { id: 'file-1' }, cb); + await new Promise((resolve) => setImmediate(resolve)); + + expect(mockBucket.delete).toHaveBeenCalledWith('file-1'); + expect(cb).toHaveBeenCalledTimes(1); + expect(cb).toHaveBeenCalledWith(null); + }); + + test('calls back with the error when the driver delete rejects', async () => { + const error = new Error('File not found for id file-1'); + mockBucket.delete.mockImplementationOnce(() => Promise.reject(error)); + const cb = jest.fn(); + gridfs.getStorage()._removeFile({}, { id: 'file-1' }, cb); + await new Promise((resolve) => setImmediate(resolve)); + + expect(cb).toHaveBeenCalledTimes(1); + expect(cb).toHaveBeenCalledWith(error); + }); + }); + + describe('createFromBuffer', () => { + test('stores the MIME type in metadata.contentType, not as a top-level option', async () => { + const result = await gridfs.createFromBuffer(Buffer.from('x'), 'a.jpeg', 'image/jpeg', { kind: 'snapshot' }); + + expect(result).toEqual({ _id: 'f1' }); + const [, filename, options] = mockBucket.openUploadStreamWithId.mock.calls[0]; + expect(filename).toBe('a.jpeg'); + expect(options).toEqual({ metadata: { kind: 'snapshot', contentType: 'image/jpeg' } }); + }); + }); +}); diff --git a/modules/uploads/repositories/uploads.repository.js b/modules/uploads/repositories/uploads.repository.js index 78f3dc30e..5f3220507 100644 --- a/modules/uploads/repositories/uploads.repository.js +++ b/modules/uploads/repositories/uploads.repository.js @@ -13,11 +13,18 @@ const bucket = new mongoose.mongo.GridFSBucket(mongoose.connection.db, { }); /** - * @desc Function to get all upload in db with filter or not - * @param {Object} Filter - * @return {Array} uploads + * @desc Function to get all upload in db with filter or not. The MIME type is + * stored in `metadata.contentType` (the driver dropped the top-level GridFS + * `contentType` option); it is returned as `contentType`, falling back to the + * top-level field older files may still carry. + * @param {Object} filter + * @return {Promise} uploads - { _id, filename, uploadDate, contentType } */ -const list = (filter) => Uploads.find(filter).select('filename uploadDate contentType').sort('-createdAt').exec(); +const list = async (filter) => { + /** @type {Array<{ _id: unknown, filename?: string, uploadDate?: Date, contentType?: string, metadata?: { contentType?: string } }>} */ + const uploads = await Uploads.find(filter).select('filename uploadDate contentType metadata.contentType').sort('-createdAt').lean().exec(); + return uploads.map(({ metadata, ...upload }) => ({ ...upload, contentType: upload.contentType || metadata?.contentType })); +}; /** * @desc Function to get an upload from db diff --git a/modules/uploads/tests/uploads.repository.unit.tests.js b/modules/uploads/tests/uploads.repository.unit.tests.js index 62be3a85d..98d5fdd64 100644 --- a/modules/uploads/tests/uploads.repository.unit.tests.js +++ b/modules/uploads/tests/uploads.repository.unit.tests.js @@ -175,13 +175,37 @@ describe('UploadRepository unit tests:', () => { }); }); + describe('list', () => { + test('returns contentType from metadata.contentType, falling back to the legacy top-level field', async () => { + const chain = { + select: jest.fn().mockReturnThis(), + sort: jest.fn().mockReturnThis(), + lean: jest.fn().mockReturnThis(), + exec: jest.fn().mockResolvedValue([ + { _id: 'a1', filename: 'a.png', metadata: { contentType: 'image/png' } }, + { _id: 'a2', filename: 'b.jpeg', contentType: 'image/jpeg' }, + ]), + }; + mockUploadsModel.find.mockReturnValue(chain); + + const result = await UploadRepository.list({ owner: 'u1' }); + + expect(chain.select).toHaveBeenCalledWith('filename uploadDate contentType metadata.contentType'); + expect(result).toEqual([ + { _id: 'a1', filename: 'a.png', contentType: 'image/png' }, + { _id: 'a2', filename: 'b.jpeg', contentType: 'image/jpeg' }, + ]); + }); + }); + describe('deleteMany', () => { test('curates details to { message } only on a bucket delete failure (issue #4059)', async () => { - // deleteMany() lists candidates via list() -> find().select().sort().exec() + // deleteMany() lists candidates via list() -> find().select().sort().lean().exec() // (a different chain shape than setCandidates()'s .select().lean().cursor()). mockUploadsModel.find.mockReturnValue({ select: jest.fn().mockReturnThis(), sort: jest.fn().mockReturnThis(), + lean: jest.fn().mockReturnThis(), exec: jest.fn().mockResolvedValue([{ _id: 'a1', filename: 'a.png' }]), }); const rawError = Object.assign(new Error('ECONNREFUSED 10.0.4.12:27017 - mongo replset primary unreachable'), {