Allow Returning Arrays from find and aggregate Operations

ballerina/Dependencies.toml

@@ -27,6 +27,9 @@ dependencies = [
 	{org = "ballerina", name = "jballerina.java"},
 	{org = "ballerina", name = "lang.value"}
 ]
+modules = [
+	{org = "ballerina", packageName = "io", moduleName = "io"}
+]
 
 [[package]]
 org = "ballerina"
@@ -36,6 +39,26 @@ modules = [
 	{org = "ballerina", packageName = "jballerina.java", moduleName = "jballerina.java"}
 ]
 
+[[package]]
+org = "ballerina"
+name = "lang.__internal"
+version = "0.0.0"
+scope = "testOnly"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"},
+	{org = "ballerina", name = "lang.object"}
+]
+
+[[package]]
+org = "ballerina"
+name = "lang.array"
+version = "0.0.0"
+scope = "testOnly"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"},
+	{org = "ballerina", name = "lang.__internal"}
+]
+
 [[package]]
 org = "ballerina"
 name = "lang.error"
@@ -45,6 +68,12 @@ dependencies = [
 	{org = "ballerina", name = "jballerina.java"}
 ]
 
+[[package]]
+org = "ballerina"
+name = "lang.object"
+version = "0.0.0"
+scope = "testOnly"
+
 [[package]]
 org = "ballerina"
 name = "lang.value"
@@ -70,7 +99,7 @@ modules = [
 [[package]]
 org = "ballerina"
 name = "observe"
-version = "1.2.2"
+version = "1.2.3"
 dependencies = [
 	{org = "ballerina", name = "jballerina.java"}
 ]
@@ -82,6 +111,7 @@ version = "0.0.0"
 scope = "testOnly"
 dependencies = [
 	{org = "ballerina", name = "jballerina.java"},
+	{org = "ballerina", name = "lang.array"},
 	{org = "ballerina", name = "lang.error"}
 ]
 modules = [
@@ -102,6 +132,7 @@ name = "mongodb"
 version = "5.0.1"
 dependencies = [
 	{org = "ballerina", name = "crypto"},
+	{org = "ballerina", name = "io"},
 	{org = "ballerina", name = "jballerina.java"},
 	{org = "ballerina", name = "log"},
 	{org = "ballerina", name = "test"}

ballerina/build.gradle

@@ -91,26 +91,32 @@ task commitTomlFiles {
 }
 
 task startMongodbServer() {
-    doLast {
-        println("Starting mongodb server...")
-        exec {
-            if (Os.isFamily(Os.FAMILY_WINDOWS)) {
-                commandLine 'cmd', '/c', "docker-compose -f tests/resources/docker/docker-compose.yml up && exit %%ERRORLEVEL%%"
-            } else {
-                commandLine 'sh', '-c', "docker-compose -f tests/resources/docker/docker-compose.yml up -d"
+    gradle.taskGraph.whenReady { graph ->
+        if (graph.hasTask(":${packageName}-ballerina:test")) {
+            println("Starting mongodb server...")
+            exec {
+                if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+                    commandLine 'cmd', '/c', "docker-compose -f tests/resources/docker/docker-compose.yml up && exit %%ERRORLEVEL%%"
+                } else {
+                    commandLine 'sh', '-c', "docker-compose -f tests/resources/docker/docker-compose.yml up -d"
+                }
             }
         }
     }
 }
 
 task stopMongodbServer() {
     doLast {
-        println("Stopping mongodb server...")
-        exec {
-            if (Os.isFamily(Os.FAMILY_WINDOWS)) {
-                commandLine 'cmd', '/c', "docker-compose -f tests/resources/docker/docker-compose.yml down && exit %%ERRORLEVEL%%"
-            } else {
-                commandLine 'sh', '-c', "docker-compose -f tests/resources/docker/docker-compose.yml down"
+        gradle.taskGraph.whenReady { graph ->
+            if (graph.hasTask(":${packageName}-ballerina:test")) {
+                println("Stopping mongodb server...")
+                exec {
+                    if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+                        commandLine 'cmd', '/c', "docker-compose -f tests/resources/docker/docker-compose.yml down && exit %%ERRORLEVEL%%"
+                    } else {
+                        commandLine 'sh', '-c', "docker-compose -f tests/resources/docker/docker-compose.yml down"
+                    }
+                }
             }
         }
     }

ballerina/collection.bal

@@ -51,7 +51,8 @@ public isolated client class Collection {
     # + documents - The documents to insert
     # + options - The options to apply to the operation
     # + return - An error if the operation failed, otherwise nil
-    isolated remote function insertMany(record {|anydata...;|}[] documents, InsertManyOptions options = {}) returns Error? {
+    isolated remote function insertMany(record {|anydata...;|}[] documents, InsertManyOptions options = {})
+    returns Error? {
         string[] documentString = documents.'map((doc) => doc.toJsonString());
         return check insertMany(self, documentString, options);
     }
@@ -67,7 +68,8 @@ public isolated client class Collection {
     # + targetType - The type of the returned documents
     # + return - A stream of documents which match the provided filter, or an error if the operation failed
     isolated remote function find(map<json> filter = {}, FindOptions findOptions = {}, map<json>? projection = (),
-    typedesc<record {|anydata...;|}> targetType = <>) returns stream<targetType, error?>|Error = @java:Method {
+            typedesc<record {|anydata...;|}|record {|anydata...;|}[]> targetType = <>)
+            returns stream<targetType, error?>|Error = @java:Method {
         'class: "io.ballerina.lib.mongodb.Collection"
     } external;
 
@@ -80,7 +82,7 @@ public isolated client class Collection {
     # + targetType - The type of the returned document
     # + return - The document which matches the provided filter, or an error if the operation failed
     isolated remote function findOne(map<json> filter = {}, FindOptions findOptions = {}, map<json>? projection = (),
-    typedesc<record {|anydata...;|}> targetType = <>) returns targetType|Error? = @java:Method {
+            typedesc<record {|anydata...;|}> targetType = <>) returns targetType|Error? = @java:Method {
         'class: "io.ballerina.lib.mongodb.Collection"
     } external;
 
@@ -196,7 +198,7 @@ public isolated client class Collection {
     # + pipeline - The aggregation pipeline
     # + targetType - The type of the returned documents
     # + return - A stream of documents which match the provided pipeline, or an error if the operation failed
-    isolated remote function aggregate(map<json>[] pipeline, typedesc<anydata> targetType = <>)
+    isolated remote function aggregate(map<json>[] pipeline, typedesc<anydata|anydata[]> targetType = <>)
             returns stream<targetType, error?>|Error = @java:Method {
         'class: "io.ballerina.lib.mongodb.Collection"
     } external;

ballerina/tests/03_collection_tests.bal

@@ -620,6 +620,58 @@ isolated function testComplexFind() returns error? {
     check database->drop();
 }
 
+@test:Config {
+    groups: ["collection", "aggregate", "sort"]
+}
+isolated function testFindReturningArray() returns error? {
+    Database database = check mongoClient->getDatabase("testFindReturningArrayDB");
+    Collection tvShowsCollection = check database->getCollection("TvShows");
+    Collection directorsCollection = check database->getCollection("Directors");
+
+    TvShow tvShow1 = {title: "Breaking Bad", year: 2008, directorId: "1"};
+    TvShow tvShow2 = {title: "Game of Thrones", year: 2011, directorId: "2"};
+    TvShow tvShow3 = {title: "The Walking Dead", year: 2010, directorId: "3"};
+    TvShow tvShow4 = {title: "Better Call Saul", year: 2015, directorId: "1"};
+    check tvShowsCollection->insertMany([tvShow1, tvShow2, tvShow3, tvShow4]);
+
+    Director director1 = {id: "1", name: "Vince Gilligan"};
+    Director director2 = {id: "2", name: "David Benioff"};
+    Director director3 = {id: "3", name: "Frank Darabont"};
+    check directorsCollection->insertMany([director1, director2, director3]);
+
+    stream<record {
+        TvShow[] tvShows;
+    }, error?> result = check tvShowsCollection->aggregate([
+        {
+            \$group: {
+                _id: {directorId: "$directorId"},
+                tvShows: {
+                    \$push: {
+                        title: "$title",
+                        year: "$year",
+                        directorId: "$directorId"
+                    }
+                }
+            }
+        },
+        {
+            \$sort: {
+                "tvShows.directorId": 1
+            }
+        }
+    ]);
+    TvShow[][] actualResult = check from record {
+        TvShow[] tvShows;
+    } item in result
+        select item.tvShows;
+    TvShow[][] expectedResult = [[tvShow1, tvShow4], [tvShow2], [tvShow3]];
+    check result.close();
+    check tvShowsCollection->drop();
+    check directorsCollection->drop();
+    check database->drop();
+    test:assertEquals(actualResult, expectedResult);
+}
+
 @test:Config {
     groups: ["collection", "insert", "aggregate", "projection"]
 }

ballerina/tests/types.bal

@@ -47,3 +47,14 @@ type Author readonly & record {|
     string name;
     Book[] books;
 |};
+
+type TvShow record {|
+    string title;
+    int year;
+    string directorId;
+|};
+
+type Director record {|
+    string id;
+    string name;
+|};

changelog.md

@@ -1,11 +1,18 @@
 # Change Log
+
 This file contains all the notable changes done to the Ballerina GraphQL package through the releases.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Added
+
+- [[#6377] Allow Returning Arrays from `find` and `aggregate` Operations](https://github.com/ballerina-platform/ballerina-standard-library/issues/6377)
+
+## [5.0.0] - 2024-04-02
+
 ### Changed
 
 - [[#5073] Revamping the connector with new Client, Database, and Collection model](https://github.com/ballerina-platform/ballerina-standard-library/issues/5073)