pulsar-client 1.13.2 → 1.14.0-rc.2

package/index.d.ts

@@ -103,6 +103,7 @@ export interface ConsumerConfig {
   regexSubscriptionMode?: RegexSubscriptionMode;
   deadLetterPolicy?: DeadLetterPolicy;
   batchReceivePolicy?: ConsumerBatchReceivePolicy;
+  keySharedPolicy?: KeySharedPolicy;
 }
 
 export class Consumer {
@@ -194,6 +195,18 @@ export interface ConsumerBatchReceivePolicy {
   timeoutMs?: number;
 }
 
+export interface ConsumerKeyShareStickyRange {
+  start: number;
+  end: number;
+}
+export type ConsumerKeyShareStickyRanges = ConsumerKeyShareStickyRange[];
+
+export interface KeySharedPolicy {
+  keyShareMode?: ConsumerKeyShareMode;
+  allowOutOfOrderDelivery?: boolean;
+  stickyRanges?: ConsumerKeyShareStickyRanges;
+}
+
 export class AuthenticationTls {
   constructor(params: { certificatePath: string, privateKeyPath: string });
 }
@@ -296,6 +309,10 @@ export type ConsumerCryptoFailureAction =
   'DISCARD' |
   'CONSUME';
 
+export type ConsumerKeyShareMode =
+    'AutoSplit' |
+    'Sticky';
+
 export type RegexSubscriptionMode =
   'PersistentOnly' |
   'NonPersistentOnly' |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pulsar-client",
-  "version": "1.13.2",
+  "version": "1.14.0-rc.2",
   "description": "Pulsar Node.js client",
   "main": "index.js",
   "types": "index.d.ts",

package/src/Client.cc

@@ -144,7 +144,8 @@ Client::Client(const Napi::CallbackInfo &info) : Napi::ObjectWrap<Client>(info)
   if (clientConfig.Has(CFG_AUTH) && clientConfig.Get(CFG_AUTH).IsObject()) {
     Napi::Object obj = clientConfig.Get(CFG_AUTH).ToObject();
     if (obj.Has(CFG_AUTH_PROP) && obj.Get(CFG_AUTH_PROP).IsObject()) {
-      Authentication *auth = Authentication::Unwrap(obj.Get(CFG_AUTH_PROP).ToObject());
+      this->authRef_ = Napi::Persistent(obj.Get(CFG_AUTH_PROP).As<Napi::Object>());
+      Authentication *auth = Authentication::Unwrap(this->authRef_.Value());
       pulsar_client_configuration_set_auth(cClientConfig.get(), auth->GetCAuthentication());
     }
   }

package/src/Client.h

@@ -54,6 +54,7 @@ class Client : public Napi::ObjectWrap<Client> {
   std::shared_ptr<pulsar_client_t> cClient;
   std::shared_ptr<pulsar_client_configuration_t> cClientConfig;
   pulsar_logger_level_t logLevel = pulsar_logger_level_t::pulsar_INFO;
+  Napi::ObjectReference authRef_;
 
   Napi::Value CreateProducer(const Napi::CallbackInfo &info);
   Napi::Value Subscribe(const Napi::CallbackInfo &info);

package/src/ConsumerConfig.cc

@@ -21,6 +21,7 @@
 #include "Consumer.h"
 #include "SchemaInfo.h"
 #include "Message.h"
+#include "pulsar/ConsumerConfiguration.h"
 #include <pulsar/c/consumer_configuration.h>
 #include <pulsar/c/consumer.h>
 #include <map>
@@ -55,6 +56,10 @@ static const std::string CFG_BATCH_RECEIVE_POLICY = "batchReceivePolicy";
 static const std::string CFG_BATCH_RECEIVE_POLICY_MAX_NUM_MESSAGES = "maxNumMessages";
 static const std::string CFG_BATCH_RECEIVE_POLICY_MAX_NUM_BYTES = "maxNumBytes";
 static const std::string CFG_BATCH_RECEIVE_POLICY_TIMEOUT_MS = "timeoutMs";
+static const std::string CFG_KEY_SHARED_POLICY = "keySharedPolicy";
+static const std::string CFG_KEY_SHARED_POLICY_MODE = "keyShareMode";
+static const std::string CFG_KEY_SHARED_POLICY_ALLOW_OUT_OF_ORDER = "allowOutOfOrderDelivery";
+static const std::string CFG_KEY_SHARED_POLICY_STICKY_RANGES = "stickyRanges";
 
 static const std::map<std::string, pulsar_consumer_type> SUBSCRIPTION_TYPE = {
     {"Exclusive", pulsar_ConsumerExclusive},
@@ -76,6 +81,15 @@ static const std::map<std::string, pulsar_consumer_crypto_failure_action> CONSUM
     {"CONSUME", pulsar_ConsumerConsume},
 };
 
+static const std::map<std::string, pulsar::KeySharedMode> CONSUMER_KEY_SHARED_POLICY_MODE = {
+    {"AutoSplit", pulsar::KeySharedMode::AUTO_SPLIT},
+    {"Sticky", pulsar::KeySharedMode::STICKY},
+};
+
+struct _pulsar_consumer_configuration {
+  pulsar::ConsumerConfiguration consumerConfiguration;
+};
+
 void FinalizeListenerCallback(Napi::Env env, MessageListenerCallback *cb, void *) { delete cb; }
 
 ConsumerConfig::ConsumerConfig()
@@ -324,6 +338,58 @@ void ConsumerConfig::InitConfig(std::shared_ptr<ThreadSafeDeferred> deferred,
       return;
     }
   }
+
+  if (consumerConfig.Has(CFG_KEY_SHARED_POLICY) && consumerConfig.Get(CFG_KEY_SHARED_POLICY).IsObject()) {
+    Napi::Object propObj = consumerConfig.Get(CFG_KEY_SHARED_POLICY).ToObject();
+    pulsar::KeySharedPolicy cppKeySharedPolicy;
+
+    if (propObj.Has(CFG_KEY_SHARED_POLICY_MODE) && propObj.Get(CFG_KEY_SHARED_POLICY_MODE).IsString()) {
+      std::string keyShareModeStr = propObj.Get(CFG_KEY_SHARED_POLICY_MODE).ToString().Utf8Value();
+      if (CONSUMER_KEY_SHARED_POLICY_MODE.count(keyShareModeStr)) {
+        cppKeySharedPolicy.setKeySharedMode(CONSUMER_KEY_SHARED_POLICY_MODE.at(keyShareModeStr));
+      }
+    }
+
+    if (propObj.Has(CFG_KEY_SHARED_POLICY_ALLOW_OUT_OF_ORDER) &&
+        propObj.Get(CFG_KEY_SHARED_POLICY_ALLOW_OUT_OF_ORDER).IsBoolean()) {
+      bool allowOutOfOrderDelivery = propObj.Get(CFG_KEY_SHARED_POLICY_ALLOW_OUT_OF_ORDER).ToBoolean();
+      cppKeySharedPolicy.setAllowOutOfOrderDelivery(allowOutOfOrderDelivery);
+    }
+
+    if (propObj.Has(CFG_KEY_SHARED_POLICY_STICKY_RANGES) &&
+        propObj.Get(CFG_KEY_SHARED_POLICY_STICKY_RANGES).IsArray()) {
+      Napi::Array rangesArray = propObj.Get(CFG_KEY_SHARED_POLICY_STICKY_RANGES).As<Napi::Array>();
+      pulsar::StickyRanges stickyRanges;
+      for (uint32_t i = 0; i < rangesArray.Length(); i++) {
+        if (rangesArray.Get(i).IsObject()) {
+          Napi::Object rangeObj = rangesArray.Get(i).ToObject();
+          if (rangeObj.Has("start") && rangeObj.Has("end") && rangeObj.Get("start").IsNumber() &&
+              rangeObj.Get("end").IsNumber()) {
+            int start = rangeObj.Get("start").ToNumber().Int32Value();
+            int end = rangeObj.Get("end").ToNumber().Int32Value();
+            if (start > end) {
+              std::string error = "Invalid sticky range at index " + std::to_string(i) + ": start (" +
+                                  std::to_string(start) + ") > end (" + std::to_string(end) + ")";
+              deferred->Reject(error);
+              return;
+            }
+            stickyRanges.emplace_back(start, end);
+          } else {
+            std::string error = "Invalid sticky range format at index " + std::to_string(i) +
+                                ": missing 'start'/'end' or invalid type, should be number type";
+            deferred->Reject(error);
+            return;
+          }
+        } else {
+          std::string error = "Sticky range element at index " + std::to_string(i) + " is not an object";
+          deferred->Reject(error);
+          return;
+        }
+      }
+      cppKeySharedPolicy.setStickyRanges(stickyRanges);
+    }
+    this->cConsumerConfig.get()->consumerConfiguration.setKeySharedPolicy(cppKeySharedPolicy);
+  }
 }
 
 ConsumerConfig::~ConsumerConfig() {

package/.clang-format

@@ -1,26 +0,0 @@
-#
-# 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.
-#
-
-BasedOnStyle: Google
-IndentWidth: 2
-ColumnLimit: 110
-SortIncludes: false
-BreakBeforeBraces: Custom
-BraceWrapping:
-  AfterEnum: true

package/.eslintignore

@@ -1,21 +0,0 @@
-#
-# 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.
-#
-
-examples
-perf

package/.eslintrc.json

@@ -1,22 +0,0 @@
-{
-  "extends": ["airbnb-base","plugin:jest/recommended"],
-  "rules": {
-    "class-methods-use-this": "warn",
-    "no-await-in-loop": "warn",
-    "no-console": "off",
-    "no-unused-vars": "warn"
-  },
-  "overrides": [
-    {
-      "files": ["tests/*.js"],
-      "rules": {
-        "no-await-in-loop": "off"
-      }
-    }
-  ],
-  "globals": {
-    "describe": true,
-    "test": true,
-    "expect": true
-  }
-}

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,85 +0,0 @@
-<!--
-
-    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.
-
--->
-<!--
-### Contribution Checklist
-  
-  - PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.trs9rsex3xom)*. 
-
-  - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
-  
-  - Each pull request should address only one issue, not mix up code from multiple issues.
-  
-  - Each commit in the pull request has a meaningful commit message
-
-  - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
--->
-
-<!-- Either this PR fixes an issue, -->
-
-Fixes #<xyz>
-
-<!-- or this PR is one task of an issue -->
-
-Master Issue: #<xyz>
-
-### Motivation
-
-<!-- Explain here the context, and why you're making that change. What is the problem you're trying to solve. -->
-
-### Modifications
-
-<!-- Describe the modifications you've done. -->
-
-### Verifying this change
-
-- [ ] Make sure that the change passes the CI checks.
-
-*(Please pick either of the following options)*
-
-This change is a trivial rework / code cleanup without any test coverage.
-
-*(or)*
-
-This change is already covered by existing tests, such as *(please describe tests)*.
-
-*(or)*
-
-This change added tests and can be verified as follows:
-
-*(example:)*
-  - *Added integration tests for end-to-end deployment with large payloads (10MB)*
-  - *Extended integration test for recovery after broker failure*
-
-### Documentation
-
-<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
-
-- [ ] `doc-required` 
-(Your PR needs to update docs and you will update later)
-
-- [ ] `doc-not-needed` 
-(Please explain why)
-
-- [ ] `doc` 
-(Your PR contains doc changes)
-
-- [ ] `doc-complete`
-(Docs have been already added)

package/.github/workflows/ci-build-release-napi.yml

@@ -1,211 +0,0 @@
-#
-# 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.
-#
-name: Build release napi
-on:
-  workflow_dispatch:
-  push:
-    tags:
-      - '*'
-env:
-  FORCE_COLOR: 1
-concurrency:
-  group: ${{ github.head_ref || github.run_id }}
-  cancel-in-progress: true
-jobs:
-  macos-napi:
-    name: Build NAPI macos - Node ${{matrix.nodejs}} - ${{matrix.arch}}
-    runs-on: ${{ matrix.os }}
-    timeout-minutes: 3000
-
-    strategy:
-      fail-fast: false
-      matrix:
-        arch:
-          - x64
-          - arm64
-        nodejs:
-          - 18
-        python:
-          - "3.10"
-        include:
-          - arch: x64
-            os: macos-13
-          - arch: arm64
-            # macos-14 is used for arm64
-            os: macos-14
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.nodejs }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.nodejs }}
-          cache: 'npm'
-          
-      - name: Use Python ${{ matrix.python }}
-        uses: actions/setup-python@v3
-        with:
-          python-version: ${{ matrix.python }}
-          
-      - name: Build Node binaries lib
-        run: |
-          if [ "${{ matrix.arch }}" = "x64" ]; then
-            export ARCH=x86_64
-          else
-            export ARCH=${{ matrix.arch }}
-          fi
-          pkg/mac/download-cpp-client.sh
-          npm install --ignore-scripts
-          npx node-pre-gyp configure --target_arch=${{ matrix.arch }}
-          npx node-pre-gyp build --target_arch=${{ matrix.arch }}
-
-      - name: Test loading Node binaries lib
-        run: |
-          node pkg/load_test.js
-
-      - name: Package Node binaries lib
-        run: |
-          npx node-pre-gyp package --target_arch=${{ matrix.arch }}
-
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: macos-${{matrix.nodejs}}-${{matrix.arch}}
-          path: build/stage/*/*.tar.gz
-
-  linux-napi:
-    name: Build NAPI ${{matrix.image}} - Node ${{matrix.nodejs}} - ${{matrix.cpu.platform}}
-    runs-on: ubuntu-22.04
-    timeout-minutes: 3000
-
-    strategy:
-      fail-fast: false
-      matrix:
-        image:
-          - 'linux_glibc'
-          - 'linux_musl'
-        nodejs:
-          - 18
-        cpu:
-          - {arch: 'x86_64', platform: 'x86_64'}
-          - {arch: 'aarch64', platform: 'arm64'}
-
-    steps:
-      - name: checkout
-        uses: actions/checkout@v3
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-
-      - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v2
-
-      - name: Build Linux Docker image
-        uses: docker/build-push-action@v3
-        with:
-          file: ./pkg/linux/Dockerfile_${{matrix.image}}
-          load: true
-          tags: build:latest
-          platforms: linux/${{matrix.cpu.arch}}
-          build-args: |
-            PLATFORM=${{matrix.cpu.platform}}
-            ARCH=${{matrix.cpu.arch}}
-            NODE_VERSION=${{matrix.nodejs}}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-
-      - name: Build and Test NAPI file
-        run: |
-          docker run -i -v $PWD:/pulsar-client-node build:latest \
-              /pulsar-client-node/pkg/linux/build-napi-inside-docker.sh
-
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{matrix.image}}-${{matrix.nodejs}}-${{matrix.cpu.platform}}
-          path: build/stage/*/*.tar.gz
-
-  windows-napi:
-    name: Build NAPI windows - Node ${{matrix.nodejs}} - ${{matrix.arch}}
-    runs-on: windows-2022
-    timeout-minutes: 3000
-
-    strategy:
-      fail-fast: false
-      matrix:
-        arch:
-          - x64
-          - x86
-        nodejs:
-          - 18
-        python:
-          - "3.10"
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.nodejs }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.nodejs }}
-          architecture: ${{ matrix.arch }}
-          cache: 'npm'
-
-      - name: Use Python ${{ matrix.python }}
-        uses: actions/setup-python@v3
-        with:
-          python-version: ${{ matrix.python }}
-
-      - name: Cache CPP Client
-        id: cache-dependencies
-        uses: actions/cache@v3
-        with:
-          path: pkg/windows/
-          key: ${{ runner.os }}-${{ matrix.arch }}-${{ hashFiles('pulsar-client-cpp.txt') }}
-
-      - name: Add env vars
-        shell: bash
-        run: |
-          if [ "${{ matrix.arch }}" = "x86" ]; then
-            echo "TARGET=ia32" >> $GITHUB_ENV
-          else
-            echo "TARGET=${{ matrix.arch }}" >> $GITHUB_ENV
-          fi
-
-      - name: Download CPP Client
-        if: steps.cache-dependencies.outputs.cache-hit != 'true'
-        run: |
-          pkg/windows/download-cpp-client.bat ${{ matrix.arch }}
-
-      - name: Build Node binaries lib
-        run: |
-          npm install --ignore-scripts
-          npx node-pre-gyp configure --target_arch=${{ env.TARGET }}
-          npx node-pre-gyp build --target_arch=${{ env.TARGET }}
-
-      - name: Test loading Node binaries lib
-        run: |
-          node pkg/load_test.js
-
-      - name: Package Node binaries lib
-        run: |
-          npx node-pre-gyp package --target_arch=${{ env.TARGET }}
-
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: windows-${{matrix.nodejs}}-${{matrix.arch}}
-          path: build/stage/*/*.tar.gz