couchbase 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 241594e3c8b47ca837a1eb6ef09c83bb5e1babdac18869a9b66bf821bf77c882
-  data.tar.gz: 0cf2f466bf600b6908e34ed7a495a9738cd74bed7f5ee7b83afaf3053a99aad1
+  metadata.gz: 823424047026c1b6b4c8c61577b4fb51fe93a7be2d14379484ba873e3ee1716c
+  data.tar.gz: b08989610223adf4ab1e3d5817dece9799be67ffb3b5e5f9b29ba7d7d4f93114
 SHA512:
-  metadata.gz: 9e9257498ef7c86c9b8ba6473a28ac55f4d725f56b818835904373a2ba934cdb7a5333eb6c978746954b1e98016250c2710d875eda8e6c45240ba468c5d1a0b4
-  data.tar.gz: cd31b914bd512515efd067aea2baff1ca0cfaa5bb5b7eebd96c1fd3fe12999811876f045c111b91d90565abb82306ef560a262e5f770ff3b7209e231a25be3b8
+  metadata.gz: fd82e96988c8d857c63d0ba655aada5315508f88f412556d20d874f4ccc1dbe8e03a31c571d6e2ff7b8ffc6ce2c75b114febc881b3d3aaa728859f527cba8210
+  data.tar.gz: 766bb40b05dad76df83d85b8a117b4f29d9d9845607ae19ad29c28c59f19f8b8545ae96ba108f5301e1e51dd46c13cac51a8e9424c31c685bc1fed3947c4a6d4

data/README.md

@@ -18,7 +18,7 @@ The library tested with the MRI 2.5, 2.6 and 2.7. Supported platforms are Linux
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "couchbase", "3.0.0"
+gem "couchbase", "3.0.1"
 ```
 
 And then execute:

data/ext/CMakeLists.txt

@@ -1,210 +1,127 @@
 cmake_minimum_required(VERSION 3.15)
 project(ruby_client LANGUAGES CXX C)
+include(cmake/PreventInSourceBuilds.cmake)
+include(cmake/StandardProjectSettings.cmake)
 
-set(CMAKE_CXX_STANDARD 17)
+# 'library' to set the c++ standard / compile-time options requested
+add_library(project_options INTERFACE)
+target_compile_features(project_options INTERFACE cxx_std_17)
 
-find_program(CCACHE ccache)
-if(CCACHE)
-    set(CMAKE_CXX_COMPILER_LAUNCHER ${CCACHE})
-endif()
+# 'library' to use the warnings specified in CompilerWarnings.cmake
+add_library(project_warnings INTERFACE)
 
-include(CMakePushCheckState)
-include(CheckSymbolExists)
-
-cmake_push_check_state(RESET)
-find_library(EXECINFO_LIBRARY NAMES execinfo)
-if(EXECINFO_LIBRARY)
-    set(CMAKE_REQUIRED_LIBRARIES "${EXECINFO_LIBRARY}")
-    list(APPEND PLATFORM_LIBRARIES "${EXECINFO_LIBRARY}")
-endif(EXECINFO_LIBRARY)
-check_symbol_exists(backtrace execinfo.h HAVE_BACKTRACE)
-cmake_pop_check_state()
-
-cmake_push_check_state(RESET)
-set(CMAKE_REQUIRED_DEFINITIONS "-D_GNU_SOURCE")
-find_library(DL_LIBRARY NAMES dl)
-if(DL_LIBRARY)
-    set(CMAKE_REQUIRED_LIBRARIES "${DL_LIBRARY}")
-    list(APPEND PLATFORM_LIBRARIES "${DL_LIBRARY}")
-endif(DL_LIBRARY)
-check_symbol_exists(dladdr dlfcn.h HAVE_DLADDR)
-cmake_pop_check_state()
-
-if(HAVE_BACKTRACE)
-    add_definitions(-DHAVE_BACKTRACE=1)
-endif()
+include(cmake/BuildTracing.cmake)
 
-if(HAVE_DLADDR)
-    add_definitions(-DHAVE_DLADDR=1)
-endif()
+# enable cache system
+include(cmake/Cache.cmake)
 
-add_subdirectory(third_party/gsl)
-add_subdirectory(third_party/json)
-add_subdirectory(third_party/spdlog)
-add_subdirectory(third_party/snappy)
+# standard compiler warnings
+include(cmake/CompilerWarnings.cmake)
+set_project_warnings(project_warnings)
 
-include_directories(BEFORE SYSTEM third_party/gsl/include)
-include_directories(BEFORE SYSTEM third_party/asio/asio/include)
-include_directories(BEFORE SYSTEM third_party/json/include)
-include_directories(BEFORE SYSTEM third_party/spdlog/include)
-include_directories(BEFORE SYSTEM third_party/http_parser)
+# sanitizer options if supported by compiler
+include(cmake/Sanitizers.cmake)
+enable_sanitizers(project_options)
 
-add_library(project_warnings INTERFACE)
-add_library(project_options INTERFACE)
+# allow for static analysis options
+include(cmake/StaticAnalyzers.cmake)
 
-target_compile_features(project_options INTERFACE cxx_std_17)
-target_include_directories(project_options INTERFACE include)
+include(cmake/Backtrace.cmake)
 
-if(MSVC)
-    target_compile_options(project_warnings INTERFACE /W4 /WX "/permissive-")
-else()
-    option(ONLY_COVERAGE "Build only tests necessary for coverage" FALSE)
-    option(STATIC_STDLIB "Statically link C++ standard library" FALSE)
-    option(ENABLE_COVERAGE "Enable coverage reporting for gcc/clang" FALSE)
-    option(ENABLE_FUZZERS "Enable fuzz testing tools" FALSE)
-
-    if(ONLY_COVERAGE OR ENABLE_COVERAGE)
-        target_compile_options(project_options INTERFACE --coverage -O0 -g)
-        target_link_libraries(project_options INTERFACE --coverage)
-    endif()
-
-    option(ENABLE_ASAN "Enable address sanitizer" FALSE)
-
-    if(ENABLE_ASAN)
-        target_compile_options(project_options INTERFACE -fsanitize=address)
-        target_link_libraries(project_options INTERFACE -fsanitize=address)
-    endif()
-
-    option(ENABLE_TSAN "Enable thread sanitizer" FALSE)
-
-    if(ENABLE_TSAN)
-        target_compile_options(project_options INTERFACE -fsanitize=thread)
-        target_link_libraries(project_options INTERFACE -fsanitize=thread)
-    endif()
-
-    if(STATIC_STDLIB)
-        target_compile_options(project_options INTERFACE -static-libgcc -static-libstdc++)
-        target_link_options(project_options INTERFACE -static-libgcc -static-libstdc++)
-    endif()
-
-    target_compile_options(
-        project_warnings
-        INTERFACE -Wall
-                  -Werror # treat all warnings as errors
-                  -Wextra # reasonable and standard
-                  -Wshadow # warn the user if a variable declaration shadows one from a parent
-                  # context
-                  -Wnon-virtual-dtor # warn the user if a class with virtual functions has a non-
-                  # virtual destructor. This helps catch hard to track down memory errors
-                  -Wcast-align # warn for potential performance problem casts
-                  -Wunused # warn on anything being unused
-                  -Woverloaded-virtual # warn if you overload (not override) a virtual function
-                  -Wpedantic # warn if non-standard C++ is used
-                  -Wold-style-cast # warn for c-style casts
-                  -Wconversion # warn on type conversions that may lose data
-                  -Wsign-conversion # warn on sign conversions
-                  -Wnull-dereference # warn if a null dereference is detected
-                  -Wformat=2 # warn on security issues around functions that format output (ie
-                  # printf)
-    )
-
-    if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
-        target_compile_options(
-            project_warnings
-            INTERFACE -Wmisleading-indentation # warn if indentation implies blocks where blocks do
-                      # not exist
-                      -Wduplicated-cond # warn if if / else chain has duplicated conditions
-                      -Wduplicated-branches # warn if if / else branches have duplicated code
-                      -Wlogical-op # warn about logical operations being used where bitwise were
-                      # probably wanted
-                      -Wuseless-cast # warn if you perform a cast to the same type
-        )
-    endif()
-
-    if(HAVE_BACKTRACE OR HAVE_DLADDR)
-        target_compile_options(project_options INTERFACE -ggdb3)
-        target_link_libraries(project_options INTERFACE -rdynamic)
-        add_definitions(-D_GNU_SOURCE=1)
-    endif()
+include(cmake/ThirdPartyDependencies.cmake)
+
+option(STATIC_STDLIB "Statically link C++ standard library" FALSE)
+if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
+  if(STATIC_STDLIB)
+    target_compile_options(project_options INTERFACE -static-libgcc -static-libstdc++)
+    target_link_libraries(project_options INTERFACE -static-libgcc -static-libstdc++)
+  endif()
 endif()
 
+option(STATIC_OPENSSL "Statically link OpenSSL library" FALSE)
 # Read more at https://wiki.wireshark.org/TLS
 option(TLS_KEY_LOG_FILE "Path to file to write per-session secrets (Useful for Wireshark SSL/TLS dissection)")
-
+if(STATIC_OPENSSL)
+  set(OPENSSL_USE_STATIC_LIBS ON)
+endif()
 include(FindOpenSSL)
-message(STATUS "OPENSSL_VERSION: ${OPENSSL_VERSION}")
-message(STATUS "OPENSSL_INCLUDEDIRS: ${OPENSSL_INCLUDE_DIR}")
-message(STATUS "OPENSSL_LIBRARIES: ${OPENSSL_LIBRARIES}")
+if(OPENSSL_LIBRARIES AND OPENSSL_INCLUDE_DIR)
+  message(STATUS "OPENSSL_VERSION: ${OPENSSL_VERSION}")
+  message(STATUS "OPENSSL_INCLUDE_DIR: ${OPENSSL_INCLUDE_DIR}")
+  message(STATUS "OPENSSL_LIBRARIES: ${OPENSSL_LIBRARIES}")
+else()
+  message(FATAL_ERROR "Cannot build couchbase extension without OpenSSL")
+endif()
+
+include(cmake/VersionInfo.cmake)
 
 include_directories(${CMAKE_SOURCE_DIR}/couchbase)
 
 add_library(
-    platform OBJECT couchbase/platform/string_hex.cc couchbase/platform/uuid.cc couchbase/platform/random.cc
-                    couchbase/platform/base64.cc couchbase/platform/backtrace.c couchbase/platform/terminate_handler.cc)
+  platform OBJECT
+  couchbase/platform/string_hex.cc
+  couchbase/platform/uuid.cc
+  couchbase/platform/random.cc
+  couchbase/platform/base64.cc
+  couchbase/platform/backtrace.c
+  couchbase/platform/terminate_handler.cc)
 target_include_directories(platform PRIVATE ${PROJECT_BINARY_DIR}/generated)
+target_link_libraries(platform PRIVATE ${PLATFORM_LIBRARIES})
 
 add_library(cbcrypto OBJECT couchbase/cbcrypto/cbcrypto.cc)
-
-add_library(http_parser OBJECT third_party/http_parser/http_parser.c)
-set_target_properties(http_parser PROPERTIES C_VISIBILITY_PRESET hidden POSITION_INDEPENDENT_CODE TRUE)
+target_link_libraries(
+  cbcrypto
+  PRIVATE project_options
+          project_warnings
+          OpenSSL::SSL
+          OpenSSL::Crypto)
 
 add_library(
-    cbsasl OBJECT
-    couchbase/cbsasl/client.cc couchbase/cbsasl/context.cc couchbase/cbsasl/mechanism.cc
-    couchbase/cbsasl/plain/plain.cc couchbase/cbsasl/scram-sha/scram-sha.cc couchbase/cbsasl/scram-sha/stringutils.cc)
+  cbsasl OBJECT
+  couchbase/cbsasl/client.cc
+  couchbase/cbsasl/context.cc
+  couchbase/cbsasl/mechanism.cc
+  couchbase/cbsasl/plain/plain.cc
+  couchbase/cbsasl/scram-sha/scram-sha.cc
+  couchbase/cbsasl/scram-sha/stringutils.cc)
 
 if(RUBY_HDR_DIR)
-    set(RUBY_INCLUDE_DIR ${RUBY_HDR_DIR} ${RUBY_ARCH_HDR_DIR})
+  set(RUBY_INCLUDE_DIR ${RUBY_HDR_DIR} ${RUBY_ARCH_HDR_DIR})
 else()
-    find_package(Ruby REQUIRED)
-    message(STATUS "RUBY_VERSION: ${RUBY_VERSION}")
-    message(STATUS "RUBY_EXECUTABLE: ${RUBY_EXECUTABLE}")
+  find_package(Ruby REQUIRED)
+  message(STATUS "RUBY_VERSION: ${RUBY_VERSION}")
+  message(STATUS "RUBY_EXECUTABLE: ${RUBY_EXECUTABLE}")
 endif()
 message(STATUS "RUBY_INCLUDE_DIR: ${RUBY_INCLUDE_DIR}")
 message(STATUS "RUBY_LIBRARY: ${RUBY_LIBRARY}")
 include_directories(BEFORE SYSTEM "${RUBY_INCLUDE_DIR}")
 
-find_program(GIT git)
-if(GIT)
-    execute_process(
-        COMMAND git rev-parse HEAD
-        WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
-        OUTPUT_STRIP_TRAILING_WHITESPACE
-        OUTPUT_VARIABLE BACKEND_GIT_REVISION)
-endif()
-
-string(TIMESTAMP BACKEND_BUILD_TIMESTAMP "%Y-%m-%d %H:%M:%S" UTC)
-configure_file(${PROJECT_SOURCE_DIR}/build_version.hxx.in ${PROJECT_BINARY_DIR}/generated/build_version.hxx @ONLY)
-configure_file(${PROJECT_SOURCE_DIR}/build_config.hxx.in ${PROJECT_BINARY_DIR}/generated/build_config.hxx @ONLY)
 add_library(couchbase SHARED couchbase/couchbase.cxx)
 target_include_directories(couchbase PRIVATE ${PROJECT_BINARY_DIR}/generated)
 target_link_libraries(
-    couchbase
-    PRIVATE project_options
-            project_warnings
-            OpenSSL::SSL
-            OpenSSL::Crypto
-            platform
-            cbcrypto
-            cbsasl
-            http_parser
-            snappy
-            spdlog::spdlog_header_only)
-set_target_properties(cbcrypto cbsasl platform snappy PROPERTIES POSITION_INDEPENDENT_CODE TRUE)
+  couchbase
+  PRIVATE project_options
+          project_warnings
+          OpenSSL::SSL
+          OpenSSL::Crypto
+          platform
+          cbcrypto
+          cbsasl
+          http_parser
+          snappy
+          spdlog::spdlog_header_only)
+
+set_target_properties(
+  cbcrypto
+  cbsasl
+  platform
+  snappy
+  PROPERTIES POSITION_INDEPENDENT_CODE TRUE)
 
 if(APPLE)
-    target_link_options(couchbase PRIVATE -Wl,-undefined,dynamic_lookup)
+  target_link_libraries(couchbase PRIVATE -Wl,-undefined,dynamic_lookup)
 else()
-    set_target_properties(cbcrypto cbsasl platform PROPERTIES CXX_VISIBILITY_PRESET hidden)
+  set_target_properties(cbcrypto cbsasl platform PROPERTIES CXX_VISIBILITY_PRESET hidden)
 endif()
 
-if(BUILD_EXAMPLES)
-    file(
-        GENERATE
-        OUTPUT ${PROJECT_BINARY_DIR}/generated/generated_config.hxx
-        CONTENT "#pragma once\n#define LIBCOUCHBASE_EXT_PATH \"$<TARGET_FILE:couchbase>\"")
-    add_executable(main test/main.cxx)
-    target_include_directories(main PRIVATE ${PROJECT_BINARY_DIR}/generated)
-    target_link_libraries(main PRIVATE project_options project_warnings ${RUBY_LIBRARY} spdlog::spdlog_header_only)
-    add_dependencies(main couchbase)
-endif()
+include(cmake/Testing.cmake)

data/ext/build_version.hxx.in

@@ -22,5 +22,6 @@
 #define BACKEND_C_COMPILER "@CMAKE_C_COMPILER_ID@ @CMAKE_C_COMPILER_VERSION@"
 #define BACKEND_SYSTEM "@CMAKE_SYSTEM@"
 #define BACKEND_SYSTEM_PROCESSOR "@CMAKE_SYSTEM_PROCESSOR@"
-#define BACKEND_GIT_REVISION "a23527c044e32c037f4a001c2b2a836716d85d35"
-
+#define BACKEND_GIT_REVISION "b59cb40f11ec2dba992eda285eae5cd7238a59c3"
+#cmakedefine STATIC_STDLIB 1
+#cmakedefine STATIC_OPENSSL 1

data/ext/cmake/Backtrace.cmake

@@ -0,0 +1,35 @@
+include(CMakePushCheckState)
+include(CheckSymbolExists)
+
+cmake_push_check_state(RESET)
+find_library(EXECINFO_LIBRARY NAMES execinfo)
+if(EXECINFO_LIBRARY)
+  set(CMAKE_REQUIRED_LIBRARIES "${EXECINFO_LIBRARY}")
+  list(APPEND PLATFORM_LIBRARIES "${EXECINFO_LIBRARY}")
+endif(EXECINFO_LIBRARY)
+check_symbol_exists(backtrace execinfo.h HAVE_BACKTRACE)
+cmake_pop_check_state()
+
+cmake_push_check_state(RESET)
+set(CMAKE_REQUIRED_DEFINITIONS "-D_GNU_SOURCE")
+find_library(DL_LIBRARY NAMES dl)
+if(DL_LIBRARY)
+  set(CMAKE_REQUIRED_LIBRARIES "${DL_LIBRARY}")
+  list(APPEND PLATFORM_LIBRARIES "${DL_LIBRARY}")
+endif(DL_LIBRARY)
+check_symbol_exists(dladdr dlfcn.h HAVE_DLADDR)
+cmake_pop_check_state()
+
+if(HAVE_BACKTRACE)
+  add_definitions(-DHAVE_BACKTRACE=1)
+endif()
+
+if(HAVE_DLADDR)
+  add_definitions(-DHAVE_DLADDR=1)
+endif()
+
+if(HAVE_BACKTRACE OR HAVE_DLADDR)
+  target_compile_options(project_options INTERFACE -ggdb3)
+  target_link_libraries(project_options INTERFACE -rdynamic)
+  add_definitions(-D_GNU_SOURCE=1)
+endif()

data/ext/cmake/BuildTracing.cmake

@@ -0,0 +1,6 @@
+if(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
+  option(ENABLE_BUILD_WITH_TIME_TRACE "Enable -ftime-trace to generate time tracing .json files on clang" OFF)
+  if(ENABLE_BUILD_WITH_TIME_TRACE)
+    target_compile_definitions(project_options INTERFACE -ftime-trace)
+  endif()
+endif()

data/ext/cmake/Cache.cmake

@@ -0,0 +1,29 @@
+option(ENABLE_CACHE "Enable cache if available" ON)
+if(NOT ENABLE_CACHE)
+  return()
+endif()
+
+set(CACHE_OPTION
+    "ccache"
+    CACHE STRING "Compiler cache to be used")
+set(CACHE_OPTION_VALUES "ccache" "sccache")
+set_property(CACHE CACHE_OPTION PROPERTY STRINGS ${CACHE_OPTION_VALUES})
+list(
+  FIND
+  CACHE_OPTION_VALUES
+  ${CACHE_OPTION}
+  CACHE_OPTION_INDEX)
+
+if(${CACHE_OPTION_INDEX} EQUAL -1)
+  message(
+    STATUS
+      "Using custom compiler cache system: '${CACHE_OPTION}', explicitly supported entries are ${CACHE_OPTION_VALUES}")
+endif()
+
+find_program(CACHE_BINARY ${CACHE_OPTION})
+if(CACHE_BINARY)
+  message(STATUS "${CACHE_OPTION} found and enabled")
+  set(CMAKE_CXX_COMPILER_LAUNCHER ${CACHE_BINARY})
+else()
+  message(WARNING "${CACHE_OPTION} is enabled but was not found. Not using it")
+endif()

data/ext/cmake/CompilerWarnings.cmake

@@ -0,0 +1,78 @@
+# from here:
+#
+# https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Available.md
+
+function(set_project_warnings project_name)
+  option(WARNINGS_AS_ERRORS "Treat compiler warnings as errors" TRUE)
+
+  set(MSVC_WARNINGS
+      /W4 # Baseline reasonable warnings
+      /w14242 # 'identifier': conversion from 'type1' to 'type1', possible loss of data
+      /w14254 # 'operator': conversion from 'type1:field_bits' to 'type2:field_bits', possible loss of data
+      /w14263 # 'function': member function does not override any base class virtual member function
+      /w14265 # 'classname': class has virtual functions, but destructor is not virtual instances of this class may not
+              # be destructed correctly
+      /w14287 # 'operator': unsigned/negative constant mismatch
+      /we4289 # nonstandard extension used: 'variable': loop control variable declared in the for-loop is used outside
+              # the for-loop scope
+      /w14296 # 'operator': expression is always 'boolean_value'
+      /w14311 # 'variable': pointer truncation from 'type1' to 'type2'
+      /w14545 # expression before comma evaluates to a function which is missing an argument list
+      /w14546 # function call before comma missing argument list
+      /w14547 # 'operator': operator before comma has no effect; expected operator with side-effect
+      /w14549 # 'operator': operator before comma has no effect; did you intend 'operator'?
+      /w14555 # expression has no effect; expected expression with side- effect
+      /w14619 # pragma warning: there is no warning number 'number'
+      /w14640 # Enable warning on thread un-safe static member initialization
+      /w14826 # Conversion from 'type1' to 'type_2' is sign-extended. This may cause unexpected runtime behavior.
+      /w14905 # wide string literal cast to 'LPSTR'
+      /w14906 # string literal cast to 'LPWSTR'
+      /w14928 # illegal copy-initialization; more than one user-defined conversion has been implicitly applied
+      /permissive- # standards conformance mode for MSVC compiler.
+  )
+
+  set(CLANG_WARNINGS
+      -Wall
+      -Wextra # reasonable and standard
+      -Wshadow # warn the user if a variable declaration shadows one from a parent context
+      -Wnon-virtual-dtor # warn the user if a class with virtual functions has a non-virtual destructor. This helps
+                         # catch hard to track down memory errors
+      -Wold-style-cast # warn for c-style casts
+      -Wcast-align # warn for potential performance problem casts
+      -Wunused # warn on anything being unused
+      -Woverloaded-virtual # warn if you overload (not override) a virtual function
+      -Wpedantic # warn if non-standard C++ is used
+      -Wconversion # warn on type conversions that may lose data
+      -Wsign-conversion # warn on sign conversions
+      -Wnull-dereference # warn if a null dereference is detected
+      -Wdouble-promotion # warn if float is implicit promoted to double
+      -Wformat=2 # warn on security issues around functions that format output (ie printf)
+  )
+
+  if(WARNINGS_AS_ERRORS)
+    set(CLANG_WARNINGS ${CLANG_WARNINGS} -Werror)
+    set(MSVC_WARNINGS ${MSVC_WARNINGS} /WX)
+  endif()
+
+  set(GCC_WARNINGS
+      ${CLANG_WARNINGS}
+      -Wmisleading-indentation # warn if indentation implies blocks where blocks do not exist
+      -Wduplicated-cond # warn if if / else chain has duplicated conditions
+      -Wduplicated-branches # warn if if / else branches have duplicated code
+      -Wlogical-op # warn about logical operations being used where bitwise were probably wanted
+      -Wuseless-cast # warn if you perform a cast to the same type
+  )
+
+  if(MSVC)
+    set(PROJECT_WARNINGS ${MSVC_WARNINGS})
+  elseif(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
+    set(PROJECT_WARNINGS ${CLANG_WARNINGS})
+  elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+    set(PROJECT_WARNINGS ${GCC_WARNINGS})
+  else()
+    message(AUTHOR_WARNING "No compiler warnings set for '${CMAKE_CXX_COMPILER_ID}' compiler.")
+  endif()
+
+  target_compile_options(${project_name} INTERFACE ${PROJECT_WARNINGS})
+
+endfunction()