pulsar-client 1.8.1-rc.2 → 1.8.2-rc.1

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

@@ -167,7 +167,7 @@ jobs:
           docker run -i -v $PWD:/pulsar-client-node build:latest \
               /pulsar-client-node/pkg/linux/build-napi-inside-docker.sh
 
-      - name: Test NAPI file in other containers
+      - name: Test NAPI file in linux_glibc containers
         if: matrix.image == 'linux_glibc'
         run: |
           ./tests/load-test.sh node:16-buster ${{matrix.cpu.platform}}
@@ -175,6 +175,12 @@ jobs:
           ./tests/load-test.sh node:19-buster ${{matrix.cpu.platform}}
           ./tests/load-test.sh node:19-bullseye ${{matrix.cpu.platform}}
 
+      - name: Test NAPI file in linux_musl containers
+        if: matrix.image == 'linux_musl'
+        run: |
+          ./tests/load-test.sh node:18-alpine3.15 ${{matrix.cpu.platform}}
+          ./tests/load-test.sh node:16-alpine3.15 ${{matrix.cpu.platform}}
+
   windows-napi:
     name: Build NAPI windows - Node ${{matrix.nodejs}} - ${{matrix.arch}}
     runs-on: windows-2022

package/README.md

@@ -154,4 +154,13 @@ Sent message: my-message-9
 ```
 
 ## Documentation
+
 * Please see https://pulsar.apache.org/docs/client-libraries-node/ for more details about the Pulsar Node.js client.
+
+You can generate the API docs by:
+
+```shell
+npm install
+npx typedoc
+# Documentation generated at ./apidocs
+```

package/binding.gyp

@@ -21,7 +21,7 @@
   "targets": [
     {
       "target_name": "pulsar",
-      "cflags_cc": ["-std=gnu++11"],
+      "cflags_cc": ["-std=gnu++11", "-fvisibility=hidden"],
       "cflags!": ["-fno-exceptions"],
       "cflags_cc!": ["-fno-exceptions", "-std=gnu++14", "-std=gnu++17"],
       "include_dirs": [
@@ -85,6 +85,9 @@
           ]
         }],
         ['OS=="linux"', {
+          "ldflags": [
+            "-Wl,--exclude-libs,ALL"
+          ],
           "dependencies": [
             "<!@(node -p \"require('node-addon-api').gyp\")"
           ],

package/build-support/pulsar-test-container-start.sh

@@ -30,6 +30,14 @@ bin/pulsar-daemon start standalone \
         --bookkeeper-dir data/bookkeeper
 
 echo "-- Wait for Pulsar service to be ready"
-until curl http://localhost:8080/metrics > /dev/null 2>&1 ; do sleep 1; done
+for i in $(seq 30); do
+    curl http://localhost:8080/metrics > /dev/null 2>&1 && break
+    if [ $i -lt 30 ]; then
+        sleep 1
+    else
+        echo '-- Pulsar standalone server startup timed out'
+        exit 1
+    fi
+done
 
 echo "-- Ready to start tests"

package/build-support/pulsar-test-service-start.sh

@@ -30,6 +30,8 @@ CONTAINER_ID=$(docker run -i -p 8080:8080 -p 6650:6650 -p 8443:8443 -p 6651:6651
 echo $CONTAINER_ID >.tests-container-id.txt
 
 docker cp $SRC_DIR/tests/conf $CONTAINER_ID:/pulsar/test-conf
+docker cp $SRC_DIR/tests/certificate/server.crt $CONTAINER_ID:/pulsar/test-conf
+docker cp $SRC_DIR/tests/certificate/server.key $CONTAINER_ID:/pulsar/test-conf
 docker cp $SRC_DIR/build-support/pulsar-test-container-start.sh $CONTAINER_ID:pulsar-test-container-start.sh
 
 docker exec -i $CONTAINER_ID /pulsar-test-container-start.sh

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pulsar-client",
-  "version": "1.8.1-rc.2",
+  "version": "1.8.2-rc.1",
   "description": "Pulsar Node.js client",
   "main": "index.js",
   "types": "index.d.ts",
@@ -19,7 +19,8 @@
     "dtslint": "dtslint .",
     "license:report": "mkdir -p report && grunt grunt-license-report",
     "license:addheader": "license-check-and-add",
-    "test": "jest --verbose --detectOpenHandles"
+    "test": "jest --verbose --detectOpenHandles",
+    "docs": "typedoc"
   },
   "repository": {
     "type": "git",
@@ -33,12 +34,12 @@
     "node": ">=10.16.0"
   },
   "devDependencies": {
+    "dtslint": "^4.2.0",
     "@seadub/clang-format-lint": "0.0.2",
     "@types/node": "^14.14.25",
     "clang-format": "^1.4.0",
     "commander": "^6.1.0",
     "delay": "^4.4.0",
-    "dtslint": "^3.4.2",
     "eslint": "^7.8.1",
     "eslint-config-airbnb-base": "^14.2.0",
     "eslint-plugin-import": "^2.22.0",
@@ -49,7 +50,8 @@
     "jest": "^27.2.4",
     "license-check-and-add": "^2.3.6",
     "lodash": "^4.17.21",
-    "typescript": "^4.1.3"
+    "typedoc": "^0.23.28",
+    "typescript": "^4.9.5"
   },
   "dependencies": {
     "@mapbox/node-pre-gyp": "^1.0.9",

package/pkg/linux/Dockerfile_linux_musl

@@ -19,7 +19,7 @@
 
 ARG NODE_VERSION
 
-FROM node:${NODE_VERSION}-alpine
+FROM node:${NODE_VERSION}-alpine3.15
 
 RUN apk add \
       bash \

package/src/Client.cc

@@ -93,12 +93,11 @@ Client::Client(const Napi::CallbackInfo &info) : Napi::ObjectWrap<Client>(info)
   Napi::HandleScope scope(env);
   Napi::Object clientConfig = info[0].As<Napi::Object>();
 
-  if (!clientConfig.Has(CFG_SERVICE_URL) || !clientConfig.Get(CFG_SERVICE_URL).IsString()) {
-    if (clientConfig.Get(CFG_SERVICE_URL).ToString().Utf8Value().empty()) {
-      Napi::Error::New(env, "Service URL is required and must be specified as a string")
-          .ThrowAsJavaScriptException();
-      return;
-    }
+  if (!clientConfig.Has(CFG_SERVICE_URL) || !clientConfig.Get(CFG_SERVICE_URL).IsString() ||
+      clientConfig.Get(CFG_SERVICE_URL).ToString().Utf8Value().empty()) {
+    Napi::Error::New(env, "Service URL is required and must be specified as a string")
+        .ThrowAsJavaScriptException();
+    return;
   }
   Napi::String serviceUrl = clientConfig.Get(CFG_SERVICE_URL).ToString();
 
@@ -186,8 +185,12 @@ Client::Client(const Napi::CallbackInfo &info) : Napi::ObjectWrap<Client>(info)
     pulsar_client_configuration_set_stats_interval_in_seconds(cClientConfig.get(), statsIntervalInSeconds);
   }
 
-  this->cClient = std::shared_ptr<pulsar_client_t>(
-      pulsar_client_create(serviceUrl.Utf8Value().c_str(), cClientConfig.get()), pulsar_client_free);
+  try {
+    this->cClient = std::shared_ptr<pulsar_client_t>(
+        pulsar_client_create(serviceUrl.Utf8Value().c_str(), cClientConfig.get()), pulsar_client_free);
+  } catch (const std::exception &e) {
+    Napi::Error::New(env, e.what()).ThrowAsJavaScriptException();
+  }
 }
 
 Client::~Client() {}

package/tests/certificate/server.crt

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDSDCCAjACCQDP7B74131FAzANBgkqhkiG9w0BAQsFADBmMQswCQYDVQQGEwJK
+UDEOMAwGA1UECAwFVG9reW8xFTATBgNVBAcMDERlZmF1bHQgQ2l0eTEcMBoGA1UE
+CgwTRGVmYXVsdCBDb21wYW55IEx0ZDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIz
+MDQwNDAzNTYxNVoXDTMzMDQwMTAzNTYxNVowZjELMAkGA1UEBhMCSlAxDjAMBgNV
+BAgMBVRva3lvMRUwEwYDVQQHDAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1
+bHQgQ29tcGFueSBMdGQxEjAQBgNVBAMMCWxvY2FsaG9zdDCCASIwDQYJKoZIhvcN
+AQEBBQADggEPADCCAQoCggEBALpN39t4b52CT58D3XO0pbAHaBmJ3BHsL/HZnLhl
+4O+Dalv97PrW1cJNzPB07jmc6ffxWXYzLgFGHq+FkqqMg294UV2qgP3P2UgmAXnJ
+i0KMkoDBw1vkbfCiOpDESqJeN2NBJpPG1IJ5SvbBvHmUDhG767H9m3PeDckEm2II
+h9EPu4HCvBK3XDPeF6jSk9vnpfSceaoq7FAb9QBmvXY7h9qe3UkEOtaCEfOvMxJL
+CliMWjFk8lZ8fLBemryVHb0/KsqJclfSoHtpcBE41nsRb9MrKraQdDjj17laiGia
+rA9z2wlLH4L946ypzoikJiqsLRvPHfDVZUd3+jI2nGxn2M8CAwEAATANBgkqhkiG
+9w0BAQsFAAOCAQEAMyey0tpbu9n5eUolkVwDdPw1bM/W5WHwe8fu9CF4Vddmliwb
+PidCUe/b5iTemHFM/ayZdplN+oiQKWyri4Guyz/cBIMI+sypj8RXB9hhPDtqk+yf
+b+6TjJPAZIbRZv/vLfCHdyRwxhc8LcmlUe+nfJN6EwNz3mDu4dDfysbzLcQMj+R6
+MM+mBvhkiZO4k0pQkGmSQkKXfVCiTxRJDLrmLADNCMs1FgyuvlBlu3DhoYn8gLfs
+ftL4W/0/aQp0BLfDa1eL5nH14WQxGMvlC5SZ9EKpX5HwB9iYHBuh7V4UMKSAJSlK
+SN6dVn1fPAfBPcBZ0i3ZgIOb2nRE9AMlqkaTgQ==
+-----END CERTIFICATE-----

package/tests/certificate/server.key

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC6Td/beG+dgk+f
+A91ztKWwB2gZidwR7C/x2Zy4ZeDvg2pb/ez61tXCTczwdO45nOn38Vl2My4BRh6v
+hZKqjINveFFdqoD9z9lIJgF5yYtCjJKAwcNb5G3wojqQxEqiXjdjQSaTxtSCeUr2
+wbx5lA4Ru+ux/Ztz3g3JBJtiCIfRD7uBwrwSt1wz3heo0pPb56X0nHmqKuxQG/UA
+Zr12O4fant1JBDrWghHzrzMSSwpYjFoxZPJWfHywXpq8lR29PyrKiXJX0qB7aXAR
+ONZ7EW/TKyq2kHQ449e5WohomqwPc9sJSx+C/eOsqc6IpCYqrC0bzx3w1WVHd/oy
+NpxsZ9jPAgMBAAECggEAUKjioIyWFmWSv0/XEv9FNN8gDN6I7yGI6HbEyXkiV9BX
+vhhD/53/0i4I6ppVgZAUJArUJr6lzltjca6s/zXyudInuBvX2QuiEQCTZv0BVAC0
+dRZu1Fwj1SkHniG+BmowJMLSRuywmQSWlhru1Nxq8vafZuJb6WBcK4nZFCqJUtN1
+wmOQLbDBj/OGM6gDTXrItQZE4GLkfJJeDxdXRyTBDu00S0y+nl75V/yb0rVKpHO9
+WE4yagN2ds9FjwBMY4Eo4+oMqELAFleuVKnjClliLJ97WTwXL+I73jJHxMP8I6hj
+Ff0YSGuZMXxwpPUml6nGww5josvFT+xuOQaxs/Kw0QKBgQDeXlItBHWkDMtq3Hhz
+/Ju0pHauWLIGTtekP3EnkLiML9kuDwXD9jpG0rwrS8ThjnFulMiCP1T35r38Ev0p
+dS9hWy+7A8+/phwLInJmV0+HY5I7r9kl89h7AZQ1LM0RzulNlzNhs0VXknHP3EEp
+2qyoyasq3fCCUYoCFAIkWRoBrQKBgQDWezcU0+RKap9ZmgFj3oUbRMnpW1OldsQj
+aY5nFZB6istuAiwi3jV/rNmpSBfJLEhpsIlbrhTNUyX8GGzjFjCyYdg0SOtKa740
+HmSjdOaNT2ileDjhfx4PCBccjHuwhcGCixU/s5J+mF9ZXxXGxD0ZfSFqwOeFJipT
+ztYNeslr6wKBgGtLS49ZJYJAgi5PrvcYHfEtoe5B8bRFeptP2UNj+wf5Vmt46ClD
+t57Qs+aYKqlC18ypkY33DQKInYbxiqHkXzY0j3VHQ4iPl9xvhI+I9WC4VKjkEnzT
+idLgUijOMyyyj7PWjv5HR+AXUz8eYXrWfpT6qdKHQDNBMLwL93SeYYQJAoGATf9n
+C4r3FVzq8DHCWag9bao5Z0SQCbdEIsCrSa+c6AN7cVkW5eM7P2ADk70k8ULKXq0V
+dqK66+RWBvR2/KpAMU7FylXOQzUlaVy4Kn1DrpX3L12mCdMpgjvl87re7FXoBmo/
+4veRybntytl6WNtagN9xfJoEV/aGJA4u554Ei9sCgYEAtLscB69G9XbWo6YAsgbG
+cBcbwFZku7tyyrcnqptxSza95w0Y9MDVUtMcgOEehLkSeIpdnIgq14Alln753BYJ
+WyNI6s+fYrusaK/aqNniQJaZRFF6K/55dVwKETUwBhsT8a1JuDVKuAXhq0YF/0Ji
+Z/yve3En4WV+agiOP0teQJM=
+-----END PRIVATE KEY-----

package/tests/client.test.js

@@ -0,0 +1,53 @@
+/**
+ * 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 Pulsar = require('../index.js');
+
+(() => {
+  describe('Client', () => {
+    describe('CreateFailedByUrlSetIncorrect', () => {
+      test('No Set Url', async () => {
+        await expect(() => new Pulsar.Client({
+          operationTimeoutSeconds: 30,
+        })).toThrow('Service URL is required and must be specified as a string');
+      });
+
+      test('Set empty url', async () => {
+        await expect(() => new Pulsar.Client({
+          serviceUrl: '',
+          operationTimeoutSeconds: 30,
+        })).toThrow('Service URL is required and must be specified as a string');
+      });
+
+      test('Set invalid url', async () => {
+        await expect(() => new Pulsar.Client({
+          serviceUrl: 'invalid://localhost:6655',
+          operationTimeoutSeconds: 30,
+        })).toThrow('Invalid scheme: invalid');
+      });
+
+      test('Set not string url', async () => {
+        await expect(() => new Pulsar.Client({
+          serviceUrl: -1,
+          operationTimeoutSeconds: 30,
+        })).toThrow('Service URL is required and must be specified as a string');
+      });
+    });
+  });
+})();

package/tests/conf/standalone.conf

@@ -26,9 +26,11 @@ zookeeperServers=
 globalZookeeperServers=
 
 brokerServicePort=6650
+brokerServicePortTls=6651
 
 # Port to use to server HTTP request
 webServicePort=8080
+webServicePortTls=8443
 
 # Hostname or IP address the service binds on, default is 0.0.0.0.
 bindAddress=0.0.0.0
@@ -90,6 +92,19 @@ delayedDeliveryEnabled=true
 # Default is 1 second.
 delayedDeliveryTickTimeMillis=1000
 
+### --- TLS --- ###
+# Path for the TLS certificate file
+tlsCertificateFilePath=/pulsar/test-conf/server.crt
+
+# Path for the TLS private key file
+tlsKeyFilePath=/pulsar/test-conf/server.key
+
+# Path for the trusted TLS certificate file.
+# This cert is used to verify that any certs presented by connecting clients
+# are signed by a certificate authority. If this verification
+# fails, then the certs are untrusted and the connections are dropped.
+tlsTrustCertsFilePath=/pulsar/test-conf/server.crt
+
 ### --- Authentication --- ###
 
 # Enable authentication

package/tests/end_to_end.test.js

@@ -22,9 +22,15 @@ const Pulsar = require('../index.js');
 
 (() => {
   describe('End To End', () => {
-    test('Produce/Consume', async () => {
+    test.each([
+      ['pulsar://localhost:6650'],
+      ['pulsar+ssl://localhost:6651'],
+      ['http://localhost:8080'],
+      ['https://localhost:8443'],
+    ])('Produce/Consume to %s', async (serviceUrl) => {
       const client = new Pulsar.Client({
-        serviceUrl: 'pulsar://localhost:6650',
+        serviceUrl,
+        tlsTrustCertsFilePath: `${__dirname}/certificate/server.crt`,
         operationTimeoutSeconds: 30,
       });
 

package/tests/load-test.sh

@@ -38,6 +38,6 @@ 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
+    sh /pulsar-client-node/tests/docker-load-test.sh
 
 rm pulsar-client-node.tar.gz

package/tests/run-unit-tests.sh

@@ -28,7 +28,7 @@ pkg/linux/download-cpp-client.sh
 
 cd $ROOT_DIR
 build-support/pulsar-test-service-start.sh
-npm install && npm run lint && npm run dtslint && npm run build && npm run test
+npm install && npm run lint && npm run dtslint && npm run build && npm run test && npm run docs
 RES=$?
 build-support/pulsar-test-service-stop.sh
 

package/tslint.json

@@ -1,6 +1,7 @@
 {
   "extends": "dtslint/dtslint.json",
   "rules": {
+    "semicolon": false,
     "no-unnecessary-class": false,
     "no-relative-import-in-test": false,
     "strict-export-declare-modifiers": false

package/tstest.ts

@@ -315,33 +315,33 @@ import Pulsar = require('./index');
 
 // Missing required parameters
 (async () => {
-  // $ExpectError
+  // @ts-expect-error
   const authAthenz: Pulsar.AuthenticationAthenz = new Pulsar.AuthenticationAthenz({
   });
 
-  // $ExpectError
+  // @ts-expect-error
   const client: Pulsar.Client = new Pulsar.Client({
   });
 
-  // $ExpectError
+  // @ts-expect-error
   const producer: Pulsar.Producer = await client.createProducer({
   });
 
-  // $ExpectError
+  // @ts-expect-error
   const consumer: Pulsar.Consumer = await client.subscribe({
   });
 
-  // $ExpectError
+  // @ts-expect-error
   const reader1: Pulsar.Reader = await client.createReader({
     topic: 'persistent://public/default/my-topic',
   });
 
-  // $ExpectError
+  // @ts-expect-error
   const reader2: Pulsar.Reader = await client.createReader({
     startMessageId: Pulsar.MessageId.latest(),
   });
 
-  // $ExpectError
+  // @ts-expect-error
   const messageId: Pulsar.MessageId = await producer.send({
   });
 })();

package/typedoc.json

@@ -0,0 +1,15 @@
+{
+    "entryPoints": ["index.d.ts"],
+    "out": "apidocs",
+    "name": "Apache Pulsar",
+    "tsconfig": "tsconfig.json",
+    "excludePrivate": true,
+    "excludeProtected": true,
+    "excludeExternals": true,
+    "includeVersion": true,
+    "githubPages": false,
+    "navigationLinks": {
+      "Homepage": "https://pulsar.apache.org/",
+      "GitHub": "https://github.com/apache/pulsar-client-node"
+    }
+}