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 | 572x 572x 572x 572x 572x 572x 572x 572x 5720x 572x 572x 5464400x 572x 572x 572x 23971460x 23971460x 23971460x 55724x 23915736x 572x 1952629x 404x 404x 396x 2002141x 64x 2002077x 64x 2002013x 49912x 1952101x 72x 1952029x 72x 1951957x 12012846x 2732200x 2732200x 2732200x 572x 1027550x 1027550x 1027550x 27884136x 8222986x 19661150x 753553x 753553x 18907597x 18907597x 15229299x 3152490x 3152490x 6613776x 6613776x 731240x 731240x 4731793x 4731793x 15229299x 1027550x 8x 1027542x 273977x 753565x 753565x 753561x 4x 8x 1027550x 237x 237x 4x 1027546x 940804x 940804x 408354x 408354x 408354x 408354x 408354x 408354x 118660x 118660x 118660x 118660x 118660x 118660x 118660x 7080x 118660x 118660x 118660x 304467x 304467x 304467x 304467x 152965x 152965x 47280x 47280x 47280x 47280x 47280x 47280x 47280x 572x 940772x 940772x 183236x 183236x 332x 332x 332x 181644x 181644x 181644x 181644x 43142x 43142x 43142x 59240x 59240x 59240x 59240x 59240x 57041x 57041x 57041x 57041x 57041x 2379x 2379x 2379x 2379x 2379x 21386x 21386x 21386x 21386x 21386x 21386x 17797x 17797x 17797x 895x 895x 895x 140x 895x 21286x 21286x 21286x 13816x 13816x 13816x 13816x 13484x 13484x 13484x 13484x 13484x 14076x 14076x 14076x 14076x 241x 241x 60x 60x 1227x 1227x 412x 1227x 12488x 12488x 60x 14076x 52695x 52695x 52695x 592x 592x 592x 80x 80x 80x 80x 432x 432x 432x 432x 592x 592x 52363x 52363x 52363x 52363x 52363x 52363x 52363x 52363x 52363x 21857x 21857x 21857x 21857x 21857x 21857x 21857x 21857x 23640x 23640x 23640x 23640x 22139x 22139x 22139x 22139x 22139x 22139x 22139x 1501x 1501x 1501x 1501x 1501x 1501x 12901x 12901x 12901x 12901x 12901x 12901x 36169x 36169x 36169x 36169x 36169x 40x 100x 40x 572x 54644x 54644x 54644x 54644x 54644x 54644x 54644x 54644x 54644x 54644x 54644x 54644x 54644x 273220x 273220x 2732200x 54644x 16x 80x 80x 800x 16x 4x 4x 4x 12x 12x 12x 12x 12x 12x 12x 40x 2767839x 2767799x 2233164x 993144x 993144x 52340x 940804x 940804x 32x 940772x 993144x 8x 8x 8x 993136x 993136x 993132x 28x 4x 2002141x 2002141x 2002141x 2002141x | import { inspect, promisify } from 'util';
import {
type Binary,
type BSONRegExp,
type BSONSymbol,
type Code,
type DBRef,
type Decimal128,
type Document,
type Double,
EJSON,
type EJSONOptions,
type Int32,
type Long,
type MaxKey,
type MinKey,
type ObjectId,
type Timestamp
} from './bson';
import type { CommandStartedEvent } from './cmap/command_monitoring_events';
import type {
ConnectionCheckedInEvent,
ConnectionCheckedOutEvent,
ConnectionCheckOutFailedEvent,
ConnectionCheckOutStartedEvent,
ConnectionClosedEvent,
ConnectionCreatedEvent,
ConnectionPoolClearedEvent,
ConnectionPoolClosedEvent,
ConnectionPoolCreatedEvent,
ConnectionPoolReadyEvent,
ConnectionReadyEvent
} from './cmap/connection_pool_events';
import {
COMMAND_FAILED,
COMMAND_STARTED,
COMMAND_SUCCEEDED,
CONNECTION_CHECK_OUT_FAILED,
CONNECTION_CHECK_OUT_STARTED,
CONNECTION_CHECKED_IN,
CONNECTION_CHECKED_OUT,
CONNECTION_CLOSED,
CONNECTION_CREATED,
CONNECTION_POOL_CLEARED,
CONNECTION_POOL_CLOSED,
CONNECTION_POOL_CREATED,
CONNECTION_POOL_READY,
CONNECTION_READY,
SERVER_CLOSED,
SERVER_HEARTBEAT_FAILED,
SERVER_HEARTBEAT_STARTED,
SERVER_HEARTBEAT_SUCCEEDED,
SERVER_OPENING,
SERVER_SELECTION_FAILED,
SERVER_SELECTION_STARTED,
SERVER_SELECTION_SUCCEEDED,
TOPOLOGY_CLOSED,
TOPOLOGY_DESCRIPTION_CHANGED,
TOPOLOGY_OPENING,
WAITING_FOR_SUITABLE_SERVER
} from './constants';
import type {
ServerClosedEvent,
ServerOpeningEvent,
TopologyClosedEvent,
TopologyDescriptionChangedEvent,
TopologyOpeningEvent
} from './sdam/events';
import type {
ServerSelectionEvent,
ServerSelectionFailedEvent,
ServerSelectionStartedEvent,
ServerSelectionSucceededEvent,
WaitingForSuitableServerEvent
} from './sdam/server_selection_events';
import { HostAddress, isPromiseLike, isUint8Array, parseUnsignedInteger } from './utils';
/**
* @public
* Severity levels align with unix syslog.
* Most typical driver functions will log to debug.
*/
export const SeverityLevel = Object.freeze({
EMERGENCY: 'emergency',
ALERT: 'alert',
CRITICAL: 'critical',
ERROR: 'error',
WARNING: 'warn',
NOTICE: 'notice',
INFORMATIONAL: 'info',
DEBUG: 'debug',
TRACE: 'trace',
OFF: 'off'
} as const);
/** @internal */
export const DEFAULT_MAX_DOCUMENT_LENGTH = 1000;
/** @public */
export type SeverityLevel = (typeof SeverityLevel)[keyof typeof SeverityLevel];
/** @internal */
class SeverityLevelMap extends Map<SeverityLevel | number, SeverityLevel | number> {
constructor(entries: [SeverityLevel | number, SeverityLevel | number][]) {
const newEntries: [number | SeverityLevel, SeverityLevel | number][] = [];
for (const [level, value] of entries) {
newEntries.push([value, level]);
}
newEntries.push(...entries);
super(newEntries);
}
getNumericSeverityLevel(severity: SeverityLevel): number {
return this.get(severity) as number;
}
getSeverityLevelName(level: number): SeverityLevel | undefined {
return this.get(level) as SeverityLevel | undefined;
}
}
/** @internal */
export const SEVERITY_LEVEL_MAP = new SeverityLevelMap([
[SeverityLevel.OFF, -Infinity],
[SeverityLevel.EMERGENCY, 0],
[SeverityLevel.ALERT, 1],
[SeverityLevel.CRITICAL, 2],
[SeverityLevel.ERROR, 3],
[SeverityLevel.WARNING, 4],
[SeverityLevel.NOTICE, 5],
[SeverityLevel.INFORMATIONAL, 6],
[SeverityLevel.DEBUG, 7],
[SeverityLevel.TRACE, 8]
]);
/** @public */
export const MongoLoggableComponent = Object.freeze({
COMMAND: 'command',
TOPOLOGY: 'topology',
SERVER_SELECTION: 'serverSelection',
CONNECTION: 'connection',
CLIENT: 'client'
} as const);
/** @public */
export type MongoLoggableComponent =
(typeof MongoLoggableComponent)[keyof typeof MongoLoggableComponent];
/** @internal */
export interface MongoLoggerEnvOptions {
/** Severity level for command component */
MONGODB_LOG_COMMAND?: string;
/** Severity level for topology component */
MONGODB_LOG_TOPOLOGY?: string;
/** Severity level for server selection component */
MONGODB_LOG_SERVER_SELECTION?: string;
/** Severity level for CMAP */
MONGODB_LOG_CONNECTION?: string;
/** Severity level for client */
MONGODB_LOG_CLIENT?: string;
/** Default severity level to be if any of the above are unset */
MONGODB_LOG_ALL?: string;
/** Max length of embedded EJSON docs. Setting to 0 disables truncation. Defaults to 1000. */
MONGODB_LOG_MAX_DOCUMENT_LENGTH?: string;
/** Destination for log messages. Must be 'stderr', 'stdout'. Defaults to 'stderr'. */
MONGODB_LOG_PATH?: string;
}
/** @public */
export interface LogComponentSeveritiesClientOptions {
/** Optional severity level for command component */
command?: SeverityLevel;
/** Optional severity level for topology component */
topology?: SeverityLevel;
/** Optional severity level for server selection component */
serverSelection?: SeverityLevel;
/** Optional severity level for connection component */
connection?: SeverityLevel;
/** Optional severity level for client component */
client?: SeverityLevel;
/** Optional default severity level to be used if any of the above are unset */
default?: SeverityLevel;
}
/** @internal */
export interface MongoLoggerMongoClientOptions {
/** Destination for log messages */
mongodbLogPath?: 'stdout' | 'stderr' | MongoDBLogWritable;
/** Severity levels for logger components */
mongodbLogComponentSeverities?: LogComponentSeveritiesClientOptions;
/** Max length of embedded EJSON docs. Setting to 0 disables truncation. Defaults to 1000. */
mongodbLogMaxDocumentLength?: number;
}
/** @internal */
export interface MongoLoggerOptions {
componentSeverities: {
/** Severity level for command component */
command: SeverityLevel;
/** Severity level for topology component */
topology: SeverityLevel;
/** Severity level for server selection component */
serverSelection: SeverityLevel;
/** Severity level for connection component */
connection: SeverityLevel;
/** Severity level for client component */
client: SeverityLevel;
/** Default severity level to be used if any of the above are unset */
default: SeverityLevel;
};
/** Max length of embedded EJSON docs. Setting to 0 disables truncation. Defaults to 1000. */
maxDocumentLength: number;
/** Destination for log messages. */
logDestination: MongoDBLogWritable;
/** For internal check to see if error should stop logging. */
logDestinationIsStdErr: boolean;
}
/**
* Parses a string as one of SeverityLevel
* @internal
*
* @param s - the value to be parsed
* @returns one of SeverityLevel if value can be parsed as such, otherwise null
*/
export function parseSeverityFromString(s?: string): SeverityLevel | null {
const validSeverities: string[] = Object.values(SeverityLevel);
const lowerSeverity = s?.toLowerCase();
if (lowerSeverity != null && validSeverities.includes(lowerSeverity)) {
return lowerSeverity as SeverityLevel;
}
return null;
}
/** @internal */
export function createStdioLogger(stream: {
write: NodeJS.WriteStream['write'];
}): MongoDBLogWritable {
return {
write: promisify((log: Log, cb: (error?: Error) => void): unknown => {
const logLine = inspect(log, { compact: true, breakLength: Infinity });
stream.write(`${logLine}\n`, 'utf-8', cb);
return;
})
};
}
/**
* resolves the MONGODB_LOG_PATH and mongodbLogPath options from the environment and the
* mongo client options respectively. The mongodbLogPath can be either 'stdout', 'stderr', a NodeJS
* Writable or an object which has a `write` method with the signature:
* ```ts
* write(log: Log): void
* ```
*
* @returns the MongoDBLogWritable object to write logs to
*/
function resolveLogPath(
{ MONGODB_LOG_PATH }: MongoLoggerEnvOptions,
{ mongodbLogPath }: MongoLoggerMongoClientOptions
): { mongodbLogPath: MongoDBLogWritable; mongodbLogPathIsStdErr: boolean } {
if (typeof mongodbLogPath === 'string' && /^stderr$/i.test(mongodbLogPath)) {
return { mongodbLogPath: createStdioLogger(process.stderr), mongodbLogPathIsStdErr: true };
}
if (typeof mongodbLogPath === 'string' && /^stdout$/i.test(mongodbLogPath)) {
return { mongodbLogPath: createStdioLogger(process.stdout), mongodbLogPathIsStdErr: false };
}
if (typeof mongodbLogPath === 'object' && typeof mongodbLogPath?.write === 'function') {
return { mongodbLogPath: mongodbLogPath, mongodbLogPathIsStdErr: false };
}
if (MONGODB_LOG_PATH && /^stderr$/i.test(MONGODB_LOG_PATH)) {
return { mongodbLogPath: createStdioLogger(process.stderr), mongodbLogPathIsStdErr: true };
}
if (MONGODB_LOG_PATH && /^stdout$/i.test(MONGODB_LOG_PATH)) {
return { mongodbLogPath: createStdioLogger(process.stdout), mongodbLogPathIsStdErr: false };
}
return { mongodbLogPath: createStdioLogger(process.stderr), mongodbLogPathIsStdErr: true };
}
function resolveSeverityConfiguration(
clientOption: string | undefined,
environmentOption: string | undefined,
defaultSeverity: SeverityLevel
): SeverityLevel {
return (
parseSeverityFromString(clientOption) ??
parseSeverityFromString(environmentOption) ??
defaultSeverity
);
}
/** @public */
export interface Log extends Record<string, any> {
t: Date;
c: MongoLoggableComponent;
s: SeverityLevel;
message?: string;
}
/**
* @public
*
* A custom destination for structured logging messages.
*/
export interface MongoDBLogWritable {
/**
* This function will be called for every enabled log message.
*
* It can be sync or async:
* - If it is synchronous it will block the driver from proceeding until this method returns.
* - If it is asynchronous the driver will not await the returned promise. It will attach fulfillment handling (`.then`).
* If the promise rejects the logger will write an error message to stderr and stop functioning.
* If the promise resolves the driver proceeds to the next log message (or waits for new ones to occur).
*
* Tips:
* - We recommend writing an async `write` function that _never_ rejects.
* Instead handle logging errors as necessary to your use case and make the write function a noop, until it can be recovered.
* - The Log messages are structured but **subject to change** since the intended purpose is informational.
* Program against this defensively and err on the side of stringifying whatever is passed in to write in some form or another.
*
*/
write(log: Log): PromiseLike<unknown> | unknown;
}
function compareSeverity(s0: SeverityLevel, s1: SeverityLevel): 1 | 0 | -1 {
const s0Num = SEVERITY_LEVEL_MAP.getNumericSeverityLevel(s0);
const s1Num = SEVERITY_LEVEL_MAP.getNumericSeverityLevel(s1);
return s0Num < s1Num ? -1 : s0Num > s1Num ? 1 : 0;
}
/**
* @internal
* Must be separate from Events API due to differences in spec requirements for logging a command success
*/
export type LoggableCommandSucceededEvent = {
address: string;
connectionId?: string | number;
requestId: number;
duration: number;
commandName: string;
reply: Document | undefined;
serviceId?: ObjectId;
name: typeof COMMAND_SUCCEEDED;
serverConnectionId: bigint | null;
databaseName: string;
};
/**
* @internal
* Must be separate from Events API due to differences in spec requirements for logging a command failure
*/
export type LoggableCommandFailedEvent = {
address: string;
connectionId?: string | number;
requestId: number;
duration: number;
commandName: string;
failure: Error;
serviceId?: ObjectId;
name: typeof COMMAND_FAILED;
serverConnectionId: bigint | null;
databaseName: string;
};
/**
* @internal
* Must be separate from Events API due to differences in spec requirements for logging server heartbeat beginning
*/
export type LoggableServerHeartbeatStartedEvent = {
topologyId: number;
awaited: boolean;
connectionId: string;
name: typeof SERVER_HEARTBEAT_STARTED;
};
/**
* @internal
* Must be separate from Events API due to differences in spec requirements for logging server heartbeat success
*/
export type LoggableServerHeartbeatSucceededEvent = {
topologyId: number;
awaited: boolean;
connectionId: string;
reply: Document;
serverConnectionId: number | '<monitor>';
duration: number;
name: typeof SERVER_HEARTBEAT_SUCCEEDED;
};
/**
* @internal
* Must be separate from Events API due to differences in spec requirements for logging server heartbeat failure
*/
export type LoggableServerHeartbeatFailedEvent = {
topologyId: number;
awaited: boolean;
connectionId: string;
failure: Error;
duration: number;
name: typeof SERVER_HEARTBEAT_FAILED;
};
type SDAMLoggableEvent =
| ServerClosedEvent
| LoggableServerHeartbeatFailedEvent
| LoggableServerHeartbeatStartedEvent
| LoggableServerHeartbeatSucceededEvent
| ServerOpeningEvent
| TopologyClosedEvent
| TopologyDescriptionChangedEvent
| TopologyOpeningEvent;
/** @internal */
export type LoggableEvent =
| ServerSelectionStartedEvent
| ServerSelectionFailedEvent
| ServerSelectionSucceededEvent
| WaitingForSuitableServerEvent
| CommandStartedEvent
| LoggableCommandSucceededEvent
| LoggableCommandFailedEvent
| ConnectionPoolCreatedEvent
| ConnectionPoolReadyEvent
| ConnectionPoolClosedEvent
| ConnectionPoolClearedEvent
| ConnectionCreatedEvent
| ConnectionReadyEvent
| ConnectionClosedEvent
| ConnectionCheckedInEvent
| ConnectionCheckedOutEvent
| ConnectionCheckOutStartedEvent
| ConnectionCheckOutFailedEvent
| ServerClosedEvent
| LoggableServerHeartbeatFailedEvent
| LoggableServerHeartbeatStartedEvent
| LoggableServerHeartbeatSucceededEvent
| ServerOpeningEvent
| TopologyClosedEvent
| TopologyDescriptionChangedEvent
| TopologyOpeningEvent;
/** @internal */
export interface LogConvertible extends Record<string, any> {
toLog(): Record<string, any>;
}
type BSONObject =
| BSONRegExp
| BSONSymbol
| Code
| DBRef
| Decimal128
| Double
| Int32
| Long
| MaxKey
| MinKey
| ObjectId
| Timestamp
| Binary;
/** @internal */
export function stringifyWithMaxLen(
value: any,
maxDocumentLength: number,
options: EJSONOptions = {}
): string {
let strToTruncate = '';
let currentLength = 0;
const maxDocumentLengthEnsurer = function maxDocumentLengthEnsurer(key: string, value: any) {
if (currentLength >= maxDocumentLength) {
return undefined;
}
// Account for root document
if (key === '') {
// Account for starting brace
currentLength += 1;
return value;
}
// +4 accounts for 2 quotation marks, colon and comma after value
// Note that this potentially undercounts since it does not account for escape sequences which
// will have an additional backslash added to them once passed through JSON.stringify.
currentLength += key.length + 4;
if (value == null) return value;
switch (typeof value) {
case 'string':
// +2 accounts for quotes
// Note that this potentially undercounts similarly to the key length calculation
currentLength += value.length + 2;
break;
case 'number':
case 'bigint':
currentLength += String(value).length;
break;
case 'boolean':
currentLength += value ? 4 : 5;
break;
case 'object':
Iif (isUint8Array(value)) {
// '{"$binary":{"base64":"<base64 string>","subType":"XX"}}'
// This is an estimate based on the fact that the base64 is approximately 1.33x the length of
// the actual binary sequence https://en.wikipedia.org/wiki/Base64
currentLength += (22 + value.byteLength + value.byteLength * 0.33 + 18) | 0;
} else Iif ('_bsontype' in value) {
const v = value as BSONObject;
switch (v._bsontype) {
case 'Int32':
currentLength += String(v.value).length;
break;
case 'Double':
// Account for representing integers as <value>.0
currentLength +=
(v.value | 0) === v.value ? String(v.value).length + 2 : String(v.value).length;
break;
case 'Long':
currentLength += v.toString().length;
break;
case 'ObjectId':
// '{"$oid":"XXXXXXXXXXXXXXXXXXXXXXXX"}'
currentLength += 35;
break;
case 'MaxKey':
case 'MinKey':
// '{"$maxKey":1}' or '{"$minKey":1}'
currentLength += 13;
break;
case 'Binary':
// '{"$binary":{"base64":"<base64 string>","subType":"XX"}}'
// This is an estimate based on the fact that the base64 is approximately 1.33x the length of
// the actual binary sequence https://en.wikipedia.org/wiki/Base64
currentLength += (22 + value.position + value.position * 0.33 + 18) | 0;
break;
case 'Timestamp':
// '{"$timestamp":{"t":<t>,"i":<i>}}'
currentLength += 19 + String(v.t).length + 5 + String(v.i).length + 2;
break;
case 'Code':
// '{"$code":"<code>"}' or '{"$code":"<code>","$scope":<scope>}'
if (v.scope == null) {
currentLength += v.code.length + 10 + 2;
} else {
// Ignoring actual scope object, so this undercounts by a significant amount
currentLength += v.code.length + 10 + 11;
}
break;
case 'BSONRegExp':
// '{"$regularExpression":{"pattern":"<pattern>","options":"<options>"}}'
currentLength += 34 + v.pattern.length + 13 + v.options.length + 3;
break;
}
}
}
return value;
};
if (typeof value === 'string') {
strToTruncate = value;
} else if (typeof value === 'function') {
strToTruncate = value.name;
} else {
try {
if (maxDocumentLength !== 0) {
strToTruncate = EJSON.stringify(value, maxDocumentLengthEnsurer, 0, options);
} else {
strToTruncate = EJSON.stringify(value, options);
}
} catch (e) {
strToTruncate = `Extended JSON serialization failed with: ${e.message}`;
}
}
// handle truncation that occurs in the middle of multi-byte codepoints
if (
maxDocumentLength !== 0 &&
strToTruncate.length > maxDocumentLength &&
strToTruncate.charCodeAt(maxDocumentLength - 1) !==
strToTruncate.codePointAt(maxDocumentLength - 1)
) {
maxDocumentLength--;
if (maxDocumentLength === 0) {
return '';
}
}
return maxDocumentLength !== 0 && strToTruncate.length > maxDocumentLength
? `${strToTruncate.slice(0, maxDocumentLength)}...`
: strToTruncate;
}
/** @internal */
export type Loggable = LoggableEvent | LogConvertible;
function isLogConvertible(obj: Loggable): obj is LogConvertible {
const objAsLogConvertible = obj as LogConvertible;
// eslint-disable-next-line no-restricted-syntax
return objAsLogConvertible.toLog !== undefined && typeof objAsLogConvertible.toLog === 'function';
}
function attachServerSelectionFields(
log: Record<string, any>,
serverSelectionEvent: ServerSelectionEvent,
maxDocumentLength: number = DEFAULT_MAX_DOCUMENT_LENGTH
) {
const { selector, operation, topologyDescription, message } = serverSelectionEvent;
log.selector = stringifyWithMaxLen(selector, maxDocumentLength);
log.operation = operation;
log.topologyDescription = stringifyWithMaxLen(topologyDescription, maxDocumentLength);
log.message = message;
return log;
}
function attachCommandFields(
log: Record<string, any>,
commandEvent: CommandStartedEvent | LoggableCommandSucceededEvent | LoggableCommandFailedEvent
) {
log.commandName = commandEvent.commandName;
log.requestId = commandEvent.requestId;
log.driverConnectionId = commandEvent.connectionId;
const { host, port } = HostAddress.fromString(commandEvent.address).toHostPort();
log.serverHost = host;
log.serverPort = port;
if (commandEvent?.serviceId) {
log.serviceId = commandEvent.serviceId.toHexString();
}
log.databaseName = commandEvent.databaseName;
log.serverConnectionId = commandEvent.serverConnectionId;
return log;
}
function attachConnectionFields(log: Record<string, any>, event: any) {
const { host, port } = HostAddress.fromString(event.address).toHostPort();
log.serverHost = host;
log.serverPort = port;
return log;
}
function attachSDAMFields(log: Record<string, any>, sdamEvent: SDAMLoggableEvent) {
log.topologyId = sdamEvent.topologyId;
return log;
}
function attachServerHeartbeatFields(
log: Record<string, any>,
serverHeartbeatEvent:
| LoggableServerHeartbeatFailedEvent
| LoggableServerHeartbeatStartedEvent
| LoggableServerHeartbeatSucceededEvent
) {
const { awaited, connectionId } = serverHeartbeatEvent;
log.awaited = awaited;
log.driverConnectionId = serverHeartbeatEvent.connectionId;
const { host, port } = HostAddress.fromString(connectionId).toHostPort();
log.serverHost = host;
log.serverPort = port;
return log;
}
/** @internal */
export function defaultLogTransform(
logObject: LoggableEvent | Record<string, any>,
maxDocumentLength: number = DEFAULT_MAX_DOCUMENT_LENGTH
): Omit<Log, 's' | 't' | 'c'> {
let log: Omit<Log, 's' | 't' | 'c'> = Object.create(null);
switch (logObject.name) {
case SERVER_SELECTION_STARTED:
log = attachServerSelectionFields(log, logObject, maxDocumentLength);
return log;
case SERVER_SELECTION_FAILED:
log = attachServerSelectionFields(log, logObject, maxDocumentLength);
log.failure = logObject.failure?.message;
return log;
case SERVER_SELECTION_SUCCEEDED:
log = attachServerSelectionFields(log, logObject, maxDocumentLength);
log.serverHost = logObject.serverHost;
log.serverPort = logObject.serverPort;
return log;
case WAITING_FOR_SUITABLE_SERVER:
log = attachServerSelectionFields(log, logObject, maxDocumentLength);
log.remainingTimeMS = logObject.remainingTimeMS;
return log;
case COMMAND_STARTED:
log = attachCommandFields(log, logObject);
log.message = 'Command started';
log.command = stringifyWithMaxLen(logObject.command, maxDocumentLength, { relaxed: true });
log.databaseName = logObject.databaseName;
return log;
case COMMAND_SUCCEEDED:
log = attachCommandFields(log, logObject);
log.message = 'Command succeeded';
log.durationMS = logObject.duration;
log.reply = stringifyWithMaxLen(logObject.reply, maxDocumentLength, { relaxed: true });
return log;
case COMMAND_FAILED:
log = attachCommandFields(log, logObject);
log.message = 'Command failed';
log.durationMS = logObject.duration;
log.failure = logObject.failure?.message ?? '(redacted)';
return log;
case CONNECTION_POOL_CREATED:
log = attachConnectionFields(log, logObject);
log.message = 'Connection pool created';
Eif (logObject.options) {
const { maxIdleTimeMS, minPoolSize, maxPoolSize, maxConnecting, waitQueueTimeoutMS } =
logObject.options;
log = {
...log,
maxIdleTimeMS,
minPoolSize,
maxPoolSize,
maxConnecting,
waitQueueTimeoutMS
};
}
return log;
case CONNECTION_POOL_READY:
log = attachConnectionFields(log, logObject);
log.message = 'Connection pool ready';
return log;
case CONNECTION_POOL_CLEARED:
log = attachConnectionFields(log, logObject);
log.message = 'Connection pool cleared';
if (logObject.serviceId?._bsontype === 'ObjectId') {
log.serviceId = logObject.serviceId?.toHexString();
}
return log;
case CONNECTION_POOL_CLOSED:
log = attachConnectionFields(log, logObject);
log.message = 'Connection pool closed';
return log;
case CONNECTION_CREATED:
log = attachConnectionFields(log, logObject);
log.message = 'Connection created';
log.driverConnectionId = logObject.connectionId;
return log;
case CONNECTION_READY:
log = attachConnectionFields(log, logObject);
log.message = 'Connection ready';
log.driverConnectionId = logObject.connectionId;
log.durationMS = logObject.durationMS;
return log;
case CONNECTION_CLOSED:
log = attachConnectionFields(log, logObject);
log.message = 'Connection closed';
log.driverConnectionId = logObject.connectionId;
switch (logObject.reason) {
case 'stale':
log.reason = 'Connection became stale because the pool was cleared';
break;
case 'idle':
log.reason =
'Connection has been available but unused for longer than the configured max idle time';
break;
case 'error':
log.reason = 'An error occurred while using the connection';
if (logObject.error) {
log.error = logObject.error;
}
break;
case 'poolClosed':
log.reason = 'Connection pool was closed';
break;
default:
log.reason = `Unknown close reason: ${logObject.reason}`;
}
return log;
case CONNECTION_CHECK_OUT_STARTED:
log = attachConnectionFields(log, logObject);
log.message = 'Connection checkout started';
return log;
case CONNECTION_CHECK_OUT_FAILED:
log = attachConnectionFields(log, logObject);
log.message = 'Connection checkout failed';
switch (logObject.reason) {
case 'poolClosed':
log.reason = 'Connection pool was closed';
break;
case 'timeout':
log.reason = 'Wait queue timeout elapsed without a connection becoming available';
break;
case 'connectionError':
log.reason = 'An error occurred while trying to establish a new connection';
Eif (logObject.error) {
log.error = logObject.error;
}
break;
default:
log.reason = `Unknown close reason: ${logObject.reason}`;
}
log.durationMS = logObject.durationMS;
return log;
case CONNECTION_CHECKED_OUT:
log = attachConnectionFields(log, logObject);
log.message = 'Connection checked out';
log.driverConnectionId = logObject.connectionId;
log.durationMS = logObject.durationMS;
return log;
case CONNECTION_CHECKED_IN:
log = attachConnectionFields(log, logObject);
log.message = 'Connection checked in';
log.driverConnectionId = logObject.connectionId;
return log;
case SERVER_OPENING:
log = attachSDAMFields(log, logObject);
log = attachConnectionFields(log, logObject);
log.message = 'Starting server monitoring';
return log;
case SERVER_CLOSED:
log = attachSDAMFields(log, logObject);
log = attachConnectionFields(log, logObject);
log.message = 'Stopped server monitoring';
return log;
case SERVER_HEARTBEAT_STARTED:
log = attachSDAMFields(log, logObject);
log = attachServerHeartbeatFields(log, logObject);
log.message = 'Server heartbeat started';
return log;
case SERVER_HEARTBEAT_SUCCEEDED:
log = attachSDAMFields(log, logObject);
log = attachServerHeartbeatFields(log, logObject);
log.message = 'Server heartbeat succeeded';
log.durationMS = logObject.duration;
log.serverConnectionId = logObject.serverConnectionId;
log.reply = stringifyWithMaxLen(logObject.reply, maxDocumentLength, { relaxed: true });
return log;
case SERVER_HEARTBEAT_FAILED:
log = attachSDAMFields(log, logObject);
log = attachServerHeartbeatFields(log, logObject);
log.message = 'Server heartbeat failed';
log.durationMS = logObject.duration;
log.failure = logObject.failure?.message;
return log;
case TOPOLOGY_OPENING:
log = attachSDAMFields(log, logObject);
log.message = 'Starting topology monitoring';
return log;
case TOPOLOGY_CLOSED:
log = attachSDAMFields(log, logObject);
log.message = 'Stopped topology monitoring';
return log;
case TOPOLOGY_DESCRIPTION_CHANGED:
log = attachSDAMFields(log, logObject);
log.message = 'Topology description changed';
log.previousDescription = log.reply = stringifyWithMaxLen(
logObject.previousDescription,
maxDocumentLength
);
log.newDescription = log.reply = stringifyWithMaxLen(
logObject.newDescription,
maxDocumentLength
);
return log;
default:
for (const [key, value] of Object.entries(logObject)) {
if (value != null) log[key] = value;
}
}
return log;
}
/** @internal */
export class MongoLogger {
componentSeverities: Record<MongoLoggableComponent, SeverityLevel>;
maxDocumentLength: number;
logDestination: MongoDBLogWritable;
logDestinationIsStdErr: boolean;
pendingLog: PromiseLike<unknown> | unknown = null;
private severities: Record<MongoLoggableComponent, Record<SeverityLevel, boolean>>;
/**
* This method should be used when logging errors that do not have a public driver API for
* reporting errors.
*/
error = this.log.bind(this, 'error');
/**
* This method should be used to log situations where undesirable application behaviour might
* occur. For example, failing to end sessions on `MongoClient.close`.
*/
warn = this.log.bind(this, 'warn');
/**
* This method should be used to report high-level information about normal driver behaviour.
* For example, the creation of a `MongoClient`.
*/
info = this.log.bind(this, 'info');
/**
* This method should be used to report information that would be helpful when debugging an
* application. For example, a command starting, succeeding or failing.
*/
debug = this.log.bind(this, 'debug');
/**
* This method should be used to report fine-grained details related to logic flow. For example,
* entering and exiting a function body.
*/
trace = this.log.bind(this, 'trace');
constructor(options: MongoLoggerOptions) {
this.componentSeverities = options.componentSeverities;
this.maxDocumentLength = options.maxDocumentLength;
this.logDestination = options.logDestination;
this.logDestinationIsStdErr = options.logDestinationIsStdErr;
this.severities = this.createLoggingSeverities();
}
createLoggingSeverities(): Record<MongoLoggableComponent, Record<SeverityLevel, boolean>> {
const severities = Object();
for (const component of Object.values(MongoLoggableComponent)) {
severities[component] = {};
for (const severityLevel of Object.values(SeverityLevel)) {
severities[component][severityLevel] =
compareSeverity(severityLevel, this.componentSeverities[component]) <= 0;
}
}
return severities;
}
turnOffSeverities() {
for (const component of Object.values(MongoLoggableComponent)) {
this.componentSeverities[component] = SeverityLevel.OFF;
for (const severityLevel of Object.values(SeverityLevel)) {
this.severities[component][severityLevel] = false;
}
}
}
private logWriteFailureHandler(error: Error) {
if (this.logDestinationIsStdErr) {
this.turnOffSeverities();
this.clearPendingLog();
return;
}
this.logDestination = createStdioLogger(process.stderr);
this.logDestinationIsStdErr = true;
this.clearPendingLog();
this.error(MongoLoggableComponent.CLIENT, {
toLog: function () {
return {
message: 'User input for mongodbLogPath is now invalid. Logging is halted.',
error: error.message
};
}
});
this.turnOffSeverities();
this.clearPendingLog();
}
private clearPendingLog() {
this.pendingLog = null;
}
willLog(component: MongoLoggableComponent, severity: SeverityLevel): boolean {
if (severity === SeverityLevel.OFF) return false;
return this.severities[component][severity];
}
private log(
severity: SeverityLevel,
component: MongoLoggableComponent,
message: Loggable | string
): void {
if (!this.willLog(component, severity)) return;
let logMessage: Log = { t: new Date(), c: component, s: severity };
if (typeof message === 'string') {
logMessage.message = message;
} else Eif (typeof message === 'object') {
if (isLogConvertible(message)) {
logMessage = { ...logMessage, ...message.toLog() };
} else {
logMessage = { ...logMessage, ...defaultLogTransform(message, this.maxDocumentLength) };
}
}
if (isPromiseLike(this.pendingLog)) {
this.pendingLog = this.pendingLog
.then(() => this.logDestination.write(logMessage))
.then(this.clearPendingLog.bind(this), this.logWriteFailureHandler.bind(this));
return;
}
try {
const logResult = this.logDestination.write(logMessage);
if (isPromiseLike(logResult)) {
this.pendingLog = logResult.then(
this.clearPendingLog.bind(this),
this.logWriteFailureHandler.bind(this)
);
}
} catch (error) {
this.logWriteFailureHandler(error);
}
}
/**
* Merges options set through environment variables and the MongoClient, preferring environment
* variables when both are set, and substituting defaults for values not set. Options set in
* constructor take precedence over both environment variables and MongoClient options.
*
* @remarks
* When parsing component severity levels, invalid values are treated as unset and replaced with
* the default severity.
*
* @param envOptions - options set for the logger from the environment
* @param clientOptions - options set for the logger in the MongoClient options
* @returns a MongoLoggerOptions object to be used when instantiating a new MongoLogger
*/
static resolveOptions(
envOptions: MongoLoggerEnvOptions,
clientOptions: MongoLoggerMongoClientOptions
): MongoLoggerOptions {
// client options take precedence over env options
const resolvedLogPath = resolveLogPath(envOptions, clientOptions);
const combinedOptions = {
...envOptions,
...clientOptions,
mongodbLogPath: resolvedLogPath.mongodbLogPath,
mongodbLogPathIsStdErr: resolvedLogPath.mongodbLogPathIsStdErr
};
const defaultSeverity = resolveSeverityConfiguration(
combinedOptions.mongodbLogComponentSeverities?.default,
combinedOptions.MONGODB_LOG_ALL,
SeverityLevel.OFF
);
return {
componentSeverities: {
command: resolveSeverityConfiguration(
combinedOptions.mongodbLogComponentSeverities?.command,
combinedOptions.MONGODB_LOG_COMMAND,
defaultSeverity
),
topology: resolveSeverityConfiguration(
combinedOptions.mongodbLogComponentSeverities?.topology,
combinedOptions.MONGODB_LOG_TOPOLOGY,
defaultSeverity
),
serverSelection: resolveSeverityConfiguration(
combinedOptions.mongodbLogComponentSeverities?.serverSelection,
combinedOptions.MONGODB_LOG_SERVER_SELECTION,
defaultSeverity
),
connection: resolveSeverityConfiguration(
combinedOptions.mongodbLogComponentSeverities?.connection,
combinedOptions.MONGODB_LOG_CONNECTION,
defaultSeverity
),
client: resolveSeverityConfiguration(
combinedOptions.mongodbLogComponentSeverities?.client,
combinedOptions.MONGODB_LOG_CLIENT,
defaultSeverity
),
default: defaultSeverity
},
maxDocumentLength:
combinedOptions.mongodbLogMaxDocumentLength ??
parseUnsignedInteger(combinedOptions.MONGODB_LOG_MAX_DOCUMENT_LENGTH) ??
1000,
logDestination: combinedOptions.mongodbLogPath,
logDestinationIsStdErr: combinedOptions.mongodbLogPathIsStdErr
};
}
}
|