Use BSON round-trip to normalize pipelines for comparison (mongodb#13)

* Use BSON round-trip to normalize pipelines for comparison
* Use Canonical Extended JSON
* Fix $regex comparison

Author: GromNaN

generator/config/query/regex.yaml

@@ -20,18 +20,18 @@ tests:
             -
                 $match:
                     sku:
-                        # Should be nested in $regex
-                        $regularExpression:
-                            pattern: '789$'
-                            options: ''
+                        $regex:
+                            $regularExpression:
+                                pattern: '789$'
+                                options: ''
     -
         name: 'Perform Case-Insensitive Regular Expression Match'
         link: 'https://www.mongodb.com/docs/manual/reference/operator/query/regex/#perform-case-insensitive-regular-expression-match'
         pipeline:
             -
                 $match:
                     sku:
-                        # Should be nested in $regex
-                        $regularExpression:
-                            pattern: '^ABC'
-                            options: 'i'
+                        $regex:
+                            $regularExpression:
+                                pattern: '^ABC'
+                                options: 'i'

generator/src/OperatorTestGenerator.php

@@ -4,6 +4,7 @@
 
 namespace MongoDB\CodeGenerator;
 
+use MongoDB\BSON\Document;
 use MongoDB\Builder\Pipeline;
 use MongoDB\CodeGenerator\Definition\GeneratorDefinition;
 use MongoDB\CodeGenerator\Definition\OperatorDefinition;
@@ -16,6 +17,7 @@
 use Throwable;
 
 use function basename;
+use function json_decode;
 use function json_encode;
 use function ksort;
 use function sprintf;
@@ -81,7 +83,9 @@ public function createClass(GeneratorDefinition $definition, OperatorDefinition
             $testName = 'test' . str_replace([' ', '-'], '', ucwords(str_replace('$', '', $test->name)));
             $caseName = str_replace([' ', '-'], '', ucwords(str_replace('$', '', $operator->name . ' ' . $test->name)));
 
-            $case = $dataEnum->addCase($caseName, new Literal('<<<\'JSON\'' . "\n" . json_encode($test->pipeline, JSON_PRETTY_PRINT) . "\n" . 'JSON'));
+            $json = Document::fromPHP(['pipeline' => $test->pipeline])->toCanonicalExtendedJSON();
+            $json = json_encode(json_decode($json)->pipeline, JSON_PRETTY_PRINT);
+            $case = $dataEnum->addCase($caseName, new Literal('<<<\'JSON\'' . "\n" . $json . "\n" . 'JSON'));
             $case->setComment($test->name);
             if ($test->link) {
                 $case->addComment('');

src/Builder/Type/OutputWindow.php

@@ -25,8 +25,6 @@
  */
 class OutputWindow implements WindowInterface
 {
-    public const ENCODE = Encode::Object;
-
     /**
      * Function used to initialize the state. The init function receives its arguments from the initArgs array expression.
      * You can specify the function definition as either BSON type Code or String.

tests/Builder/Accumulator/Pipelines.php

@@ -5,6 +5,7 @@
 namespace MongoDB\Tests\Builder;
 
 use Generator;
+use MongoDB\BSON\Document;
 use MongoDB\Builder\Accumulator;
 use MongoDB\Builder\BuilderEncoder;
 use MongoDB\Builder\Expression;
@@ -15,10 +16,7 @@
 use MongoDB\Builder\Variable;
 use PHPUnit\Framework\TestCase;
 
-use function array_is_list;
 use function array_merge;
-use function array_walk;
-use function is_array;
 use function MongoDB\object;
 use function var_export;
 
@@ -342,26 +340,11 @@ private static function assertSamePipeline(array $expected, Pipeline $pipeline):
         $codec = new BuilderEncoder();
         $actual = $codec->encode($pipeline);
 
-        self::objectify($expected);
+        // Normalize with BSON round-trip
+        // BSON Documents doesn't support top-level arrays.
+        $actual = Document::fromPHP(['root' => $actual])->toCanonicalExtendedJSON();
+        $expected = Document::fromPHP(['root' => $expected])->toCanonicalExtendedJSON();
 
-        self::assertEquals($expected, $actual, var_export($actual, true));
-    }
-
-    /**
-     * Recursively convert associative arrays to objects.
-     *
-     * @param array<mixed> $array
-     */
-    private static function objectify(array &$array): void
-    {
-        array_walk($array, function (&$value): void {
-            if (is_array($value)) {
-                self::objectify($value);
-
-                if (! array_is_list($value)) {
-                    $value = (object) $value;
-                }
-            }
-        });
+        self::assertJsonStringEqualsJsonString($expected, $actual, var_export($actual, true));
     }
 }

tests/Builder/BuilderEncoderTest.php

@@ -5,15 +5,12 @@
 namespace MongoDB\Tests\Builder;
 
 use BackedEnum;
+use MongoDB\BSON\Document;
 use MongoDB\Builder\BuilderEncoder;
 use MongoDB\Builder\Pipeline;
 use PHPUnit\Framework\TestCase;
 
-use function MongoDB\BSON\fromJSON;
-use function MongoDB\BSON\toPHP;
-use function var_export;
-
-class PipelineTestCase extends TestCase
+abstract class PipelineTestCase extends TestCase
 {
     final public static function assertSamePipeline(string|BackedEnum $expectedJson, Pipeline $pipeline): void
     {
@@ -22,11 +19,13 @@ final public static function assertSamePipeline(string|BackedEnum $expectedJson,
         }
 
         // BSON Documents doesn't support top-level arrays.
-        $expected = toPHP(fromJSON('{"root":' . $expectedJson . '}'))->root;
+        $expected = '{"pipeline":' . $expectedJson . '}';
 
         $codec = new BuilderEncoder();
         $actual = $codec->encode($pipeline);
+        // Normalize with BSON round-trip
+        $actual = Document::fromPHP(['pipeline' => $actual])->toCanonicalExtendedJSON();
 
-        self::assertEquals($expected, $actual, var_export($actual, true));
+        self::assertJsonStringEqualsJsonString($expected, $actual);
     }
 }

tests/Builder/PipelineTestCase.php

@@ -4,8 +4,8 @@
 
 namespace MongoDB\Tests\Builder\Query;
 
-use MongoDB\BSON\Regex;
 use MongoDB\Builder\Pipeline;
+use MongoDB\Builder\Query;
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
@@ -18,8 +18,7 @@ public function testPerformALIKEMatch(): void
     {
         $pipeline = new Pipeline(
             Stage::match(
-                // sku: \MongoDB\Builder\Query::regex('789$', ''),
-                sku: new Regex('789$', ''),
+                sku: Query::regex('789$', ''),
             ),
         );
 
@@ -30,8 +29,7 @@ public function testPerformCaseInsensitiveRegularExpressionMatch(): void
     {
         $pipeline = new Pipeline(
             Stage::match(
-                // sku: \MongoDB\Builder\Query::regex('^ABC', 'i'),
-                sku: new Regex('^ABC', 'i'),
+                sku: Query::regex('^ABC', 'i'),
             ),
         );