Merge v2.3 into v2.x (#2006)

Author: mongodb-drivers-pr-bot[bot]

.github/workflows/tests.yml

@@ -235,3 +235,63 @@ jobs:
           files: test-results.xml
           flags: "${{ env.SERVER_VERSION }}-server"
           token: ${{ secrets.CODECOV_TOKEN }}
+
+  # Verifies that the extension can be compiled statically into PHP (i.e. with
+  # --enable-mongodb instead of --enable-mongodb=shared), as done by projects
+  # like StaticPHP.  This exercises the PHP in-tree build path where configure
+  # is invoked from the PHP source root rather than the extension directory.
+  test-static-php-build:
+    name: "Static PHP Build"
+    runs-on: "ubuntu-latest"
+    env:
+      # Update this when cutting a new PHP 8.3 patch release
+      PHP_VERSION: "8.3.21"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v6"
+        with:
+          submodules: true
+          path: "mongo-php-driver"
+
+      - name: "Install build dependencies"
+        run: |
+          sudo apt-get update -q
+          sudo apt-get install -y \
+            autoconf \
+            bison \
+            libsqlite3-dev \
+            libssl-dev \
+            libxml2-dev \
+            pkg-config \
+            re2c
+
+      - name: "Download PHP ${{ env.PHP_VERSION }} source"
+        run: |
+          curl -fsSL "https://www.php.net/distributions/php-${{ env.PHP_VERSION }}.tar.gz" | tar -xz
+          mv "php-${{ env.PHP_VERSION }}" php-src
+
+      - name: "Link extension into PHP source tree"
+        run: ln -s "$GITHUB_WORKSPACE/mongo-php-driver" "$GITHUB_WORKSPACE/php-src/ext/mongodb"
+
+      - name: "Generate PHP build scripts"
+        run: cd "$GITHUB_WORKSPACE/php-src" && ./buildconf --force
+
+        # Note: --with-openssl is needed for the bundled libmongoc's TLS support.
+      - name: "Configure PHP with MongoDB extension (static)"
+        run: |
+          cd "$GITHUB_WORKSPACE/php-src"
+          ./configure \
+            --enable-debug \
+            --enable-cli \
+            --enable-mongodb \
+            --enable-mongodb-developer-flags \
+            --with-openssl
+
+      - name: "Build PHP"
+        run: cd "$GITHUB_WORKSPACE/php-src" && make -j$(nproc)
+
+      - name: "Verify MongoDB extension is compiled in"
+        run: |
+          "$GITHUB_WORKSPACE/php-src/sapi/cli/php" -m | grep -ix mongodb
+          "$GITHUB_WORKSPACE/php-src/sapi/cli/php" --ri mongodb

config.m4

@@ -374,10 +374,25 @@ if test "$PHP_MONGODB" != "no"; then
     PHP_MONGODB_ADD_SOURCES([src/libmongoc/src/libbson/src/jsonsl/], $PHP_MONGODB_JSONSL_SOURCES, $PHP_MONGODB_BUNDLED_CFLAGS)
     PHP_MONGODB_ADD_SOURCES([src/libmongoc/src/libmongoc/src/mongoc/], $PHP_MONGODB_MONGOC_SOURCES, $PHP_MONGODB_BUNDLED_CFLAGS)
 
-    dnl Add the build directories as include paths to some generated files
-    PHP_ADD_INCLUDE([$PWD/src/libmongoc/src/common/src])
-    PHP_ADD_INCLUDE([$PWD/src/libmongoc/src/libbson/src])
-    PHP_ADD_INCLUDE([$PWD/src/libmongoc/src/libmongoc/src])
+    dnl TODO: Use $ext_builddir/$ext_srcdir once this block can move after PHP_NEW_EXTENSION.
+    dnl $ext_builddir and $ext_srcdir are set by PHP_NEW_EXTENSION, but PHP_ADD_INCLUDE
+    dnl and PHP_MONGODB_ADD_SOURCES calls must precede PHP_NEW_EXTENSION, so the whole
+    dnl block cannot be deferred.  PHP_EXT_BUILDDIR/PHP_EXT_SRCDIR are M4 macros that
+    dnl are always available and provide equivalent values without that constraint.
+    dnl
+    dnl PHP_EXT_BUILDDIR expands to the extension's directory relative to the build
+    dnl root: "ext/mongodb" for PHP in-tree builds, "." for phpize builds.  Pairing
+    dnl it with $abs_builddir (the absolute path to wherever configure was invoked)
+    dnl produces the correct absolute path to the generated config headers regardless
+    dnl of build layout.  Using $PWD here breaks PHP in-tree builds because $PWD is
+    dnl the PHP source/build root, not the extension's subdirectory within it.
+    php_mongodb_ext_builddir=PHP_EXT_BUILDDIR(mongodb)
+
+    dnl Add the build directories as include paths so the compiler finds generated
+    dnl config headers (common-config.h, bson/config.h, mongoc-config.h, etc.).
+    PHP_ADD_INCLUDE([$abs_builddir/$php_mongodb_ext_builddir/src/libmongoc/src/common/src])
+    PHP_ADD_INCLUDE([$abs_builddir/$php_mongodb_ext_builddir/src/libmongoc/src/libbson/src])
+    PHP_ADD_INCLUDE([$abs_builddir/$php_mongodb_ext_builddir/src/libmongoc/src/libmongoc/src])
 
     PHP_MONGODB_ADD_INCLUDE([src/libmongoc/src/common/src/])
     PHP_MONGODB_ADD_INCLUDE([src/libmongoc/src/uthash/])
@@ -399,16 +414,17 @@ if test "$PHP_MONGODB" != "no"; then
       PHP_MONGODB_ADD_BUILD_DIR([src/libmongoc/src/kms-message/src/])
     fi
 
-    dnl TODO: Use $ext_srcdir if we can move this after PHP_NEW_EXTENSION
-    ac_config_dir=PHP_EXT_SRCDIR(mongodb)
-
+    dnl Write generated config headers into the extension's build directory
+    dnl (${php_mongodb_ext_builddir}/... relative to the configure invocation directory).
+    dnl For standalone out-of-source builds this stays in the build tree; for
+    dnl PHP in-tree builds it lands under ext/mongodb/ rather than the PHP root.
     AC_CONFIG_FILES([
-      src/libmongoc/src/common/src/common-config.h
-      src/libmongoc/src/libbson/src/bson/config.h
-      src/libmongoc/src/libbson/src/bson/version.h
-      src/libmongoc/src/libmongoc/src/mongoc/mongoc-config.h
-      src/libmongoc/src/libmongoc/src/mongoc/mongoc-config-private.h
-      src/libmongoc/src/libmongoc/src/mongoc/mongoc-version.h
+      ${php_mongodb_ext_builddir}/src/libmongoc/src/common/src/common-config.h
+      ${php_mongodb_ext_builddir}/src/libmongoc/src/libbson/src/bson/config.h
+      ${php_mongodb_ext_builddir}/src/libmongoc/src/libbson/src/bson/version.h
+      ${php_mongodb_ext_builddir}/src/libmongoc/src/libmongoc/src/mongoc/mongoc-config.h
+      ${php_mongodb_ext_builddir}/src/libmongoc/src/libmongoc/src/mongoc/mongoc-config-private.h
+      ${php_mongodb_ext_builddir}/src/libmongoc/src/libmongoc/src/mongoc/mongoc-version.h
     ])
 
     if test "x$bundled_utf8proc" = "xyes"; then
@@ -423,7 +439,7 @@ if test "$PHP_MONGODB" != "no"; then
       PHP_MONGODB_ADD_SOURCES([src/libmongoc/src/zlib-1.3.1/], $PHP_MONGODB_ZLIB_SOURCES, $PHP_MONGODB_ZLIB_CFLAGS)
       PHP_MONGODB_ADD_INCLUDE([src/libmongoc/src/zlib-1.3.1/])
       PHP_MONGODB_ADD_BUILD_DIR([src/libmongoc/src/zlib-1.3.1/])
-      AC_CONFIG_FILES([${ac_config_dir}/src/libmongoc/src/zlib-1.3.1/zconf.h])
+      AC_CONFIG_FILES([${php_mongodb_ext_builddir}/src/libmongoc/src/zlib-1.3.1/zconf.h])
     fi
 
     if test "$PHP_MONGODB_CLIENT_SIDE_ENCRYPTION" = "yes"; then
@@ -462,7 +478,7 @@ if test "$PHP_MONGODB" != "no"; then
       PHP_MONGODB_ADD_BUILD_DIR([src/libmongocrypt/kms-message/src/])
 
       AC_CONFIG_FILES([
-        ${ac_config_dir}/src/libmongocrypt/src/mongocrypt-config.h
+        ${php_mongodb_ext_builddir}/src/libmongocrypt/src/mongocrypt-config.h
       ])
     fi
   fi