pulsar-client 1.4.0 → 1.6.0

package/README.md

@@ -42,17 +42,45 @@ Compatibility between each version of the Node.js client and the C++ client is a
 
 | Node.js client | C++ client     |
 |----------------|----------------|
-| 1.0.0          | 2.3.0 or later |
-| 1.1.0          | 2.4.0 or later |
-| 1.2.0          | 2.5.0 or later |
-| 1.3.0          | 2.7.0 or later |
-| 1.4.0          | 2.8.0 or later |
+| 1.0.x          | 2.3.0 or later |
+| 1.1.x          | 2.4.0 or later |
+| 1.2.x          | 2.5.0 or later |
+| 1.3.x          | 2.7.0 or later |
+| 1.4.x - 1.5.x  | 2.8.0 or later |
 
 If an incompatible version of the C++ client is installed, you may fail to build or run this library.
 
 ## How to install
 
-### Please install pulsar-client in your project:
+### Install on windows
+
+1. Build the Pulsar C++ client on windows.
+
+```shell
+cmake \
+ -A x64 \
+ -DBUILD_PYTHON_WRAPPER=OFF -DBUILD_TESTS=OFF \
+ -DVCPKG_TRIPLET=x64-windows \
+ -DCMAKE_BUILD_TYPE=Release \
+ -S .
+cmake --config Release
+```
+
+2. Set the variable `PULSAR_CPP_DIR` with the `pulsar-client-cpp` path in a Windows command tool.
+
+```shell
+# for example
+set PULSAR_CPP_DIR=C:\pulsar\pulsar-client-cpp
+```
+
+3. Set the variable `OS_ARCH` in a Windows command tool, `OS_ARCH` is related to the configuration of VCPKG_TRIPLET on the command line above.(Optional)
+
+```shell
+set OS_ARCH=x64-windows
+```
+
+
+### Install pulsar-client to your project
 
 ```shell
 $ npm install pulsar-client
@@ -72,6 +100,10 @@ $ cd pulsar-client-node
 $ npm install
 ```
 
+> **Note**
+>
+> If you build `pulsar-client-node on` windows, you need to set the variable `PULSAR_CPP_DIR` first, then install npm (run the command `npm install`) in a Windows command-line tool.
+
 ### Rebuild Pulsar client library:
 
 ```shell

package/binding.gyp

@@ -18,14 +18,24 @@
 #
 
 {
+  'conditions': [
+    ['OS=="win"', {
+      'variables': {
+       'pulsar_cpp_dir%': '<!(echo %PULSAR_CPP_DIR%)',
+       'os_arch%': '<!(echo %OS_ARCH%)',
+      },
+    }]
+  ],
   "targets": [
     {
       "target_name": "Pulsar",
+      "cflags_cc": ["-std=gnu++11"],
       "cflags!": ["-fno-exceptions"],
-      "cflags_cc!": ["-fno-exceptions"],
-      "include_dirs": ["<!@(node -p \"require('node-addon-api').include\")"],
-      "dependencies": ["<!@(node -p \"require('node-addon-api').gyp\")"],
-      "defines": ["NAPI_DISABLE_CPP_EXCEPTIONS"],
+      "cflags_cc!": ["-fno-exceptions", "-std=gnu++14", "-std=gnu++17"],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")",
+      ],
+      "defines": ["NAPI_VERSION=4", "NAPI_DISABLE_CPP_EXCEPTIONS=1"],
       "sources": [
         "src/addon.cc",
         "src/Message.cc",
@@ -39,7 +49,42 @@
         "src/Reader.cc",
         "src/ReaderConfig.cc",
       ],
-      "libraries": ["-lpulsar"],
+      'conditions': [
+        ['OS=="win"', {
+          "include_dirs": [
+            "<(pulsar_cpp_dir)\include",
+          ],
+          "libraries": [
+            "-l<(pulsar_cpp_dir)\\lib\Release\pulsar.lib"
+          ],
+          "dependencies": [
+            "<!(node -p \"require('node-addon-api').gyp\")"
+          ],
+          "copies": [
+            {
+              "destination": "<(PRODUCT_DIR)",
+              "files": [
+                "<(pulsar_cpp_dir)\\lib\Release\pulsar.dll",
+                "<(pulsar_cpp_dir)\\vcpkg_installed\\<(os_arch)\\bin\libcurl.dll",
+                "<(pulsar_cpp_dir)\\vcpkg_installed\\<(os_arch)\\bin\libprotobuf.dll",
+                "<(pulsar_cpp_dir)\\vcpkg_installed\\<(os_arch)\\bin\libssl-1_1-x64.dll",
+                "<(pulsar_cpp_dir)\\vcpkg_installed\\<(os_arch)\\bin\libcrypto-1_1-x64.dll",
+                "<(pulsar_cpp_dir)\\vcpkg_installed\\<(os_arch)\\bin\dl.dll",
+                "<(pulsar_cpp_dir)\\vcpkg_installed\\<(os_arch)\\bin\snappy.dll",
+                "<(pulsar_cpp_dir)\\vcpkg_installed\\<(os_arch)\\bin\zlib1.dll",
+                "<(pulsar_cpp_dir)\\vcpkg_installed\\<(os_arch)\\bin\zstd.dll",
+              ]
+            }
+          ]
+        }, {  # 'OS!="win"'
+          "libraries": [
+            "-lpulsar",
+          ],
+          "dependencies": [
+            "<!@(node -p \"require('node-addon-api').gyp\")"
+          ],
+        }]
+      ]
     }
   ]
 }

package/index.d.ts

@@ -20,7 +20,7 @@
 
 export interface ClientConfig {
   serviceUrl: string;
-  authentication?: AuthenticationTls | AuthenticationAthenz | AuthenticationToken;
+  authentication?: AuthenticationTls | AuthenticationAthenz | AuthenticationToken | AuthenticationOauth2;
   operationTimeoutSeconds?: number;
   ioThreads?: number;
   messageListenerThreads?: number;
@@ -175,6 +175,18 @@ export class AuthenticationToken {
   constructor(params: { token: string });
 }
 
+export class AuthenticationOauth2 {
+  constructor(params: {
+    type: string;
+    issuer_url: string;
+    client_id?: string;
+    client_secret?: string;
+    private_key?: string;
+    audience?: string;
+    scope?: string;
+  });
+}
+
 export enum LogLevel {
   DEBUG = 0,
   INFO = 1,

package/index.js

@@ -21,6 +21,7 @@ const PulsarBinding = require('bindings')('Pulsar');
 const AuthenticationTls = require('./src/AuthenticationTls.js');
 const AuthenticationAthenz = require('./src/AuthenticationAthenz.js');
 const AuthenticationToken = require('./src/AuthenticationToken.js');
+const AuthenticationOauth2 = require('./src/AuthenticationOauth2.js');
 
 const LogLevel = {
   DEBUG: 0,
@@ -36,6 +37,7 @@ const Pulsar = {
   AuthenticationTls,
   AuthenticationAthenz,
   AuthenticationToken,
+  AuthenticationOauth2,
   LogLevel,
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pulsar-client",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Pulsar Node.js client",
   "main": "index.js",
   "types": "index.d.ts",
@@ -37,24 +37,24 @@
     "clang-format": "^1.4.0",
     "commander": "^6.1.0",
     "delay": "^4.4.0",
-    "dtslint": "^4.0.6",
+    "dtslint": "^3.4.2",
     "eslint": "^7.8.1",
     "eslint-config-airbnb-base": "^14.2.0",
     "eslint-plugin-import": "^2.22.0",
     "eslint-plugin-jest": "^24.3.6",
-    "grunt": "^1.3.0",
+    "grunt": "^1.4.1",
     "grunt-license-report": "^0.0.8",
     "hdr-histogram-js": "^2.0.1",
-    "jest": "^26.4.2",
+    "jest": "^27.2.4",
     "license-check-and-add": "^2.3.6",
     "lodash": "^4.17.21",
     "typescript": "^4.1.3"
   },
   "dependencies": {
+    "@mapbox/node-pre-gyp": "^1.0.7",
     "bindings": "^1.5.0",
-    "node-addon-api": "^3.0.0",
-    "node-gyp": "^7.1.0",
-    "node-pre-gyp": "^0.15.0"
+    "node-addon-api": "^3.2.1",
+    "node-gyp": "^8.4.1"
   },
   "binary": {
     "module_name": "libpulsar",

package/src/Authentication.cc

@@ -80,6 +80,13 @@ Authentication::Authentication(const Napi::CallbackInfo &info)
       return;
     }
     this->cAuthentication = pulsar_authentication_athenz_create(info[1].ToString().Utf8Value().c_str());
+  } else if (authMethod == "oauth2") {
+    if (info.Length() < 2 || !info[1].IsString()) {
+      Napi::Error::New(env, "Authentication parameter must be a JSON string for oauth2")
+          .ThrowAsJavaScriptException();
+      return;
+    }
+    this->cAuthentication = pulsar_authentication_oauth2_create(info[1].ToString().Utf8Value().c_str());
   } else {
     Napi::Error::New(env, "Unsupported authentication method").ThrowAsJavaScriptException();
     return;

package/src/AuthenticationOauth2.js

@@ -0,0 +1,28 @@
+/**
+ * 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 PulsarBinding = require('bindings')('Pulsar');
+
+class AuthenticationOauth2 {
+  constructor(params) {
+    const paramsStr = (typeof params === 'object') ? JSON.stringify(params) : params;
+    this.binding = new PulsarBinding.Authentication('oauth2', paramsStr);
+  }
+}
+
+module.exports = AuthenticationOauth2;

package/src/Consumer.cc

@@ -164,6 +164,12 @@ class ConsumerNewInstanceWorker : public Napi::AsyncWorker {
 
     consumer->SetCConsumer(this->consumerWrapper);
     consumer->SetListenerCallback(this->listener);
+
+    if (this->listener) {
+      // resume to enable MessageListener function callback
+      resume_message_listener(this->consumerWrapper->cConsumer);
+    }
+
     this->deferred.Resolve(obj);
   }
   void OnError(const Napi::Error &e) { this->deferred.Reject(Napi::Error::New(Env(), e.Message()).Value()); }
@@ -183,6 +189,11 @@ class ConsumerNewInstanceWorker : public Napi::AsyncWorker {
     } else {
       worker->consumerWrapper->cConsumer = consumer;
       worker->listener = worker->consumerConfig->GetListenerCallback();
+
+      if (worker->listener) {
+        // pause, will resume in OnOK, to prevent MessageListener get a nullptr of consumer
+        pulsar_consumer_pause_message_listener(consumer);
+      }
     }
 
     delete worker->consumerConfig;

package/tslint.json

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

package/tstest.ts

@@ -39,6 +39,23 @@ import Pulsar = require('./index');
     tokenExpirationTime: '3600',
   });
 
+  const authOauth2PrivateKey: Pulsar.AuthenticationOauth2 = new Pulsar.AuthenticationOauth2({
+    type: "client_credentials",
+    issuer_url: "issuer-url",
+    private_key: "credentials-file-path",
+    audience: "audience",
+    scope: "your-scope",
+  });
+
+  const authOauth2ClientId: Pulsar.AuthenticationOauth2 = new Pulsar.AuthenticationOauth2({
+    type: "client_credentials",
+    issuer_url: "issuer-url",
+    client_id: "client-id",
+    client_secret: "client-secret",
+    audience: "audience",
+    scope: "scope"
+  });
+
   const authToken: Pulsar.AuthenticationToken = new Pulsar.AuthenticationToken({
     token: 'foobar',
   });