feat: exclude system collections, add engine collection type to getTables

Author: masterbater

src/Schema/Builder.php

@@ -29,6 +29,7 @@
 use function sort;
 use function sprintf;
 use function str_ends_with;
+use function str_starts_with;
 use function substr;
 use function usort;
 
@@ -148,11 +149,25 @@ public function getTables($schema = null)
         $db = $this->connection->getDatabase($schema);
         $collections = [];
 
-        foreach ($db->listCollectionNames() as $collectionName) {
-            $stats = $db->selectCollection($collectionName)->aggregate([
-                ['$collStats' => ['storageStats' => ['scale' => 1]]],
-                ['$project' => ['storageStats.totalSize' => 1]],
-            ])->toArray();
+        foreach ($db->listCollections() as $collectionInfo) {
+            $collectionName = $collectionInfo->getName();
+
+            // Skip system collections
+            if (str_starts_with($collectionName, 'system.')) {
+                continue;
+            }
+
+            // Skip views it doesnt suport aggregate
+            $isView = ($collectionInfo['type'] ?? '') === 'view';
+            $stats = null;
+
+            if (! $isView) {
+                // Only run aggregation if it's a normal collection
+                $stats = $db->selectCollection($collectionName)->aggregate([
+                    ['$collStats' => ['storageStats' => ['scale' => 1]]],
+                    ['$project' => ['storageStats.totalSize' => 1]],
+                ])->toArray();
+            }
 
             $collections[] = [
                 'name' => $collectionName,
@@ -161,13 +176,11 @@ public function getTables($schema = null)
                 'size' => $stats[0]?->storageStats?->totalSize ?? null,
                 'comment' => null,
                 'collation' => null,
-                'engine' => null,
+                'engine' => $isView ? 'view' : 'collection',
             ];
         }
 
-        usort($collections, function ($a, $b) {
-            return $a['name'] <=> $b['name'];
-        });
+        usort($collections, fn ($a, $b) => $a['name'] <=> $b['name']);
 
         return $collections;
     }
@@ -196,6 +209,9 @@ public function getTableListing($schema = null, $schemaQualified = false)
 
         $collections = array_merge(...array_values($collections));
 
+        // Exclude system collections before sorting
+        $collections = array_filter($collections, fn ($name) => ! str_starts_with($name, 'system.'));
+
         sort($collections);
 
         return $collections;
@@ -346,7 +362,14 @@ protected function getAllCollections()
     {
         $collections = [];
         foreach ($this->connection->getDatabase()->listCollections() as $collection) {
-            $collections[] = $collection->getName();
+            $name = $collection->getName();
+
+            // Skip system collections
+            if (str_starts_with($name, 'system.')) {
+                continue;
+            }
+
+            $collections[] = $name;
         }
 
         return $collections;

tests/SchemaTest.php

@@ -17,15 +17,17 @@
 use function collect;
 use function count;
 use function sprintf;
+use function str_starts_with;
 
 class SchemaTest extends TestCase
 {
     public function tearDown(): void
     {
-        $database = $this->getConnection('mongodb')->getMongoDB();
+        $database = $this->getConnection('mongodb')->getDatabase();
         assert($database instanceof Database);
         $database->dropCollection('newcollection');
         $database->dropCollection('newcollection_two');
+        $database->dropCollection('test_view');
 
         parent::tearDown();
     }
@@ -397,6 +399,13 @@ public function testGetTables()
         DB::connection('mongodb')->table('newcollection_two')->insert(['test' => 'value']);
         $dbName = DB::connection('mongodb')->getDatabaseName();
 
+        // Create a view (this creates system.views)
+        DB::connection('mongodb')->getDatabase()->command([
+            'create' => 'test_view',
+            'viewOn' => 'newcollection',
+            'pipeline' => [],
+        ]);
+
         $tables = Schema::getTables();
         $this->assertIsArray($tables);
         $this->assertGreaterThanOrEqual(2, count($tables));
@@ -413,6 +422,9 @@ public function testGetTables()
                 $this->assertEquals($dbName . '.newcollection', $table['schema_qualified_name']);
                 $found = true;
             }
+
+            // Ensure system collections are excluded
+            $this->assertFalse(str_starts_with($table['name'], 'system.'));
         }
 
         if (! $found) {
@@ -425,12 +437,22 @@ public function testGetTableListing()
         DB::connection('mongodb')->table('newcollection')->insert(['test' => 'value']);
         DB::connection('mongodb')->table('newcollection_two')->insert(['test' => 'value']);
 
+         // Create a view (this creates system.views)
+        DB::connection('mongodb')->getDatabase()->command([
+            'create' => 'test_view',
+            'viewOn' => 'newcollection',
+            'pipeline' => [],
+        ]);
+
         $tables = Schema::getTableListing();
 
         $this->assertIsArray($tables);
         $this->assertGreaterThanOrEqual(2, count($tables));
         $this->assertContains('newcollection', $tables);
         $this->assertContains('newcollection_two', $tables);
+
+        // Ensure system collections are excluded
+        $this->assertNotContains('system.views', $tables);
     }
 
     public function testGetTableListingBySchema()
@@ -453,6 +475,58 @@ public function testGetTableListingBySchema()
         $this->assertContains('newcollection', $tables);
         $this->assertContains('newcollection_two', $tables);
     }
+// Protected method cannot test
+    // public function testGetAllCollections()
+    // {
+    //     // Insert test data into normal collections
+    //     DB::connection('mongodb')->table('newcollection')->insert(['test' => 'value']);
+    //     DB::connection('mongodb')->table('newcollection_two')->insert(['test' => 'value']);
+
+    //     // Create a view (this creates system.views)
+    //     DB::connection('mongodb')->getDatabase()->command([
+    //         'create' => 'test_view',
+    //         'viewOn' => 'newcollection',
+    //         'pipeline' => [],
+    //     ]);
+
+    //     $collections = Schema::getAllCollections();
+
+    //     $this->assertIsArray($collections);
+    //     $this->assertGreaterThanOrEqual(2, count($collections));
+
+    //     // Ensure normal collections are present
+    //     $this->assertContains('newcollection', $collections);
+    //     $this->assertContains('newcollection_two', $collections);
+
+    //     // Ensure system collections are excluded
+    //     $this->assertNotContains('system.views', $collections);
+    // }
+
+    public function testSystemCollectionsArePresentButFiltered()
+    {
+        // Create a view to trigger system.views collection
+        DB::connection('mongodb')->getDatabase()->command([
+            'create' => 'test_view',
+            'viewOn' => 'newcollection',
+            'pipeline' => [],
+        ]);
+
+        // Get all collections directly from MongoDB
+        $allCollections = DB::connection('mongodb')->getDatabase()->listCollectionNames();
+
+        // Ensure the system.views collection exists in MongoDB
+        $this->assertContains('system.views', $allCollections);
+
+        // Ensure Schema::getTables does NOT include system collections
+        $tables = Schema::getTables();
+        foreach ($tables as $table) {
+            $this->assertFalse(str_starts_with($table['name'], 'system.'));
+        }
+
+        // Ensure Schema::getTableListing does NOT include system collections
+        $tableListing = Schema::getTableListing();
+        $this->assertNotContains('system.views', $tableListing);
+    }
 
     public function testGetColumns()
     {