rocketmq-client-nodejs-bate 1.0.12

package/src/producer/Transaction.ts

@@ -0,0 +1,86 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TransactionResolution } from '../../proto/apache/rocketmq/v2/definition_pb';
+import { MessageOptions, PublishingMessage } from '../message';
+import type { Producer } from './Producer';
+import { SendReceipt } from './SendReceipt';
+
+export class Transaction {
+  static readonly MAX_MESSAGE_NUM = 1;
+  readonly #producer: Producer;
+  readonly #messageMap = new Map<string, PublishingMessage>();
+  readonly #messageSendReceiptMap = new Map<string, SendReceipt>();
+
+  constructor(producer: Producer) {
+    this.#producer = producer;
+  }
+
+  tryAddMessage(message: MessageOptions) {
+    if (this.#messageMap.size >= Transaction.MAX_MESSAGE_NUM) {
+      throw new TypeError(`Message in transaction has exceeded the threshold=${Transaction.MAX_MESSAGE_NUM}`);
+    }
+    const publishingMessage = new PublishingMessage(message, this.#producer.publishingSettings, true);
+    this.#messageMap.set(publishingMessage.messageId, publishingMessage);
+    return publishingMessage;
+  }
+
+  tryAddReceipt(publishingMessage: PublishingMessage, sendReceipt: SendReceipt) {
+    if (!this.#messageMap.has(publishingMessage.messageId)) {
+      throw new TypeError('Message not in transaction');
+    }
+    this.#messageSendReceiptMap.set(publishingMessage.messageId, sendReceipt);
+  }
+
+  async commit() {
+    if (this.#messageSendReceiptMap.size === 0) {
+      throw new TypeError('Transactional message has not been sent yet');
+    }
+
+    const logger = (this.#producer as any).logger;
+    logger.info('Begin to commit transaction, messageCount=%d, clientId=%s',
+      this.#messageSendReceiptMap.size, (this.#producer as any).clientId);
+
+    for (const [ messageId, sendReceipt ] of this.#messageSendReceiptMap.entries()) {
+      const publishingMessage = this.#messageMap.get(messageId)!;
+      await this.#producer.endTransaction(sendReceipt.endpoints, publishingMessage,
+        sendReceipt.messageId, sendReceipt.transactionId, TransactionResolution.COMMIT);
+    }
+
+    logger.info('Commit transaction successfully, messageCount=%d, clientId=%s',
+      this.#messageSendReceiptMap.size, (this.#producer as any).clientId);
+  }
+
+  async rollback() {
+    if (this.#messageSendReceiptMap.size === 0) {
+      throw new TypeError('Transactional message has not been sent yet');
+    }
+
+    const logger = (this.#producer as any).logger;
+    logger.info('Begin to rollback transaction, messageCount=%d, clientId=%s',
+      this.#messageSendReceiptMap.size, (this.#producer as any).clientId);
+
+    for (const [ messageId, sendReceipt ] of this.#messageSendReceiptMap.entries()) {
+      const publishingMessage = this.#messageMap.get(messageId)!;
+      await this.#producer.endTransaction(sendReceipt.endpoints, publishingMessage,
+        sendReceipt.messageId, sendReceipt.transactionId, TransactionResolution.ROLLBACK);
+    }
+
+    logger.info('Rollback transaction successfully, messageCount=%d, clientId=%s',
+      this.#messageSendReceiptMap.size, (this.#producer as any).clientId);
+  }
+}

package/src/producer/TransactionChecker.ts

@@ -0,0 +1,23 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TransactionResolution } from '../../proto/apache/rocketmq/v2/definition_pb';
+import { MessageView } from '../message';
+
+export interface TransactionChecker {
+  check(messageView: MessageView): Promise<TransactionResolution>;
+}

package/src/producer/index.ts

@@ -0,0 +1,24 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './Producer';
+export * from './PublishingLoadBalancer';
+export * from './PublishingSettings';
+export * from './RecallReceipt';
+export * from './SendReceipt';
+// export * from './Transaction';
+export * from './TransactionChecker';

package/src/retry/ExponentialBackoffRetryPolicy.ts

@@ -0,0 +1,76 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import assert = require('node:assert');
+import { Duration } from 'google-protobuf/google/protobuf/duration_pb';
+import {
+  RetryPolicy as RetryPolicyPB,
+  ExponentialBackoff,
+} from '../../proto/apache/rocketmq/v2/definition_pb';
+import { RetryPolicy } from './RetryPolicy';
+
+export class ExponentialBackoffRetryPolicy implements RetryPolicy {
+  #maxAttempts: number;
+  // seconds
+  #initialBackoff: number;
+  #maxBackoff: number;
+  #backoffMultiplier: number;
+
+  constructor(maxAttempts: number, initialBackoff = 0, maxBackoff = 0, backoffMultiplier = 1) {
+    this.#maxAttempts = maxAttempts;
+    this.#initialBackoff = initialBackoff;
+    this.#maxBackoff = maxBackoff;
+    this.#backoffMultiplier = backoffMultiplier;
+  }
+
+  static immediatelyRetryPolicy(maxAttempts: number) {
+    return new ExponentialBackoffRetryPolicy(maxAttempts, 0, 0, 1);
+  }
+
+  getMaxAttempts(): number {
+    return this.#maxAttempts;
+  }
+
+  getNextAttemptDelay(attempt: number): number {
+    assert(attempt > 0, 'attempt must be positive');
+    const delay = Math.min(this.#initialBackoff * Math.pow(this.#backoffMultiplier, 1.0 * (attempt - 1)), this.#maxBackoff);
+    if (delay <= 0) {
+      return 0;
+    }
+    return delay;
+  }
+
+  inheritBackoff(retryPolicy: RetryPolicyPB): RetryPolicy {
+    assert(retryPolicy.getStrategyCase() === RetryPolicyPB.StrategyCase.EXPONENTIAL_BACKOFF,
+      'strategy must be exponential backoff');
+    const backoff = retryPolicy.getExponentialBackoff()!.toObject();
+    return new ExponentialBackoffRetryPolicy(this.#maxAttempts,
+      backoff.initial?.seconds,
+      backoff.max?.seconds,
+      backoff.multiplier);
+  }
+
+  toProtobuf(): RetryPolicyPB {
+    return new RetryPolicyPB()
+      .setMaxAttempts(this.#maxAttempts)
+      .setExponentialBackoff(
+        new ExponentialBackoff()
+          .setInitial(new Duration().setSeconds(this.#initialBackoff))
+          .setMax(new Duration().setSeconds(this.#maxBackoff))
+          .setMultiplier(this.#backoffMultiplier));
+  }
+}

package/src/retry/RetryPolicy.ts

@@ -0,0 +1,51 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { RetryPolicy as RetryPolicyPB } from '../../proto/apache/rocketmq/v2/definition_pb';
+
+/**
+ * Internal interface for retry policy.
+ */
+export interface RetryPolicy {
+  /**
+   * Get the max attempt times for retry.
+   *
+   * @return max attempt times.
+   */
+  getMaxAttempts(): number;
+
+  /**
+   * Get await time after current attempts, the attempt index starts at 1.
+   *
+   * @param attempt current attempt.
+   * @return await time in seconds.
+   */
+  getNextAttemptDelay(attempt: number): number;
+
+  /**
+   * Update the retry backoff strategy and generate a new one.
+   *
+   * @param retryPolicy retry policy which contains the backoff strategy.
+   * @return the new retry policy.
+   */
+  inheritBackoff(retryPolicy: RetryPolicyPB): RetryPolicy;
+
+  /**
+   * Convert to RetryPolicyPB
+   */
+  toProtobuf(): RetryPolicyPB;
+}

package/src/retry/index.ts

@@ -0,0 +1,19 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './ExponentialBackoffRetryPolicy';
+export * from './RetryPolicy';

package/src/route/Broker.ts

@@ -0,0 +1,39 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Broker as BrokerPB } from '../../proto/apache/rocketmq/v2/definition_pb';
+import { Endpoints } from './Endpoints';
+
+export class Broker implements BrokerPB.AsObject {
+  name: string;
+  id: number;
+  endpoints: Endpoints;
+
+  constructor(broker: BrokerPB.AsObject) {
+    this.name = broker.name;
+    this.id = broker.id;
+    this.endpoints = new Endpoints(broker.endpoints!);
+  }
+
+  toProtobuf() {
+    const broker = new BrokerPB();
+    broker.setName(this.name);
+    broker.setId(this.id);
+    broker.setEndpoints(this.endpoints.toProtobuf());
+    return broker;
+  }
+}

package/src/route/Endpoints.ts

@@ -0,0 +1,70 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { isIPv4, isIPv6 } from 'node:net';
+import { Address, AddressScheme, Endpoints as EndpointsPB } from '../../proto/apache/rocketmq/v2/definition_pb';
+
+const DEFAULT_PORT = 80;
+
+export class Endpoints {
+  readonly addressesList: Address.AsObject[];
+  readonly scheme: AddressScheme;
+  /**
+   * URI path for grpc target, e.g:
+   * 127.0.0.1:10911[,127.0.0.2:10912]
+   */
+  readonly facade: string;
+
+  constructor(endpoints: string | EndpointsPB.AsObject) {
+    if (typeof endpoints === 'string') {
+      const splits = endpoints.split(';');
+      this.addressesList = [];
+      for (const endpoint of splits) {
+        const [ host, port ] = endpoint.split(':');
+        if (isIPv4(host)) {
+          this.scheme = AddressScheme.IPV4;
+        } else if (isIPv6(host)) {
+          this.scheme = AddressScheme.IPV6;
+        } else {
+          this.scheme = AddressScheme.DOMAIN_NAME;
+        }
+        this.addressesList.push({ host, port: parseInt(port) || DEFAULT_PORT });
+      }
+    } else {
+      this.scheme = endpoints.scheme;
+      this.addressesList = endpoints.addressesList;
+    }
+    this.facade = this.addressesList.map(addr => `${addr.host}:${addr.port}`).join(',');
+  }
+
+  getGrpcTarget() {
+    return this.facade;
+  }
+
+  toString() {
+    return this.facade;
+  }
+
+  toProtobuf() {
+    const endpoints = new EndpointsPB();
+    endpoints.setScheme(this.scheme);
+    for (const address of this.addressesList) {
+      endpoints.addAddresses().setHost(address.host).setPort(address.port);
+    }
+    return endpoints;
+  }
+}

package/src/route/MessageQueue.ts

@@ -0,0 +1,49 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  MessageQueue as MessageQueuePB, MessageType, Permission,
+  Resource,
+} from '../../proto/apache/rocketmq/v2/definition_pb';
+import { createResource } from '../util';
+import { Broker } from './Broker';
+
+export class MessageQueue {
+  topic: Resource.AsObject;
+  queueId: number;
+  broker: Broker;
+  permission: Permission;
+  acceptMessageTypesList: MessageType[];
+
+  constructor(messageQueue: MessageQueuePB) {
+    this.topic = messageQueue.getTopic()!.toObject();
+    this.queueId = messageQueue.getId();
+    this.permission = messageQueue.getPermission();
+    this.acceptMessageTypesList = messageQueue.getAcceptMessageTypesList();
+    this.broker = new Broker(messageQueue.getBroker()!.toObject());
+  }
+
+  toProtobuf() {
+    const messageQueue = new MessageQueuePB();
+    messageQueue.setId(this.queueId);
+    messageQueue.setTopic(createResource(this.topic.name));
+    messageQueue.setBroker(this.broker.toProtobuf());
+    messageQueue.setPermission(this.permission);
+    messageQueue.setAcceptMessageTypesList(this.acceptMessageTypesList);
+    return messageQueue;
+  }
+}

package/src/route/TopicRouteData.ts

@@ -0,0 +1,38 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { MessageQueue as MessageQueuePB } from '../../proto/apache/rocketmq/v2/definition_pb';
+import { Endpoints } from './Endpoints';
+import { MessageQueue } from './MessageQueue';
+
+export class TopicRouteData {
+  readonly messageQueues: MessageQueue[] = [];
+
+  constructor(messageQueues: MessageQueuePB[]) {
+    for (const mq of messageQueues) {
+      this.messageQueues.push(new MessageQueue(mq));
+    }
+  }
+
+  getTotalEndpoints() {
+    const endpointsMap = new Map<string, Endpoints>();
+    for (const mq of this.messageQueues) {
+      endpointsMap.set(mq.broker.endpoints.facade, mq.broker.endpoints);
+    }
+    return Array.from(endpointsMap.values());
+  }
+}

package/src/route/index.ts

@@ -0,0 +1,21 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './Broker';
+export * from './Endpoints';
+export * from './MessageQueue';
+export * from './TopicRouteData';

package/src/util/index.ts

@@ -0,0 +1,83 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { performance } from 'node:perf_hooks';
+import { createHash, createHmac } from 'node:crypto';
+import { Duration } from 'google-protobuf/google/protobuf/duration_pb';
+import { crc32 } from '@node-rs/crc32';
+import siphash24 from 'siphash24';
+import { Resource } from '../../proto/apache/rocketmq/v2/definition_pb';
+
+export const MASTER_BROKER_ID = 0;
+
+export function getTimestamp() {
+  const timestamp = performance.timeOrigin + performance.now();
+  const seconds = Math.floor(timestamp / 1000);
+  const nanos = Math.floor((timestamp % 1000) * 1e6);
+  return { seconds, nanos, timestamp };
+}
+
+// DATE_TIME_FORMAT = "yyyyMMdd'T'HHmmss'Z'"
+export function getRequestDateTime() {
+  // 2023-09-13T06:30:59.399Z => 20230913T063059Z
+  const now = new Date().toISOString().split('.')[0].replace(/[\-\:]/g, '');
+  return `${now}Z`;
+}
+
+export function sign(accessSecret: string, dateTime: string) {
+  const hmacSha1 = createHmac('sha1', accessSecret);
+  hmacSha1.update(dateTime);
+  return hmacSha1.digest('hex').toUpperCase();
+}
+
+export function createDuration(ms: number) {
+  const nanos = ms % 1000 * 1000000;
+  return new Duration()
+    .setSeconds(ms / 1000)
+    .setNanos(nanos);
+}
+
+export function createResource(name: string) {
+  return new Resource().setName(name);
+}
+
+export function crc32CheckSum(bytes: Buffer) {
+  return `${crc32(bytes)}`;
+}
+
+export function md5CheckSum(bytes: Uint8Array) {
+  return createHash('md5').update(bytes).digest('hex')
+    .toUpperCase();
+}
+
+export function sha1CheckSum(bytes: Uint8Array) {
+  return createHash('sha1').update(bytes).digest('hex')
+    .toUpperCase();
+}
+
+// k0: 0x0706050403020100L, k1: 0x0f0e0d0c0b0a0908L
+const SIP_HASH_24_KEY = Buffer.from([
+  0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
+  0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
+]);
+/**
+ * Java: Hashing.sipHash24().hashBytes(messageGroup.getBytes(StandardCharsets.UTF_8)).asLong()
+ */
+export function calculateStringSipHash24(value: string) {
+  const hash = siphash24(Buffer.from(value), SIP_HASH_24_KEY);
+  return Buffer.from(hash).readBigUInt64BE();
+}