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 | 1x 1x 1x 1x 1x 1x 5x 6x 10x 1x 1x 1x 1x 45x 56x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 8x 3x 8x 8x 8x 10x 8x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 191x 649x 649x 649x 649x 643x 643x 649x 285x 440x 112x 112x 112x 112x 112x 40x 112x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 262x 1x | const error = require("./_error");
const process = require("process");
const { AsyncLocalStorage } = require('node:async_hooks');
/* A list of kafkaJS compatible properties that we process.
* All of these are not necessarily supported, and an error will be
* thrown if they aren't. */
const kafkaJSProperties = {
common: [
"brokers",
"clientId",
"sasl",
"ssl",
"requestTimeout",
"enforceRequestTimeout",
"connectionTimeout",
"authenticationTimeout",
"retry",
"socketFactory",
"reauthenticationThreshold",
"logLevel",
'logger',
],
producer: [
'createPartitioner',
'metadataMaxAge',
'allowAutoTopicCreation',
'transactionTimeout',
'idempotent',
'maxInFlightRequests',
'transactionalId',
'compression',
'acks',
'timeout',
],
consumer: [
'groupId',
'partitionAssigners',
'partitionAssignors',
'sessionTimeout',
'rebalanceTimeout',
'heartbeatInterval',
'metadataMaxAge',
'allowAutoTopicCreation',
'maxBytesPerPartition',
'maxWaitTimeInMs',
'minBytes',
'maxBytes',
'readUncommitted',
'maxInFlightRequests',
'rackId',
'fromBeginning',
'autoCommit',
'autoCommitInterval',
'autoCommitThreshold',
],
admin: [],
};
/**
* A list of supported log levels.
* @enum {number}
* @readonly
* @memberof KafkaJS
*/
const logLevel = {
NOTHING: 0,
ERROR: 1,
WARN: 2,
INFO: 3,
DEBUG: 4,
};
const severityToLogLevel = Object.freeze({
0: logLevel.NOTHING,
1: logLevel.ERROR,
2: logLevel.ERROR,
3: logLevel.ERROR,
4: logLevel.WARN,
5: logLevel.WARN,
6: logLevel.INFO,
7: logLevel.DEBUG,
});
/**
* Default logger implementation.
* @type import("../../types/kafkajs").Logger
* @private
*/
class DefaultLogger {
constructor() {
this.logLevel = logLevel.INFO;
}
setLogLevel(logLevel) {
this.logLevel = logLevel;
}
info(message, extra) {
Iif (this.logLevel >= logLevel.INFO)
console.info({ message, ...extra });
}
error(message, extra) {
Eif (this.logLevel >= logLevel.ERROR)
console.error({ message, ...extra });
}
warn(message, extra) {
Eif (this.logLevel >= logLevel.WARN)
console.warn({ message, ...extra });
}
debug(message, extra) {
Iif (this.logLevel >= logLevel.DEBUG)
console.log({ message, ...extra });
}
namespace() {
return this;
}
}
/**
* Convenience function to create a new object to be used as metadata for log messages.
* Returned object is intended to be used immediately and not stored.
*
* @param {string|undefined} clientName
* @private
*/
function createBindingMessageMetadata(clientName) {
return {
name: clientName,
fac: 'BINDING',
timestamp: Date.now(),
};
}
/**
* Trampoline for user defined logger, if any.
* @param {{severity: number, fac: string, message: string}} msg
* @private
*
*/
function loggerTrampoline(msg, logger) {
Iif (!logger) {
return;
}
const level = severityToLogLevel[msg.severity];
switch (level) {
case logLevel.NOTHING:
break;
case logLevel.ERROR:
logger.error(msg.message, { fac: msg.fac, timestamp: Date.now(), name: msg.name });
break;
case logLevel.WARN:
logger.warn(msg.message, { fac: msg.fac, timestamp: Date.now(), name: msg.name });
break;
case logLevel.INFO:
logger.info(msg.message, { fac: msg.fac, timestamp: Date.now(), name: msg.name });
break;
case logLevel.DEBUG:
logger.debug(msg.message, { fac: msg.fac, timestamp: Date.now(), name: msg.name });
break;
default:
throw new error.KafkaJSError("Invalid logLevel", {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
}
function createReplacementErrorMessage(cOrP, fnCall, property, propertyVal, replacementVal, isLK = false) {
if (!isLK) {
replacementVal = `kafkaJS: { ${replacementVal}, ... }`;
}
return `'${property}' is not supported as a property to '${fnCall}', but must be passed to the ${cOrP} during creation.\n` +
`Before: \n` +
`\tconst ${cOrP} = kafka.${cOrP}({ ... });\n` +
`\tawait ${cOrP}.connect();\n` +
`\t${cOrP}.${fnCall}({ ${propertyVal}, ... });\n` +
`After: \n` +
`\tconst ${cOrP} = kafka.${cOrP}({ ${replacementVal}, ... });\n` +
`\tawait ${cOrP}.connect();\n` +
`\t${cOrP}.${fnCall}({ ... });\n` +
(isLK ? `For more details on what can be used outside the kafkaJS block, see https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md\n` : '');
}
const CompatibilityErrorMessages = Object.freeze({
/* Common */
brokerString: () =>
"The 'brokers' property must be an array of strings.\n" +
"For example: ['kafka:9092', 'kafka2:9093']\n",
saslUnsupportedMechanism: (mechanism) =>
`SASL mechanism ${mechanism} is not supported.`,
saslUsernamePasswordString: (mechanism) =>
`The 'sasl.username' and 'sasl.password' properties must be strings and must be present for the mechanism ${mechanism}.`,
saslOauthBearerProvider: () =>
`The 'oauthBearerProvider' property must be a function.`,
sslObject: () =>
"The 'ssl' property must be a boolean. Any additional configuration must be provided outside the kafkaJS block.\n" +
"Before: \n" +
"\tconst kafka = new Kafka({ kafkaJS: { ssl: { rejectUnauthorized: false, ca: [ ... ], key: ..., cert: ... }, } }); \n" +
"After: \n" +
'\tconst kafka = new Kafka({ kafkaJS: { ssl: true, }, "enable.ssl.certificate.verification": false, "ssl.ca.location": ..., "ssl.certificate.pem": ... });\n' +
`For more details on what can be used outside the kafkaJS block, see https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md\n`,
retryFactorMultiplier: () =>
+ "The 'retry.factor' and 'retry.multiplier' are not supported. They are always set to the default of 0.2 and 2 respectively.",
retryRestartOnFailure: () =>
"The restartOnFailure property is ignored. The client always retries on failure.",
socketFactory: () =>
"The socketFactory property is not supported.",
logLevelName: (setLevel) =>
"The log level must be one of: " + Object.keys(logLevel).join(", ") + ", was " + setLevel,
reauthenticationThreshold: () =>
"Reauthentication threshold cannot be set, and reauthentication is automated when 80% of connections.max.reauth.ms is reached.",
unsupportedKey: (key) =>
`The '${key}' property is not supported.`,
kafkaJSCommonKey: (key) =>
`The '${key}' property seems to be a KafkaJS property in the main config block.` +
`It must be moved to the kafkaJS block.` +
`\nBefore: \n` +
`\tconst kafka = new Kafka({ ${key}: <value>, ... });\n` +
`After: \n` +
`\tconst kafka = new Kafka({ kafkaJS: { ${key}: <value>, ... }, ... });\n`,
kafkaJSClientKey: (key, cOrP) =>
`The '${key}' property seems to be a KafkaJS property in the main config block. ` +
`It must be moved to the kafkaJS block.` +
`\nBefore: \n` +
`\tconst kafka = new Kafka({ ... });\n` +
`\tconst ${cOrP} = kafka.${cOrP}({ ${key}: <value>, ... });\n` +
`After: \n` +
`\tconst kafka = new Kafka({ ... });\n` +
`\tconst ${cOrP} = kafka.${cOrP}({ kafkaJS: { ${key}: <value>, ... }, ... });\n`,
/* Producer */
createPartitioner: () =>
"The 'createPartitioner' property is not supported yet. The default partitioner is set to murmur2_random, compatible with the DefaultPartitioner and the Java partitioner.\n" +
"A number of alternative partioning strategies are available through the 'rdKafka' property, for example: \n" +
"\tconst kafka = new Kafka({ rdKafka: { 'partitioner': 'random|consistent_random|consistent|murmur2|murmur2_random|fnv1a|fnv1a_random' } });\n" +
`For more details on what can be used inside the rdKafka block, see https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md\n`,
sendOptionsMandatoryMissing: () =>
"The argument passed to send must be an object, and must contain the 'topic' and 'messages' properties: {topic: string, messages: Message[]}\n",
sendOptionsAcks: (fn) =>
createReplacementErrorMessage('producer', fn, 'acks', 'acks: <number>', 'acks: <number>', false),
sendOptionsCompression: (fn) =>
createReplacementErrorMessage('producer', fn, 'compression', 'compression: <type>', 'compression: CompressionTypes.GZIP|SNAPPY|LZ4|ZSTD', false),
sendOptionsTimeout: (fn) =>
createReplacementErrorMessage('producer', fn, 'timeout', 'timeout: <number>', 'timeout: <number>', false),
sendBatchMandatoryMissing: () =>
"The argument passed to sendbatch must be an object, and must contain the 'topicMessages' property: { topicMessages: {topic: string, messages: Message[]}[] } \n",
sendOffsetsMustProvideConsumer: () =>
"The sendOffsets method must be called with a connected consumer instance and without a consumerGroupId parameter.\n",
/* Consumer */
partitionAssignors: () =>
'partitionAssignors must be a list of strings from within `PartitionAssignors`.\n',
subscribeOptionsFromBeginning: () =>
createReplacementErrorMessage('consumer', 'subscribe', 'fromBeginning', 'fromBeginning: <boolean>', 'fromBeginning: <boolean>', false),
subscribeOptionsMandatoryMissing: () =>
"The argument passed to subscribe must be an object, and must contain the 'topics' or the 'topic' property: {topics: string[]} or {topic: string}\n",
subscribeOptionsRegexFlag: () =>
"If subscribing to topic by RegExp, no flags are allowed. /^abcd/ is okay, but /^abcd/i is not.\n",
subscribeOptionsRegexStart: () =>
"If subscribing to topic by RegExp, the pattern must start with a '^'. If you want to use something like /abcd/, /^.*abcd/ must be used.\n",
runOptionsAutoCommit: () =>
createReplacementErrorMessage('consumer', 'run', 'autoCommit', 'autoCommit: <boolean>', 'autoCommit: <boolean>', false),
runOptionsAutoCommitInterval: () =>
createReplacementErrorMessage('consumer', 'run', 'autoCommitInterval', 'autoCommitInterval: <number>', 'autoCommitInterval: <number>', false),
runOptionsAutoCommitThreshold: () =>
"The property 'autoCommitThreshold' is not supported by run.\n",
runOptionsRunConcurrently: () =>
"The property 'partitionsConsumedConcurrently' is not currently supported by run\n",
});
/**
* Converts the common configuration from KafkaJS to a format that can be used by node-rdkafka.
* @param {object} config
* @returns {import('../../types/config').ProducerGlobalConfig | import('../../types/config').ConsumerGlobalConfig} the converted configuration
* @throws {error.KafkaJSError} if the configuration is invalid.
* The error code will be ERR__INVALID_ARG in case of invalid arguments or features that are not supported.
* The error code will be ERR__NOT_IMPLEMENTED in case of features that are not yet implemented.
* @private
*/
function kafkaJSToRdKafkaConfig(config) {
/* Since the kafkaJS block is specified, we operate in
* kafkaJS compatibility mode. That means we change the defaults
* match the kafkaJS defaults. */
const rdkafkaConfig = {};
Eif (Object.hasOwn(config, "brokers")) {
Iif (!Array.isArray(config["brokers"])) {
throw new error.KafkaJSError(CompatibilityErrorMessages.brokerString(), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
rdkafkaConfig["bootstrap.servers"] = config["brokers"].join(",");
}
Iif (Object.hasOwn(config, "clientId")) {
rdkafkaConfig["client.id"] = config.clientId;
}
let withSASL = false;
Iif (Object.hasOwn(config, "sasl")) {
const sasl = config.sasl;
const mechanism = sasl.mechanism.toUpperCase();
if (mechanism === 'OAUTHBEARER') {
rdkafkaConfig["sasl.mechanism"] = mechanism;
if (Object.hasOwn(sasl, "oauthBearerProvider")) {
if (typeof sasl.oauthBearerProvider !== 'function') {
throw new error.KafkaJSError(CompatibilityErrorMessages.saslOauthBearerProvider(), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
rdkafkaConfig['oauthbearer_token_refresh_cb'] = function (oauthbearer_config) {
return sasl.oauthBearerProvider(oauthbearer_config)
.then((token) => {
if (!Object.hasOwn(token, 'value')) {
throw new error.KafkaJSError('Token must have a value property.', {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
} else if (!Object.hasOwn(token, 'principal')) {
throw new error.KafkaJSError('Token must have a principal property.', {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
} else if (!Object.hasOwn(token, 'lifetime')) {
throw new error.KafkaJSError('Token must have a lifetime property.', {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
// Recast token into a value expected by node-rdkafka's callback.
const setToken = {
tokenValue: token.value,
extensions: token.extensions,
principal: token.principal,
lifetime: token.lifetime,
};
return setToken;
})
.catch(err => {
if (!(err instanceof Error)) {
err = new Error(err);
}
throw err;
});
};
}
/* It's a valid case (unlike in KafkaJS) for oauthBearerProvider to be
* null, because librdkafka provides an unsecured token provider for
* non-prod usecases. So don't do anything in that case. */
} else if (mechanism === 'PLAIN' || mechanism.startsWith('SCRAM')) {
if (typeof sasl.username !== "string" || typeof sasl.password !== "string") {
throw new error.KafkaJSError(CompatibilityErrorMessages.saslUsernamePasswordString(mechanism), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
rdkafkaConfig["sasl.mechanism"] = mechanism;
rdkafkaConfig["sasl.username"] = sasl.username;
rdkafkaConfig["sasl.password"] = sasl.password;
} else {
throw new error.KafkaJSError(CompatibilityErrorMessages.saslUnsupportedMechanism(mechanism), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
withSASL = true;
}
Iif (Object.hasOwn(config, "ssl") && config.ssl && withSASL) {
rdkafkaConfig["security.protocol"] = "sasl_ssl";
} else Iif (withSASL) {
rdkafkaConfig["security.protocol"] = "sasl_plaintext";
} else Iif (Object.hasOwn(config, "ssl") && config.ssl) {
rdkafkaConfig["security.protocol"] = "ssl";
}
/* TODO: add best-effort support for ssl besides just true/false */
Iif (Object.hasOwn(config, "ssl") && typeof config.ssl !== "boolean") {
throw new error.KafkaJSError(CompatibilityErrorMessages.sslObject(), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
Iif (Object.hasOwn(config, "requestTimeout")) {
rdkafkaConfig["socket.timeout.ms"] = config.requestTimeout;
} else {
/* KafkaJS default */
rdkafkaConfig["socket.timeout.ms"] = 30000;
}
Iif (Object.hasOwn(config, "enforceRequestTimeout") && !config.enforceRequestTimeout) {
rdkafkaConfig["socket.timeout.ms"] = 300000;
}
const connectionTimeout = config.connectionTimeout ?? 1000;
const authenticationTimeout = config.authenticationTimeout ?? 10000;
let totalConnectionTimeout = Number(connectionTimeout) + Number(authenticationTimeout);
/* The minimum value for socket.connection.setup.timeout.ms is 1000. */
totalConnectionTimeout = Math.max(totalConnectionTimeout, 1000);
rdkafkaConfig["socket.connection.setup.timeout.ms"] = totalConnectionTimeout;
const retry = config.retry ?? {};
const { maxRetryTime, initialRetryTime, factor, multiplier, restartOnFailure } = retry;
rdkafkaConfig["retry.backoff.max.ms"] = maxRetryTime ?? 30000;
rdkafkaConfig["retry.backoff.ms"] = initialRetryTime ?? 300;
Iif ((typeof factor === 'number') || (typeof multiplier === 'number')) {
throw new error.KafkaJSError(CompatibilityErrorMessages.retryFactorMultiplier(), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
Iif (restartOnFailure) {
throw new error.KafkaJSError(CompatibilityErrorMessages.retryRestartOnFailure(), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
Iif (Object.hasOwn(config, "socketFactory")) {
throw new error.KafkaJSError(CompatibilityErrorMessages.socketFactory(), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
Iif (Object.hasOwn(config, "reauthenticationThreshold")) {
throw new error.KafkaJSError(CompatibilityErrorMessages.reauthenticationThreshold(), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
rdkafkaConfig["log_level"] = 6 /* LOG_INFO - default in KafkaJS compatibility mode. */;
Iif (Object.hasOwn(config, "logLevel")) {
let setLevel = config.logLevel;
if (process.env.KAFKAJS_LOG_LEVEL) {
setLevel = logLevel[process.env.KAFKAJS_LOG_LEVEL.toUpperCase()];
}
switch (setLevel) {
case logLevel.NOTHING:
rdkafkaConfig["log_level"] = 0; /* LOG_EMERG - we don't have a true log nothing yet */
break;
case logLevel.ERROR:
rdkafkaConfig["log_level"] = 3 /* LOG_ERR */;
break;
case logLevel.WARN:
rdkafkaConfig["log_level"] = 4 /* LOG_WARNING */;
break;
case logLevel.INFO:
rdkafkaConfig["log_level"] = 6 /* LOG_INFO */;
break;
case logLevel.DEBUG:
rdkafkaConfig["log_level"] = 7 /* LOG_DEBUG */;
break;
default:
throw new error.KafkaJSError(CompatibilityErrorMessages.logLevelName(setLevel), {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
}
return rdkafkaConfig;
}
/**
* Checks if the config object contains any keys not allowed by KafkaJS.
* @param {'producer'|'consumer'|'admin'} clientType
* @param {any} config
* @returns {string|null} the first unsupported key, or null if all keys are supported.
* @private
*/
function checkAllowedKeys(clientType, config) {
const allowedKeysCommon = kafkaJSProperties.common;
Iif (!Object.hasOwn(kafkaJSProperties, clientType)) {
throw new error.KafkaJSError(`Unknown client type ${clientType}`, {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
const allowedKeysSpecific = kafkaJSProperties[clientType];
for (const key of Object.keys(config)) {
Iif (!allowedKeysCommon.includes(key) && !allowedKeysSpecific.includes(key)) {
return key;
}
}
return null;
}
/**
* Checks if the config object contains any keys specific to KafkaJS.
* @param {'producer'|'consumer'|'admin'|'common'} propertyType
* @param {any} config
* @returns {string|null} the first KafkaJS specific key, or null if none is present.
* @private
*/
function checkIfKafkaJsKeysPresent(propertyType, config) {
Iif (!Object.hasOwn(kafkaJSProperties, propertyType)) {
throw new error.KafkaJSError(`Unknown config type for ${propertyType}`, {
code: error.ErrorCodes.ERR__INVALID_ARG,
});
}
const kjsKeys = kafkaJSProperties[propertyType];
for (const key of Object.keys(config)) {
/* We exclude 'acks' since it's common to both librdkafka and kafkaJS.
* We don't intend to keep up with new properties, so we don't need to really worry about making it extensible. */
Iif (kjsKeys.includes(key) && key !== 'acks') {
return key;
}
}
return null;
}
/**
* Converts a topicPartitionOffset from KafkaJS to a format that can be used by node-rdkafka.
* @param {import("../../types/kafkajs").TopicPartitionOffset} tpo
* @returns {{topic: string, partition: number, offset: number}}
* @private
*/
function topicPartitionOffsetToRdKafka(tpo) {
// TODO: do we need some checks for negative offsets and stuff? Or 'named' offsets?
return {
topic: tpo.topic,
partition: tpo.partition,
offset: Number(tpo.offset),
leaderEpoch: tpo.leaderEpoch,
};
}
/**
* Converts a topicPartitionOffset from KafkaJS to a format that can be used by node-rdkafka.
* Includes metadata.
*
* @param {import("../../types/kafkajs").TopicPartitionOffsetAndMetadata} tpo
* @returns {import("../../types/rdkafka").TopicPartitionOffsetAndMetadata}
* @private
*/
function topicPartitionOffsetMetadataToRdKafka(tpo) {
return {
topic: tpo.topic,
partition: tpo.partition,
offset: tpo.offset ? Number(tpo.offset) : null,
metadata: tpo.metadata,
leaderEpoch: tpo.leaderEpoch,
};
}
/**
* Converts a topicPartitionOffset from node-rdkafka to a format that can be used by KafkaJS.
* Includes metadata.
*
* @param {import("../../types/rdkafka").TopicPartitionOffsetAndMetadata} tpo
* @returns {import("../../types/kafkajs").TopicPartitionOffsetAndMetadata}
* @private
*/
function topicPartitionOffsetMetadataToKafkaJS(tpo) {
return {
topic: tpo.topic,
partition: tpo.partition,
offset: tpo.offset ? tpo.offset.toString() : null,
metadata: tpo.metadata,
leaderEpoch: tpo.leaderEpoch
};
}
/**
* Convert a librdkafka error from node-rdkafka into a KafkaJSError.
* @param {import("../error")} librdKafkaError to convert from.
* @returns {error.KafkaJSError} the converted error.
* @private
*/
function createKafkaJsErrorFromLibRdKafkaError(librdKafkaError) {
const properties = {
retriable: librdKafkaError.retriable,
fatal: librdKafkaError.fatal,
abortable: librdKafkaError.abortable,
stack: librdKafkaError.stack,
code: librdKafkaError.code,
};
let err = null;
Iif (properties.code === error.ErrorCodes.ERR_OFFSET_OUT_OF_RANGE) {
err = new error.KafkaJSOffsetOutOfRange(librdKafkaError, properties);
} else Iif (properties.code === error.ErrorCodes.ERR_REQUEST_TIMED_OUT) {
err = new error.KafkaJSRequestTimeoutError(librdKafkaError, properties);
} else Iif (properties.code === error.ErrorCodes.ERR__PARTIAL) {
err = new error.KafkaJSPartialMessageError(librdKafkaError, properties);
} else Iif (properties.code === error.ErrorCodes.ERR__AUTHENTICATION) {
err = new error.KafkaJSSASLAuthenticationError(librdKafkaError, properties);
} else Iif (properties.code === error.ErrorCodes.ERR_GROUP_COORDINATOR_NOT_AVAILABLE) {
err = new error.KafkaJSGroupCoordinatorNotAvailableError(librdKafkaError, properties);
} else Iif (properties.code === error.ErrorCodes.ERR__NOT_IMPLEMENTED) {
err = new error.KafkaJSNotImplemented(librdKafkaError, properties);
} else Iif (properties.code === error.ErrorCodes.ERR__TIMED_OUT) {
err = new error.KafkaJSTimeout(librdKafkaError, properties);
} else Iif (properties.code === error.ErrorCodes.ERR__ALL_BROKERS_DOWN) {
err = new error.KafkaJSNoBrokerAvailableError(librdKafkaError, properties);
} else Iif (properties.code === error.ErrorCodes.ERR__TRANSPORT) {
err = new error.KafkaJSConnectionError(librdKafkaError, properties);
} else Iif (properties.code > 0) { /* Indicates a non-local error */
err = new error.KafkaJSProtocolError(librdKafkaError, properties);
} else {
err = new error.KafkaJSError(librdKafkaError, properties);
}
return err;
}
/**
* Converts KafkaJS headers to a format that can be used by node-rdkafka.
* @param {import("../../types/kafkajs").IHeaders|null} kafkaJSHeaders
* @returns {import("../../").MessageHeader[]|null} the converted headers.
* @private
*/
function convertToRdKafkaHeaders(kafkaJSHeaders) {
Eif (!kafkaJSHeaders) return null;
const headers = [];
for (const [key, value] of Object.entries(kafkaJSHeaders)) {
if (value && value.constructor === Array) {
for (const v of value) {
const header = {};
header[key] = v;
headers.push(header);
}
} else {
const header = {};
header[key] = value;
headers.push(header);
}
}
return headers;
}
function notImplemented(msg = 'Not implemented') {
throw new error.KafkaJSError(msg, { code: error.ErrorCodes.ERR__NOT_IMPLEMENTED });
}
/**
* A promise that can be resolved externally.
* @private
*/
class DeferredPromise extends Promise{
#resolved = false;
/**
* JS expects a resolver function to be passed to classes extending Promise.
* that takes the same parameter a normal Promise constructor does.
* The DeferredPromise cannot be rejected to avoid unhandled rejections
* entirely.
* @param {(resolve: (value: any) => void, reject: (error: Error) => void) => void} resolver
*/
constructor(resolver) {
let resolveF;
super((resolve) => {
resolveF = resolve;
});
this.resolve = (...args) => {
this.#resolved = true;
resolveF(...args);
};
if (resolver)
resolver(this.resolve, () => {});
}
get resolved() {
return this.#resolved;
}
}
/**
* Utility class for time related functions
* @private
*/
class Timer {
/**
* Function that resolves when the given timeout is reached
* or the passed promise resolves, when it's passed, clearing the timeout
* in any case.
*
* WARNING: it must be avoided to call `withTimeout` with the same promise
* more than once, as `Promise.race` will add more callbacks to it,
* creating a memory leak if the promise is never resolved or not resolved
* soon enough.
*
* @param {number} timeoutMs The timeout in milliseconds.
* @param {Promise|undefined} promise The promise to wait for,
* alternatively to the timeout, or `undefined` to just wait for the timeout.
*/
static async withTimeout(timeoutMs, promise) {
const timer = new DeferredPromise();
const registration = setTimeout(timer.resolve, timeoutMs);
Iif (!promise)
await timer;
else {
await Promise.race([
promise,
timer
]);
}
if (!timer.resolved) {
timer.resolve();
}
clearTimeout(registration);
}
}
/**
* Readers-writer lock with reentrant calls.
* Upgrading from a read to a write lock is supported.
* Acquiring a read lock while holding a write lock is a no-op.
* @private
*/
class Lock {
// Total number of readers, not increases when already holding a write lock
#readers = 0;
// Total number of writers, increased only by a single write and
// its reentrant calls
#writers = 0;
#asyncLocalStorage = new AsyncLocalStorage();
// Promise to resolve and recreate when there are no readers or writers
// This is used to notify all waiting writers so at least one can proceed.
// It's also used to notify all waiting readers so they can can check
// the writer has finished.
#zeroReadersAndWritersPromise = new DeferredPromise();
#notifyZeroReadersAndWriters() {
Eif (this.#readers === 0 && this.#writers === 0) {
this.#zeroReadersAndWritersPromise.resolve();
this.#zeroReadersAndWritersPromise = new DeferredPromise();
}
}
#createAsyncLocalStorageStore() {
return {
// All reentrant calls
stack: [],
// Number of write locks in reentrant calls
writers: 0,
// Number of read locks in reentrant calls
readers: 0,
};
}
async #runAsyncStack(type, f) {
let store = this.#asyncLocalStorage.getStore();
Iif (store) {
let promise = f();
store.stack.push(promise);
await promise;
} else {
await this.#asyncLocalStorage.run(this.#createAsyncLocalStorageStore(type),
async () => {
store = this.#asyncLocalStorage.getStore();
let promise = f();
store.stack.push(promise);
// Await all promises are settled
await Promise.allSettled(store.stack);
// Reject if any promise is rejected
await Promise.all(store.stack);
});
}
}
async #acquireRead() {
let store = this.#asyncLocalStorage.getStore();
if (!store.writers) {
while (this.#writers > 0) {
await this.#zeroReadersAndWritersPromise;
}
this.#readers++;
store.readers++;
}
}
async #acquireWrite() {
let store = this.#asyncLocalStorage.getStore();
// We remove current stack readers and writers so it
// becomes reentrant
let readers = this.#readers - store.readers;
let writers = this.#writers - store.writers;
while (readers > 0 || writers > 0) {
await this.#zeroReadersAndWritersPromise;
writers = this.#writers - store.writers;
readers = this.#readers - store.readers;
}
this.#writers++;
store.writers++;
}
async #releaseRead() {
let store = this.#asyncLocalStorage.getStore();
this.#readers--;
store.readers--;
this.#notifyZeroReadersAndWriters();
}
async #releaseWrite() {
let store = this.#asyncLocalStorage.getStore();
this.#writers--;
store.writers--;
this.#notifyZeroReadersAndWriters();
}
/**
* Acquire a write (exclusive) lock while executing
* the given task.
* @param {function} task The task to execute.
* @returns {Promise} The result of the task.
*/
async write(task) {
let withWriteLock = async () => {
try {
await this.#acquireWrite();
return await task();
} finally {
await this.#releaseWrite();
}
};
await this.#runAsyncStack(1, withWriteLock);
}
/**
* Acquire a read (shared) lock while executing
* the given task.
* @param {function} task The task to execute.
* @returns {Promise} The result of the task.
*/
async read(task) {
let withReadLock = async () => {
try {
await this.#acquireRead();
return await task();
} finally {
await this.#releaseRead();
}
};
await this.#runAsyncStack(0, withReadLock);
}
}
/**
* Creates a key for maps from a topicPartition object.
* @param {{topic: string, partition: number}} topicPartition Any object which can be treated as a topic partition.
* @returns {string} The created key.
* @private
*/
function partitionKey(topicPartition) {
return topicPartition.topic + '|'+ (topicPartition.partition);
}
module.exports = {
kafkaJSToRdKafkaConfig,
topicPartitionOffsetToRdKafka,
topicPartitionOffsetMetadataToRdKafka,
topicPartitionOffsetMetadataToKafkaJS,
createKafkaJsErrorFromLibRdKafkaError,
convertToRdKafkaHeaders,
createBindingMessageMetadata,
notImplemented,
logLevel: Object.freeze(logLevel),
loggerTrampoline,
DefaultLogger,
createReplacementErrorMessage,
CompatibilityErrorMessages,
severityToLogLevel,
checkAllowedKeys,
checkIfKafkaJsKeysPresent,
Lock,
DeferredPromise,
Timer,
partitionKey,
};
|