feat(mongo): allow passing transaction options to the mongo client

Closes #3703

Author: B4nan

packages/mongodb/src/MongoConnection.ts

@@ -1,6 +1,6 @@
 import type {
  Collection, Db, MongoClientOptions, ClientSession, BulkWriteResult, Filter, UpdateFilter, OptionalUnlessRequiredId, UpdateResult,
- DeleteResult, InsertManyResult, InsertOneResult,
+ DeleteResult, InsertManyResult, InsertOneResult, TransactionOptions,
 } from 'mongodb';
 import { MongoClient } from 'mongodb';
 import { ObjectId } from 'bson';
@@ -199,7 +199,7 @@ export class MongoConnection extends Connection {
  return this.runQuery<T, number>('countDocuments', collection, undefined, where, ctx);
  }
 
- async transactional<T>(cb: (trx: Transaction<ClientSession>) => Promise<T>, options: { isolationLevel?: IsolationLevel; ctx?: Transaction<ClientSession>; eventBroadcaster?: TransactionEventBroadcaster } = {}): Promise<T> {
+ async transactional<T>(cb: (trx: Transaction<ClientSession>) => Promise<T>, options: { isolationLevel?: IsolationLevel; ctx?: Transaction<ClientSession>; eventBroadcaster?: TransactionEventBroadcaster } & TransactionOptions = {}): Promise<T> {
  const session = await this.begin(options);
 
  try {
@@ -215,15 +215,16 @@ export class MongoConnection extends Connection {
  }
  }
 
- async begin(options: { isolationLevel?: IsolationLevel; ctx?: ClientSession; eventBroadcaster?: TransactionEventBroadcaster } = {}): Promise<ClientSession> {
- if (!options.ctx) {
- await options.eventBroadcaster?.dispatchEvent(EventType.beforeTransactionStart);
- }
+ async begin(options: { isolationLevel?: IsolationLevel; ctx?: ClientSession; eventBroadcaster?: TransactionEventBroadcaster } & TransactionOptions = {}): Promise<ClientSession> {
+ const { ctx, isolationLevel, eventBroadcaster, ...txOptions } = options;
 
- const session = options.ctx || this.client.startSession();
- session.startTransaction();
+ if (!ctx) {
+ await eventBroadcaster?.dispatchEvent(EventType.beforeTransactionStart);
+ }
+ const session = ctx || this.client.startSession();
+ session.startTransaction(txOptions);
  this.logQuery('db.begin();');
- await options.eventBroadcaster?.dispatchEvent(EventType.afterTransactionStart, session);
+ await eventBroadcaster?.dispatchEvent(EventType.afterTransactionStart, session);
 
  return session;
  }

packages/mongodb/src/MongoEntityManager.ts

@@ -1,8 +1,8 @@
-import type { EntityName, EntityRepository, GetRepository } from '@mikro-orm/core';
+import type { EntityName, EntityRepository, GetRepository, TransactionOptions, EntityManagerType } from '@mikro-orm/core';
 import { EntityManager, Utils } from '@mikro-orm/core';
 import type { MongoDriver } from './MongoDriver';
 import type { MongoEntityRepository } from './MongoEntityRepository';
-import type { Collection, Document } from 'mongodb';
+import type { Collection, Document, TransactionOptions as MongoTransactionOptions } from 'mongodb';
 
 /**
  * @inheritDoc
@@ -21,8 +21,25 @@ export class MongoEntityManager<D extends MongoDriver = MongoDriver> extends Ent
  return this.getConnection().getCollection(entityName);
  }
 
+ /**
+ * @inheritDoc
+ */
  getRepository<T extends object, U extends EntityRepository<T> = MongoEntityRepository<T>>(entityName: EntityName<T>): GetRepository<T, U> {
  return super.getRepository<T, U>(entityName);
  }
 
+ /**
+ * @inheritDoc
+ */
+ async begin(options: TransactionOptions & MongoTransactionOptions = {}): Promise<void> {
+ return super.begin(options);
+ }
+
+ /**
+ * @inheritDoc
+ */
+ async transactional<T>(cb: (em: D[typeof EntityManagerType]) => Promise<T>, options: TransactionOptions & MongoTransactionOptions = {}): Promise<T> {
+ return super.transactional(cb, options);
+ }
+
 }

tests/EntityManager.mongo.test.ts

@@ -406,7 +406,7 @@ describe('EntityManagerMongo', () => {
 
  test('transactions', async () => {
  const god1 = new Author('God1', 'hello@heaven1.god');
- await orm.em.begin();
+ await orm.em.begin({ readPreference: 'secondary' });
  await orm.em.persist(god1).flush();
  await orm.em.rollback();
  const res1 = await orm.em.findOne(Author, { name: 'God1' });