jam:mongo-transactions

v1.1.0-rc.4Published 3 weeks ago

Mongo Transactions

jam:mongo-transactions enables an easy way to work with Mongo Transactions in Meteor apps. Here are a few of the benefits:

  • Write with the standard Meteor collection methods you're accustomed to. You don't need to worry about using rawCollection(), though if you need a particular rawCollection() method, you can still use it.
  • You don't need to worry about passing session around. This package takes care of that for you.
  • Because it's a low-level solution, ID generation works as expected.
  • Works out-of-the-box with other packages that automatically validate on DB writes, like jam:easy-schema and aldeed:collection2.
  • One simple API to use. Mongo has made things complicated with two APIs for Transactions, the Callback API and the Core API. This package defaults to using the Callback API as recommended by Mongo, but allows you to use the Core API by passing in autoRetry: false.
  • Can be used isomorphically.
  • Compatible with Meteor 2.8.1 and up, including support for Meteor 3.0+

Important: This package expects that you'll use the promise-based *Async Meteor collection methods introduced in v2.8.1 though it will technically work with the older syntax without the *Async suffix as long as you don't use callbacks. It does not cover using callbacks with Meteor collection methods.

Usage

Add the package to your app

meteor add jam:mongo-transactions@1.1.0-rc.4

Note: The specific version number @1.1.0-rc.4 must be specified as above at this time. It's there for Meteor 3.0 compatibility reasons since 3.0 is in a pre-release state. Once Meteor 3.0 is officially released, the specific version will not be required.

Create a Transaction

Note: there's no need to pass session into the *Async collection methods. This package handles that for you.

1import { Mongo } from 'meteor/mongo';
2
3async function purchase(purchaseData) {
4  try {
5    const { invoiceId } = await Mongo.withTransaction(async () => {
6      const invoiceId = await Invoices.insertAsync(purchaseData);
7      const changeQuantity = await Items.updateAsync(purchaseData.itemId, { $set: {...} });
8      return { invoiceId, changeQuantity } // you can return whatever you'd like
9    });
10    return invoiceId;
11  } catch (error) {
12    // something went wrong with the transaction and it could not be automatically retried
13    // handle the error as you see fit
14  }
15}

Passing Transaction options

If you want customize how the Transaction runs, pass in the Transaction options as the second argument, for example:

1await Mongo.withTransaction(async () => {
2  ...
3}, { writeConcern: { w: 1 } });

Refer to the Mongo Node API docs for more information about Transaction options.

Preventing automatic retries if the Transaction fails

Most of the time, you'll want the default behavior where the Transaction is automatically retried for a TransientTransactionError or UnknownTransactionCommitResult commit error. But if you don't want that behavior, simply pass in { autoRetry: false } like this:

1await Mongo.withTransaction(async () => {
2  ...
3}, { autoRetry: false });

Setting { autoRetry: false }, means the Transactions Core API will be used rather than the Callback API and you'll be responsible for handling all errors. You can read more about the differences in the Mongo Docs.

Determine if you're in a Transaction

To determine if the code is currently running in a Transaction, use:

1Mongo.inTransaction(); // returns true or false

Using Isomorphically for Optimistic UI

You can write Mongo.withTransaction and Mongo.inTransaction isomorphically for Optimistic UI however note that the Transaction will only truly be performed on the server.

As with any isomorphic code, you should be aware that it may fail because the operation can't succeed on the client but will succeed on the server. For example, let's say you're using .find within the Transaction and Minimongo on the client doesn't have that particular data, the client will fail but the server should still succeed. You can wrap specific server-only code with if (Meteor.isServer), but in these cases, you'll likely want to avoid isomorphic code and make sure the entire Transaction code only runs on the server.

Using Mongo Atlas as your DB?

Important: In my experience, you must use a paid tier for Transactions to work as expected with Meteor. The free tier would not tail the oplog for Transactions. So if you're trying this out in production, be sure to use a paid tier.