@relaybus/mongodb 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { EventStore, RelayBusLogger, IdentifierGenerator, AppendEntry, AppendResult, ClaimRequest, ClaimedDelivery, LeaseReference, ErrorInfo, DeliveryQuery, DeliveryRecord, PurgeRequest, PurgeResult, EventStoreStatistics } from '@relaybus/core';
+import { EventStore, RelayBusLogger, IdentifierGenerator, EventStoreTransactionOptions, AppendEntry, AppendResult, ClaimRequest, ClaimedDelivery, LeaseReference, ErrorInfo, DeliveryQuery, DeliveryRecord, PurgeRequest, PurgeResult, EventStoreStatistics } from '@relaybus/core';
 import { ClientSession, MongoClient, TransactionOptions } from 'mongodb';
 
 interface MongoEventStoreOptions {
@@ -103,7 +103,7 @@ declare class MongoEventStore implements EventStore<ClientSession> {
     /**
      * Verifies the deployment supports transactions, creates the collections and
      * indexes and seeds the lane documents. Upgrades a 0.1.0 database in place
-     * first (see {@link MongoEventStore.#upgradeFromVersion010}); the seeded lanes
+     * first (see `MongoSchema.#upgradeFromVersion010`); the seeded lanes
      * mark the upgrade as done, so later runs skip it. Safe to run repeatedly and
      * from several processes. Stop 0.1.0 workers before the first run.
      *
@@ -120,9 +120,12 @@ declare class MongoEventStore implements EventStore<ClientSession> {
      * not safe for side effects outside the session (HTTP calls, other databases),
      * so keep those out of `work`; relaybus handlers are already at-least-once.
      *
+     * With `options.timeoutMs` (from `bus.transaction`) the server bounds the commit with
+     * `maxCommitTimeMS`; the bus aborts a transaction that ran past the budget before its commit.
+     *
      * @throws ConfigurationError when the deployment does not support transactions.
      */
-    transaction<T>(work: (transaction: ClientSession) => Promise<T>): Promise<T>;
+    transaction<T>(work: (transaction: ClientSession) => Promise<T>, options?: EventStoreTransactionOptions): Promise<T>;
     /**
      * Writes the entries in `session`. An existing event gets a delivery only for
      * handlers it does not list yet; the added handlers are appended to its list
@@ -138,7 +141,7 @@ declare class MongoEventStore implements EventStore<ClientSession> {
      * needs. It then records the batch with one write per lane and hands back the
      * lanes that yielded nothing and run nothing. No delivery document is
      * written, except for the attempt charged to deliveries of a lane taken over
-     * and for parking (see {@link MongoEventStore.#parkDeliveries}).
+     * and for parking (see `MongoOrdering.#parkDeliveries`).
      *
      * Taking a lane is one conditional `findOneAndUpdate` that also moves the
      * previous owner's in-flight list to the lane's `lost` list; a lane another
@@ -166,7 +169,7 @@ declare class MongoEventStore implements EventStore<ClientSession> {
     /**
      * Completes many leases with a fixed number of round trips, whatever lanes
      * they belong to: three commands without a completion history, one
-     * transaction with it (see {@link MongoEventStore.#deleteFenced}).
+     * transaction with it (see `MongoCompletion.#deleteFenced`).
      * Returns one flag per lease in input order; a lease listed twice completes
      * once, and a token this store cannot have issued is refused.
      */

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { EventStore, RelayBusLogger, IdentifierGenerator, AppendEntry, AppendResult, ClaimRequest, ClaimedDelivery, LeaseReference, ErrorInfo, DeliveryQuery, DeliveryRecord, PurgeRequest, PurgeResult, EventStoreStatistics } from '@relaybus/core';
+import { EventStore, RelayBusLogger, IdentifierGenerator, EventStoreTransactionOptions, AppendEntry, AppendResult, ClaimRequest, ClaimedDelivery, LeaseReference, ErrorInfo, DeliveryQuery, DeliveryRecord, PurgeRequest, PurgeResult, EventStoreStatistics } from '@relaybus/core';
 import { ClientSession, MongoClient, TransactionOptions } from 'mongodb';
 
 interface MongoEventStoreOptions {
@@ -103,7 +103,7 @@ declare class MongoEventStore implements EventStore<ClientSession> {
     /**
      * Verifies the deployment supports transactions, creates the collections and
      * indexes and seeds the lane documents. Upgrades a 0.1.0 database in place
-     * first (see {@link MongoEventStore.#upgradeFromVersion010}); the seeded lanes
+     * first (see `MongoSchema.#upgradeFromVersion010`); the seeded lanes
      * mark the upgrade as done, so later runs skip it. Safe to run repeatedly and
      * from several processes. Stop 0.1.0 workers before the first run.
      *
@@ -120,9 +120,12 @@ declare class MongoEventStore implements EventStore<ClientSession> {
      * not safe for side effects outside the session (HTTP calls, other databases),
      * so keep those out of `work`; relaybus handlers are already at-least-once.
      *
+     * With `options.timeoutMs` (from `bus.transaction`) the server bounds the commit with
+     * `maxCommitTimeMS`; the bus aborts a transaction that ran past the budget before its commit.
+     *
      * @throws ConfigurationError when the deployment does not support transactions.
      */
-    transaction<T>(work: (transaction: ClientSession) => Promise<T>): Promise<T>;
+    transaction<T>(work: (transaction: ClientSession) => Promise<T>, options?: EventStoreTransactionOptions): Promise<T>;
     /**
      * Writes the entries in `session`. An existing event gets a delivery only for
      * handlers it does not list yet; the added handlers are appended to its list
@@ -138,7 +141,7 @@ declare class MongoEventStore implements EventStore<ClientSession> {
      * needs. It then records the batch with one write per lane and hands back the
      * lanes that yielded nothing and run nothing. No delivery document is
      * written, except for the attempt charged to deliveries of a lane taken over
-     * and for parking (see {@link MongoEventStore.#parkDeliveries}).
+     * and for parking (see `MongoOrdering.#parkDeliveries`).
      *
      * Taking a lane is one conditional `findOneAndUpdate` that also moves the
      * previous owner's in-flight list to the lane's `lost` list; a lane another
@@ -166,7 +169,7 @@ declare class MongoEventStore implements EventStore<ClientSession> {
     /**
      * Completes many leases with a fixed number of round trips, whatever lanes
      * they belong to: three commands without a completion history, one
-     * transaction with it (see {@link MongoEventStore.#deleteFenced}).
+     * transaction with it (see `MongoCompletion.#deleteFenced`).
      * Returns one flag per lease in input order; a lease listed twice completes
      * once, and a token this store cannot have issued is refused.
      */