Skip to content

PHPC-2347: Deprecate BSON functions #1607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 11, 2024
Merged

PHPC-2347: Deprecate BSON functions #1607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
705f2aa
PHPC-2347: Deprecate BSON functions
alcaeus Jul 10, 2024
7e528ae
Remove deprecated functionality from BSON corpus tests
alcaeus Jul 10, 2024
8d75a3c
Change test-only BSON functions to use BSON document class
alcaeus Jul 10, 2024
324792d
Fix changed test expectations
alcaeus Jul 10, 2024
f65d546
Account for deprecations in BSON function tests
alcaeus Jul 10, 2024
b04ac3b
Don't use deprecated functions in tests where possible
alcaeus Jul 10, 2024
ca35bb6
Suggest replacement methods with deprecations
alcaeus Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
46 changes: 3 additions & 43 deletions scripts/convert-bson-corpus-tests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,8 @@
require_once __DIR__ . '/../tests/utils/basic.inc';

$expectedFailures = [
'Int64 type: -1' => 'PHP encodes integers as 32-bit if range allows',
'Int64 type: 0' => 'PHP encodes integers as 32-bit if range allows',
'Int64 type: 1' => 'PHP encodes integers as 32-bit if range allows',
'Javascript Code: Embedded nulls' => 'Embedded null in code string is not supported in libbson (CDRIVER-1879)',
'Javascript Code with Scope: Unicode and embedded null in code string, empty scope' => 'Embedded null in code string is not supported in libbson (CDRIVER-1879)',
'Multiple types within the same document: All BSON types' => 'PHP encodes integers as 32-bit if range allows',
'Top-level document validity: Bad $date (number, not string or hash)' => 'Legacy extended JSON $date syntax uses numbers (CDRIVER-2223)',
];

Expand Down Expand Up @@ -147,85 +143,49 @@ function getParamsForValid(array $test, array $case)
$code .= sprintf('$convertedExtJson = %s;', var_export($convertedExtJson, true)) . "\n";
}

$code .= "\n// Canonical BSON -> Native -> Canonical BSON\n";
$code .= 'echo bin2hex(fromPHP(toPHP($canonicalBson))), "\n";' . "\n";
$expect .= $expectedCanonicalBson . "\n";

$code .= "\n// Canonical BSON -> BSON object -> Canonical BSON\n";
$code .= 'echo bin2hex((string) MongoDB\BSON\Document::fromBSON($canonicalBson)), "\n";' . "\n";
$expect .= $expectedCanonicalBson . "\n";

$code .= "\n// Canonical BSON -> Canonical extJSON\n";
$code .= 'echo json_canonicalize(toCanonicalExtendedJSON($canonicalBson)), "\n";' . "\n";
$expect .= $expectedCanonicalExtJson . "\n";

$code .= "\n// Canonical BSON -> BSON object -> Canonical extJSON\n";
$code .= 'echo json_canonicalize(MongoDB\BSON\Document::fromBSON($canonicalBson)->toCanonicalExtendedJSON()), "\n";' . "\n";
$expect .= $expectedCanonicalExtJson . "\n";

if (isset($relaxedExtJson)) {
$code .= "\n// Canonical BSON -> Relaxed extJSON\n";
$code .= 'echo json_canonicalize(toRelaxedExtendedJSON($canonicalBson)), "\n";' . "\n";
$expect .= $expectedRelaxedExtJson . "\n";

$code .= "\n// Canonical BSON -> BSON object -> Relaxed extJSON\n";
$code .= 'echo json_canonicalize(MongoDB\BSON\Document::fromBSON($canonicalBson)->toRelaxedExtendedJSON()), "\n";' . "\n";
$expect .= $expectedRelaxedExtJson . "\n";
}

if (!$lossy) {
$code .= "\n// Canonical extJSON -> Canonical BSON\n";
$code .= 'echo bin2hex(fromJSON($canonicalExtJson)), "\n";' . "\n";
$expect .= $expectedCanonicalBson . "\n";

$code .= "\n// Canonical extJSON -> BSON object -> Canonical BSON\n";
$code .= 'echo bin2hex((string) MongoDB\BSON\Document::fromJSON($canonicalExtJson)), "\n";' . "\n";
$expect .= $expectedCanonicalBson . "\n";
}

if (isset($degenerateBson)) {
$code .= "\n// Degenerate BSON -> Native -> Canonical BSON\n";
$code .= 'echo bin2hex(fromPHP(toPHP($degenerateBson))), "\n";' . "\n";
$expect .= $expectedCanonicalBson . "\n";

$code .= "\n// Degenerate BSON -> BSON object -> Canonical BSON\n";
$code .= 'echo bin2hex(fromPHP(MongoDB\BSON\Document::fromBSON($degenerateBson)->toPHP())), "\n";' . "\n";
$code .= 'echo bin2hex((string) MongoDB\BSON\Document::fromPHP(MongoDB\BSON\Document::fromBSON($degenerateBson)->toPHP())), "\n";' . "\n";
$expect .= $expectedCanonicalBson . "\n";

$code .= "\n// Degenerate BSON -> Canonical extJSON\n";
$code .= 'echo json_canonicalize(toCanonicalExtendedJSON($degenerateBson)), "\n";' . "\n";
$expect .= $expectedCanonicalExtJson . "\n";

$code .= "\n// Degenerate BSON -> BSON object -> Canonical extJSON\n";
$code .= 'echo json_canonicalize(MongoDB\BSON\Document::fromBSON($degenerateBson)->toCanonicalExtendedJSON()), "\n";' . "\n";
$expect .= $expectedCanonicalExtJson . "\n";

if (isset($relaxedExtJson)) {
$code .= "\n// Degenerate BSON -> Relaxed extJSON\n";
$code .= 'echo json_canonicalize(toRelaxedExtendedJSON($degenerateBson)), "\n";' . "\n";
$expect .= $expectedRelaxedExtJson . "\n";

$code .= "\n// Degenerate BSON -> BSON object -> Relaxed extJSON\n";
$code .= 'echo json_canonicalize(MongoDB\BSON\Document::fromBSON($degenerateBson)->toRelaxedExtendedJSON()), "\n";' . "\n";
$expect .= $expectedRelaxedExtJson . "\n";
}
}

if (isset($degenerateExtJson) && !$lossy) {
$code .= "\n// Degenerate extJSON -> Canonical BSON\n";
$code .= 'echo bin2hex(fromJSON($degenerateExtJson)), "\n";' . "\n";
$expect .= $expectedCanonicalBson . "\n";

$code .= "\n// Degenerate extJSON -> BSON object -> Canonical BSON\n";
$code .= 'echo bin2hex((string) MongoDB\BSON\Document::fromJSON($degenerateExtJson)), "\n";' . "\n";
$expect .= $expectedCanonicalBson . "\n";
}

if (isset($relaxedExtJson)) {
$code .= "\n// Relaxed extJSON -> BSON -> Relaxed extJSON\n";
$code .= 'echo json_canonicalize(toRelaxedExtendedJSON(fromJSON($relaxedExtJson))), "\n";' . "\n";
$expect .= $expectedRelaxedExtJson . "\n";

$code .= "\n// Relaxed extJSON -> BSON object -> Relaxed extJSON\n";
$code .= 'echo json_canonicalize(MongoDB\BSON\Document::fromJSON($relaxedExtJson)->toRelaxedExtendedJSON()), "\n";' . "\n";
$expect .= $expectedRelaxedExtJson . "\n";
Expand All @@ -248,7 +208,7 @@ function getParamsForDecodeError(array $test, array $case)

$code = sprintf('$bson = hex2bin(%s);', var_export($case['bson'], true)) . "\n\n";
$code .= "throws(function() use (\$bson) {\n";
$code .= " var_dump(toPHP(\$bson));\n";
$code .= " MongoDB\\BSON\\Document::fromBSON(\$bson)->toPHP();\n";
$code .= "}, 'MongoDB\Driver\Exception\UnexpectedValueException');";

/* We do not test for the exception message, since that may differ based on
Expand Down Expand Up @@ -277,7 +237,7 @@ function getParamsForParseError(array $test, array $case)
case '0x00': // Top-level document
case '0x05': // Binary
$code = "throws(function() {\n";
$code .= sprintf(" fromJSON(%s);\n", var_export($case['string'], true));
$code .= sprintf(" MongoDB\\BSON\\Document::fromJSON(%s);\n", var_export($case['string'], true));
$code .= "}, 'MongoDB\Driver\Exception\UnexpectedValueException');";

/* We do not test for the exception message, since that may differ
Expand Down
16 changes: 14 additions & 2 deletions src/functions.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,38 @@
/** @generate-function-entries */

namespace MongoDB\BSON {
/** @deprecated use MongoDB\BSON\Document::fromJSON instead */
function fromJSON(string $json): string {}

#if PHP_VERSION_ID >= 80000
/** @deprecated use MongoDB\BSON\Document::fromPHP instead */
function fromPHP(array|object $value): string {}
#else
/** @param array|object $value */
/**
* @param array|object $value
* @deprecated use MongoDB\BSON\Document::fromPHP instead
*/
function fromPHP($value): string {}
#endif

/** @deprecated use MongoDB\BSON\Document::toCanonicalExtendedJSON instead */
function toCanonicalExtendedJSON(string $bson): string {}

/** @deprecated */
function toJSON(string $bson): string {}

#if PHP_VERSION_ID >= 80000
/** @deprecated use MongoDB\BSON\Document::toPHP instead */
function toPHP(string $bson, ?array $typemap = null): array|object {}
#else
/** @return array|object */
/**
* @return array|object
* @deprecated use MongoDB\BSON\Document::toPHP instead
*/
function toPHP(string $bson, ?array $typemap = null) {}
#endif

/** @deprecated use MongoDB\BSON\Document::toRelaxedExtendedJSON instead */
function toRelaxedExtendedJSON(string $bson): string {}
}

Expand Down
18 changes: 9 additions & 9 deletions src/functions_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/bson-corpus/array-decodeError-001.phpt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/bson-corpus/array-decodeError-002.phpt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/bson-corpus/array-decodeError-003.phpt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 0 additions & 12 deletions tests/bson-corpus/array-valid-001.phpt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 0 additions & 12 deletions tests/bson-corpus/array-valid-002.phpt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 1 addition & 21 deletions tests/bson-corpus/array-valid-003.phpt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 1 addition & 21 deletions tests/bson-corpus/array-valid-004.phpt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading