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 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 | 728x 728x 728x 728x 728x 728x 728x 728x 728x 728x 728x 728x 728x 728x 728x 728x 732747x 110x 732531x 94x 728x 4731817x 728x 76x 116x 36x 40x 728x 2109x 2109x 627x 1482x 398x 398x 398x 1084x 885x 885x 885x 2109x 11542549x 728x 11542549x 728x 1378x 728x 5226701x 5226701x 193161881x 31040069x 5226701x 728x 421640x 417550x 421640x 728x 1995513x 728x 116453x 116453x 800x 800x 728x 62814x 1928x 60886x 60886x 70x 60886x 70x 728x 605729x 458x 605271x 604813x 458x 728x 14971060x 728x 34580275x 34580275x 34580275x 316597x 2360215x 15246714x 8x 15246706x 15246706x 15246706x 728x 4601323x 4601323x 275626x 728x 1836240x 1836240x 2078017x 2078017x 2078017x 728x 1892968x 1892968x 1892968x 1892968x 728x 43460751x 43458880x 4109666x 39349214x 25535601x 13813613x 37669x 37669x 37669x 13775944x 4162913x 9614902x 728x 177770x 222618x 728x 3505141x 3363049x 142092x 135291x 6801x 6801x 4x 6797x 45x 6752x 728x 1192x 32946254x 32946254x 32946254x 32946254x 728x 136705667x 136705667x 728x 32458166x 18406x 32439760x 32439760x 728x 260847x 8042x 8042x 8042x 252805x 252805x 728x 88535x 88535x 728x 9948097x 9948097x 9948097x 9948097x 9877799x 9877799x 213798x 9877799x 9877799x 4971065x 9337x 4971065x 9948097x 9948097x 9947868x 9322535x 9947868x 9947868x 172x 9947696x 728x 3696755x 3696755x 3696755x 5391498x 175x 3696580x 728x 2210x 728x 2002485x 2002485x 222209460x 2002485x 728x 5745852x 728x 5748954x 3102x 5745852x 5745852x 5745852x 5745852x 33x 5745819x 3696755x 3696755x 2049064x 728x 240507242x 1873x 54476250x 54476250x 54476250x 54476250x 20x 4x 24564228x 3803389x 36688828x 36688828x 9905833x 9905833x 9905833x 70483252x 70483252x 70483252x 70483252x 28x 472x 25313913x 25313913x 25313913x 25313913x 111510059x 19521428x 91988631x 91988631x 91988631x 91988631x 91988631x 91988631x 111509499x 40x 12124600x 6102444x 520x 3224638x 3224638x 3224638x 34942311x 728x 5180814x 5180814x 20078785x 19852079x 19852079x 19748174x 8x 19748166x 19748166x 19748138x 28x 28x 28x 28x 28x 19446597x 8x 19446589x 4x 19446585x 19446585x 19895218x 19895218x 19895218x 19895218x 19895218x 19895218x 19895218x 19895218x 19895218x 43195x 19446585x 728x 19757649x 19757649x 19757649x 19757649x 19757649x 19757649x 956x 956x 19756693x 19756693x 19756693x 56x 56x 56x 19756637x 19756637x 19756637x 19756637x 3494583x 3494583x 19756637x 19756637x 19756637x 19730513x 26124x 19756637x 8x 19756629x 70474822x 70473598x 3102459x 67371139x 1224x 19757441x 5108242x 3065506x 5108242x 23x 652471x 652471x 652471x 652471x 728x 48143097x 728x 728x 320x 728x 728x 8917x 229x 229x 728x 118x 728x 13248886x 13248886x 1097945x 12150941x 12138297x 9042462x 3108479x 728x 824931x 824931x 12x 824919x 824919x 824919x 910332x 910332x 910332x 910332x 910332x 824919x 728x 4837x 2874x 1963x 728x 1193967x 444x 1193523x 461000x 732523x 16x 732507x 728x 28112572x 1707837x 1707837x 728x 1578504x 1578504x 728x 3925x 3925x 3925x 3925x 3925x 3925x 3925x 1888x 3925x 474x 3451x 1406x 728x 1152x 1152x 1152x 1152x 2541x 1152x 1152x 1152x 192x 192x 1152x 192x 728x 728x 728x 728x 728x 728x 8017240x 728x 53685594x 53685594x 53685594x 53685594x 728x 7258x 728x 728x 24369x 20247x 20247x 20247x 20247x 20247x 20247x 20247x 20247x 20247x 20247x 728x 31023465x 31023465x 118x 31023347x 31023347x 29141957x 31023347x 31023347x 728x 319x 319x 319x 728x 112605x 112605x 112605x 728x 181995x 728x 22359x 715x 715x 22359x 3571x 22106x 22106x 462x 308x 462x 462x 21644x 728x 728x 52902339x 164547x 212657x 728x 355802x 354958x 844x 844x 8x 844x 844x 844x | import * as crypto from 'crypto';
import type { SrvRecord } from 'dns';
import { type EventEmitter } from 'events';
import { promises as fs } from 'fs';
import * as http from 'http';
import { clearTimeout, setTimeout } from 'timers';
import * as url from 'url';
import { URL } from 'url';
import { promisify } from 'util';
import { deserialize, type Document, ObjectId, resolveBSONOptions } from './bson';
import type { Connection } from './cmap/connection';
import { MAX_SUPPORTED_WIRE_VERSION } from './cmap/wire_protocol/constants';
import type { Collection } from './collection';
import { kDecoratedKeys, LEGACY_HELLO_COMMAND } from './constants';
import type { AbstractCursor } from './cursor/abstract_cursor';
import type { FindCursor } from './cursor/find_cursor';
import type { Db } from './db';
import {
type AnyError,
MongoAPIError,
MongoCompatibilityError,
MongoInvalidArgumentError,
MongoNetworkTimeoutError,
MongoNotConnectedError,
MongoParseError,
MongoRuntimeError
} from './error';
import type { MongoClient } from './mongo_client';
import { type Abortable } from './mongo_types';
import type { CommandOperationOptions, OperationParent } from './operations/command';
import type { Hint, OperationOptions } from './operations/operation';
import { ReadConcern } from './read_concern';
import { ReadPreference } from './read_preference';
import { ServerType } from './sdam/common';
import type { Server } from './sdam/server';
import type { Topology } from './sdam/topology';
import type { ClientSession } from './sessions';
import { type TimeoutContextOptions } from './timeout';
import { WriteConcern } from './write_concern';
/**
* MongoDB Driver style callback
* @public
*/
export type Callback<T = any> = (error?: AnyError, result?: T) => void;
export type AnyOptions = Document;
export const ByteUtils = {
toLocalBufferType(this: void, buffer: Buffer | Uint8Array): Buffer {
return Buffer.isBuffer(buffer)
? buffer
: Buffer.from(buffer.buffer, buffer.byteOffset, buffer.byteLength);
},
equals(this: void, seqA: Uint8Array, seqB: Uint8Array) {
return ByteUtils.toLocalBufferType(seqA).equals(seqB);
},
compare(this: void, seqA: Uint8Array, seqB: Uint8Array) {
return ByteUtils.toLocalBufferType(seqA).compare(seqB);
},
toBase64(this: void, uint8array: Uint8Array) {
return ByteUtils.toLocalBufferType(uint8array).toString('base64');
}
};
/**
* Returns true if value is a Uint8Array or a Buffer
* @param value - any value that may be a Uint8Array
*/
export function isUint8Array(value: unknown): value is Uint8Array {
return (
value != null &&
typeof value === 'object' &&
Symbol.toStringTag in value &&
value[Symbol.toStringTag] === 'Uint8Array'
);
}
/**
* Determines if a connection's address matches a user provided list
* of domain wildcards.
*/
export function hostMatchesWildcards(host: string, wildcards: string[]): boolean {
for (const wildcard of wildcards) {
if (
host === wildcard ||
(wildcard.startsWith('*.') && host?.endsWith(wildcard.substring(2, wildcard.length))) ||
(wildcard.startsWith('*/') && host?.endsWith(wildcard.substring(2, wildcard.length)))
) {
return true;
}
}
return false;
}
/**
* Ensure Hint field is in a shape we expect:
* - object of index names mapping to 1 or -1
* - just an index name
* @internal
*/
export function normalizeHintField(hint?: Hint): Hint | undefined {
let finalHint = undefined;
if (typeof hint === 'string') {
finalHint = hint;
} else if (Array.isArray(hint)) {
finalHint = {};
hint.forEach(param => {
finalHint[param] = 1;
});
} else if (hint != null && typeof hint === 'object') {
finalHint = {} as Document;
for (const name in hint) {
finalHint[name] = hint[name];
}
}
return finalHint;
}
const TO_STRING = (object: unknown) => Object.prototype.toString.call(object);
/**
* Checks if arg is an Object:
* - **NOTE**: the check is based on the `[Symbol.toStringTag]() === 'Object'`
* @internal
*/
export function isObject(arg: unknown): arg is object {
return '[object Object]' === TO_STRING(arg);
}
/** @internal */
export function mergeOptions<T, S>(target: T, source: S): T & S {
return { ...target, ...source };
}
/** @internal */
export function filterOptions(options: AnyOptions, names: ReadonlyArray<string>): AnyOptions {
const filterOptions: AnyOptions = {};
for (const name in options) {
if (names.includes(name)) {
filterOptions[name] = options[name];
}
}
// Filtered options
return filterOptions;
}
interface HasRetryableWrites {
retryWrites?: boolean;
}
/**
* Applies retryWrites: true to a command if retryWrites is set on the command's database.
* @internal
*
* @param target - The target command to which we will apply retryWrites.
* @param db - The database from which we can inherit a retryWrites value.
*/
export function applyRetryableWrites<T extends HasRetryableWrites>(target: T, db?: Db): T {
if (db && db.s.options?.retryWrites) {
target.retryWrites = true;
}
return target;
}
/**
* Applies a write concern to a command based on well defined inheritance rules, optionally
* detecting support for the write concern in the first place.
* @internal
*
* @param target - the target command we will be applying the write concern to
* @param sources - sources where we can inherit default write concerns from
* @param options - optional settings passed into a command for write concern overrides
*/
/**
* Checks if a given value is a Promise
*
* @typeParam T - The resolution type of the possible promise
* @param value - An object that could be a promise
* @returns true if the provided value is a Promise
*/
export function isPromiseLike<T = unknown>(value?: unknown): value is PromiseLike<T> {
return (
value != null &&
typeof value === 'object' &&
'then' in value &&
typeof value.then === 'function'
);
}
/**
* Applies collation to a given command.
* @internal
*
* @param command - the command on which to apply collation
* @param target - target of command
* @param options - options containing collation settings
*/
export function decorateWithCollation(
command: Document,
target: MongoClient | Db | Collection,
options: AnyOptions
): void {
const capabilities = getTopology(target).capabilities;
if (options.collation && typeof options.collation === 'object') {
Eif (capabilities && capabilities.commandsTakeCollation) {
command.collation = options.collation;
} else {
throw new MongoCompatibilityError(`Current topology does not support collation`);
}
}
}
/**
* Applies a read concern to a given command.
* @internal
*
* @param command - the command on which to apply the read concern
* @param coll - the parent collection of the operation calling this method
*/
export function decorateWithReadConcern(
command: Document,
coll: { s: { readConcern?: ReadConcern } },
options?: OperationOptions
): void {
if (options && options.session && options.session.inTransaction()) {
return;
}
const readConcern = Object.assign({}, command.readConcern || {});
if (coll.s.readConcern) {
Object.assign(readConcern, coll.s.readConcern);
}
if (Object.keys(readConcern).length > 0) {
Object.assign(command, { readConcern: readConcern });
}
}
/**
* @internal
*/
export type TopologyProvider =
| MongoClient
| ClientSession
| FindCursor
| AbstractCursor
| Collection<any>
| Db;
/**
* A helper function to get the topology from a given provider. Throws
* if the topology cannot be found.
* @throws MongoNotConnectedError
* @internal
*/
export function getTopology(provider: TopologyProvider): Topology {
// MongoClient or ClientSession or AbstractCursor
if ('topology' in provider && provider.topology) {
return provider.topology;
} else if ('client' in provider && provider.client.topology) {
return provider.client.topology;
}
throw new MongoNotConnectedError('MongoClient must be connected to perform this operation');
}
/** @internal */
export function ns(ns: string): MongoDBNamespace {
return MongoDBNamespace.fromString(ns);
}
/** @public */
export class MongoDBNamespace {
/**
* Create a namespace object
*
* @param db - database name
* @param collection - collection name
*/
constructor(
public db: string,
public collection?: string
) {
this.collection = collection === '' ? undefined : collection;
}
toString(): string {
return this.collection ? `${this.db}.${this.collection}` : this.db;
}
withCollection(collection: string): MongoDBCollectionNamespace {
return new MongoDBCollectionNamespace(this.db, collection);
}
static fromString(namespace?: string): MongoDBNamespace {
if (typeof namespace !== 'string' || namespace === '') {
// TODO(NODE-3483): Replace with MongoNamespaceError
throw new MongoRuntimeError(`Cannot parse namespace from "${namespace}"`);
}
const [db, ...collectionParts] = namespace.split('.');
const collection = collectionParts.join('.');
return new MongoDBNamespace(db, collection === '' ? undefined : collection);
}
}
/**
* @public
*
* A class representing a collection's namespace. This class enforces (through Typescript) that
* the `collection` portion of the namespace is defined and should only be
* used in scenarios where this can be guaranteed.
*/
export class MongoDBCollectionNamespace extends MongoDBNamespace {
constructor(
db: string,
override collection: string
) {
super(db, collection);
}
static override fromString(namespace?: string): MongoDBCollectionNamespace {
return super.fromString(namespace) as MongoDBCollectionNamespace;
}
}
/** @internal */
export function* makeCounter(seed = 0): Generator<number> {
let count = seed;
while (true) {
const newCount = count;
count += 1;
yield newCount;
}
}
/**
* Synchronously Generate a UUIDv4
* @internal
*/
export function uuidV4(): Buffer {
const result = crypto.randomBytes(16);
result[6] = (result[6] & 0x0f) | 0x40;
result[8] = (result[8] & 0x3f) | 0x80;
return result;
}
/**
* A helper function for determining `maxWireVersion` between legacy and new topology instances
* @internal
*/
export function maxWireVersion(topologyOrServer?: Connection | Topology | Server): number {
if (topologyOrServer) {
if (topologyOrServer.loadBalanced || topologyOrServer.serverApi?.version) {
// Since we do not have a monitor in the load balanced mode,
// we assume the load-balanced server is always pointed at the latest mongodb version.
// There is a risk that for on-prem deployments
// that don't upgrade immediately that this could alert to the
// application that a feature is available that is actually not.
// We also return the max supported wire version for serverAPI.
return MAX_SUPPORTED_WIRE_VERSION;
}
if (topologyOrServer.hello) {
return topologyOrServer.hello.maxWireVersion;
}
if ('lastHello' in topologyOrServer && typeof topologyOrServer.lastHello === 'function') {
const lastHello = topologyOrServer.lastHello();
Eif (lastHello) {
return lastHello.maxWireVersion;
}
}
if (
topologyOrServer.description &&
'maxWireVersion' in topologyOrServer.description &&
topologyOrServer.description.maxWireVersion != null
) {
return topologyOrServer.description.maxWireVersion;
}
}
return 0;
}
/** @internal */
export function arrayStrictEqual(arr: unknown[], arr2: unknown[]): boolean {
Iif (!Array.isArray(arr) || !Array.isArray(arr2)) {
return false;
}
return arr.length === arr2.length && arr.every((elt, idx) => elt === arr2[idx]);
}
/** @internal */
export function errorStrictEqual(lhs?: AnyError | null, rhs?: AnyError | null): boolean {
if (lhs === rhs) {
return true;
}
if (!lhs || !rhs) {
return lhs === rhs;
}
Iif ((lhs == null && rhs != null) || (lhs != null && rhs == null)) {
return false;
}
if (lhs.constructor.name !== rhs.constructor.name) {
return false;
}
if (lhs.message !== rhs.message) {
return false;
}
return true;
}
interface StateTable {
[key: string]: string[];
}
interface ObjectWithState {
s: { state: string };
emit(event: 'stateChanged', state: string, newState: string): void;
}
interface StateTransitionFunction {
(target: ObjectWithState, newState: string): void;
}
/** @public */
export type EventEmitterWithState = {
/** @internal */
stateChanged(previous: string, current: string): void;
};
/** @internal */
export function makeStateMachine(stateTable: StateTable): StateTransitionFunction {
return function stateTransition(target, newState) {
const legalStates = stateTable[target.s.state];
Iif (legalStates && legalStates.indexOf(newState) < 0) {
throw new MongoRuntimeError(
`illegal state transition from [${target.s.state}] => [${newState}], allowed: [${legalStates}]`
);
}
target.emit('stateChanged', target.s.state, newState);
target.s.state = newState;
};
}
/** @internal */
export function now(): number {
const hrtime = process.hrtime();
return Math.floor(hrtime[0] * 1000 + hrtime[1] / 1000000);
}
/** @internal */
export function calculateDurationInMs(started: number | undefined): number {
if (typeof started !== 'number') {
return -1;
}
const elapsed = now() - started;
return elapsed < 0 ? 0 : elapsed;
}
/** @internal */
export function hasAtomicOperators(doc: Document | Document[]): boolean {
if (Array.isArray(doc)) {
for (const document of doc) {
Eif (hasAtomicOperators(document)) {
return true;
}
}
return false;
}
const keys = Object.keys(doc);
return keys.length > 0 && keys[0][0] === '$';
}
export function resolveTimeoutOptions<T extends Partial<TimeoutContextOptions>>(
client: MongoClient,
options: T
): T &
Pick<
MongoClient['s']['options'],
'timeoutMS' | 'serverSelectionTimeoutMS' | 'waitQueueTimeoutMS' | 'socketTimeoutMS'
> {
const { socketTimeoutMS, serverSelectionTimeoutMS, waitQueueTimeoutMS, timeoutMS } =
client.s.options;
return { socketTimeoutMS, serverSelectionTimeoutMS, waitQueueTimeoutMS, timeoutMS, ...options };
}
/**
* Merge inherited properties from parent into options, prioritizing values from options,
* then values from parent.
*
* @param parent - An optional owning class of the operation being run. ex. Db/Collection/MongoClient.
* @param options - The options passed to the operation method.
*
* @internal
*/
export function resolveOptions<T extends CommandOperationOptions>(
parent: OperationParent | undefined,
options?: T
): T {
const result: T = Object.assign({}, options, resolveBSONOptions(options, parent));
const timeoutMS = options?.timeoutMS ?? parent?.timeoutMS;
// Users cannot pass a readConcern/writeConcern to operations in a transaction
const session = options?.session;
if (!session?.inTransaction()) {
const readConcern = ReadConcern.fromOptions(options) ?? parent?.readConcern;
if (readConcern) {
result.readConcern = readConcern;
}
let writeConcern = WriteConcern.fromOptions(options) ?? parent?.writeConcern;
if (writeConcern) {
if (timeoutMS != null) {
writeConcern = WriteConcern.fromOptions({
writeConcern: {
...writeConcern,
wtimeout: undefined,
wtimeoutMS: undefined
}
});
}
result.writeConcern = writeConcern;
}
}
result.timeoutMS = timeoutMS;
const readPreference = ReadPreference.fromOptions(options) ?? parent?.readPreference;
if (readPreference) {
result.readPreference = readPreference;
}
const isConvenientTransaction = session?.explicit && session?.timeoutContext != null;
if (isConvenientTransaction && options?.timeoutMS != null) {
throw new MongoInvalidArgumentError(
'An operation cannot be given a timeoutMS setting when inside a withTransaction call that has a timeoutMS setting'
);
}
return result;
}
export function isSuperset(set: Set<any> | any[], subset: Set<any> | any[]): boolean {
set = Array.isArray(set) ? new Set(set) : set;
subset = Array.isArray(subset) ? new Set(subset) : subset;
for (const elem of subset) {
if (!set.has(elem)) {
return false;
}
}
return true;
}
/**
* Checks if the document is a Hello request
* @internal
*/
export function isHello(doc: Document): boolean {
return doc[LEGACY_HELLO_COMMAND] || doc.hello ? true : false;
}
/** Returns the items that are uniquely in setA */
export function setDifference<T>(setA: Iterable<T>, setB: Iterable<T>): Set<T> {
const difference = new Set<T>(setA);
for (const elem of setB) {
difference.delete(elem);
}
return difference;
}
const HAS_OWN = (object: unknown, prop: string) =>
Object.prototype.hasOwnProperty.call(object, prop);
export function isRecord<T extends readonly string[]>(
value: unknown,
requiredKeys: T
): value is Record<T[number], any>;
export function isRecord(value: unknown): value is Record<string, any>;
export function isRecord(
value: unknown,
requiredKeys: string[] | undefined = undefined
): value is Record<string, any> {
if (!isObject(value)) {
return false;
}
const ctor = (value as any).constructor;
Eif (ctor && ctor.prototype) {
Iif (!isObject(ctor.prototype)) {
return false;
}
// Check to see if some method exists from the Object exists
if (!HAS_OWN(ctor.prototype, 'isPrototypeOf')) {
return false;
}
}
if (requiredKeys) {
const keys = Object.keys(value as Record<string, any>);
return isSuperset(keys, requiredKeys);
}
return true;
}
type ListNode<T> = {
value: T;
next: ListNode<T> | HeadNode<T>;
prev: ListNode<T> | HeadNode<T>;
};
type HeadNode<T> = {
value: null;
next: ListNode<T>;
prev: ListNode<T>;
};
/**
* When a list is empty the head is a reference with pointers to itself
* So this type represents that self referential state
*/
type EmptyNode = {
value: null;
next: EmptyNode;
prev: EmptyNode;
};
/**
* A sequential list of items in a circularly linked list
* @remarks
* The head node is special, it is always defined and has a value of null.
* It is never "included" in the list, in that, it is not returned by pop/shift or yielded by the iterator.
* The circular linkage and always defined head node are to reduce checks for null next/prev references to zero.
* New nodes are declared as object literals with keys always in the same order: next, prev, value.
* @internal
*/
export class List<T = unknown> {
private readonly head: HeadNode<T> | EmptyNode;
private count: number;
get length() {
return this.count;
}
get [Symbol.toStringTag]() {
return 'List' as const;
}
constructor() {
this.count = 0;
// this is carefully crafted:
// declaring a complete and consistently key ordered
// object is beneficial to the runtime optimizations
this.head = {
next: null,
prev: null,
value: null
} as unknown as EmptyNode;
this.head.next = this.head;
this.head.prev = this.head;
}
toArray() {
return Array.from(this);
}
toString() {
return `head <=> ${this.toArray().join(' <=> ')} <=> head`;
}
*[Symbol.iterator](): Generator<T, void, void> {
for (const node of this.nodes()) {
yield node.value;
}
}
private *nodes(): Generator<ListNode<T>, void, void> {
let ptr: HeadNode<T> | ListNode<T> | EmptyNode = this.head.next;
while (ptr !== this.head) {
// Save next before yielding so that we make removing within iteration safe
const { next } = ptr as ListNode<T>;
yield ptr as ListNode<T>;
ptr = next;
}
}
/** Insert at end of list */
push(value: T) {
this.count += 1;
const newNode: ListNode<T> = {
next: this.head as HeadNode<T>,
prev: this.head.prev as ListNode<T>,
value
};
this.head.prev.next = newNode;
this.head.prev = newNode;
}
/** Inserts every item inside an iterable instead of the iterable itself */
pushMany(iterable: Iterable<T>) {
for (const value of iterable) {
this.push(value);
}
}
/** Insert at front of list */
unshift(value: T) {
this.count += 1;
const newNode: ListNode<T> = {
next: this.head.next as ListNode<T>,
prev: this.head as HeadNode<T>,
value
};
this.head.next.prev = newNode;
this.head.next = newNode;
}
private remove(node: ListNode<T> | EmptyNode): T | null {
if (node === this.head || this.length === 0) {
return null;
}
this.count -= 1;
const prevNode = node.prev;
const nextNode = node.next;
prevNode.next = nextNode;
nextNode.prev = prevNode;
return node.value;
}
/** Removes the first node at the front of the list */
shift(): T | null {
return this.remove(this.head.next);
}
/** Removes the last node at the end of the list */
pop(): T | null {
return this.remove(this.head.prev);
}
/** Iterates through the list and removes nodes where filter returns true */
prune(filter: (value: T) => boolean) {
for (const node of this.nodes()) {
if (filter(node.value)) {
this.remove(node);
}
}
}
clear() {
this.count = 0;
this.head.next = this.head as EmptyNode;
this.head.prev = this.head as EmptyNode;
}
/** Returns the first item in the list, does not remove */
first(): T | null {
// If the list is empty, value will be the head's null
return this.head.next.value;
}
/** Returns the last item in the list, does not remove */
last(): T | null {
// If the list is empty, value will be the head's null
return this.head.prev.value;
}
}
/**
* A pool of Buffers which allow you to read them as if they were one
* @internal
*/
export class BufferPool {
private buffers: List<Buffer>;
private totalByteLength: number;
constructor() {
this.buffers = new List();
this.totalByteLength = 0;
}
get length(): number {
return this.totalByteLength;
}
/** Adds a buffer to the internal buffer pool list */
append(buffer: Buffer): void {
this.buffers.push(buffer);
this.totalByteLength += buffer.length;
}
/**
* If BufferPool contains 4 bytes or more construct an int32 from the leading bytes,
* otherwise return null. Size can be negative, caller should error check.
*/
getInt32(): number | null {
if (this.totalByteLength < 4) {
return null;
}
const firstBuffer = this.buffers.first();
if (firstBuffer != null && firstBuffer.byteLength >= 4) {
return firstBuffer.readInt32LE(0);
}
// Unlikely case: an int32 is split across buffers.
// Use read and put the returned buffer back on top
const top4Bytes = this.read(4);
const value = top4Bytes.readInt32LE(0);
// Put it back.
this.totalByteLength += 4;
this.buffers.unshift(top4Bytes);
return value;
}
/** Reads the requested number of bytes, optionally consuming them */
read(size: number): Buffer {
if (typeof size !== 'number' || size < 0) {
throw new MongoInvalidArgumentError('Argument "size" must be a non-negative number');
}
// oversized request returns empty buffer
if (size > this.totalByteLength) {
return Buffer.alloc(0);
}
// We know we have enough, we just don't know how it is spread across chunks
// TODO(NODE-4732): alloc API should change based on raw option
const result = Buffer.allocUnsafe(size);
for (let bytesRead = 0; bytesRead < size; ) {
const buffer = this.buffers.shift();
Iif (buffer == null) {
break;
}
const bytesRemaining = size - bytesRead;
const bytesReadable = Math.min(bytesRemaining, buffer.byteLength);
const bytes = buffer.subarray(0, bytesReadable);
result.set(bytes, bytesRead);
bytesRead += bytesReadable;
this.totalByteLength -= bytesReadable;
if (bytesReadable < buffer.byteLength) {
this.buffers.unshift(buffer.subarray(bytesReadable));
}
}
return result;
}
}
/** @public */
export class HostAddress {
host: string | undefined = undefined;
port: number | undefined = undefined;
socketPath: string | undefined = undefined;
isIPv6 = false;
constructor(hostString: string) {
const escapedHost = hostString.split(' ').join('%20'); // escape spaces, for socket path hosts
if (escapedHost.endsWith('.sock')) {
// heuristically determine if we're working with a domain socket
this.socketPath = decodeURIComponent(escapedHost);
return;
}
const urlString = `iLoveJS://${escapedHost}`;
let url;
try {
url = new URL(urlString);
} catch (urlError) {
const runtimeError = new MongoRuntimeError(`Unable to parse ${escapedHost} with URL`);
runtimeError.cause = urlError;
throw runtimeError;
}
const hostname = url.hostname;
const port = url.port;
let normalized = decodeURIComponent(hostname).toLowerCase();
if (normalized.startsWith('[') && normalized.endsWith(']')) {
this.isIPv6 = true;
normalized = normalized.substring(1, hostname.length - 1);
}
this.host = normalized.toLowerCase();
Iif (typeof port === 'number') {
this.port = port;
} else if (typeof port === 'string' && port !== '') {
this.port = Number.parseInt(port, 10);
} else {
this.port = 27017;
}
if (this.port === 0) {
throw new MongoParseError('Invalid port (zero) with hostname');
}
Object.freeze(this);
}
[Symbol.for('nodejs.util.inspect.custom')](): string {
return this.inspect();
}
inspect(): string {
return `new HostAddress('${this.toString()}')`;
}
toString(): string {
if (typeof this.host === 'string') {
if (this.isIPv6) {
return `[${this.host}]:${this.port}`;
}
return `${this.host}:${this.port}`;
}
return `${this.socketPath}`;
}
static fromString(this: void, s: string): HostAddress {
return new HostAddress(s);
}
static fromHostPort(host: string, port: number): HostAddress {
if (host.includes(':')) {
host = `[${host}]`; // IPv6 address
}
return HostAddress.fromString(`${host}:${port}`);
}
static fromSrvRecord({ name, port }: SrvRecord): HostAddress {
return HostAddress.fromHostPort(name, port);
}
toHostPort(): { host: string; port: number } {
Iif (this.socketPath) {
return { host: this.socketPath, port: 0 };
}
const host = this.host ?? '';
const port = this.port ?? 0;
return { host, port };
}
}
export const DEFAULT_PK_FACTORY = {
// We prefer not to rely on ObjectId having a createPk method
createPk(): ObjectId {
return new ObjectId();
}
};
/**
* When the driver used emitWarning the code will be equal to this.
* @public
*
* @example
* ```ts
* process.on('warning', (warning) => {
* if (warning.code === MONGODB_WARNING_CODE) console.error('Ah an important warning! :)')
* })
* ```
*/
export const MONGODB_WARNING_CODE = 'MONGODB DRIVER';
/** @internal */
export function emitWarning(message: string): void {
return process.emitWarning(message, { code: MONGODB_WARNING_CODE } as any);
}
const emittedWarnings = new Set();
/**
* Will emit a warning once for the duration of the application.
* Uses the message to identify if it has already been emitted
* so using string interpolation can cause multiple emits
* @internal
*/
export function emitWarningOnce(message: string): void {
if (!emittedWarnings.has(message)) {
emittedWarnings.add(message);
return emitWarning(message);
}
}
/**
* Takes a JS object and joins the values into a string separated by ', '
*/
export function enumToString(en: Record<string, unknown>): string {
return Object.values(en).join(', ');
}
/**
* Determine if a server supports retryable writes.
*
* @internal
*/
export function supportsRetryableWrites(server?: Server): boolean {
Iif (!server) {
return false;
}
if (server.loadBalanced) {
// Loadbalanced topologies will always support retry writes
return true;
}
if (server.description.logicalSessionTimeoutMinutes != null) {
// that supports sessions
if (server.description.type !== ServerType.Standalone) {
// and that is not a standalone
return true;
}
}
return false;
}
/**
* Fisher–Yates Shuffle
*
* Reference: https://bost.ocks.org/mike/shuffle/
* @param sequence - items to be shuffled
* @param limit - Defaults to `0`. If nonzero shuffle will slice the randomized array e.g, `.slice(0, limit)` otherwise will return the entire randomized array.
*/
export function shuffle<T>(sequence: Iterable<T>, limit = 0): Array<T> {
const items = Array.from(sequence); // shallow copy in order to never shuffle the input
if (limit > items.length) {
throw new MongoRuntimeError('Limit must be less than the number of items');
}
let remainingItemsToShuffle = items.length;
const lowerBound = limit % items.length === 0 ? 1 : items.length - limit;
while (remainingItemsToShuffle > lowerBound) {
// Pick a remaining element
const randomIndex = Math.floor(Math.random() * remainingItemsToShuffle);
remainingItemsToShuffle -= 1;
// And swap it with the current element
const swapHold = items[remainingItemsToShuffle];
items[remainingItemsToShuffle] = items[randomIndex];
items[randomIndex] = swapHold;
}
return limit % items.length === 0 ? items : items.slice(lowerBound);
}
/**
* TODO(NODE-4936): read concern eligibility for commands should be codified in command construction
* @internal
* @see https://github.com/mongodb/specifications/blob/master/source/read-write-concern/read-write-concern.md#read-concern
*/
export function commandSupportsReadConcern(command: Document): boolean {
if (command.aggregate || command.count || command.distinct || command.find || command.geoNear) {
return true;
}
return false;
}
/**
* Compare objectIds. `null` is always less
* - `+1 = oid1 is greater than oid2`
* - `-1 = oid1 is less than oid2`
* - `+0 = oid1 is equal oid2`
*/
export function compareObjectId(oid1?: ObjectId | null, oid2?: ObjectId | null): 0 | 1 | -1 {
if (oid1 == null && oid2 == null) {
return 0;
}
if (oid1 == null) {
return -1;
}
if (oid2 == null) {
return 1;
}
return ByteUtils.compare(oid1.id, oid2.id);
}
export function parseInteger(value: unknown): number | null {
if (typeof value === 'number') return Math.trunc(value);
const parsedValue = Number.parseInt(String(value), 10);
return Number.isNaN(parsedValue) ? null : parsedValue;
}
export function parseUnsignedInteger(value: unknown): number | null {
const parsedInt = parseInteger(value);
return parsedInt != null && parsedInt >= 0 ? parsedInt : null;
}
/**
* This function throws a MongoAPIError in the event that either of the following is true:
* * If the provided address domain does not match the provided parent domain
* * If the parent domain contains less than three `.` separated parts and the provided address does not contain at least one more domain level than its parent
*
* If a DNS server were to become compromised SRV records would still need to
* advertise addresses that are under the same domain as the srvHost.
*
* @param address - The address to check against a domain
* @param srvHost - The domain to check the provided address against
* @returns void
*/
export function checkParentDomainMatch(address: string, srvHost: string): void {
// Remove trailing dot if exists on either the resolved address or the srv hostname
const normalizedAddress = address.endsWith('.') ? address.slice(0, address.length - 1) : address;
const normalizedSrvHost = srvHost.endsWith('.') ? srvHost.slice(0, srvHost.length - 1) : srvHost;
const allCharacterBeforeFirstDot = /^.*?\./;
const srvIsLessThanThreeParts = normalizedSrvHost.split('.').length < 3;
// Remove all characters before first dot
// Add leading dot back to string so
// an srvHostDomain = '.trusted.site'
// will not satisfy an addressDomain that endsWith '.fake-trusted.site'
const addressDomain = `.${normalizedAddress.replace(allCharacterBeforeFirstDot, '')}`;
let srvHostDomain = srvIsLessThanThreeParts
? normalizedSrvHost
: `.${normalizedSrvHost.replace(allCharacterBeforeFirstDot, '')}`;
if (!srvHostDomain.startsWith('.')) {
srvHostDomain = '.' + srvHostDomain;
}
if (
srvIsLessThanThreeParts &&
normalizedAddress.split('.').length <= normalizedSrvHost.split('.').length
) {
throw new MongoAPIError(
'Server record does not have at least one more domain level than parent URI'
);
}
if (!addressDomain.endsWith(srvHostDomain)) {
throw new MongoAPIError('Server record does not share hostname with parent URI');
}
}
interface RequestOptions {
json?: boolean;
method?: string;
timeout?: number;
headers?: http.OutgoingHttpHeaders;
}
/**
* Perform a get request that returns status and body.
* @internal
*/
export function get(
url: URL | string,
options: http.RequestOptions = {}
): Promise<{ body: string; status: number | undefined }> {
return new Promise((resolve, reject) => {
/* eslint-disable prefer-const */
let timeoutId: NodeJS.Timeout;
const request = http
.get(url, options, response => {
response.setEncoding('utf8');
let body = '';
response.on('data', chunk => (body += chunk));
response.on('end', () => {
clearTimeout(timeoutId);
resolve({ status: response.statusCode, body });
});
})
.on('error', error => {
clearTimeout(timeoutId);
reject(error);
})
.end();
timeoutId = setTimeout(() => {
request.destroy(new MongoNetworkTimeoutError(`request timed out after 10 seconds`));
}, 10000);
});
}
export async function request(uri: string): Promise<Record<string, any>>;
export async function request(
uri: string,
options?: { json?: true } & RequestOptions
): Promise<Record<string, any>>;
export async function request(
uri: string,
options?: { json: false } & RequestOptions
): Promise<string>;
export async function request(
uri: string,
options: RequestOptions = {}
): Promise<string | Record<string, any>> {
return await new Promise<string | Record<string, any>>((resolve, reject) => {
const requestOptions = {
method: 'GET',
timeout: 10000,
json: true,
...url.parse(uri),
...options
};
const req = http.request(requestOptions, res => {
res.setEncoding('utf8');
let data = '';
res.on('data', d => {
data += d;
});
res.once('end', () => {
if (options.json === false) {
resolve(data);
return;
}
try {
const parsed = JSON.parse(data);
resolve(parsed);
} catch {
// TODO(NODE-3483)
reject(new MongoRuntimeError(`Invalid JSON response: "${data}"`));
}
});
});
req.once('timeout', () =>
req.destroy(
new MongoNetworkTimeoutError(
`Network request to ${uri} timed out after ${options.timeout} ms`
)
)
);
req.once('error', error => reject(error));
req.end();
});
}
/** @internal */
export const DOCUMENT_DB_CHECK = /(\.docdb\.amazonaws\.com$)|(\.docdb-elastic\.amazonaws\.com$)/;
/** @internal */
export const COSMOS_DB_CHECK = /\.cosmos\.azure\.com$/;
/** @internal */
export const DOCUMENT_DB_MSG =
'You appear to be connected to a DocumentDB cluster. For more information regarding feature compatibility and support please visit https://www.mongodb.com/supportability/documentdb';
/** @internal */
export const COSMOS_DB_MSG =
'You appear to be connected to a CosmosDB cluster. For more information regarding feature compatibility and support please visit https://www.mongodb.com/supportability/cosmosdb';
/** @internal */
export function isHostMatch(match: RegExp, host?: string): boolean {
return host && match.test(host.toLowerCase()) ? true : false;
}
export function promiseWithResolvers<T>(): {
promise: Promise<T>;
resolve: (value: T) => void;
reject: (error: Error) => void;
} {
let resolve!: (value: T) => void;
let reject!: (error: Error) => void;
const promise = new Promise<T>(function withResolversExecutor(promiseResolve, promiseReject) {
resolve = promiseResolve;
reject = promiseReject;
});
return { promise, resolve, reject } as const;
}
/**
* A noop function intended for use in preventing unhandled rejections.
*
* @example
* ```js
* const promise = myAsyncTask();
* // eslint-disable-next-line github/no-then
* promise.then(undefined, squashError);
* ```
*/
export function squashError(_error: unknown) {
return;
}
export const randomBytes = promisify(crypto.randomBytes);
/**
* Replicates the events.once helper.
*
* Removes unused signal logic and It **only** supports 0 or 1 argument events.
*
* @param ee - An event emitter that may emit `ev`
* @param name - An event name to wait for
*/
export async function once<T>(ee: EventEmitter, name: string, options?: Abortable): Promise<T> {
options?.signal?.throwIfAborted();
const { promise, resolve, reject } = promiseWithResolvers<T>();
const onEvent = (data: T) => resolve(data);
const onError = (error: Error) => reject(error);
const abortListener = addAbortListener(options?.signal, function () {
reject(this.reason);
});
ee.once(name, onEvent).once('error', onError);
try {
return await promise;
} finally {
ee.off(name, onEvent);
ee.off('error', onError);
abortListener?.[kDispose]();
}
}
export function maybeAddIdToDocuments(
coll: Collection,
docs: Document[],
options: { forceServerObjectId?: boolean }
): Document[];
export function maybeAddIdToDocuments(
coll: Collection,
docs: Document,
options: { forceServerObjectId?: boolean }
): Document;
export function maybeAddIdToDocuments(
coll: Collection,
docOrDocs: Document[] | Document,
options: { forceServerObjectId?: boolean }
): Document[] | Document {
const forceServerObjectId =
typeof options.forceServerObjectId === 'boolean'
? options.forceServerObjectId
: coll.s.db.options?.forceServerObjectId;
// no need to modify the docs if server sets the ObjectId
if (forceServerObjectId === true) {
return docOrDocs;
}
const transform = (doc: Document): Document => {
if (doc._id == null) {
doc._id = coll.s.pkFactory.createPk();
}
return doc;
};
return Array.isArray(docOrDocs) ? docOrDocs.map(transform) : transform(docOrDocs);
}
export async function fileIsAccessible(fileName: string, mode?: number) {
try {
await fs.access(fileName, mode);
return true;
} catch {
return false;
}
}
export function csotMin(duration1: number, duration2: number): number {
Iif (duration1 === 0) return duration2;
Iif (duration2 === 0) return duration1;
return Math.min(duration1, duration2);
}
export function noop() {
return;
}
/**
* Recurse through the (identically-shaped) `decrypted` and `original`
* objects and attach a `decryptedKeys` property on each sub-object that
* contained encrypted fields. Because we only call this on BSON responses,
* we do not need to worry about circular references.
*
* @internal
*/
export function decorateDecryptionResult(
decrypted: Document & { [kDecoratedKeys]?: Array<string> },
original: Document,
isTopLevelDecorateCall = true
): void {
if (isTopLevelDecorateCall) {
// The original value could have been either a JS object or a BSON buffer
Iif (Buffer.isBuffer(original)) {
original = deserialize(original);
}
Iif (Buffer.isBuffer(decrypted)) {
throw new MongoRuntimeError('Expected result of decryption to be deserialized BSON object');
}
}
if (!decrypted || typeof decrypted !== 'object') return;
for (const k of Object.keys(decrypted)) {
const originalValue = original[k];
// An object was decrypted by libmongocrypt if and only if it was
// a BSON Binary object with subtype 6.
if (originalValue && originalValue._bsontype === 'Binary' && originalValue.sub_type === 6) {
if (!decrypted[kDecoratedKeys]) {
Object.defineProperty(decrypted, kDecoratedKeys, {
value: [],
configurable: true,
enumerable: false,
writable: false
});
}
// this is defined in the preceding if-statement
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
decrypted[kDecoratedKeys]!.push(k);
// Do not recurse into this decrypted value. It could be a sub-document/array,
// in which case there is no original value associated with its subfields.
continue;
}
decorateDecryptionResult(decrypted[k], originalValue, false);
}
}
/** @internal */
export const kDispose: unique symbol = (Symbol.dispose as any) ?? Symbol('dispose');
/** @internal */
export interface Disposable {
[kDispose](): void;
}
/**
* A utility that helps with writing listener code idiomatically
*
* @example
* ```js
* using listener = addAbortListener(signal, function () {
* console.log('aborted', this.reason);
* });
* ```
*
* @param signal - if exists adds an abort listener
* @param listener - the listener to be added to signal
* @returns A disposable that will remove the abort listener
*/
export function addAbortListener(
signal: AbortSignal | undefined | null,
listener: (this: AbortSignal, event: Event) => void
): Disposable | undefined {
if (signal == null) return;
signal.addEventListener('abort', listener, { once: true });
return { [kDispose]: () => signal.removeEventListener('abort', listener) };
}
/**
* Takes a promise and races it with a promise wrapping the abort event of the optionally provided signal.
* The given promise is _always_ ordered before the signal's abort promise.
* When given an already rejected promise and an already aborted signal, the promise's rejection takes precedence.
*
* Any asynchronous processing in `promise` will continue even after the abort signal has fired,
* but control will be returned to the caller
*
* @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/race
*
* @param promise - A promise to discard if the signal aborts
* @param options - An options object carrying an optional signal
*/
export async function abortable<T>(
promise: Promise<T>,
{ signal }: { signal?: AbortSignal }
): Promise<T> {
if (signal == null) {
return await promise;
}
const { promise: aborted, reject } = promiseWithResolvers<never>();
const abortListener = signal.aborted
? reject(signal.reason)
: addAbortListener(signal, function () {
reject(this.reason);
});
try {
return await Promise.race([promise, aborted]);
} finally {
abortListener?.[kDispose]();
}
}
|