Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 | 560x 560x 560x 560x 560x 560x 560x 560x 560x 560x 560x 560x 560x 560x 560x 560x 560x 560x 11971426x 11971426x 11971426x 11971426x 4x 11971422x 8x 11971414x 11971414x 11971414x 4x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 11971410x 131699x 24787399x 24787399x 11844574x 4x 11844570x 4x 11844566x 11844566x 24787391x 13795696x 119275x 119275x 119275x 37140x 6615x 30525x 13742824x 15548459x 15548459x 2076x 342x 15548459x 11970298x 11970298x 11970298x 11970298x 11970298x 11970298x 15548459x 1x 118966x 44122x 44122x 74844x 26929x 51966x 16x 51950x 20x 51930x 36x 51894x 792106x 89280675x 47667x 104x 47563x 492x 47071x 940x 47071x 47071x 6x 47065x 47065x 47065x 46737x 34294x 328x 33966x 1594x 1594x 32372x 328x 32044x 32044x 32044x 32044x 6886x 6630x 256x 256x 32044x 4238x 4238x 32044x 1354x 32044x 19034x 32044x 32044x 32044x 32044x 22038x 22038x 10006x 10006x 4208x 4208x 4208x 4208x 2704x 1504x 1410x 1504x 1504x 1504x 5798x 1640x 5798x 4070x 5798x 32044x 18643x 328x 18315x 2091x 2091x 16224x 164x 16060x 328x 15732x 15732x 15732x 15732x 15732x 1652x 15732x 9395x 15732x 15732x 15732x 6733x 6733x 8999x 8999x 8999x 342x 8657x 2782x 2782x 1796x 986x 986x 15732x 15732x 1965x 7293x 7293x 7293x 7293x 7293x 7293x 7293x 9237x 9237x 9237x 9237x 128x 9109x 7947x 1100x 1290x 586x 586x 704x 704x 704x 704x 6847x 7975x 7975x 4247x 3728x 1128x 2600x 1944x 656x 4247x 7293x 560x 560x 7302x 7302x 4034x 3050x 3268x 2524x 1728x 7302x 7302x 7302x 7302x 7302x 8068x 8068x 560x 23554555x 23554555x 23554555x 480x 23554075x 23554075x 119860x 119860x 119860x 119275x 119275x 119275x 119275x 720x 18988x 2968x 16020x 560x 13863043x 11970298x 11970298x 11970298x 11970298x 11970298x 11970298x 11970298x 1892745x 1892745x 1892745x 1892745x 23021856x 23021856x 560x 2000221x 4x 2000217x 2000217x 11970566x 11970566x 11970566x 10077933x 10077933x 10077929x 10077929x 11970566x 1892637x 11970566x 11970346x 11970346x 11970346x 11970346x 11970346x 11970342x 34443x 11935899x 560x 12595099x 2075x 12593024x 12593024x 12593024x 17567x 70x 17497x 12575457x 12575457x 12575457x 12575457x 12575457x 868216x 868216x 868216x 12575457x 12457063x 1142x 12457063x 620x 620x 12456443x 2903x 2903x 1000x 12457063x 118394x 118394x 43538x 43538x 43538x 43538x 2924x 43538x 4204x 4204x 118394x 560x 12523033x 8266016x 12523033x 118966x 12523033x 55915x 12523033x 1903x 1903x 1000x | import { Binary, type Document, Long, type Timestamp } from './bson';
import type { CommandOptions, Connection } from './cmap/connection';
import { ConnectionPoolMetrics } from './cmap/metrics';
import { type MongoDBResponse } from './cmap/wire_protocol/responses';
import { isSharded } from './cmap/wire_protocol/shared';
import { PINNED, UNPINNED } from './constants';
import type { AbstractCursor } from './cursor/abstract_cursor';
import {
type AnyError,
isRetryableWriteError,
MongoAPIError,
MongoCompatibilityError,
MONGODB_ERROR_CODES,
type MongoDriverError,
MongoError,
MongoErrorLabel,
MongoExpiredSessionError,
MongoInvalidArgumentError,
MongoRuntimeError,
MongoServerError,
MongoTransactionError,
MongoWriteConcernError
} from './error';
import type { MongoClient, MongoOptions } from './mongo_client';
import { TypedEventEmitter } from './mongo_types';
import { executeOperation } from './operations/execute_operation';
import { RunAdminCommandOperation } from './operations/run_command';
import { ReadConcernLevel } from './read_concern';
import { ReadPreference } from './read_preference';
import { type AsyncDisposable, configureResourceManagement } from './resource_management';
import { _advanceClusterTime, type ClusterTime, TopologyType } from './sdam/common';
import { TimeoutContext } from './timeout';
import {
isTransactionCommand,
Transaction,
type TransactionOptions,
TxnState
} from './transactions';
import {
ByteUtils,
calculateDurationInMs,
commandSupportsReadConcern,
isPromiseLike,
List,
maxWireVersion,
noop,
now,
squashError,
uuidV4
} from './utils';
import { WriteConcern, type WriteConcernOptions, type WriteConcernSettings } from './write_concern';
const minWireVersionForShardedTransactions = 8;
/** @public */
export interface ClientSessionOptions {
/** Whether causal consistency should be enabled on this session */
causalConsistency?: boolean;
/** Whether all read operations should be read from the same snapshot for this session (NOTE: not compatible with `causalConsistency=true`) */
snapshot?: boolean;
/** The default TransactionOptions to use for transactions started on this session. */
defaultTransactionOptions?: TransactionOptions;
/**
* @public
* @experimental
* An overriding timeoutMS value to use for a client-side timeout.
* If not provided the session uses the timeoutMS specified on the MongoClient.
*/
defaultTimeoutMS?: number;
/** @internal */
owner?: symbol | AbstractCursor;
/** @internal */
explicit?: boolean;
/** @internal */
initialClusterTime?: ClusterTime;
}
/** @public */
export type WithTransactionCallback<T = any> = (session: ClientSession) => Promise<T>;
/** @public */
export type ClientSessionEvents = {
ended(session: ClientSession): void;
};
/** @public */
export interface EndSessionOptions {
/**
* An optional error which caused the call to end this session
* @internal
*/
error?: AnyError;
force?: boolean;
forceClear?: boolean;
/** Specifies the time an operation will run until it throws a timeout error */
timeoutMS?: number;
}
/**
* A class representing a client session on the server
*
* NOTE: not meant to be instantiated directly.
* @public
*/
export class ClientSession
extends TypedEventEmitter<ClientSessionEvents>
implements AsyncDisposable
{
/** @internal */
client: MongoClient;
/** @internal */
sessionPool: ServerSessionPool;
hasEnded: boolean;
clientOptions: MongoOptions;
supports: { causalConsistency: boolean };
clusterTime?: ClusterTime;
operationTime?: Timestamp;
explicit: boolean;
/** @internal */
owner?: symbol | AbstractCursor;
defaultTransactionOptions: TransactionOptions;
transaction: Transaction;
/**
* @internal
* Keeps track of whether or not the current transaction has attempted to be committed. Is
* initially undefined. Gets set to false when startTransaction is called. When commitTransaction is sent to server, if the commitTransaction succeeds, it is then set to undefined, otherwise, set to true
*/
private commitAttempted?: boolean;
public readonly snapshotEnabled: boolean;
/** @internal */
private _serverSession: ServerSession | null;
/** @internal */
public snapshotTime?: Timestamp;
/** @internal */
public pinnedConnection?: Connection;
/** @internal */
public txnNumberIncrement: number;
/**
* @experimental
* Specifies the time an operation in a given `ClientSession` will run until it throws a timeout error
*/
timeoutMS?: number;
/** @internal */
public timeoutContext: TimeoutContext | null = null;
/**
* Create a client session.
* @internal
* @param client - The current client
* @param sessionPool - The server session pool (Internal Class)
* @param options - Optional settings
* @param clientOptions - Optional settings provided when creating a MongoClient
*/
constructor(
client: MongoClient,
sessionPool: ServerSessionPool,
options: ClientSessionOptions,
clientOptions: MongoOptions
) {
super();
this.on('error', noop);
if (client == null) {
// TODO(NODE-3483)
throw new MongoRuntimeError('ClientSession requires a MongoClient');
}
if (sessionPool == null || !(sessionPool instanceof ServerSessionPool)) {
// TODO(NODE-3483)
throw new MongoRuntimeError('ClientSession requires a ServerSessionPool');
}
options = options ?? {};
this.snapshotEnabled = options.snapshot === true;
if (options.causalConsistency === true && this.snapshotEnabled) {
throw new MongoInvalidArgumentError(
'Properties "causalConsistency" and "snapshot" are mutually exclusive'
);
}
this.client = client;
this.sessionPool = sessionPool;
this.hasEnded = false;
this.clientOptions = clientOptions;
this.timeoutMS = options.defaultTimeoutMS ?? client.s.options?.timeoutMS;
this.explicit = !!options.explicit;
this._serverSession = this.explicit ? this.sessionPool.acquire() : null;
this.txnNumberIncrement = 0;
const defaultCausalConsistencyValue = this.explicit && options.snapshot !== true;
this.supports = {
// if we can enable causal consistency, do so by default
causalConsistency: options.causalConsistency ?? defaultCausalConsistencyValue
};
this.clusterTime = options.initialClusterTime;
this.operationTime = undefined;
this.owner = options.owner;
this.defaultTransactionOptions = { ...options.defaultTransactionOptions };
this.transaction = new Transaction();
}
/** The server id associated with this session */
get id(): ServerSessionId | undefined {
return this.serverSession?.id;
}
get serverSession(): ServerSession {
let serverSession = this._serverSession;
if (serverSession == null) {
if (this.explicit) {
throw new MongoRuntimeError('Unexpected null serverSession for an explicit session');
}
if (this.hasEnded) {
throw new MongoRuntimeError('Unexpected null serverSession for an ended implicit session');
}
serverSession = this.sessionPool.acquire();
this._serverSession = serverSession;
}
return serverSession;
}
get loadBalanced(): boolean {
return this.client.topology?.description.type === TopologyType.LoadBalanced;
}
/** @internal */
pin(conn: Connection): void {
Iif (this.pinnedConnection) {
throw TypeError('Cannot pin multiple connections to the same session');
}
this.pinnedConnection = conn;
conn.emit(
PINNED,
this.inTransaction() ? ConnectionPoolMetrics.TXN : ConnectionPoolMetrics.CURSOR
);
}
/** @internal */
unpin(options?: { force?: boolean; forceClear?: boolean; error?: AnyError }): void {
if (this.loadBalanced) {
return maybeClearPinnedConnection(this, options);
}
this.transaction.unpinServer();
}
get isPinned(): boolean {
return this.loadBalanced ? !!this.pinnedConnection : this.transaction.isPinned;
}
/**
* Frees any client-side resources held by the current session. If a session is in a transaction,
* the transaction is aborted.
*
* Does not end the session on the server.
*
* @param options - Optional settings. Currently reserved for future use
*/
async endSession(options?: EndSessionOptions): Promise<void> {
try {
if (this.inTransaction()) {
await this.abortTransaction({ ...options, throwTimeout: true });
}
} catch (error) {
// spec indicates that we should ignore all errors for `endSessions`
Eif (error.name === 'MongoOperationTimeoutError') throw error;
squashError(error);
} finally {
if (!this.hasEnded) {
const serverSession = this.serverSession;
Eif (serverSession != null) {
// release the server session back to the pool
this.sessionPool.release(serverSession);
// Store a clone of the server session for reference (debugging)
this._serverSession = new ServerSession(serverSession);
}
// mark the session as ended, and emit a signal
this.hasEnded = true;
this.emit('ended', this);
}
maybeClearPinnedConnection(this, { force: true, ...options });
}
}
/**
* @beta
* @experimental
* An alias for {@link ClientSession.endSession|ClientSession.endSession()}.
*/
declare [Symbol.asyncDispose]: () => Promise<void>;
/** @internal */
async asyncDispose() {
await this.endSession({ force: true });
}
/**
* Advances the operationTime for a ClientSession.
*
* @param operationTime - the `BSON.Timestamp` of the operation type it is desired to advance to
*/
advanceOperationTime(operationTime: Timestamp): void {
if (this.operationTime == null) {
this.operationTime = operationTime;
return;
}
if (operationTime.greaterThan(this.operationTime)) {
this.operationTime = operationTime;
}
}
/**
* Advances the clusterTime for a ClientSession to the provided clusterTime of another ClientSession
*
* @param clusterTime - the $clusterTime returned by the server from another session in the form of a document containing the `BSON.Timestamp` clusterTime and signature
*/
advanceClusterTime(clusterTime: ClusterTime): void {
if (!clusterTime || typeof clusterTime !== 'object') {
throw new MongoInvalidArgumentError('input cluster time must be an object');
}
if (!clusterTime.clusterTime || clusterTime.clusterTime._bsontype !== 'Timestamp') {
throw new MongoInvalidArgumentError(
'input cluster time "clusterTime" property must be a valid BSON Timestamp'
);
}
if (
!clusterTime.signature ||
clusterTime.signature.hash?._bsontype !== 'Binary' ||
(typeof clusterTime.signature.keyId !== 'bigint' &&
typeof clusterTime.signature.keyId !== 'number' &&
clusterTime.signature.keyId?._bsontype !== 'Long') // apparently we decode the key to number?
) {
throw new MongoInvalidArgumentError(
'input cluster time must have a valid "signature" property with BSON Binary hash and BSON Long keyId'
);
}
_advanceClusterTime(this, clusterTime);
}
/**
* Used to determine if this session equals another
*
* @param session - The session to compare to
*/
equals(session: ClientSession): boolean {
if (!(session instanceof ClientSession)) {
return false;
}
if (this.id == null || session.id == null) {
return false;
}
return ByteUtils.equals(this.id.id.buffer, session.id.id.buffer);
}
/**
* Increment the transaction number on the internal ServerSession
*
* @privateRemarks
* This helper increments a value stored on the client session that will be
* added to the serverSession's txnNumber upon applying it to a command.
* This is because the serverSession is lazily acquired after a connection is obtained
*/
incrementTransactionNumber(): void {
this.txnNumberIncrement += 1;
}
/** @returns whether this session is currently in a transaction or not */
inTransaction(): boolean {
return this.transaction.isActive;
}
/**
* Starts a new transaction with the given options.
*
* @remarks
* **IMPORTANT**: Running operations in parallel is not supported during a transaction. The use of `Promise.all`,
* `Promise.allSettled`, `Promise.race`, etc to parallelize operations inside a transaction is
* undefined behaviour.
*
* @param options - Options for the transaction
*/
startTransaction(options?: TransactionOptions): void {
if (this.snapshotEnabled) {
throw new MongoCompatibilityError('Transactions are not supported in snapshot sessions');
}
if (this.inTransaction()) {
throw new MongoTransactionError('Transaction already in progress');
}
if (this.isPinned && this.transaction.isCommitted) {
this.unpin();
}
const topologyMaxWireVersion = maxWireVersion(this.client.topology);
if (
isSharded(this.client.topology) &&
topologyMaxWireVersion != null &&
topologyMaxWireVersion < minWireVersionForShardedTransactions
) {
throw new MongoCompatibilityError(
'Transactions are not supported on sharded clusters in MongoDB < 4.2.'
);
}
this.commitAttempted = false;
// increment txnNumber
this.incrementTransactionNumber();
// create transaction state
this.transaction = new Transaction({
readConcern:
options?.readConcern ??
this.defaultTransactionOptions.readConcern ??
this.clientOptions?.readConcern,
writeConcern:
options?.writeConcern ??
this.defaultTransactionOptions.writeConcern ??
this.clientOptions?.writeConcern,
readPreference:
options?.readPreference ??
this.defaultTransactionOptions.readPreference ??
this.clientOptions?.readPreference,
maxCommitTimeMS: options?.maxCommitTimeMS ?? this.defaultTransactionOptions.maxCommitTimeMS
});
this.transaction.transition(TxnState.STARTING_TRANSACTION);
}
/**
* Commits the currently active transaction in this session.
*
* @param options - Optional options, can be used to override `defaultTimeoutMS`.
*/
async commitTransaction(options?: { timeoutMS?: number }): Promise<void> {
if (this.transaction.state === TxnState.NO_TRANSACTION) {
throw new MongoTransactionError('No transaction started');
}
if (
this.transaction.state === TxnState.STARTING_TRANSACTION ||
this.transaction.state === TxnState.TRANSACTION_COMMITTED_EMPTY
) {
// the transaction was never started, we can safely exit here
this.transaction.transition(TxnState.TRANSACTION_COMMITTED_EMPTY);
return;
}
if (this.transaction.state === TxnState.TRANSACTION_ABORTED) {
throw new MongoTransactionError(
'Cannot call commitTransaction after calling abortTransaction'
);
}
const command: {
commitTransaction: 1;
writeConcern?: WriteConcernSettings;
recoveryToken?: Document;
maxTimeMS?: number;
} = { commitTransaction: 1 };
const timeoutMS =
typeof options?.timeoutMS === 'number'
? options.timeoutMS
: typeof this.timeoutMS === 'number'
? this.timeoutMS
: null;
const wc = this.transaction.options.writeConcern ?? this.clientOptions?.writeConcern;
if (wc != null) {
if (timeoutMS == null && this.timeoutContext == null) {
WriteConcern.apply(command, { wtimeoutMS: 10000, w: 'majority', ...wc });
} else {
const wcKeys = Object.keys(wc);
Iif (wcKeys.length > 2 || (!wcKeys.includes('wtimeoutMS') && !wcKeys.includes('wTimeoutMS')))
// if the write concern was specified with wTimeoutMS, then we set both wtimeoutMS and wTimeoutMS, guaranteeing at least two keys, so if we have more than two keys, then we can automatically assume that we should add the write concern to the command. If it has 2 or fewer keys, we need to check that those keys aren't the wtimeoutMS or wTimeoutMS options before we add the write concern to the command
WriteConcern.apply(command, { ...wc, wtimeoutMS: undefined });
}
}
if (this.transaction.state === TxnState.TRANSACTION_COMMITTED || this.commitAttempted) {
Eif (timeoutMS == null && this.timeoutContext == null) {
WriteConcern.apply(command, { wtimeoutMS: 10000, ...wc, w: 'majority' });
} else {
WriteConcern.apply(command, { w: 'majority', ...wc, wtimeoutMS: undefined });
}
}
if (typeof this.transaction.options.maxTimeMS === 'number') {
command.maxTimeMS = this.transaction.options.maxTimeMS;
}
if (this.transaction.recoveryToken) {
command.recoveryToken = this.transaction.recoveryToken;
}
const operation = new RunAdminCommandOperation(command, {
session: this,
readPreference: ReadPreference.primary,
bypassPinningCheck: true
});
const timeoutContext =
this.timeoutContext ??
(typeof timeoutMS === 'number'
? TimeoutContext.create({
serverSelectionTimeoutMS: this.clientOptions.serverSelectionTimeoutMS,
socketTimeoutMS: this.clientOptions.socketTimeoutMS,
timeoutMS
})
: null);
try {
await executeOperation(this.client, operation, timeoutContext);
this.commitAttempted = undefined;
return;
} catch (firstCommitError) {
this.commitAttempted = true;
if (firstCommitError instanceof MongoError && isRetryableWriteError(firstCommitError)) {
// SPEC-1185: apply majority write concern when retrying commitTransaction
WriteConcern.apply(command, { wtimeoutMS: 10000, ...wc, w: 'majority' });
// per txns spec, must unpin session in this case
this.unpin({ force: true });
try {
await executeOperation(
this.client,
new RunAdminCommandOperation(command, {
session: this,
readPreference: ReadPreference.primary,
bypassPinningCheck: true
}),
timeoutContext
);
return;
} catch (retryCommitError) {
// If the retry failed, we process that error instead of the original
if (shouldAddUnknownTransactionCommitResultLabel(retryCommitError)) {
retryCommitError.addErrorLabel(MongoErrorLabel.UnknownTransactionCommitResult);
}
Eif (shouldUnpinAfterCommitError(retryCommitError)) {
this.unpin({ error: retryCommitError });
}
throw retryCommitError;
}
}
if (shouldAddUnknownTransactionCommitResultLabel(firstCommitError)) {
firstCommitError.addErrorLabel(MongoErrorLabel.UnknownTransactionCommitResult);
}
if (shouldUnpinAfterCommitError(firstCommitError)) {
this.unpin({ error: firstCommitError });
}
throw firstCommitError;
} finally {
this.transaction.transition(TxnState.TRANSACTION_COMMITTED);
}
}
/**
* Aborts the currently active transaction in this session.
*
* @param options - Optional options, can be used to override `defaultTimeoutMS`.
*/
async abortTransaction(options?: { timeoutMS?: number }): Promise<void>;
/** @internal */
async abortTransaction(options?: { timeoutMS?: number; throwTimeout?: true }): Promise<void>;
async abortTransaction(options?: { timeoutMS?: number; throwTimeout?: true }): Promise<void> {
if (this.transaction.state === TxnState.NO_TRANSACTION) {
throw new MongoTransactionError('No transaction started');
}
if (this.transaction.state === TxnState.STARTING_TRANSACTION) {
// the transaction was never started, we can safely exit here
this.transaction.transition(TxnState.TRANSACTION_ABORTED);
return;
}
if (this.transaction.state === TxnState.TRANSACTION_ABORTED) {
throw new MongoTransactionError('Cannot call abortTransaction twice');
}
if (
this.transaction.state === TxnState.TRANSACTION_COMMITTED ||
this.transaction.state === TxnState.TRANSACTION_COMMITTED_EMPTY
) {
throw new MongoTransactionError(
'Cannot call abortTransaction after calling commitTransaction'
);
}
const command: {
abortTransaction: 1;
writeConcern?: WriteConcernOptions;
recoveryToken?: Document;
} = { abortTransaction: 1 };
const timeoutMS =
typeof options?.timeoutMS === 'number'
? options.timeoutMS
: this.timeoutContext?.csotEnabled()
? this.timeoutContext.timeoutMS // refresh timeoutMS for abort operation
: typeof this.timeoutMS === 'number'
? this.timeoutMS
: null;
const timeoutContext =
timeoutMS != null
? TimeoutContext.create({
timeoutMS,
serverSelectionTimeoutMS: this.clientOptions.serverSelectionTimeoutMS,
socketTimeoutMS: this.clientOptions.socketTimeoutMS
})
: null;
const wc = this.transaction.options.writeConcern ?? this.clientOptions?.writeConcern;
if (wc != null && timeoutMS == null) {
WriteConcern.apply(command, { wtimeoutMS: 10000, w: 'majority', ...wc });
}
if (this.transaction.recoveryToken) {
command.recoveryToken = this.transaction.recoveryToken;
}
const operation = new RunAdminCommandOperation(command, {
session: this,
readPreference: ReadPreference.primary,
bypassPinningCheck: true
});
try {
await executeOperation(this.client, operation, timeoutContext);
this.unpin();
return;
} catch (firstAbortError) {
this.unpin();
Iif (firstAbortError.name === 'MongoRuntimeError') throw firstAbortError;
if (options?.throwTimeout && firstAbortError.name === 'MongoOperationTimeoutError') {
throw firstAbortError;
}
if (firstAbortError instanceof MongoError && isRetryableWriteError(firstAbortError)) {
try {
await executeOperation(this.client, operation, timeoutContext);
return;
} catch (secondAbortError) {
Iif (secondAbortError.name === 'MongoRuntimeError') throw secondAbortError;
Iif (options?.throwTimeout && secondAbortError.name === 'MongoOperationTimeoutError') {
throw secondAbortError;
}
// we do not retry the retry
}
}
// The spec indicates that if the operation times out or fails with a non-retryable error, we should ignore all errors on `abortTransaction`
} finally {
this.transaction.transition(TxnState.TRANSACTION_ABORTED);
if (this.loadBalanced) {
maybeClearPinnedConnection(this, { force: false });
}
}
}
/**
* This is here to ensure that ClientSession is never serialized to BSON.
*/
toBSON(): never {
throw new MongoRuntimeError('ClientSession cannot be serialized to BSON.');
}
/**
* Starts a transaction and runs a provided function, ensuring the commitTransaction is always attempted when all operations run in the function have completed.
*
* **IMPORTANT:** This method requires the function passed in to return a Promise. That promise must be made by `await`-ing all operations in such a way that rejections are propagated to the returned promise.
*
* **IMPORTANT:** Running operations in parallel is not supported during a transaction. The use of `Promise.all`,
* `Promise.allSettled`, `Promise.race`, etc to parallelize operations inside a transaction is
* undefined behaviour.
*
* **IMPORTANT:** When running an operation inside a `withTransaction` callback, if it is not
* provided the explicit session in its options, it will not be part of the transaction and it will not respect timeoutMS.
*
*
* @remarks
* - If all operations successfully complete and the `commitTransaction` operation is successful, then the provided function will return the result of the provided function.
* - If the transaction is unable to complete or an error is thrown from within the provided function, then the provided function will throw an error.
* - If the transaction is manually aborted within the provided function it will not throw.
* - If the driver needs to attempt to retry the operations, the provided function may be called multiple times.
*
* Checkout a descriptive example here:
* @see https://www.mongodb.com/blog/post/quick-start-nodejs--mongodb--how-to-implement-transactions
*
* If a command inside withTransaction fails:
* - It may cause the transaction on the server to be aborted.
* - This situation is normally handled transparently by the driver.
* - However, if the application catches such an error and does not rethrow it, the driver will not be able to determine whether the transaction was aborted or not.
* - The driver will then retry the transaction indefinitely.
*
* To avoid this situation, the application must not silently handle errors within the provided function.
* If the application needs to handle errors within, it must await all operations such that if an operation is rejected it becomes the rejection of the callback function passed into withTransaction.
*
* @param fn - callback to run within a transaction
* @param options - optional settings for the transaction
* @returns A raw command response or undefined
*/
async withTransaction<T = any>(
fn: WithTransactionCallback<T>,
options?: TransactionOptions & {
/**
* Configures a timeoutMS expiry for the entire withTransactionCallback.
*
* @remarks
* - The remaining timeout will not be applied to callback operations that do not use the ClientSession.
* - Overriding timeoutMS for operations executed using the explicit session inside the provided callback will result in a client-side error.
*/
timeoutMS?: number;
}
): Promise<T> {
const MAX_TIMEOUT = 120000;
const timeoutMS = options?.timeoutMS ?? this.timeoutMS ?? null;
this.timeoutContext =
timeoutMS != null
? TimeoutContext.create({
timeoutMS,
serverSelectionTimeoutMS: this.clientOptions.serverSelectionTimeoutMS,
socketTimeoutMS: this.clientOptions.socketTimeoutMS
})
: null;
const startTime = this.timeoutContext?.csotEnabled() ? this.timeoutContext.start : now();
let committed = false;
let result: any;
try {
while (!committed) {
this.startTransaction(options); // may throw on error
try {
const promise = fn(this);
if (!isPromiseLike(promise)) {
throw new MongoInvalidArgumentError(
'Function provided to `withTransaction` must return a Promise'
);
}
result = await promise;
if (
this.transaction.state === TxnState.NO_TRANSACTION ||
this.transaction.state === TxnState.TRANSACTION_COMMITTED ||
this.transaction.state === TxnState.TRANSACTION_ABORTED
) {
// Assume callback intentionally ended the transaction
return result;
}
} catch (fnError) {
if (!(fnError instanceof MongoError) || fnError instanceof MongoInvalidArgumentError) {
await this.abortTransaction();
throw fnError;
}
Eif (
this.transaction.state === TxnState.STARTING_TRANSACTION ||
this.transaction.state === TxnState.TRANSACTION_IN_PROGRESS
) {
await this.abortTransaction();
}
Iif (
fnError.hasErrorLabel(MongoErrorLabel.TransientTransactionError) &&
(this.timeoutContext != null || now() - startTime < MAX_TIMEOUT)
) {
continue;
}
throw fnError;
}
while (!committed) {
try {
/*
* We will rely on ClientSession.commitTransaction() to
* apply a majority write concern if commitTransaction is
* being retried (see: DRIVERS-601)
*/
await this.commitTransaction();
committed = true;
} catch (commitError) {
/*
* Note: a maxTimeMS error will have the MaxTimeMSExpired
* code (50) and can be reported as a top-level error or
* inside writeConcernError, ex.
* { ok:0, code: 50, codeName: 'MaxTimeMSExpired' }
* { ok:1, writeConcernError: { code: 50, codeName: 'MaxTimeMSExpired' } }
*/
if (
!isMaxTimeMSExpiredError(commitError) &&
commitError.hasErrorLabel(MongoErrorLabel.UnknownTransactionCommitResult) &&
(this.timeoutContext != null || now() - startTime < MAX_TIMEOUT)
) {
continue;
}
if (
commitError.hasErrorLabel(MongoErrorLabel.TransientTransactionError) &&
(this.timeoutContext != null || now() - startTime < MAX_TIMEOUT)
) {
break;
}
throw commitError;
}
}
}
return result;
} finally {
this.timeoutContext = null;
}
}
}
configureResourceManagement(ClientSession.prototype);
const NON_DETERMINISTIC_WRITE_CONCERN_ERRORS = new Set([
'CannotSatisfyWriteConcern',
'UnknownReplWriteConcern',
'UnsatisfiableWriteConcern'
]);
function shouldUnpinAfterCommitError(commitError: Error) {
Eif (commitError instanceof MongoError) {
if (
isRetryableWriteError(commitError) ||
commitError instanceof MongoWriteConcernError ||
isMaxTimeMSExpiredError(commitError)
) {
if (isUnknownTransactionCommitResult(commitError)) {
// per txns spec, must unpin session in this case
return true;
}
} else if (commitError.hasErrorLabel(MongoErrorLabel.TransientTransactionError)) {
return true;
}
}
return false;
}
function shouldAddUnknownTransactionCommitResultLabel(commitError: MongoError) {
let ok = isRetryableWriteError(commitError);
ok ||= commitError instanceof MongoWriteConcernError;
ok ||= isMaxTimeMSExpiredError(commitError);
ok &&= isUnknownTransactionCommitResult(commitError);
return ok;
}
function isUnknownTransactionCommitResult(err: MongoError): err is MongoError {
const isNonDeterministicWriteConcernError =
err instanceof MongoServerError &&
err.codeName &&
NON_DETERMINISTIC_WRITE_CONCERN_ERRORS.has(err.codeName);
return (
isMaxTimeMSExpiredError(err) ||
(!isNonDeterministicWriteConcernError &&
err.code !== MONGODB_ERROR_CODES.UnsatisfiableWriteConcern &&
err.code !== MONGODB_ERROR_CODES.UnknownReplWriteConcern)
);
}
export function maybeClearPinnedConnection(
session: ClientSession,
options?: EndSessionOptions
): void {
// unpin a connection if it has been pinned
const conn = session.pinnedConnection;
const error = options?.error;
if (
session.inTransaction() &&
error &&
error instanceof MongoError &&
error.hasErrorLabel(MongoErrorLabel.TransientTransactionError)
) {
return;
}
const topology = session.client.topology;
// NOTE: the spec talks about what to do on a network error only, but the tests seem to
// to validate that we don't unpin on _all_ errors?
if (conn && topology != null) {
const servers = Array.from(topology.s.servers.values());
const loadBalancer = servers[0];
if (options?.error == null || options?.force) {
loadBalancer.pool.checkIn(conn);
session.pinnedConnection = undefined;
conn.emit(
UNPINNED,
session.transaction.state !== TxnState.NO_TRANSACTION
? ConnectionPoolMetrics.TXN
: ConnectionPoolMetrics.CURSOR
);
if (options?.forceClear) {
loadBalancer.pool.clear({ serviceId: conn.serviceId });
}
}
}
}
function isMaxTimeMSExpiredError(err: MongoError): boolean {
if (err == null || !(err instanceof MongoServerError)) {
return false;
}
return (
err.code === MONGODB_ERROR_CODES.MaxTimeMSExpired ||
err.writeConcernError?.code === MONGODB_ERROR_CODES.MaxTimeMSExpired
);
}
/** @public */
export type ServerSessionId = { id: Binary };
/**
* Reflects the existence of a session on the server. Can be reused by the session pool.
* WARNING: not meant to be instantiated directly. For internal use only.
* @public
*/
export class ServerSession {
id: ServerSessionId;
lastUse: number;
txnNumber: number;
isDirty: boolean;
/** @internal */
constructor(cloned?: ServerSession | null) {
if (cloned != null) {
const idBytes = Buffer.allocUnsafe(16);
idBytes.set(cloned.id.id.buffer);
this.id = { id: new Binary(idBytes, cloned.id.id.sub_type) };
this.lastUse = cloned.lastUse;
this.txnNumber = cloned.txnNumber;
this.isDirty = cloned.isDirty;
return;
}
this.id = { id: new Binary(uuidV4(), Binary.SUBTYPE_UUID) };
this.lastUse = now();
this.txnNumber = 0;
this.isDirty = false;
}
/**
* Determines if the server session has timed out.
*
* @param sessionTimeoutMinutes - The server's "logicalSessionTimeoutMinutes"
*/
hasTimedOut(sessionTimeoutMinutes: number): boolean {
// Take the difference of the lastUse timestamp and now, which will result in a value in
// milliseconds, and then convert milliseconds to minutes to compare to `sessionTimeoutMinutes`
const idleTimeMinutes = Math.round(
((calculateDurationInMs(this.lastUse) % 86400000) % 3600000) / 60000
);
return idleTimeMinutes > sessionTimeoutMinutes - 1;
}
}
/**
* Maintains a pool of Server Sessions.
* For internal use only
* @internal
*/
export class ServerSessionPool {
client: MongoClient;
sessions: List<ServerSession>;
constructor(client: MongoClient) {
if (client == null) {
throw new MongoRuntimeError('ServerSessionPool requires a MongoClient');
}
this.client = client;
this.sessions = new List<ServerSession>();
}
/**
* Acquire a Server Session from the pool.
* Iterates through each session in the pool, removing any stale sessions
* along the way. The first non-stale session found is removed from the
* pool and returned. If no non-stale session is found, a new ServerSession is created.
*/
acquire(): ServerSession {
const sessionTimeoutMinutes = this.client.topology?.logicalSessionTimeoutMinutes ?? 10;
let session: ServerSession | null = null;
// Try to obtain from session pool
while (this.sessions.length > 0) {
const potentialSession = this.sessions.shift();
if (
potentialSession != null &&
(!!this.client.topology?.loadBalanced ||
!potentialSession.hasTimedOut(sessionTimeoutMinutes))
) {
session = potentialSession;
break;
}
}
// If nothing valid came from the pool make a new one
if (session == null) {
session = new ServerSession();
}
return session;
}
/**
* Release a session to the session pool
* Adds the session back to the session pool if the session has not timed out yet.
* This method also removes any stale sessions from the pool.
*
* @param session - The session to release to the pool
*/
release(session: ServerSession): void {
const sessionTimeoutMinutes = this.client.topology?.logicalSessionTimeoutMinutes ?? 10;
Iif (this.client.topology?.loadBalanced && !sessionTimeoutMinutes) {
this.sessions.unshift(session);
}
Iif (!sessionTimeoutMinutes) {
return;
}
this.sessions.prune(session => session.hasTimedOut(sessionTimeoutMinutes));
if (!session.hasTimedOut(sessionTimeoutMinutes)) {
if (session.isDirty) {
return;
}
// otherwise, readd this session to the session pool
this.sessions.unshift(session);
}
}
}
/**
* Optionally decorate a command with sessions specific keys
*
* @param session - the session tracking transaction state
* @param command - the command to decorate
* @param options - Optional settings passed to calling operation
*
* @internal
*/
export function applySession(
session: ClientSession,
command: Document,
options: CommandOptions
): MongoDriverError | undefined {
if (session.hasEnded) {
return new MongoExpiredSessionError();
}
// May acquire serverSession here
const serverSession = session.serverSession;
Iif (serverSession == null) {
return new MongoRuntimeError('Unable to acquire server session');
}
if (options.writeConcern?.w === 0) {
if (session && session.explicit) {
// Error if user provided an explicit session to an unacknowledged write (SPEC-1019)
return new MongoAPIError('Cannot have explicit session with unacknowledged writes');
}
return;
}
// mark the last use of this session, and apply the `lsid`
serverSession.lastUse = now();
command.lsid = serverSession.id;
const inTxnOrTxnCommand = session.inTransaction() || isTransactionCommand(command);
const isRetryableWrite = !!options.willRetryWrite;
if (isRetryableWrite || inTxnOrTxnCommand) {
serverSession.txnNumber += session.txnNumberIncrement;
session.txnNumberIncrement = 0;
// TODO(NODE-2674): Preserve int64 sent from MongoDB
command.txnNumber = Long.fromNumber(serverSession.txnNumber);
}
if (!inTxnOrTxnCommand) {
if (session.transaction.state !== TxnState.NO_TRANSACTION) {
session.transaction.transition(TxnState.NO_TRANSACTION);
}
if (
session.supports.causalConsistency &&
session.operationTime &&
commandSupportsReadConcern(command)
) {
command.readConcern = command.readConcern || {};
Object.assign(command.readConcern, { afterClusterTime: session.operationTime });
} else if (session.snapshotEnabled) {
command.readConcern = command.readConcern || { level: ReadConcernLevel.snapshot };
if (session.snapshotTime != null) {
Object.assign(command.readConcern, { atClusterTime: session.snapshotTime });
}
}
return;
}
// now attempt to apply transaction-specific sessions data
// `autocommit` must always be false to differentiate from retryable writes
command.autocommit = false;
if (session.transaction.state === TxnState.STARTING_TRANSACTION) {
session.transaction.transition(TxnState.TRANSACTION_IN_PROGRESS);
command.startTransaction = true;
const readConcern =
session.transaction.options.readConcern || session?.clientOptions?.readConcern;
if (readConcern) {
command.readConcern = readConcern;
}
if (session.supports.causalConsistency && session.operationTime) {
command.readConcern = command.readConcern || {};
Object.assign(command.readConcern, { afterClusterTime: session.operationTime });
}
}
return;
}
export function updateSessionFromResponse(session: ClientSession, document: MongoDBResponse): void {
if (document.$clusterTime) {
_advanceClusterTime(session, document.$clusterTime);
}
if (document.operationTime && session && session.supports.causalConsistency) {
session.advanceOperationTime(document.operationTime);
}
if (document.recoveryToken && session && session.inTransaction()) {
session.transaction._recoveryToken = document.recoveryToken;
}
if (session?.snapshotEnabled && session.snapshotTime == null) {
// find and aggregate commands return atClusterTime on the cursor
// distinct includes it in the response body
const atClusterTime = document.atClusterTime;
if (atClusterTime) {
session.snapshotTime = atClusterTime;
}
}
}
|