pulsar-client 1.8.0-rc1 → 1.8.1-rc.1

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +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.
+
+-->
 <!--
 ### Contribution Checklist
   

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

@@ -1,3 +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.
+#
 name: Build release napi
 on:
   workflow_dispatch:
@@ -109,7 +127,7 @@ jobs:
       - name: Build Linux Docker image
         uses: docker/build-push-action@v3
         with:
-          context: ./pkg/${{matrix.image}}
+          file: ./pkg/linux/Dockerfile_${{matrix.image}}
           load: true
           tags: build:latest
           platforms: linux/${{matrix.cpu.arch}}
@@ -123,7 +141,7 @@ jobs:
       - name: Build and Test NAPI file
         run: |
           docker run -i -v $PWD:/pulsar-client-node build:latest \
-              /pulsar-client-node/pkg/build-napi-inside-docker.sh
+              /pulsar-client-node/pkg/linux/build-napi-inside-docker.sh
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v3

package/.github/workflows/ci-pr-validation.yml

@@ -151,7 +151,7 @@ jobs:
       - name: Build Linux Docker image
         uses: docker/build-push-action@v3
         with:
-          context: ./pkg/${{matrix.image}}
+          file: ./pkg/linux/Dockerfile_${{matrix.image}}
           load: true
           tags: build:latest
           platforms: linux/${{matrix.cpu.arch}}
@@ -165,7 +165,15 @@ jobs:
       - name: Build and Test NAPI file
         run: |
           docker run -i -v $PWD:/pulsar-client-node build:latest \
-              /pulsar-client-node/pkg/build-napi-inside-docker.sh
+              /pulsar-client-node/pkg/linux/build-napi-inside-docker.sh
+
+      - name: Test NAPI file in other containers
+        if: matrix.image == 'linux_glibc'
+        run: |
+          ./tests/load-test.sh node:16-buster ${{matrix.cpu.platform}}
+          ./tests/load-test.sh node:16-bullseye ${{matrix.cpu.platform}}
+          ./tests/load-test.sh node:19-buster ${{matrix.cpu.platform}}
+          ./tests/load-test.sh node:19-bullseye ${{matrix.cpu.platform}}
 
   windows-napi:
     name: Build NAPI windows - Node ${{matrix.nodejs}} - ${{matrix.arch}}

package/README.md

@@ -94,6 +94,10 @@ You can see more examples in the [examples](./examples) directory. However, sinc
 
 ## How to build
 
+> **Note**
+>
+> Build from source code requires the Node.js version greater than 16.18
+
 First, clone the repository.
 
 ```shell
@@ -106,7 +110,7 @@ Since this client is a [C++ addon](https://nodejs.org/api/addons.html#c-addons)
 - Install C++ client on Linux:
 
 ```shell
-build-support/install-cpp-client.sh
+pkg/linux/download-cpp-client.sh
 ```
 
 - Install C++ client on Windows:

package/binding.gyp

@@ -20,7 +20,7 @@
 {
   "targets": [
     {
-      "target_name": "Pulsar",
+      "target_name": "pulsar",
       "cflags_cc": ["-std=gnu++11"],
       "cflags!": ["-fno-exceptions"],
       "cflags_cc!": ["-fno-exceptions", "-std=gnu++14", "-std=gnu++17"],
@@ -60,6 +60,9 @@
           "include_dirs": [
             "pkg/mac/build-pulsar/install/include"
           ],
+          "libraries": [
+            "../pkg/mac/build-pulsar/install/lib/libpulsarwithdeps.a"
+          ],
         }],
         ['OS=="win"', {
           "defines": [
@@ -80,12 +83,16 @@
           "dependencies": [
             "<!(node -p \"require('node-addon-api').gyp\")"
           ]
-        }, {  # 'OS!="win"'
+        }],
+        ['OS=="linux"', {
           "dependencies": [
             "<!@(node -p \"require('node-addon-api').gyp\")"
           ],
+          "include_dirs": [
+             "pkg/linux/pulsar-cpp/include"
+          ],
           "libraries": [
-             "../pkg/lib/libpulsarwithdeps.a"
+             "../pkg/linux/pulsar-cpp/lib/libpulsarwithdeps.a"
           ],
         }]
       ]

package/docs/release-process.md

@@ -1,3 +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.
+
+-->
 This page contains instructions for Pulsar committers on how to perform a release.
 
 ## Making the release
@@ -8,10 +28,10 @@ The steps for releasing are as follows:
 3. Update package version and tag
 4. Sign and stage the artifacts
 5. Move master branch to next version
-6. Write release notes
+6. Publish the release candidate to the npm
 7. Run the vote
 8. Promote the release
-9. Update release notes
+9. Add release notes
 10. Announce the release
  
 ## Requirements
@@ -94,14 +114,15 @@ $ cd pulsar-dist-dev
 
 # '-candidate-1' needs to be incremented in case of multiple iterations in getting
 #    to the final release)
-$ svn mkdir pulsar-client-node-1.X.0-candidate-1
+$ svn mkdir pulsar-client-node-1.X.0-rc.1
+$ cd pulsar-client-node-1.X.0-rc.1
 
 # Generate token from here: https://github.com/settings/tokens
 $ export GITHUB_TOKEN=${Your github token} 
 $ $PULSAR_PATH/build-support/stage-release.sh . $WORKFLOW_ID
 
 $ svn add *
-$ svn ci -m 'Staging artifacts and signature for Pulsar Node.js client release 1.X.0-candidate-1'
+$ svn ci -m 'Staging artifacts and signature for Pulsar Node.js client release 1.X.0-rc.1'
 ```
 
 #### 5. Move master branch to next version
@@ -116,14 +137,15 @@ $ npm version preminor --preid=rc
 Since this needs to be merged in `master`, we need to follow the regular process
 and create a Pull Request on GitHub.
 
-#### 6. Write release notes
+#### 6. Publish the release candidate to the npm
 
-Check the milestone in GitHub associated with the release.
-https://github.com/apache/pulsar-client-node/milestones?closed=1
+Set the npm version for the release candidate
+```sh
+npm version 1.8.0-rc.1 --no-git-tag-version
+```
 
-In the release item, add the list of most important changes that happened in the release
-and a link to the associated milestone, with the complete list of all the changes.
-https://github.com/apache/pulsar-client-node/releases
+You can use `npm pack` and test the package before publishing. 
+If there are no problems, then use `npm publish` to publish to the npm.
 
 #### 7. Run the vote
 
@@ -134,9 +156,6 @@ To: dev@pulsar.apache.org
 Subject: [VOTE] Pulsar Node.js Client Release 1.X.0 Candidate 1
 
 Hi everyone,
-Please review and vote on the release candidate #1 for the version 1.X.0, as follows:
-[ ] +1, Approve the release
-[ ] -1, Do not approve the release (please provide specific comments)
 
 This is the first release candidate for Apache Pulsar Node.js client, version 1.X.0.
 
@@ -144,13 +163,17 @@ It fixes the following issues:
 https://github.com/apache/pulsar-client-node/milestone/1?closed=1
 
 Please download the source files and review this release candidate:
-- Review release notes
-- Download the source package (verify shasum and asc) and follow the README.md to build and run the Pulsar Node.js client.
+- Download the source package, verify shasum and asc
+- Follow the README.md to build and run the Pulsar Node.js client.
+
+The release candidate package has been published to the npm registry:
+https://www.npmjs.com/package/pulsar-client/v/1.X.0-rc.1
+You can install it by `npm i pulsar-client@1.X.0-rc.1 --pulsar_binary_host_mirror=https://dist.apache.org/repos/dist/dev/pulsar/pulsar-client-node/` and verify the package.
 
 The vote will be open for at least 72 hours. It is adopted by majority approval, with at least 3 PMC affirmative votes.
 
 Source files:
-https://dist.apache.org/repos/dist/dev/pulsar/pulsar-client-node/pulsar-client-node-1.X.0-candidate-1/
+https://dist.apache.org/repos/dist/dev/pulsar/pulsar-client-node/pulsar-client-node-1.X.0-rc.1/
 
 Pulsar's KEYS file containing PGP keys we use to sign the release:
 https://dist.apache.org/repos/dist/dev/pulsar/KEYS
@@ -161,6 +184,10 @@ SHA-512 checksum:
 The tag to be voted upon:
 v1.X.0-rc.1
 https://github.com/apache/pulsar-client-node/releases/tag/v1.X.0-rc.1
+
+Please review and vote on the release candidate #1 for the version 1.X.0, as follows:
+[ ] +1, Approve the release
+[ ] -1, Do not approve the release (please provide specific comments)
 ```
 
 The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC members
@@ -198,7 +225,7 @@ $ npm publish
 Promote the artifacts on the release location (need PMC permissions):
 ```sh
 $ svn mv -m 'Release Pulsar Node.js client 1.X.0' \
-  https://dist.apache.org/repos/dist/dev/pulsar/pulsar-client-node/pulsar-client-node-1.X.0-candidate-1 \
+  https://dist.apache.org/repos/dist/dev/pulsar/pulsar-client-node/pulsar-client-node-1.X.0-rc.1 \
   https://dist.apache.org/repos/dist/release/pulsar/pulsar-client-node/pulsar-client-node-1.X.0
 
 # Remove the old releases (if any)
@@ -207,10 +234,12 @@ $ svn rm -m 'Remove the old release' \
   https://dist.apache.org/repos/dist/release/pulsar/pulsar-client-node/pulsar-client-node-1.Y.0
 ```
 
-#### 9. Update release notes
+#### 9. Add release notes
 
-Add the release notes there:
-https://github.com/apache/pulsar-client-node/releases
+Create a PR to add release notes to the pulsar site. Here is the example: https://github.com/apache/pulsar-site/pull/360
+If there are any new contributors for this release, please add a `New Contributors` section in the release note.
+
+Once the PR has been approved, add release notes to the Github release page (https://github.com/apache/pulsar-client-node/releases)
 
 #### 10. Announce the release
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pulsar-client",
-  "version": "1.8.0-rc1",
+  "version": "1.8.1-rc.1",
   "description": "Pulsar Node.js client",
   "main": "index.js",
   "types": "index.d.ts",
@@ -57,9 +57,9 @@
     "node-addon-api": "^4.3.0"
   },
   "binary": {
-    "module_name": "Pulsar",
+    "module_name": "pulsar",
     "module_path": "./lib/binding/",
-    "host": "https://dist.apache.org/repos/dist/release/pulsar/pulsar-client-node/",
+    "host": "https://archive.apache.org/dist/pulsar/pulsar-client-node/",
     "remote_path": "pulsar-client-node-{version}",
     "package_name": "napi-{platform}-{libc}-{arch}.tar.gz"
   },
@@ -79,7 +79,8 @@
       ".json",
       ".pem",
       ".txt",
-      ".gz"
+      ".gz",
+      ".bat"
     ],
     "trailing_whitespace": "TRIM",
     "insert_license": true,

package/pkg/{linux_glibc/Dockerfile → linux/Dockerfile_linux_glibc}

@@ -17,17 +17,19 @@
 # under the License.
 #
 
-ARG NODE_VERSION
+FROM centos:7
 
-FROM node:${NODE_VERSION}-bullseye
+RUN yum update -y
+RUN yum install -y gcc gcc-c++ make python3
 
-ARG NODE_VERSION
+WORKDIR /app
+ARG PLATFORM
+RUN SUFFIX=$(echo ${PLATFORM} | sed 's/86_//') && \
+  echo $SUFFIX && \
+  curl -O -L https://nodejs.org/download/release/v16.19.0/node-v16.19.0-linux-$SUFFIX.tar.gz && \
+  tar zxf node-v16.19.0-linux-$SUFFIX.tar.gz && \
+  mv node-v16.19.0-linux-$SUFFIX node-v16.19.0
 
-RUN apt-get update -y && \
-     apt-get install -y \
-        curl \
-        g++ \
-        make \
-        python3
+ENV PATH="/app/node-v16.19.0/bin:$PATH"
 
 CMD ["sh"]

package/pkg/{build-napi-inside-docker.sh → linux/build-napi-inside-docker.sh}

@@ -22,7 +22,7 @@ set -e -x
 
 cd /pulsar-client-node
 
-build-support/install-cpp-client.sh
+pkg/linux/download-cpp-client.sh
 
 npm install --ignore-scripts
 npx node-pre-gyp configure

package/{build-support/install-cpp-client.sh → pkg/linux/download-cpp-client.sh}

@@ -20,7 +20,7 @@
 
 set -e -x
 
-ROOT_DIR=`cd $(dirname $0) && cd .. && pwd`
+ROOT_DIR=`cd $(dirname $0) && cd ../../ && pwd`
 source $ROOT_DIR/pulsar-client-cpp.txt
 
 if [ $USER != "root" ]; then
@@ -29,9 +29,6 @@ fi
 
 # Get the flavor of Linux
 export $(cat /etc/*-release | grep "^ID=")
-
-cd /tmp
-
 UNAME_ARCH=$(uname -m)
 if [ $UNAME_ARCH == 'aarch64' ]; then
   PLATFORM=arm64
@@ -39,28 +36,30 @@ else
   PLATFORM=x86_64
 fi
 
+rm -rf $ROOT_DIR/pkg/linux/pulsar-cpp
+mkdir $ROOT_DIR/pkg/linux/pulsar-cpp
+rm -rf $ROOT_DIR/pkg/linux/tmp
+mkdir $ROOT_DIR/pkg/linux/tmp
+cd $ROOT_DIR/pkg/linux/tmp
+
 if [ $ID == 'ubuntu' -o $ID == 'debian' ]; then
-  curl -L -O ${CPP_CLIENT_BASE_URL}/deb-${PLATFORM}/apache-pulsar-client.deb
   curl -L -O ${CPP_CLIENT_BASE_URL}/deb-${PLATFORM}/apache-pulsar-client-dev.deb
-  $SUDO apt install -y /tmp/*.deb
+  $SUDO ar x apache-pulsar-client-dev.deb
+  $SUDO tar -xvf data.tar.xz
+  cp -r usr/* $ROOT_DIR/pkg/linux/pulsar-cpp/
 
 elif [ $ID == 'alpine' ]; then
-  curl -L -O ${CPP_CLIENT_BASE_URL}/apk-${PLATFORM}/${UNAME_ARCH}/apache-pulsar-client-${CPP_CLIENT_VERSION}-r0.apk
   curl -L -O ${CPP_CLIENT_BASE_URL}/apk-${PLATFORM}/${UNAME_ARCH}/apache-pulsar-client-dev-${CPP_CLIENT_VERSION}-r0.apk
-  $SUDO apk add --allow-untrusted /tmp/*.apk
+  $SUDO tar -xvf apache-pulsar-client-dev-${CPP_CLIENT_VERSION}-r0.apk
+  cp -r usr/* $ROOT_DIR/pkg/linux/pulsar-cpp/
 
-elif [ $ID == '"centos"' ]; then
-  curl -L -O ${CPP_CLIENT_BASE_URL}/rpm-${PLATFORM}/${UNAME_ARCH}/apache-pulsar-client-${CPP_CLIENT_VERSION}-1.${UNAME_ARCH}.rpm
+elif [ $ID == '"centos"' -o $ID == '"rocky"' ]; then
   curl -L -O ${CPP_CLIENT_BASE_URL}/rpm-${PLATFORM}/${UNAME_ARCH}/apache-pulsar-client-devel-${CPP_CLIENT_VERSION}-1.${UNAME_ARCH}.rpm
-  $SUDO rpm -i /tmp/*.rpm
+  $SUDO rpm -i --prefix=$ROOT_DIR/pkg/linux/pulsar-cpp apache-pulsar-client-devel-${CPP_CLIENT_VERSION}-1.${UNAME_ARCH}.rpm --nodeps --force
 
 else
   echo "Unknown Linux distribution: '$ID'"
   exit 1
 fi
 
-mkdir -p $ROOT_DIR/pkg/lib/
-cp /usr/lib/libpulsarwithdeps.a $ROOT_DIR/pkg/lib/
-
-
-
+$SUDO rm -rf $ROOT_DIR/pkg/linux/tmp

package/pkg/load_test.js

@@ -20,6 +20,10 @@
 const Pulsar = require('../index.js');
 
 (async () => {
+  Pulsar.Client.setLogHandler((level, file, line, message) => {
+    console.log('[%s][%s:%d] %s', Pulsar.LogLevel.toString(level), file, line, message);
+  });
+
   // Create a client
   const clientConfig = {
     serviceUrl: 'pulsar://localhost:6650',

package/pkg/mac/build-cpp-lib.sh

@@ -43,9 +43,6 @@ pushd apache-pulsar-client-cpp-${CPP_CLIENT_VERSION}
       -DBUILD_DYNAMIC_LIB=OFF \
       -DPROTOC_PATH=$PREFIX/bin/protoc
   make -j16 install
-  mkdir -p $ROOT_DIR/pkg/lib/
-  cp -r lib/libpulsarwithdeps.a $ROOT_DIR/pkg/lib/
 popd
 
 rm -rf apache-pulsar-client-cpp-${CPP_CLIENT_VERSION}.tar.gz apache-pulsar-client-cpp-${CPP_CLIENT_VERSION}
-

package/pulsar-client-cpp.txt

@@ -1,2 +1,2 @@
-CPP_CLIENT_BASE_URL=https://archive.apache.org/dist/pulsar/pulsar-client-cpp-3.1.0/
-CPP_CLIENT_VERSION=3.1.0
+CPP_CLIENT_BASE_URL=https://archive.apache.org/dist/pulsar/pulsar-client-cpp-3.1.2
+CPP_CLIENT_VERSION=3.1.2

package/src/pulsar-binding.js

@@ -1,3 +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.
+ */
 const path = require('path');
 const binary = require('@mapbox/node-pre-gyp');
 

package/tests/docker-load-test.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+#
+# 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.
+#
+
+# NOTE: This script should only run inside a Node.js docker container.
+# See ./load-test.sh for details.
+set -ex
+
+# Create an empty directory to test
+mkdir -p /app && cd /app
+tar zxf /pulsar-client-node/pulsar-client-node.tar.gz
+
+# Use the existing Pulsar.node built in a specific container
+mkdir -p lib/binding
+cp /pulsar-client-node/build/Release/pulsar.node lib/binding/
+npm install
+
+# Test if Pulsar.node can be loaded
+node pkg/load_test.js

package/tests/load-test.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+#
+# 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.
+#
+
+# Test if the Pulsar.node built from ../pkg/linux/build-napi-inside-docker.sh
+# can be loaded in other Linux distributions.
+
+set -e
+
+if [[ $# -lt 2 ]]; then
+    echo "Usage $0 <node-image-name> <platform>
+
+See https://hub.docker.com/_/node for valid images"
+    exit 1
+fi
+IMAGE=$1
+PLATFORM=$2
+
+ROOT_DIR=${ROOT_DIR:-$(git rev-parse --show-toplevel)}
+cd $ROOT_DIR
+
+git archive -o pulsar-client-node.tar.gz HEAD
+
+docker run --platform $PLATFORM -v $PWD:/pulsar-client-node $IMAGE \
+    /bin/bash /pulsar-client-node/tests/docker-load-test.sh
+
+rm pulsar-client-node.tar.gz

package/tests/run-unit-tests.sh

@@ -23,8 +23,8 @@ set -e
 ROOT_DIR=${ROOT_DIR:-$(git rev-parse --show-toplevel)}
 cd $ROOT_DIR
 
-# install pulsar cpp client pkg
-build-support/install-cpp-client.sh
+# download pulsar cpp client
+pkg/linux/download-cpp-client.sh
 
 cd $ROOT_DIR
 build-support/pulsar-test-service-start.sh