couchbase 4.4.3 → 4.4.4

package/BUILDING.md

@@ -0,0 +1,182 @@
+# Setup
+
+Make sure to have cloned the [SDK repository](https://github.com/couchbase/couchnode.git) and have the submodules appropriately synced (`git submodule update --init --recursive`).
+
+# Building
+
+## Set CPM Cache
+The C++ core utilizes the CMake Package Manager (CPM) to include depencies.  These can be set to a cache directory and can be used for future builds.  Periodically the dependencies should be updated.  So, in general it is good practice to configure the build environment by setting the CPM cache.
+
+### Via npm command
+```console
+npm run prebuild -- --configure --set-cpm-cache --use-boringssl
+```
+
+### Available Options
+>Note: Section under construction
+
+### Via cmake-js
+
+Set the cache directory `CXXCBC_CACHE_DIR`:
+```console
+export CXXCBC_CACHE_DIR=$PWD/deps/couchbase-cxx-cache
+```
+
+Remove the cache directory
+```console
+rm -rf $CXXCBC_CACHE_DIR
+```
+
+Configure the build:
+```console
+$ npx cmake-js configure \
+--runtime node \
+--runtime-version $(node --version) \
+--CDUSE_STATIC_OPENSSL=OFF \
+--CDCPM_DOWNLOAD_ALL=OFF \
+--CDCPM_USE_NAMED_CACHE_DIRECTORIES=ON \
+--CDCPM_USE_LOCAL_PACKAGES=OFF \
+--CDCPM_SOURCE_CACHE=$CXXCBC_CACHE_DIR
+```
+
+## Build the client binary
+
+### Via npm command
+```console
+npm run prebuild -- --use-boringssl
+```
+
+### Available Options
+>Note: Section under construction
+
+### Via cmake-js
+
+>NOTE:  If using the `compile` command, the build will automatically clean and re-execute a build upon a failure.  Use the `build` command to only attempt a single build.
+
+Set the cache directory (if it has not already been set) `CXXCBC_CACHE_DIR`:
+```console
+export CXXCBC_CACHE_DIR=$PWD/deps/couchbase-cxx-cache
+```
+
+```console
+npx cmake-js compile \
+--runtime node \
+--runtime-version $(node --version) \
+--CDUSE_STATIC_OPENSSL=OFF \
+--CDCPM_DOWNLOAD_ALL=OFF \
+--CDCPM_USE_NAMED_CACHE_DIRECTORIES=ON \
+--CDCPM_USE_LOCAL_PACKAGES=OFF \
+--CDCPM_SOURCE_CACHE=$CXXCBC_CACHE_DIR
+```
+
+# Autogen
+
+>**IMPORTANT**: Autogen is only needed for maintainers of the library.  If not making updates to the core bindings, running the autogen tooling should *NOT* be required.
+
+Move into the `tools` directory prior to running any autogen commands.
+
+## Python Environment
+
+>NOTE: Python >= 3.9 required
+
+Setup virtual env:
+```console
+python3 -m venv <path to virtualenv>
+```
+Example: `python3 -m venv $(pwd)/couchnode`
+
+Activate virtual env:
+```console
+source <path to virtualenv>/bin/activate
+```
+Example: `source $(pwd)/couchnode/bin/activate`
+
+Install `clang` from PyPI:
+```console
+python3 -m pip install clang
+```
+
+Generate `bindings.json`.  If no arguments are passed in the binding generator will attempt to determine the necessary version, lib directory, include directory and system headers directory.
+```console
+python3 gen-bindings-json.py
+```
+Alternatively, options can be provided (or ENV variables may be set):
+```console
+python gen-bindings-json.py -v $(llvm-config --version) \
+-i $(llvm-config --includedir) \
+-l $(llvm-config --libdir) \
+-s $(xcrun --show-sdk-path)
+```
+
+Available Environment Variables:
+- `CN_LLVM_VERSION`: LLVM version
+- `CN_LLVM_INCLUDE`: LLVM include directory path
+- `CN_LLVM_LIB`:  LLVM lib directory path
+- `CN_SYS_HEADERS`: System headers path
+
+## Node.js
+
+Populate SDK autogen code sections:
+```console
+node gen-bindings.js.js
+```
+
+## clean-up
+### Format C++ source files.
+
+On MacOS, make sure LLVM clang-format is used (configure the PATH appropriately):
+```console
+export PATH="/opt/homebrew/opt/llvm/bin:$PATH" 
+```
+
+>NOTE:  Be aware of the current working directory (commands below assume the CWD is `tools`).
+
+```console
+clang-format -i ../src/connection.cpp
+clang-format -i ../src/connection.hpp
+clang-format -i ../src/connection_autogen.cpp
+clang-format -i ../src/constants.cpp
+clang-format -i ../src/jstocbpp_autogen.hpp
+```
+### Format Node.js source files.
+
+>NOTE:  Be aware of the current working directory (commands below assume the CWD is `tools`).
+
+```console
+npx prettier --write ../lib/binding.ts
+```
+
+### Remove bindings.json
+
+```console
+rm bindings.json
+```
+
+### Format autogen scripts.
+
+This should rarely be needed (e.g. updating the autogen logic).
+
+>NOTE:  Be aware of the current working directory (commands below assume the CWD is `tools`).
+
+#### Python
+
+Install `autopep8` from PyPI:
+```console
+python3 -m pip install autopep8
+```
+
+```console
+autopep8 -i -a -a --max-line-length 120 gen-bindings-json.py
+```
+
+#### Node.js
+```console
+npx prettier --write gen-bindings-js.js
+```
+
+If a virtualenv was setup (hopefully it was ;)), deactivate and the environment
+```console
+deactivate
+rm -rf <path to virtualenv>
+```
+Example: `deactivate && rm -rf $(pwd)/couchnode`

package/CMakeLists.txt

@@ -7,6 +7,13 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 project (couchbase_impl)
 
+function(get_couchnode_version)
+  execute_process(COMMAND node -e "console.log(JSON.parse(fs.readFileSync('${PROJECT_SOURCE_DIR}/package.json')).version)"
+                  OUTPUT_VARIABLE sdk_version)
+  string(STRIP "${sdk_version}" SDK_VERSION)
+  set(COUCHNODE_VERSION "${SDK_VERSION}" PARENT_SCOPE)
+endfunction()
+
 function(download_nodejs_headers)
   message("Finding Node.js headers SHA for version: ${NODE_RUNTIMEVERSION}")
   file(DOWNLOAD
@@ -146,6 +153,10 @@ endif()
 # We need to import headers globally for our dependant libraries such as couchbase-cxx-client.
 include_directories(${NODEJS_INC_DIR})
 
+get_couchnode_version()
+message(STATUS "COUCHNODE_VERSION=${COUCHNODE_VERSION}")
+
+set(COUCHBASE_CXX_CLIENT_WRAPPER_UNIFIED_ID "nodejs/${COUCHNODE_VERSION}" CACHE STRING "" FORCE)
 set(COUCHBASE_CXX_CLIENT_BUILD_STATIC ON CACHE BOOL "" FORCE)
 set(COUCHBASE_CXX_CLIENT_BUILD_SHARED OFF CACHE BOOL "" FORCE)
 set(COUCHBASE_CXX_CLIENT_BUILD_INSTALL OFF CACHE BOOL "" FORCE)

package/CONTRIBUTING.md

@@ -25,7 +25,7 @@ Ensure the feature you are adding does not already exist, and think about how th
 
 #### For fixing bugs
 
-Ensure the bug you are fixing is actually a bug (and not a usage) error, and that it has not been fixed in a more recent version. Please read the [release notes](https://docs.couchbase.com/nodejs-sdk/current/project-docs/sdk-release-notes.html) as well as the [issue tracker](https://issues.couchbase.com/projects/JSCBC/issues/) to see a list of open and resolved issues.
+Ensure the bug you are fixing is actually a bug (and not a usage) error, and that it has not been fixed in a more recent version. Please read the [release notes](https://docs.couchbase.com/nodejs-sdk/current/project-docs/sdk-release-notes.html) as well as the [issue tracker](https://jira.issues.couchbase.com/projects/JSCBC/issues/) to see a list of open and resolved issues.
 
 ### Code Review
 

package/README.md

@@ -9,7 +9,7 @@ protocol.
 
 Source - [https://github.com/couchbase/couchnode](https://github.com/couchbase/couchnode)
 
-Bug Tracker - [https://www.couchbase.com/issues/browse/JSCBC](https://www.couchbase.com/issues/browse/JSCBC)
+Bug Tracker - [https://jira.issues.couchbase.com/projects/JSCBC/issues/](https://jira.issues.couchbase.com/projects/JSCBC/issues/)
 
 Couchbase Developer Portal - [https://docs.couchbase.com/](https://docs.couchbase.com/nodejs-sdk/3.0/hello-world/start-using-sdk.html)
 
@@ -145,6 +145,8 @@ Once you have cloned the repository, you may contribute changes through our
 gerrit server. For more details see
 [CONTRIBUTING.md](https://github.com/couchbase/couchnode/blob/master/CONTRIBUTING.md).
 
+To build the client, follow the steps outlined on the [BUILDING page](https://github.com/couchbase/couchnode/blob/main/BUILDING.md)
+
 To execute our test suite, run `make test` from the root directory.
 
 To execute our code coverage, run `make cover` from the root directory.
@@ -159,7 +161,7 @@ root directory, and a docs folder will be created with the api reference.
 
 # Support & Additional Resources
 
-If you found an issue, please file it in our [JIRA](https://issues.couchbase.com/projects/JSCBC/issues/).
+If you found an issue, please file it in our [Github issues](https://github.com/couchbase/couchnode/issues).  We will bring over the issue to our [JIRA](https://jira.issues.couchbase.com/projects/JSCBC/issues/) as needed.
 
 The Couchbase Discord server is a place where you can collaborate about all things Couchbase. Connect with others from the community, learn tips and tricks, and ask questions. [Join Discord and contribute](https://discord.com/invite/sQ5qbPZuTh).
 

package/deps/couchbase-cxx-cache/boringssl/e31ea00c1ea52052d2d78d44006cc88c80fa24a9/boringssl/src/BUILDING.md

@@ -0,0 +1,206 @@
+# Building BoringSSL
+
+## Build Prerequisites
+
+The standalone CMake build is primarily intended for developers. If embedding
+BoringSSL into another project with a pre-existing build system, see
+[INCORPORATING.md](/INCORPORATING.md).
+
+Unless otherwise noted, build tools must at most five years old, matching
+[Abseil guidelines](https://abseil.io/about/compatibility). If in doubt, use the
+most recent stable version of each tool.
+
+  * [CMake](https://cmake.org/download/) 3.10 or later is required.
+
+  * A recent version of Perl is required. On Windows,
+    [Active State Perl](http://www.activestate.com/activeperl/) has been
+    reported to work, as has MSYS Perl.
+    [Strawberry Perl](http://strawberryperl.com/) also works but it adds GCC
+    to `PATH`, which can confuse some build tools when identifying the compiler
+    (removing `C:\Strawberry\c\bin` from `PATH` should resolve any problems).
+    If Perl is not found by CMake, it may be configured explicitly by setting
+    `PERL_EXECUTABLE`.
+
+  * Building with [Ninja](https://ninja-build.org/) instead of Make is
+    recommended, because it makes builds faster. On Windows, CMake's Visual
+    Studio generator may also work, but it not tested regularly and requires
+    recent versions of CMake for assembly support.
+
+  * On Windows only, [NASM](https://www.nasm.us/) is required. If not found
+    by CMake, it may be configured explicitly by setting
+    `CMAKE_ASM_NASM_COMPILER`.
+
+  * C and C++ compilers with C++14 support are required. If using a C compiler
+    other than MSVC, C11 support is also requried. On Windows, MSVC from
+    Visual Studio 2019 or later with Windows 10 SDK 2104 or later are supported,
+    but using the latest versions is recommended. Recent versions of GCC (6.1+)
+    and Clang should work on non-Windows platforms, and maybe on Windows too.
+
+  * The most recent stable version of [Go](https://golang.org/dl/) is required.
+    Note Go is exempt from the five year support window. If not found by CMake,
+    the go executable may be configured explicitly by setting `GO_EXECUTABLE`.
+
+  * On x86_64 Linux, the tests have an optional
+    [libunwind](https://www.nongnu.org/libunwind/) dependency to test the
+    assembly more thoroughly.
+
+## Building
+
+Using Ninja (note the 'N' is capitalized in the cmake invocation):
+
+    cmake -GNinja -B build
+    ninja -C build
+
+Using Make (does not work on Windows):
+
+    cmake -B build
+    make -C build
+
+You usually don't need to run `cmake` again after changing `CMakeLists.txt`
+files because the build scripts will detect changes to them and rebuild
+themselves automatically.
+
+Note that the default build flags in the top-level `CMakeLists.txt` are for
+debugging—optimisation isn't enabled. Pass `-DCMAKE_BUILD_TYPE=Release` to
+`cmake` to configure a release build.
+
+If you want to cross-compile then there is an example toolchain file for 32-bit
+Intel in `util/`. Wipe out the build directory, run `cmake` like this:
+
+    cmake -B build -DCMAKE_TOOLCHAIN_FILE=../util/32-bit-toolchain.cmake -GNinja
+
+If you want to build as a shared library, pass `-DBUILD_SHARED_LIBS=1`. On
+Windows, where functions need to be tagged with `dllimport` when coming from a
+shared library, define `BORINGSSL_SHARED_LIBRARY` in any code which `#include`s
+the BoringSSL headers.
+
+In order to serve environments where code-size is important as well as those
+where performance is the overriding concern, `OPENSSL_SMALL` can be defined to
+remove some code that is especially large.
+
+See [CMake's documentation](https://cmake.org/cmake/help/v3.4/manual/cmake-variables.7.html)
+for other variables which may be used to configure the build.
+
+### Building for Android
+
+It's possible to build BoringSSL with the Android NDK using CMake. Recent
+versions of the NDK include a CMake toolchain file which works with CMake 3.6.0
+or later. This has been tested with version r16b of the NDK.
+
+Unpack the Android NDK somewhere and export `ANDROID_NDK` to point to the
+directory. Then run CMake like this:
+
+    cmake -DANDROID_ABI=armeabi-v7a \
+          -DANDROID_PLATFORM=android-19 \
+          -DCMAKE_TOOLCHAIN_FILE=${ANDROID_NDK}/build/cmake/android.toolchain.cmake \
+          -GNinja -B build
+
+Once you've run that, Ninja should produce Android-compatible binaries.  You
+can replace `armeabi-v7a` in the above with `arm64-v8a` and use API level 21 or
+higher to build aarch64 binaries.
+
+For other options, see the documentation in the toolchain file.
+
+To debug the resulting binaries on an Android device with `gdb`, run the
+commands below. Replace `ARCH` with the architecture of the target device, e.g.
+`arm` or `arm64`.
+
+    adb push ${ANDROID_NDK}/prebuilt/android-ARCH/gdbserver/gdbserver \
+        /data/local/tmp
+    adb forward tcp:5039 tcp:5039
+    adb shell /data/local/tmp/gdbserver :5039 /path/on/device/to/binary
+
+Then run the following in a separate shell. Replace `HOST` with the OS and
+architecture of the host machine, e.g. `linux-x86_64`.
+
+    ${ANDROID_NDK}/prebuilt/HOST/bin/gdb
+    target remote :5039  # in gdb
+
+### Building for iOS
+
+To build for iOS, pass `-DCMAKE_OSX_SYSROOT=iphoneos` and
+`-DCMAKE_OSX_ARCHITECTURES=ARCH` to CMake, where `ARCH` is the desired
+architecture, matching values used in the `-arch` flag in Apple's toolchain.
+
+Passing multiple architectures for a multiple-architecture build is not
+supported.
+
+### Building with Prefixed Symbols
+
+BoringSSL's build system has experimental support for adding a custom prefix to
+all symbols. This can be useful when linking multiple versions of BoringSSL in
+the same project to avoid symbol conflicts.
+
+In order to build with prefixed symbols, the `BORINGSSL_PREFIX` CMake variable
+should specify the prefix to add to all symbols, and the
+`BORINGSSL_PREFIX_SYMBOLS` CMake variable should specify the path to a file
+which contains a list of symbols which should be prefixed (one per line;
+comments are supported with `#`). In other words, `cmake -B build
+-DBORINGSSL_PREFIX=MY_CUSTOM_PREFIX
+-DBORINGSSL_PREFIX_SYMBOLS=/path/to/symbols.txt` will configure the build to add
+the prefix `MY_CUSTOM_PREFIX` to all of the symbols listed in
+`/path/to/symbols.txt`.
+
+It is currently the caller's responsibility to create and maintain the list of
+symbols to be prefixed. Alternatively, `util/read_symbols.go` reads the list of
+exported symbols from a `.a` file, and can be used in a build script to generate
+the symbol list on the fly (by building without prefixing, using
+`read_symbols.go` to construct a symbol list, and then building again with
+prefixing).
+
+This mechanism is under development and may change over time. Please contact the
+BoringSSL maintainers if making use of it.
+
+## Known Limitations on Windows
+
+  * CMake can generate Visual Studio projects, but the generated project files
+    don't have steps for assembling the assembly language source files, so they
+    currently cannot be used to build BoringSSL.
+
+## ARM CPU Capabilities
+
+ARM, unlike Intel, does not have a userspace instruction that allows
+applications to discover the capabilities of the processor. Instead, the
+capability information has to be provided by a combination of compile-time
+information and the operating system.
+
+BoringSSL determines capabilities at compile-time based on `__ARM_NEON`,
+`__ARM_FEATURE_AES`, and other preprocessor symbols defined in
+[Arm C Language Extensions (ACLE)](https://developer.arm.com/architectures/system-architectures/software-standards/acle).
+These values are usually controlled by the `-march` flag. You can also define
+any of the following to enable the corresponding ARM feature, but using the ACLE
+symbols via `-march` is recommended.
+
+  * `OPENSSL_STATIC_ARMCAP_NEON`
+  * `OPENSSL_STATIC_ARMCAP_AES`
+  * `OPENSSL_STATIC_ARMCAP_SHA1`
+  * `OPENSSL_STATIC_ARMCAP_SHA256`
+  * `OPENSSL_STATIC_ARMCAP_PMULL`
+
+The resulting binary will assume all such features are always present. This can
+reduce code size, by allowing the compiler to omit fallbacks. However, if the
+feature is not actually supported at runtime, BoringSSL will likely crash.
+
+BoringSSL will additionally query the operating system at runtime for additional
+features, e.g. with `getauxval` on Linux. This allows a single binary to use
+newer instructions when present, but still function on CPUs without them. But
+some environments don't support runtime queries. If building for those, define
+`OPENSSL_STATIC_ARMCAP` to limit BoringSSL to compile-time capabilities. If not
+defined, the target operating system must be known to BoringSSL.
+
+## Binary Size
+
+The implementations of some algorithms require a trade-off between binary size
+and performance. For instance, BoringSSL's fastest P-256 implementation uses a
+148 KiB pre-computed table. To optimize instead for binary size, pass
+`-DOPENSSL_SMALL=1` to CMake or define the `OPENSSL_SMALL` preprocessor symbol.
+
+# Running Tests
+
+There are two sets of tests: the C/C++ tests and the blackbox tests. For former
+are built by Ninja and can be run from the top-level directory with `go run
+util/all_tests.go`. The latter have to be run separately by running `go test`
+from within `ssl/test/runner`.
+
+Both sets of tests may also be run with `ninja -C build run_tests`, but CMake
+3.2 or later is required to avoid Ninja's output buffering.

package/deps/couchbase-cxx-client/CMakeLists.txt

@@ -21,7 +21,7 @@ endif()
 
 project(
   couchbase_cxx_client
-  VERSION "1.0.3"
+  VERSION "1.0.4"
   LANGUAGES CXX C)
 message(STATUS "Couchbase C++ client ${couchbase_cxx_client_VERSION} build ${couchbase_cxx_client_BUILD_NUMBER}, master: ${COUCHBASE_CXX_CLIENT_MASTER_PROJECT}")
 message(STATUS "System: ${CMAKE_SYSTEM_NAME}, ${CMAKE_SYSTEM_VERSION}, ${CMAKE_SYSTEM_PROCESSOR}")
@@ -76,6 +76,8 @@ include(cmake/OpenSSL.cmake)
 
 include(cmake/VersionInfo.cmake)
 
+include(cmake/RPath.cmake)
+
 add_subdirectory(core/platform)
 set(couchbase_cxx_client_FILES
     ${CMAKE_CURRENT_BINARY_DIR}/generated/mozilla_ca_bundle.cxx

package/deps/couchbase-cxx-client/README.md

@@ -21,9 +21,9 @@ CPMAddPackage(
   NAME
   couchbase_cxx_client
   GIT_TAG
-  1.0.3
+  1.0.4
   VERSION
-  1.0.3
+  1.0.4
   GITHUB_REPOSITORY
   "couchbase/couchbase-cxx-client"
   OPTIONS

package/deps/couchbase-cxx-client/cmake/APKBUILD.in

@@ -0,0 +1,54 @@
+# Contributor: Couchbase SDK Team <support@couchbase.com>
+# Maintainer: Couchbase SDK Team <support@couchbase.com>
+
+pkgname=couchbase-cxx-client
+pkgver=@COUCHBASE_CXX_CLIENT_PACKAGE_VERSION@
+pkgrel=1
+_number_of_commits=@COUCHBASE_CXX_CLIENT_NUMBER_OF_COMMITS@
+if [ "${_number_of_commits}" -gt 0 ]; then
+	pkgver="${pkgver}_p${_number_of_commits}"
+fi
+source="${pkgname}-${pkgver}.tar.gz"
+pkgdesc="Couchbase C++ SDK"
+url="https://docs.couchbase.com/cxx-sdk/current/hello-world/overview.html"
+arch="all"
+license="Apache-2.0"
+depends=""
+makedepends="
+	linux-headers
+	cmake
+	ninja
+"
+subpackages="${pkgname}-dev ${pkgname}-tools"
+options="!check"
+
+unpack() {
+	(cd "${srcdir}"; tar -xzf "${source}" --strip-components=1)
+}
+
+build() {
+	cmake -B apk-build -S "${srcdir}" -G Ninja \
+		-DCMAKE_INSTALL_PREFIX=/usr \
+		-DCMAKE_BUILD_TYPE=MinSizeRel \
+		-DBUILD_SHARED_LIBS=OFF \
+		-DCOUCHBASE_CXX_CLIENT_PKGCONFIG_VERSION="${pkgver}" \
+		-DCOUCHBASE_CXX_CLIENT_INSTALL=ON \
+		-DCOUCHBASE_CXX_CLIENT_STATIC_BORINGSSL=ON \
+		-DCOUCHBASE_CXX_CLIENT_BUILD_EXAMPLES=OFF \
+		-DCOUCHBASE_CXX_CLIENT_BUILD_TESTS=OFF \
+		-DCOUCHBASE_CXX_CLIENT_BUILD_TOOLS=ON \
+		-DCOUCHBASE_CXX_CLIENT_BUILD_STATIC=OFF \
+		-DCOUCHBASE_CXX_CLIENT_BUILD_SHARED=ON
+	cmake --build apk-build
+}
+
+tools() {
+	pkgdesc="${pkgdesc} (tools)"
+	depends="${pkgname}=${pkgver}-r${pkgrel}"
+
+	amove usr/bin
+}
+
+package() {
+	DESTDIR="${pkgdir}" cmake --install apk-build
+}

package/deps/couchbase-cxx-client/cmake/CompilerWarnings.cmake

@@ -70,11 +70,6 @@ function(set_project_warnings project_name)
   )
 
   set(CLANG_WARNINGS ${COMMON_WARNINGS})
-  if(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS_EQUAL "17.0.0")
-    set(CLANG_WARNINGS ${CLANG_WARNINGS} -Wshadow # warn the user if a variable declaration shadows one from a parent
-                                                  # context
-    )
-  endif()
 
   if(MSVC)
     set(PROJECT_WARNINGS ${MSVC_WARNINGS})