PHPLIB-1348 Add tests on Custom Aggregation Expression Operators

generator/config/accumulator/accumulator.yaml

@@ -64,14 +64,29 @@ tests:
                     avgCopies:
                         $accumulator:
                             init:
-                                $code: 'function () { return { count: 0, sum: 0 } }'
+                                $code: |-
+                                    function() {
+                                        return { count: 0, sum: 0 }
+                                    }
                             accumulate:
-                                $code: 'function (state, numCopies) { return { count: state.count + 1, sum: state.sum + numCopies } }'
+                                $code: |-
+                                    function(state, numCopies) {
+                                        return { count: state.count + 1, sum: state.sum + numCopies }
+                                    }
                             accumulateArgs: [ "$copies" ],
                             merge:
-                                $code: 'function (state1, state2) { return { count: state1.count + state2.count, sum: state1.sum + state2.sum } }'
+                                $code: |-
+                                    function(state1, state2) {
+                                        return {
+                                            count: state1.count + state2.count,
+                                            sum: state1.sum + state2.sum
+                                        }
+                                    }
                             finalize:
-                                $code: 'function (state) { return (state.sum / state.count) }'
+                                $code: |-
+                                    function(state) {
+                                        return (state.sum / state.count)
+                                    }
                             lang: 'js'
 
     -
@@ -85,16 +100,34 @@ tests:
                     restaurants:
                         $accumulator:
                             init:
-                                $code: 'function (city, userProfileCity) { return { max: city === userProfileCity ? 3 : 1, restaurants: [] } }'
+                                $code: |-
+                                    function(city, userProfileCity) {
+                                        return { max: city === userProfileCity ? 3 : 1, restaurants: [] }
+                                    }
                             initArgs:
                                 - '$city'
                                 - 'Bettles'
                             accumulate:
-                                $code: 'function (state, restaurantName) { if (state.restaurants.length < state.max) { state.restaurants.push(restaurantName); } return state; }'
+                                $code: |-
+                                    function(state, restaurantName) {
+                                        if (state.restaurants.length < state.max) {
+                                            state.restaurants.push(restaurantName);
+                                        }
+                                        return state;
+                                    }
                             accumulateArgs:
                                 - '$name'
                             merge:
-                                $code: 'function (state1, state2) { return { max: state1.max, restaurants: state1.restaurants.concat(state2.restaurants).slice(0, state1.max) } }'
+                                $code: |-
+                                    function(state1, state2) {
+                                        return {
+                                            max: state1.max,
+                                            restaurants: state1.restaurants.concat(state2.restaurants).slice(0, state1.max)
+                                        }
+                                    }
                             finalize:
-                                $code: 'function (state) { return state.restaurants }'
+                                $code: |-
+                                    function(state) {
+                                        return state.restaurants
+                                    }
                             lang: 'js'

generator/config/expression/function.yaml

@@ -21,8 +21,54 @@ arguments:
             - array
         description: |
             Arguments passed to the function body. If the body function does not take an argument, you can specify an empty array [ ].
+        default: []
     -
         name: lang
         type:
             - string
         default: js
+tests:
+    -
+        name: 'Usage Example'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/function/#example-1--usage-example'
+        pipeline:
+            -
+                $addFields:
+                    isFound:
+                        $function:
+                            body:
+                                $code: |-
+                                    function(name) {
+                                        return hex_md5(name) == "15b0a220baa16331e8d80e15367677ad"
+                                    }
+                            args:
+                                - '$name'
+                            lang: 'js'
+                    message:
+                        $function:
+                            body:
+                                $code: |-
+                                    function(name, scores) {
+                                        let total = Array.sum(scores);
+                                        return `Hello ${name}. Your total score is ${total}.`
+                                    }
+                            args:
+                                - '$name'
+                                - '$scores'
+                            lang: 'js'
+    -
+        name: 'Alternative to $where'
+        link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/function/#example-2--alternative-to--where'
+        pipeline:
+            -
+                $match:
+                    $expr:
+                        $function:
+                            body:
+                                $code: |-
+                                    function(name) {
+                                        return hex_md5(name) == "15b0a220baa16331e8d80e15367677ad";
+                                    }
+                            args:
+                                - '$name'
+                            lang: 'js'

generator/config/query/where.yaml

@@ -18,14 +18,19 @@ tests:
         pipeline:
             -
                 $match:
-                    $where: 'function() { return hex_md5(this.name) == "9b53e667f30cd329dca1ec9e6a83e994" }'
+                    $where:
+                        $code: |-
+                            function() {
+                                return hex_md5(this.name) == "9b53e667f30cd329dca1ec9e6a83e994"
+                            }
             -
                 $match:
                     $expr:
                         $function:
-                            body: |-
-                                function(name) {
-                                    return hex_md5(name) == "9b53e667f30cd329dca1ec9e6a83e994";
-                                }
+                            body:
+                                $code: |-
+                                    function(name) {
+                                        return hex_md5(name) == "9b53e667f30cd329dca1ec9e6a83e994";
+                                    }
                             args: ['$name']
                             lang: 'js'

generator/config/schema.json

@@ -166,7 +166,7 @@
                 },
                 "default": {
                     "$comment": "The default value for the argument.",
-                    "type": ["string", "number", "boolean"]
+                    "type": ["array", "boolean", "number", "string"]
                 }
             },
             "required": [

generator/src/OperatorClassGenerator.php

@@ -4,6 +4,7 @@
 
 namespace MongoDB\CodeGenerator;
 
+use MongoDB\BSON\Javascript;
 use MongoDB\Builder\Type\Encode;
 use MongoDB\Builder\Type\OperatorInterface;
 use MongoDB\Builder\Type\QueryObject;
@@ -151,6 +152,17 @@ public function createClass(GeneratorDefinition $definition, OperatorDefinition
 
                     PHP);
                 }
+
+                if ($type->javascript) {
+                    $namespace->addUseFunction('is_string');
+                    $namespace->addUse(Javascript::class);
+                    $constuctor->addBody(<<<PHP
+                    if (is_string(\${$argument->name})) {
+                        \${$argument->name} = new Javascript(\${$argument->name});
+                    }
+
+                    PHP);
+                }
             }
 
             // Set property from constructor argument

generator/src/OperatorFactoryGenerator.php

@@ -80,6 +80,8 @@ private function addMethod(GeneratorDefinition $definition, OperatorDefinition $
             } else {
                 if ($argument->optional) {
                     $parameter->setDefaultValue(new Literal('Optional::Undefined'));
+                } elseif ($argument->default !== null) {
+                    $parameter->setDefaultValue($argument->default);
                 }
 
                 $method->addComment('@param ' . $type->doc . ' $' . $argument->name . rtrim(' ' . $argument->description));

generator/src/OperatorGenerator.php

@@ -71,7 +71,7 @@ final protected function getType(string $type): ExpressionDefinition
      * Expression types can contain class names, interface, native types or "list".
      * PHPDoc types are more precise than native types, so we use them systematically even if redundant.
      *
-     * @return object{native:string,doc:string,use:list<class-string>,list:bool,query:bool}
+     * @return object{native:string,doc:string,use:list<class-string>,list:bool,query:bool,javascript:bool}
      */
     final protected function getAcceptedTypes(ArgumentDefinition $arg): stdClass
     {
@@ -117,6 +117,9 @@ final protected function getAcceptedTypes(ArgumentDefinition $arg): stdClass
         // If the argument is a query, we need to convert it to a QueryObject
         $isQuery = in_array('query', $arg->type, true);
 
+        // If the argument is code, we need to convert it to a Javascript object
+        $isJavascript = in_array('javascript', $arg->type, true);
+
         // mixed can only be used as a standalone type
         if (in_array('mixed', $nativeTypes, true)) {
             $nativeTypes = ['mixed'];
@@ -132,6 +135,7 @@ final protected function getAcceptedTypes(ArgumentDefinition $arg): stdClass
             'use' => array_unique($use),
             'list' => $listCheck,
             'query' => $isQuery,
+            'javascript' => $isJavascript,
         ];
     }