couchbase 3.2.0 → 3.2.4

package/README.md

@@ -42,24 +42,30 @@ Here is a simple example of instantiating a connection, adding a new document
 into the bucket and then retrieving its contents:
 
 ```javascript
-var couchbase = require('couchbase');
-var cluster = new couchbase.Cluster('couchbase://127.0.0.1', {
-  username: 'username',
-  password: 'password',
-});
-var bucket = cluster.bucket('default');
-var coll = bucket.defaultCollection();
-
-coll.upsert('testdoc', { name: 'Frank' }, (err, res) => {
-  if (err) throw err;
-
-  coll.get('testdoc', (err, res) => {
-    if (err) throw err;
-
-    console.log(res.value);
-    // {name: Frank}
-  });
-});
+var couchbase = require('couchbase')
+
+couchbase.connect(
+  'couchbase://127.0.0.1',
+  {
+    username: 'username',
+    password: 'password',
+  },
+  (err, cluster) => {
+    var bucket = cluster.bucket('default')
+    var coll = bucket.defaultCollection()
+
+    coll.upsert('testdoc', { name: 'Frank' }, (err, res) => {
+      if (err) throw err
+
+      coll.get('testdoc', (err, res) => {
+        if (err) throw err
+
+        console.log(res.value)
+        // {name: Frank}
+      })
+    })
+  }
+)
 ```
 
 ## Documentation

package/binding.gyp

@@ -1,92 +1,95 @@
 {
-  'targets': [{
-    'target_name': 'couchbase_impl',
-    'variables': {
-      'couchbase_root%': ''
-    },
-    'defines': [
-      'LCBUV_EMBEDDED_SOURCE',
-      'LCB_TRACING'
-    ],
-    'conditions': [
-      [ 'couchbase_root==""', {
+    'targets': [{
+        'target_name': 'couchbase_impl',
+        'variables': {
+            'couchbase_root%': ''
+        },
         'defines': [
-          'LIBCOUCHBASE_STATIC'
+            'LCBUV_EMBEDDED_SOURCE',
+            'LCB_TRACING'
         ],
-        'dependencies': [
-          'deps/lcb/libcouchbase.gyp:couchbase'
-        ]
-      }, {
         'conditions': [
-          [ 'OS=="win"', {
-            'include_dirs': [
-              '<(couchbase_root)/include/'
-            ],
-            'link_settings': {
-              'libraries': [
-                '-l<(couchbase_root)/lib/libcouchbase.lib'
-              ]
-            },
-            'copies': [
-              {
-                'files': [ '<(couchbase_root)/bin/libcouchbase.dll' ],
-                'destination': '<(module_root_dir)/build/Release/'
-              },{
-                'files': [ '<(couchbase_root)/bin/libcouchbase.dll' ],
-                'destination': '<(module_root_dir)/build/Debug/'
-              }
-            ],
-          }, {
-            'link_settings': {
-              'libraries': [
-                '-lcouchbase',
-              ],
-            },
-            'include_dirs': [ '<(couchbase_root)/include' ],
-            'libraries+': [ '-L<(couchbase_root)/lib' ],
-            'conditions': [ [ 'OS!="mac"', {'libraries+':['-Wl,-rpath=<(couchbase_root)/lib']} ] ]
-          }]
-        ]
-      }],
-      ['OS!="win"', {
-        'link_settings': {
-          'libraries': [
-            '$(EXTRA_LDFLAGS)'
-          ],
-        },
-        'cflags': [
-          '-g',
-          '-fPIC',
-          '-Wall',
-          '-Wextra',
-          '$(EXTRA_CFLAGS)',
-          '$(EXTRA_CPPFLAGS)',
-          '$(EXTRA_CXXFLAGS)',
+            ['couchbase_root==""', {
+                'defines': [
+                    'LIBCOUCHBASE_STATIC'
+                ],
+                'dependencies': [
+                    'deps/lcb/libcouchbase.gyp:couchbase'
+                ]
+            }, {
+                'conditions': [
+                    ['OS=="win"', {
+                        'include_dirs': [
+                            '<(couchbase_root)/include/'
+                        ],
+                        'link_settings': {
+                            'libraries': [
+                                '-l<(couchbase_root)/lib/libcouchbase.lib'
+                            ]
+                        },
+                        'copies': [
+                            {
+                                'files': ['<(couchbase_root)/bin/libcouchbase.dll'],
+                                'destination': '<(module_root_dir)/build/Release/'
+                            }, {
+                                'files': ['<(couchbase_root)/bin/libcouchbase.dll'],
+                                'destination': '<(module_root_dir)/build/Debug/'
+                            }
+                        ],
+                    }, {
+                        'link_settings': {
+                            'libraries': [
+                                '-lcouchbase',
+                            ],
+                        },
+                        'include_dirs': ['<(couchbase_root)/include'],
+                        'libraries+': ['-L<(couchbase_root)/lib'],
+                        'conditions': [['OS!="mac"', {'libraries+': ['-Wl,-rpath=<(couchbase_root)/lib']}]]
+                    }]
+                ]
+            }],
+            ['OS!="win"', {
+                'link_settings': {
+                    'libraries': [
+                        '$(EXTRA_LDFLAGS)'
+                    ],
+                },
+                'cflags': [
+                    '-g',
+                    '-fPIC',
+                    '-Wall',
+                    '-Wextra',
+                    '$(EXTRA_CFLAGS)',
+                    '$(EXTRA_CPPFLAGS)',
+                    '$(EXTRA_CXXFLAGS)',
+                ],
+                'cflags_c':[
+                    '-pedantic',
+                    '-std=gnu99',
+                ]
+            }]
+        ],
+        'sources': [
+            'src/addondata.cpp',
+            'src/binding.cpp',
+            'src/cas.cpp',
+            'src/connection_ops.cpp',
+            'src/connection.cpp',
+            'src/constants.cpp',
+            'src/error.cpp',
+            'src/instance.cpp',
+            'src/instance_callbacks.cpp',
+            'src/lcbx.cpp',
+            'src/logger.cpp',
+            'src/metrics.cpp',
+            'src/mutationtoken.cpp',
+            'src/opbuilder.cpp',
+            'src/respreader.cpp',
+            'src/tracing.cpp',
+            'src/uv-plugin-all.cpp'
         ],
-        'cflags_c':[
-          '-pedantic',
-          '-std=gnu99',
+        'include_dirs': [
+            '<!(node -e "require(\'nan\')")'
         ]
-      }]
-    ],
-    'sources': [
-      'src/binding.cpp',
-      'src/cas.cpp',
-      'src/connection_callbacks.cpp',
-      'src/connection_ops.cpp',
-      'src/connection.cpp',
-      'src/constants.cpp',
-      'src/error.cpp',
-      'src/lcbx.cpp',
-      'src/logger.cpp',
-      'src/metrics.cpp',
-      'src/mutationtoken.cpp',
-      'src/opbuilder.cpp',
-      'src/tracing.cpp',
-      'src/uv-plugin-all.cpp'
-    ],
-    'include_dirs': [
-      '<!(node -e "require(\'nan\')")'
-    ]
-  }]
+    }]
 }

package/deps/lcb/CMakeLists.txt

@@ -30,7 +30,7 @@ CMAKE_MINIMUM_REQUIRED(VERSION 3.5.1)
 # Couchbase mock path to download
 SET(COUCHBASE_MOCK_VERSION 1.5.25)
 SET(COUCHBASE_MOCK_URL "https://github.com/couchbase/CouchbaseMock/releases/download/${COUCHBASE_MOCK_VERSION}/CouchbaseMock-${COUCHBASE_MOCK_VERSION}.jar")
-project(libcouchbase VERSION 3.2.0 LANGUAGES C CXX)
+project(libcouchbase VERSION 3.2.4 LANGUAGES C CXX)
 
 if (NOT CMAKE_VERSION VERSION_LESS "3.13")
     # CMP0077: option() honors normal variables

package/deps/lcb/CONTRIBUTING.md

@@ -66,7 +66,7 @@ Add your public SSH key to gerrit before submitting.
 Assuming you have a repository created like so:
 
 ```
-$ git clone git://github.com/couchbase/libcouchbase.git
+$ git clone https://github.com/couchbase/libcouchbase.git
 ```
 
 you can simply perform two simple steps to get started with gerrit:

package/deps/lcb/README.markdown

@@ -48,7 +48,7 @@ Provided is a convenience script called `cmake/configure`. It is a Perl
 script and functions like a normal `autotools` script.
 
 ```shell
-$ git clone git://github.com/couchbase/libcouchbase.git
+$ git clone https://github.com/couchbase/libcouchbase.git
 $ cd libcouchbase && mkdir build && cd build
 $ ../cmake/configure
 $ make
@@ -60,7 +60,7 @@ $ ctest
 Assuming `git` and Visual Studio 2010 are installed, from a `CMD` shell, do:
 
 ```
-C:\> git clone git://github.com/couchbase/libcouchbase.git
+C:\> git clone https://github.com/couchbase/libcouchbase.git
 C:\> mkdir lcb-build
 C:\> cd lcb-build
 C:\> cmake -G "Visual Studio 10" ..\libcouchbase

package/deps/lcb/RELEASE_NOTES.markdown

@@ -1,60 +1,145 @@
 # Release Notes
 
+## 3.2.4 (2021-11-23)
+
+CCBC-1522: Filter `DnsQuery` results on Windows by type: only use records with `DNS_TYPE_SRV` type.
+
+CCBC-1521: Fixed bootstrap process when client certificate is used. We always pipeline error map request with `HELLO`
+request, and usually await for `hello`+`error_map` responses, because after that goes SASL authentication (and then
+optional selection of the bucket) which cannot be completely pipelined. But in case of client certificate, we might
+terminate bootstrap process too early if the bootstrap process does not require immediate selection of the bucket.
+    
+CCBC-1432: Support for rate limiting error codes: `LCB_ERR_RATE_LIMITED` and `LCB_ERR_QUOTA_LIMITED`.
+
+CCBC-1514: Do not translate unknown error with "item-only" attribute into `LCB_ERR_CAS_MISMATCH`.
+
+CCBC-1515: Performance optimization: replace `sstream` with string `append()`. Only if list of IO vectors supplied for
+value in mutation operations.
+
+## 3.2.3 (2021-10-20)
+
+* CCBC-1484: Fixed tracing tags in accordance to RFC.
+
+* CCBC-1510: Fixed key length calculation for exists/get/touch/unlock.
+
+* CCBC-1495: Fixed payload encoding in query index management helpers. Query index management helpers now explicitly
+  declared deperecated.
+
+* CCBC-1506: Duration values now accepted golang style encoding. Connection string and `lcb_cntl_string` now can parse
+  strings with duration encoded in golang style, e.g. `analytics_timeout=5s42us`. The result still converted into 32-bit
+  value with microsecond resolution.
+
+* Improved test coverage, stability and documentation.
+
+## 3.2.2 (2021-09-22)
+
+* CCBC-1485: Allow disabling tracer for connected instance.
+
+* CCBC-1472: Ensure strict JSON parsing mode for query meta.
+
+* CCBC-1494: Disconnect logger after `lcb_destroy` invoked to avoid double free errors.
+
+* CCBC-1457: improve error message when server enforces encryption
+
+* CCBC-1489: Fixed get_and_touch to use the correct expiry.
+
+* CCBC-1487: Fixed `retryq` erasing already sent packets.
+
+* CCBC-1488: Fixed incorrect refcounting in `Connstart`.
+
+* CCBC-1479: Initialize fields of custom tracer struct.
+
+* CCBC-1478: Do not retry successful query with empty result.
+
+* CCBC-1216: Implement user impersonation API
+
+* Improved test coverage and stability.
+
+## 3.2.1 (2021-08-20)
+
+* CCBC-1429: Fixed positional parameters for query/analtyics:
+
+  * reverts behaviour `lcb_cmdquery_positional_param` and `lcb_cmdanalytics_positional_param` to append single
+    JSON-encoded value to arguments array.
+
+  * introduces new functions `lcb_cmdquery_positional_params` and `lcb_cmdanalytics_positional_params` that accept all
+    positional arguments at once as JSON-encoded array.
+
+  * document, that old functions will emit compiler warning since 3.3.0 release and will be removed later.
+
+* CCBC-1428: Clear callback upon error in `lcb_search`.
+
+* CCBC-1454: Fixed compiler warning in `lcb_getreplica`.
+
+* CCBC-1453: Refactored local name caching in `lcbio_cache_local_name` to simplify the code and eliminate compiler warnings.
+
+* CCBC-1451: Fixed strdup usage, in some cases the compiler might choose `strdup` to return `int` instead of `char *`
+  which might lead to memory issues.
+
+* CCBC-1448: Fixed cmake macro for examples. The macro `ADD_EXAMPLE` now correctly updates header directories for
+  generated target.
+
+* CCBC-1445: Always invoke callbacks for pending HTTP operations. When destroying `lcb_INSTANCE` make sure that all HTTP
+  requests (views, query, search, analytics) will have their callbacks invoked.
+
+* CCBC-1438: Fixed frame size for mutations with durability. Counter, Store and Subdoc mutations were sending incorrect
+  frame size of durability encoding, which led to rejection of the command by the server.
+
 ## 3.2.0 (2021-07-19)
 
 * Various improvements and fixes in test and build infrastruture
 
 * CBCC-1280 Support for OpenTelemetry tracing.
-    
+
   Tracing updated to allow for an external tracer that creates and finishes spans, adds tags, destroys spans.  Also,
   spans now have the notion of being the 'outer' span.  That is the span that has all the outer span tags, and is the
   one whose duration is used to determine whether or not the operation has exceeded the threshold if the
   ThresholdLoggingTracer is used.
-    
+
   If you pass in a parent that is an outer span, you must call `lcbtrace_span_finish` yourself. When an operation
   begins, if there is no parent span passed in, or if there is but it isn't an 'outer' span, then the operation creates
   the outer span itself.
   See `/examples/tracing/otel_tracing.cc` for an example.
-    
+
 * CCBC-1362: Support for metrics.
-    
+
    When enabled, by default will output a histogram of latencies for various kv operations plus query, search, analytics
    and view queries.
-    
+
   If desired, an external metrics collector can be passed in when the instance is created, which will then be called
   with latencies for each operation.  This can be used to call into an opentelemetry meter for aggregation and export.
   See `/examples/metrics/otel_metrics.cc` for an example.
 
 * CCBC-1421: Allow empty path for subdocument array methods.
-    
+
 * CCBC-1417: Depecate CAS usage with counter operation.
 
 * CCBC-1418: Map query error 13014 to `LCB_ERR_AUTHENTICATION_FAILURE`.
-    
+
 * CCBC-1357: Allow to preserve expiration with Replace, Upsert and MutateIn operations.
 
 * CCBC-1384: Allow the operations to be deferred until the instance will be connected to cluster.
 
 * CCBC-1410: Refactor dynamic authenticator. NOTE: this API still volatile and might be changed in future.
-    
+
   In order to improve UX and allow caller to implement credential caching the API for authenticator was revised:
-    
+
     * instead of separate callbacks for username/password, now it uses single callback
-    
+
     * in the callback, the caller can figure out the reason of credentials request using `lcbauth_credentials_reason()`
-    
+
     * the caller can signal that it failed to retrieve credentials from external provider, and set result with
       `lcbauth_credentials_result()`. In this case the SDK will not retry the operation.
-    
+
 
 * CCBC-1413: Skip `SELECT_BUCKET` packets waiting retry queue.
 
 * CCBC-1169: Request copy from active vbucket for `get_all_replicas` operation.
 
 * CCBC-1406: Fill in prepared statement handle on retry.
-    
+
 * CCBC-1405: Remove const from command cookie.
-    
+
 * CCBC-1402: Fix parsing JSON primitives as query rows.
 
 ## 3.1.3 (2021-05-10)

package/deps/lcb/cmake/Modules/GetVersionInfo.cmake

@@ -65,7 +65,7 @@ IF(APPLE)
 ELSE()
     SET(LCB_SONAME_MAJOR "8")
 ENDIF()
-SET(LCB_SONAME_FULL "${LCB_SONAME_MAJOR}.0.1")
+SET(LCB_SONAME_FULL "${LCB_SONAME_MAJOR}.0.5")
 
 MESSAGE(STATUS "libcouchbase ${LCB_VERSION_MAJOR},${LCB_VERSION_MINOR},${LCB_VERSION_PATCH}")
 MESSAGE(STATUS "Building libcouchbase ${LCB_VERSION}/${LCB_VERSION_CHANGESET}")

package/deps/lcb/contrib/cbsasl/src/scram-sha/scram_utils.cc

@@ -16,8 +16,8 @@
 
 #include "scram_utils.h"
 #include "config.h"
-#include <time.h>
-#include <ctype.h>
+#include <ctime>
+#include <cctype>
 #include "strcodecs/strcodecs.h"
 
 #ifndef LCB_NO_SSL
@@ -46,9 +46,9 @@ void seed_rand(void)
     // The entropy of these values is not good, but that's enough for generating nonces.
 
 #ifdef LCB_NO_SSL
-    srand(time(NULL));
+    srand(time(nullptr));
 #else
-    time_t current_time = time(NULL);
+    time_t current_time = time(nullptr);
     clock_t clk;
 #ifdef _WIN32
     int pid;
@@ -73,7 +73,7 @@ void seed_rand(void)
  */
 void generate_nonce(char *buffer, int buffer_length)
 {
-    if ((NULL == buffer) || (0 == buffer_length)) {
+    if ((nullptr == buffer) || (0 == buffer_length)) {
         // invalid input arguments
         return;
     }
@@ -88,14 +88,13 @@ void generate_nonce(char *buffer, int buffer_length)
         int aRandom = 0;
         unsigned int aMaxRandBits = 0, aRandRange,
                      aMaxRand = RAND_MAX; // we have to compute how many bits the rand() function can return
-        int i;
         while (aMaxRand >>= 1) {
             aMaxRandBits++;
         }
         aRandRange = aMaxRandBits / 8; // number of bytes we can extract from a rand() value.
         // To avoid generating a new random number for each character, we call rand() only once every 5 characters.
         // A 32-bits integer can give 5 values of 6 bits.
-        for (i = 0; i < buffer_length; ++i) {
+        for (int i = 0; i < buffer_length; ++i) {
             if (i % aRandRange == 0) {
                 // we refill aRandom
                 aRandom = rand();
@@ -115,8 +114,7 @@ void generate_nonce(char *buffer, int buffer_length)
 int compute_special_chars(const char *buffer, int buffer_length)
 {
     int result = 0;
-    int i;
-    for (i = 0; i < buffer_length; ++i) {
+    for (int i = 0; i < buffer_length; ++i) {
         char c = buffer[i];
         if (iscntrl(c)) {
             return -1; // control characters are not allowed
@@ -140,13 +138,12 @@ int compute_special_chars(const char *buffer, int buffer_length)
 void usernmcpy(char *dest, const char *src, size_t n)
 {
     char *newdest = dest;
-    unsigned int i;
 
-    if (NULL == dest || NULL == src || 0 == n) {
+    if (nullptr == dest || nullptr == src || 0 == n) {
         return; // invalid arguments
     }
 
-    for (i = 0; i < n; ++i) {
+    for (size_t i = 0; i < n; ++i) {
         char c = src[i];
         switch (c) {
             case '=':
@@ -178,7 +175,7 @@ cbsasl_error_t parse_server_challenge(const char *serverin, unsigned int serveri
     const char *oldptr = serverin;
     unsigned int remainlen = serverinlen;
 
-    if (NULL == serverin || 0 == serverinlen) {
+    if (nullptr == serverin || 0 == serverinlen) {
         return SASL_BADPARAM;
     }
 
@@ -186,7 +183,7 @@ cbsasl_error_t parse_server_challenge(const char *serverin, unsigned int serveri
     do {
         unsigned int attrlen; // attribute length
         ptr = static_cast<const char *>(memchr(ptr, ',', remainlen));
-        if (ptr != NULL) {
+        if (ptr != nullptr) {
             // oldptr points to the beginning of the attribute
             // Ex: "r=xxxxx,s=zzzzzz,i=10"
             //      ^      ^
@@ -209,7 +206,7 @@ cbsasl_error_t parse_server_challenge(const char *serverin, unsigned int serveri
         }
         switch (oldptr[0]) {
             case 'r': // nonce
-                if (*nonce != NULL) {
+                if (*nonce != nullptr) {
                     // it looks like we already stored a previous occurrence of the nonce attribute
                     return SASL_BADPARAM;
                 }
@@ -217,7 +214,7 @@ cbsasl_error_t parse_server_challenge(const char *serverin, unsigned int serveri
                 *noncelength = attrlen - 2;
                 break;
             case 's': // salt
-                if (*salt != NULL) {
+                if (*salt != nullptr) {
                     // it looks like we already stored a previous occurrence of the salt attribute
                     return SASL_BADPARAM;
                 }
@@ -244,7 +241,7 @@ cbsasl_error_t parse_server_challenge(const char *serverin, unsigned int serveri
 
         remainlen = remainlen - attrlen - 1;
         oldptr = ptr;
-    } while (ptr != NULL);
+    } while (ptr != nullptr);
 
     return SASL_OK;
 }
@@ -313,17 +310,17 @@ static cbsasl_error_t HMAC_digest(cbsasl_auth_mechanism_t auth_mech, const unsig
 {
     switch (auth_mech) {
         case SASL_AUTH_MECH_SCRAM_SHA1:
-            if (HMAC(EVP_sha1(), key, keylen, data, datalen, digest, digestlen) == NULL) {
+            if (HMAC(EVP_sha1(), key, keylen, data, datalen, digest, digestlen) == nullptr) {
                 return SASL_FAIL;
             }
             break;
         case SASL_AUTH_MECH_SCRAM_SHA256:
-            if (HMAC(EVP_sha256(), key, keylen, data, datalen, digest, digestlen) == NULL) {
+            if (HMAC(EVP_sha256(), key, keylen, data, datalen, digest, digestlen) == nullptr) {
                 return SASL_FAIL;
             }
             break;
         case SASL_AUTH_MECH_SCRAM_SHA512:
-            if (HMAC(EVP_sha512(), key, keylen, data, datalen, digest, digestlen) == NULL) {
+            if (HMAC(EVP_sha512(), key, keylen, data, datalen, digest, digestlen) == nullptr) {
                 return SASL_FAIL;
             }
             break;
@@ -369,19 +366,19 @@ cbsasl_error_t compute_client_proof(cbsasl_auth_mechanism_t auth_mech, const uns
     unsigned int storedkeylen = 0;
     switch (auth_mech) {
         case SASL_AUTH_MECH_SCRAM_SHA1:
-            if (SHA1(clientkeyhmac, hmaclen, storedkey) == NULL) {
+            if (SHA1(clientkeyhmac, hmaclen, storedkey) == nullptr) {
                 return SASL_FAIL;
             }
             storedkeylen = SHA_DIGEST_LENGTH;
             break;
         case SASL_AUTH_MECH_SCRAM_SHA256:
-            if (SHA256(clientkeyhmac, hmaclen, storedkey) == NULL) {
+            if (SHA256(clientkeyhmac, hmaclen, storedkey) == nullptr) {
                 return SASL_FAIL;
             }
             storedkeylen = SHA256_DIGEST_LENGTH;
             break;
         case SASL_AUTH_MECH_SCRAM_SHA512:
-            if (SHA512(clientkeyhmac, hmaclen, storedkey) == NULL) {
+            if (SHA512(clientkeyhmac, hmaclen, storedkey) == nullptr) {
                 return SASL_FAIL;
             }
             storedkeylen = SHA512_DIGEST_LENGTH;
@@ -396,7 +393,7 @@ cbsasl_error_t compute_client_proof(cbsasl_auth_mechanism_t auth_mech, const uns
     //                   client-final-message-without-proof
     unsigned int authmesslen = cfblen + 1 + sfmlen + 1 + cfwplen;
     char *authmess = static_cast<char *>(calloc(authmesslen + 1, 1)); // +1 for the binary zero
-    if (NULL == authmess) {
+    if (nullptr == authmess) {
         return SASL_NOMEM;
     }
     memcpy(authmess, clientfirstbare, cfblen);
@@ -419,8 +416,7 @@ cbsasl_error_t compute_client_proof(cbsasl_auth_mechanism_t auth_mech, const uns
     // final step:
     // ClientProof     := ClientKey XOR ClientSignature
     char clientproof[EVP_MAX_MD_SIZE]; // binary client proof
-    unsigned int i;
-    for (i = 0; i < clientsignlen; ++i) {
+    for (unsigned i = 0; i < clientsignlen; ++i) {
         clientproof[i] = clientkeyhmac[i] ^ clientsign[i];
     }