Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/frankenphp.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: "FrankenPHP"

on:
pull_request:
branches:
- "v*.*"
- "feature/*"
push:
branches:
- "v*.*"
- "feature/*"

permissions:
contents: read

jobs:
thread-reboot:
name: "FrankenPHP in-process thread reboot"
runs-on: "ubuntu-24.04"

services:
mongodb:
# Single-node replica set with a built-in healthcheck, which the runner
# waits for before running the steps.
image: "mongodb/mongodb-atlas-local:8.0"
ports:
- "27017:27017"

env:
# The FrankenPHP container reaches the service through the Docker host.
MONGODB_URI: "mongodb://host.docker.internal:27017/?directConnection=true&serverSelectionTimeoutMS=2000"

steps:
- name: "Checkout"
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
submodules: true

- name: "Set up Docker buildx"
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1

- name: "Build the image with the driver"
uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
with:
context: "."
file: "tests/frankenphp/Dockerfile"
tags: "mongodb-frankenphp"
load: true
# Layer cache shared between runs: dependency layers and the extension
# build are reused when the sources they depend on did not change.
cache-from: "type=gha"
cache-to: "type=gha,mode=max"

- name: "Run the restart test"
run: "SKIP_BUILD=1 bash tests/frankenphp/restart-test.sh"
env:
IMAGE_NAME: "mongodb-frankenphp"
Comment thread
github-advanced-security[bot] marked this conversation as resolved.
Fixed
55 changes: 32 additions & 23 deletions phongo.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
#include <ext/standard/info.h>

#include "phongo.h"
#include "src/phongo_atomic.h"
#include "src/phongo_client.h"
#include "src/phongo_error.h"
#include "src/phongo_ini.h"
Expand All @@ -37,12 +36,25 @@ ZEND_DECLARE_MODULE_GLOBALS(mongodb)
ZEND_TSRMLS_CACHE_DEFINE();
#endif

/* Initialize a thread counter, which will be atomically incremented in GINIT.
* In turn, GSHUTDOWN will decrement the counter and call mongoc_cleanup() when
* it reaches zero (i.e. last thread is shutdown). This is necessary because
* mongoc_cleanup() must be called after all persistent clients have been
* destroyed. */
static int32_t phongo_num_threads = 0;
/* Track whether libmongoc has been initialized in this process. libmongoc
* state is process-wide: the C driver documents that mongoc_init() must be
* called exactly once and that it does not reinitialize the driver after
* mongoc_cleanup(). Some SAPIs (e.g. FrankenPHP) shut the PHP engine down and
* start it again in the same process, which runs GINIT, GSHUTDOWN, MINIT, and
* MSHUTDOWN once per engine lifecycle. libmongoc must therefore be initialized
* and shut down once per process, not once per engine lifecycle. Otherwise, the
* next engine startup reuses a libmongoc instance whose global state (e.g. the
* handshake data) was freed by mongoc_cleanup() and cannot be restored by the
* subsequent mongoc_init() call. */
static bool phongo_libmongoc_initialized = false;

/* Shut down libmongoc when the process exits. This is registered with atexit()
* in MINIT and is intentionally not tied to the engine lifecycle. */
static void phongo_libmongoc_shutdown(void)
{
mongoc_cleanup();
bson_mem_restore_vtable();
}

/* Declare zend_class_entry dependencies, which are initialized in MINIT */
zend_class_entry* phongo_json_serializable_ce;
Expand Down Expand Up @@ -130,9 +142,6 @@ PHP_GINIT_FUNCTION(mongodb) /* {{{ */
ZEND_TSRMLS_CACHE_UPDATE();
#endif

/* Increment the thread counter. */
phongo_atomic_int32_fetch_add(&phongo_num_threads, 1, phongo_memory_order_seq_cst);

/* Clear extension globals */
memset(mongodb_globals, 0, sizeof(zend_mongodb_globals));

Expand Down Expand Up @@ -203,11 +212,20 @@ PHP_MINIT_FUNCTION(mongodb) /* {{{ */
phongo_register_ini_entries(INIT_FUNC_ARGS_PASSTHRU);

/* Assign our custom vtable to libbson, so all memory allocation in libbson
* (and libmongoc) will use PHP's persistent memory API. After doing so,
* initialize libmongoc. Later, we will shutdown libmongoc and restore
* libbson's vtable in the final GSHUTDOWN. */
* (and libmongoc) will use PHP's persistent memory API. The vtable must be
* assigned on every engine startup because libmongoc outlives the engine.
* libmongoc is initialized once per process and shut down along with the
* vtable restoration when the process exits. */
bson_mem_set_vtable(&bson_mem_vtable);
mongoc_init();

if (!phongo_libmongoc_initialized) {
mongoc_init();
phongo_libmongoc_initialized = true;

/* libmongoc must be shut down at process exit. See the comment above
* phongo_libmongoc_initialized for details. */
(void) atexit(phongo_libmongoc_shutdown);
}

/* Prep default object handlers to be used when we register the classes */
memcpy(&phongo_std_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
Expand Down Expand Up @@ -387,15 +405,6 @@ PHP_GSHUTDOWN_FUNCTION(mongodb) /* {{{ */
/* TODO: Check that logging actually gets disabled. The logger HashTable
* should be empty by this point. */
phongo_log_set_stream(NULL);

/* Decrement the thread counter. If it reaches zero, we can infer that this
* is the last thread, MSHUTDOWN has been called, persistent clients from
* all threads have been destroyed, and it is now safe to shutdown libmongoc
* and restore libbson's original vtable. */
if (phongo_atomic_int32_fetch_sub(&phongo_num_threads, 1, phongo_memory_order_seq_cst) - 1 == 0) {
mongoc_cleanup();
bson_mem_restore_vtable();
}
} /* }}} */

PHP_MINFO_FUNCTION(mongodb) /* {{{ */
Expand Down
27 changes: 27 additions & 0 deletions tests/bson/bson-document-duplicate-keys-001.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
--TEST--
MongoDB\BSON\Document: Encoding duplicate keys
--DESCRIPTION--
BSON corpus spec prose test #2.1 (encoding)
https://github.com/mongodb/specifications/blob/master/source/bson-corpus/bson-corpus.md#21-test-encoding
--FILE--
<?php

require_once __DIR__ . '/../utils/basic.inc';

/* PHPC does not expose a BSON builder API. PHP arrays and objects cannot hold
* duplicate keys, so the duplicate keys below are collapsed by PHP itself
* before reaching the driver. */
$document = MongoDB\BSON\Document::fromPHP(['foo' => 1, 'foo' => 2]);

echo "PHP collapses duplicate keys, keeping the last value\n";
echo $document->toRelaxedExtendedJSON(), "\n";
var_dump((string) $document === hex2bin('0e00000010666f6f000200000000'));

?>
===DONE===
<?php exit(0); ?>
--EXPECT--
PHP collapses duplicate keys, keeping the last value
{ "foo" : 2 }
bool(true)
===DONE===
79 changes: 79 additions & 0 deletions tests/bson/bson-document-duplicate-keys-002.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
--TEST--
MongoDB\BSON\Document: Decoding BSON with duplicate keys
--DESCRIPTION--
BSON corpus spec prose test #2.2 (decoding)
https://github.com/mongodb/specifications/blob/master/source/bson-corpus/bson-corpus.md#22-test-decoding
--FILE--
<?php

require_once __DIR__ . '/../utils/basic.inc';

/* Duplicate keys are not validated by the driver. This test documents how each
* decoding API behaves. Bytes represent BSON for { "foo": 1, "foo": 2 } */
$document = MongoDB\BSON\Document::fromBSON(hex2bin('1700000010666f6f000100000010666f6f000200000000'));

echo "Iteration returns both elements in order\n";
foreach ($document as $key => $value) {
var_dump($key, $value);
}

echo "\nget() and offsetGet() return the first value\n";
var_dump($document->get('foo'));
var_dump($document['foo']);
var_dump($document->has('foo'));

echo "\ntoPHP() keeps the last value for object type maps\n";
var_dump($document->toPHP());
var_dump($document->toPHP(['root' => 'object']));

echo "\ntoPHP() keeps the last value for array type maps\n";
var_dump($document->toPHP(['root' => 'array']));

echo "\ntoPHP() with the bson type map preserves duplicates\n";
$bsonDocument = $document->toPHP(['root' => 'bson']);
var_dump($bsonDocument instanceof MongoDB\BSON\Document);
echo $bsonDocument->toRelaxedExtendedJSON(), "\n";

echo "\nExtended JSON preserves duplicates\n";
echo $document->toRelaxedExtendedJSON(), "\n";
echo $document->toCanonicalExtendedJSON(), "\n";

?>
===DONE===
<?php exit(0); ?>
--EXPECTF--
Iteration returns both elements in order
string(3) "foo"
int(1)
string(3) "foo"
int(2)

get() and offsetGet() return the first value
int(1)
int(1)
bool(true)

toPHP() keeps the last value for object type maps
object(stdClass)#%d (1) {
["foo"]=>
int(2)
}
object(stdClass)#%d (1) {
["foo"]=>
int(2)
}

toPHP() keeps the last value for array type maps
array(1) {
["foo"]=>
int(2)
}

toPHP() with the bson type map preserves duplicates
bool(true)
{ "foo" : 1, "foo" : 2 }

Extended JSON preserves duplicates
{ "foo" : 1, "foo" : 2 }
{ "foo" : { "$numberInt" : "1" }, "foo" : { "$numberInt" : "2" } }
===DONE===
42 changes: 42 additions & 0 deletions tests/bson/bson-document-duplicate-keys-003.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
--TEST--
MongoDB\BSON\Document: Round-trip of BSON with duplicate keys
--DESCRIPTION--
BSON corpus spec prose test #2.3 (round-trip)
https://github.com/mongodb/specifications/blob/master/source/bson-corpus/bson-corpus.md#23-test-round-trip
--FILE--
<?php

require_once __DIR__ . '/../utils/basic.inc';

/* Bytes represent BSON for { "foo": 1, "foo": 2 } */
$bson = hex2bin('1700000010666f6f000100000010666f6f000200000000');
$document = MongoDB\BSON\Document::fromBSON($bson);

echo "Raw BSON is preserved\n";
var_dump((string) $document === $bson);

echo "\nRound-trip through Extended JSON preserves duplicates\n";
$fromJson = MongoDB\BSON\Document::fromJSON($document->toRelaxedExtendedJSON());
echo $fromJson->toRelaxedExtendedJSON(), "\n";
var_dump((string) $fromJson === $bson);

echo "\nRound-trip through PHP keeps the last value\n";
$roundTrip = MongoDB\BSON\Document::fromPHP($document->toPHP());
echo $roundTrip->toRelaxedExtendedJSON(), "\n";
var_dump((string) $roundTrip === $bson);

?>
===DONE===
<?php exit(0); ?>
--EXPECT--
Raw BSON is preserved
bool(true)

Round-trip through Extended JSON preserves duplicates
{ "foo" : 1, "foo" : 2 }
bool(true)

Round-trip through PHP keeps the last value
{ "foo" : 2 }
bool(false)
===DONE===
27 changes: 27 additions & 0 deletions tests/bson/bson-document-duplicate-keys-004.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
--TEST--
MongoDB\BSON\Document: Parsing Extended JSON with duplicate keys
--DESCRIPTION--
BSON corpus spec prose test #2.4 (parsing Extended JSON)
https://github.com/mongodb/specifications/blob/master/source/bson-corpus/bson-corpus.md#24-test-parsing-extended-json
--FILE--
<?php

require_once __DIR__ . '/../utils/basic.inc';

/* Bytes represent BSON for { "foo": 1, "foo": 2 } */
$expected = hex2bin('1700000010666f6f000100000010666f6f000200000000');

$document = MongoDB\BSON\Document::fromJSON('{ "foo": 1, "foo": 2 }');

echo "Duplicate keys are preserved in order\n";
echo $document->toRelaxedExtendedJSON(), "\n";
var_dump((string) $document === $expected);

?>
===DONE===
<?php exit(0); ?>
--EXPECT--
Duplicate keys are preserved in order
{ "foo" : 1, "foo" : 2 }
bool(true)
===DONE===
17 changes: 17 additions & 0 deletions tests/frankenphp/Caddyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
auto_https off
}

:80 {
root * /app/public
php_server {
worker {
file /app/public/worker.php
# A single worker, so a different instance identifier can only come
# from a restart of that worker.
num 1
# All requests go to the worker, whatever the requested path is.
match *
}
}
}
23 changes: 23 additions & 0 deletions tests/frankenphp/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Builds the extension from this checkout into the FrankenPHP image, so the
# functional test runs against the PHP build that FrankenPHP embeds (ZTS).
FROM dunglas/frankenphp:1.13.4-php8.5

# Dependencies needed by the bundled libmongoc and libmongocrypt builds.
RUN apt-get update && \
apt-get install --yes --no-install-recommends cmake libssl-dev libsasl2-dev && \
rm -rf /var/lib/apt/lists/*

COPY config.m4 Makefile.frag phongo.c phongo.h phongo_version.h /usr/src/mongodb/
COPY scripts /usr/src/mongodb/scripts
COPY src /usr/src/mongodb/src

WORKDIR /usr/src/mongodb

RUN phpize && \
./configure --with-php-config="$(command -v php-config)" && \
make -j "$(nproc)" && \
make install && \
docker-php-ext-enable mongodb

COPY tests/frankenphp/Caddyfile /etc/frankenphp/Caddyfile
COPY tests/frankenphp/worker.php /app/public/worker.php
Loading
Loading