rocketmq-client-nodejs-bate 1.0.12

package/src/consumer/SimpleConsumer.ts

@@ -0,0 +1,153 @@
+/**
+ * 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 { ClientType } from '../../proto/apache/rocketmq/v2/definition_pb';
+import { HeartbeatRequest, NotifyClientTerminationRequest } from '../../proto/apache/rocketmq/v2/service_pb';
+import { MessageView } from '../message';
+import { TopicRouteData } from '../route';
+import { createResource } from '../util';
+import { FilterExpression } from './FilterExpression';
+import { SimpleSubscriptionSettings } from './SimpleSubscriptionSettings';
+import { SubscriptionLoadBalancer } from './SubscriptionLoadBalancer';
+import { Consumer, ConsumerOptions } from './Consumer';
+
+const RANDOM_INDEX = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
+
+export interface SimpleConsumerOptions extends ConsumerOptions {
+  /**
+   * support tag string as filter, e.g.:
+   * ```ts
+   * new Map()
+   *  .set('TestTopic1', 'TestTag1')
+   *  .set('TestTopic2', 'TestTag2')
+   * ```
+   */
+  subscriptions: Map<string/* topic */, FilterExpression | string>;
+  /**
+   * set await duration for long-polling, default is 30000ms
+   */
+  awaitDuration?: number;
+}
+
+export class SimpleConsumer extends Consumer {
+  readonly #simpleSubscriptionSettings: SimpleSubscriptionSettings;
+  readonly #subscriptionExpressions = new Map<string, FilterExpression>();
+  readonly #subscriptionRouteDataCache = new Map<string, SubscriptionLoadBalancer>();
+  readonly #awaitDuration: number;
+  #topicIndex = RANDOM_INDEX;
+
+  constructor(options: SimpleConsumerOptions) {
+    options.topics = Array.from(options.subscriptions.keys());
+    super(options);
+    for (const [ topic, filter ] of options.subscriptions.entries()) {
+      if (typeof filter === 'string') {
+        // filter is tag string
+        this.#subscriptionExpressions.set(topic, new FilterExpression(filter));
+      } else {
+        this.#subscriptionExpressions.set(topic, filter);
+      }
+    }
+    this.#awaitDuration = options.awaitDuration ?? 30000;
+    this.#simpleSubscriptionSettings = new SimpleSubscriptionSettings(options.namespace, this.clientId, this.endpoints,
+      this.consumerGroup, this.requestTimeout, this.#awaitDuration, this.#subscriptionExpressions);
+  }
+
+  protected getSettings() {
+    return this.#simpleSubscriptionSettings;
+  }
+
+  protected wrapHeartbeatRequest() {
+    return new HeartbeatRequest()
+      .setClientType(ClientType.SIMPLE_CONSUMER)
+      .setGroup(createResource(this.consumerGroup));
+  }
+
+  protected wrapNotifyClientTerminationRequest() {
+    return new NotifyClientTerminationRequest()
+      .setGroup(createResource(this.consumerGroup));
+  }
+
+  protected onTopicRouteDataUpdate(topic: string, topicRouteData: TopicRouteData) {
+    this.#updateSubscriptionLoadBalancer(topic, topicRouteData);
+  }
+
+  #updateSubscriptionLoadBalancer(topic: string, topicRouteData: TopicRouteData) {
+    let subscriptionLoadBalancer = this.#subscriptionRouteDataCache.get(topic);
+    if (!subscriptionLoadBalancer) {
+      subscriptionLoadBalancer = new SubscriptionLoadBalancer(topicRouteData);
+    } else {
+      subscriptionLoadBalancer = subscriptionLoadBalancer.update(topicRouteData);
+    }
+    this.#subscriptionRouteDataCache.set(topic, subscriptionLoadBalancer);
+    return subscriptionLoadBalancer;
+  }
+
+  async #getSubscriptionLoadBalancer(topic: string) {
+    let loadBalancer = this.#subscriptionRouteDataCache.get(topic);
+    if (!loadBalancer) {
+      const topicRouteData = await this.getRouteData(topic);
+      loadBalancer = this.#updateSubscriptionLoadBalancer(topic, topicRouteData);
+    }
+    return loadBalancer;
+  }
+
+  async subscribe(topic: string, filterExpression: FilterExpression) {
+    await this.getRouteData(topic);
+    this.#subscriptionExpressions.set(topic, filterExpression);
+  }
+
+  unsubscribe(topic: string) {
+    this.#subscriptionExpressions.delete(topic);
+  }
+
+  async receive(maxMessageNum = 10, invisibleDuration = 15000) {
+    if (maxMessageNum <= 0) {
+      throw new Error(`maxMessageNum must be greater than 0, but got ${maxMessageNum}`);
+    }
+
+    const topic = this.#nextTopic();
+    const filterExpression = this.#subscriptionExpressions.get(topic);
+    if (!filterExpression) {
+      throw new Error(`No subscription found for topic=${topic}, please subscribe first`);
+    }
+
+    const loadBalancer = await this.#getSubscriptionLoadBalancer(topic);
+    const mq = loadBalancer.takeMessageQueue();
+    const request = this.wrapReceiveMessageRequest(maxMessageNum, mq, filterExpression,
+      invisibleDuration, this.#awaitDuration);
+    return await this.receiveMessage(request, mq, this.#awaitDuration);
+  }
+
+  async ack(message: MessageView) {
+    await this.ackMessage(message);
+  }
+
+  async changeInvisibleDuration(message: MessageView, invisibleDuration: number) {
+    const response = await this.invisibleDuration(message, invisibleDuration);
+    // Refresh receipt handle manually
+    (message as any).receiptHandle = response;
+  }
+
+  #nextTopic() {
+    const topics = Array.from(this.#subscriptionExpressions.keys());
+    if (topics.length === 0) {
+      throw new Error('No subscriptions available to receive messages');
+    }
+    const index = Math.abs(this.#topicIndex++ % topics.length);
+    return topics[index];
+  }
+}

package/src/consumer/SimpleSubscriptionSettings.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 {
+  Settings as SettingsPB,
+  ClientType,
+  Subscription,
+} from '../../proto/apache/rocketmq/v2/definition_pb';
+import { Endpoints } from '../route';
+import { Settings, UserAgent } from '../client';
+import { createDuration, createResource } from '../util';
+import { FilterExpression } from './FilterExpression';
+
+export class SimpleSubscriptionSettings extends Settings {
+  readonly longPollingTimeout: number;
+  readonly group: string;
+  readonly subscriptionExpressions: Map<string, FilterExpression>;
+
+  constructor(namespace: string, clientId: string, accessPoint: Endpoints, group: string, requestTimeout: number, longPollingTimeout: number, subscriptionExpressions: Map<string, FilterExpression>) {
+    super(namespace, clientId, ClientType.SIMPLE_CONSUMER, accessPoint, requestTimeout);
+    this.longPollingTimeout = longPollingTimeout;
+    this.group = group;
+    this.subscriptionExpressions = subscriptionExpressions;
+  }
+
+  toProtobuf(): SettingsPB {
+    const subscription = new Subscription()
+      .setGroup(createResource(this.group))
+      .setLongPollingTimeout(createDuration(this.longPollingTimeout));
+
+    for (const [ topic, filterExpression ] of this.subscriptionExpressions.entries()) {
+      subscription.addSubscriptions()
+        .setTopic(createResource(topic))
+        .setExpression(filterExpression.toProtobuf());
+    }
+    return new SettingsPB()
+      .setClientType(this.clientType)
+      .setAccessPoint(this.accessPoint.toProtobuf())
+      .setRequestTimeout(createDuration(this.requestTimeout))
+      .setSubscription(subscription)
+      .setUserAgent(UserAgent.INSTANCE.toProtobuf());
+  }
+
+  sync(settings: SettingsPB): void {
+    if (settings.getPubSubCase() !== SettingsPB.PubSubCase.SUBSCRIPTION) {
+      // log.error("[Bug] Issued settings not match with the client type, clientId={}, pubSubCase={}, "
+      //       + "clientType={}", clientId, pubSubCase, clientType);
+    }
+  }
+}

package/src/consumer/StandardConsumeService.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { MessageView } from '../message';
+import { ConsumeService } from './ConsumeService';
+import { MessageListener } from './MessageListener';
+import type { ProcessQueue } from './ProcessQueue';
+
+export class StandardConsumeService extends ConsumeService {
+  constructor(clientId: string, messageListener: MessageListener) {
+    super(clientId, messageListener);
+  }
+
+  consume(pq: ProcessQueue, messageViews: MessageView[]): void {
+    for (const messageView of messageViews) {
+      if (messageView.corrupted) {
+        pq.discardMessage(messageView);
+        continue;
+      }
+
+      this.consumeMessage(messageView)
+        .then(result => {
+          pq.eraseMessage(messageView, result);
+        })
+        .catch(() => {
+          // Should never reach here.
+        });
+    }
+  }
+}

package/src/consumer/SubscriptionLoadBalancer.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 { randomInt } from 'node:crypto';
+import { Permission } from '../../proto/apache/rocketmq/v2/definition_pb';
+import { MessageQueue, TopicRouteData } from '../route';
+import { MASTER_BROKER_ID } from '../util';
+
+export class SubscriptionLoadBalancer {
+  #index: number;
+  #messageQueues: MessageQueue[];
+
+  constructor(topicRouteData: TopicRouteData, index?: number) {
+    this.#messageQueues = topicRouteData.messageQueues.filter(mq => {
+      return mq.queueId === MASTER_BROKER_ID && (mq.permission === Permission.READ || mq.permission === Permission.READ_WRITE);
+    });
+    this.#index = index === undefined ? randomInt(this.#messageQueues.length) : index;
+    if (this.#messageQueues.length === 0) {
+      throw new Error(`No readable message queue found, topicRouteData=${JSON.stringify(topicRouteData)}`);
+    }
+  }
+
+  update(topicRouteData: TopicRouteData) {
+    return new SubscriptionLoadBalancer(topicRouteData, this.#index);
+  }
+
+  takeMessageQueue() {
+    if (this.#index >= this.#messageQueues.length) {
+      this.#index = 0;
+    }
+    return this.#messageQueues[this.#index++];
+  }
+}

package/src/consumer/index.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 './Consumer';
+export * from './FilterExpression';
+export * from './SimpleConsumer';
+export * from './SimpleSubscriptionSettings';
+export * from './SubscriptionLoadBalancer';
+export * from './ConsumeResult';
+export * from './MessageListener';
+export * from './Assignment';
+export * from './Assignments';
+export * from './PushSubscriptionSettings';
+export * from './ConsumeTask';
+export * from './ConsumeService';
+export * from './StandardConsumeService';
+export * from './FifoConsumeService';
+export * from './ProcessQueue';
+export * from './PushConsumer';

package/src/exception/BadRequestException.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ClientException } from './ClientException';
+
+export class BadRequestException extends ClientException {
+  constructor(code: number, message: string, requestId?: string) {
+    super(code, message, requestId);
+    this.name = 'BadRequestException';
+  }
+}

package/src/exception/ClientException.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+
+const REQUEST_ID_KEY = 'request-id';
+const RESPONSE_CODE_KEY = 'response-code';
+
+export class ClientException extends Error {
+  code: number;
+
+  constructor(code: number, message: string, requestId?: string) {
+    super(`[${REQUEST_ID_KEY}=${requestId}, ${RESPONSE_CODE_KEY}=${code}] ${message}`);
+    this.code = code;
+    this.name = 'ClientException';
+  }
+}

package/src/exception/ForbiddenException.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ClientException } from './ClientException';
+
+export class ForbiddenException extends ClientException {
+  constructor(code: number, message: string, requestId?: string) {
+    super(code, message, requestId);
+    this.name = 'ForbiddenException';
+  }
+}

package/src/exception/InternalErrorException.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ClientException } from './ClientException';
+
+export class InternalErrorException extends ClientException {
+  constructor(code: number, message: string, requestId?: string) {
+    super(code, message, requestId);
+    this.name = 'InternalErrorException';
+  }
+}

package/src/exception/NotFoundException.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ClientException } from './ClientException';
+
+export class NotFoundException extends ClientException {
+  constructor(code: number, message: string, requestId?: string) {
+    super(code, message, requestId);
+    this.name = 'NotFoundException';
+  }
+}

package/src/exception/PayloadTooLargeException.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ClientException } from './ClientException';
+
+export class PayloadTooLargeException extends ClientException {
+  constructor(code: number, message: string, requestId?: string) {
+    super(code, message, requestId);
+    this.name = 'PayloadTooLargeException';
+  }
+}

package/src/exception/PaymentRequiredException.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ClientException } from './ClientException';
+
+export class PaymentRequiredException extends ClientException {
+  constructor(code: number, message: string, requestId?: string) {
+    super(code, message, requestId);
+    this.name = 'PaymentRequiredException';
+  }
+}

package/src/exception/ProxyTimeoutException.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ClientException } from './ClientException';
+
+export class ProxyTimeoutException extends ClientException {
+  constructor(code: number, message: string, requestId?: string) {
+    super(code, message, requestId);
+    this.name = 'ProxyTimeoutException';
+  }
+}

package/src/exception/RequestHeaderFieldsTooLargeException.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ClientException } from './ClientException';
+
+export class RequestHeaderFieldsTooLargeException extends ClientException {
+  constructor(code: number, message: string, requestId?: string) {
+    super(code, message, requestId);
+    this.name = 'RequestHeaderFieldsTooLargeException';
+  }
+}