Merge pull request #429 from ianmeigh/feature/add-default-site-filter-to-sites-query

Add `isDefaultSite` filter to sites query

Author: jams2

CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## [0.31.0] - 2026-04-21
+
+### Added
+
+- Add an `is_default_site` filter to the sites query ([#429](https://github.com/torchbox/wagtail-grapple/pull/429)) @ianmeigh
+
 ## [0.30.0] - 2026-03-20
 
 ### Added
@@ -430,7 +436,8 @@
 -   Improve field definition and under-the-hood implementation ([#28](https://github.com/torchbox/wagtail-grapple/pull/28))
 -   Add conditional checks when resolving streamfield type ([#29](https://github.com/torchbox/wagtail-grapple/pull/29))
 
-[unreleased]: https://github.com/torchbox/wagtail-grapple/compare/v0.30.0...HEAD
+[unreleased]: https://github.com/torchbox/wagtail-grapple/compare/v0.31.0...HEAD
+[0.31.0]: https://github.com/torchbox/wagtail-grapple/compare/v0.30.0...v0.31.0
 [0.30.0]: https://github.com/torchbox/wagtail-grapple/compare/v0.29.0...v0.30.0
 [0.29.0]: https://github.com/torchbox/wagtail-grapple/compare/v0.28.0...v0.29.0
 [0.28.0]: https://github.com/torchbox/wagtail-grapple/compare/v0.27.0...v0.28.0

docs/general-usage/graphql-types.rst

@@ -155,12 +155,19 @@ the ``sites`` or ``site`` field on the root query type. Available fields for the
     pages(limit: PositiveInt, offset: PositiveInt, order: String, searchQuery: String, id: ID): [PageInterface]
 
 
-The plural ``sites`` field can be queried like so:
+The plural ``sites`` field accepts the following arguments:
+
+::
+
+    # Optionally filters sites by their default site status. Omitting this returns all sites.
+    is_default_site: Boolean
+
+and can be queried like so:
 
 ::
 
     query {
-        sites {
+        sites (isDefaultSite: true) {
             port
             hostname
         }

grapple/__init__.py

@@ -1 +1 @@
-__version__ = "0.30.0"
+__version__ = "0.31.0"

grapple/types/sites.py

@@ -72,15 +72,24 @@ class Mixin:
             SiteObjectType, hostname=graphene.String(), id=graphene.ID()
         )
         sites = QuerySetList(
-            graphene.NonNull(SiteObjectType), enable_search=True, required=True
+            graphene.NonNull(SiteObjectType),
+            enable_search=True,
+            required=True,
+            is_default_site=graphene.Argument(graphene.Boolean),
         )
 
         def resolve_sites(self, info, **kwargs) -> QuerySet[Site]:
             """
-            Return all `Site` objects.
+            Return all `Site` objects, optionally filtered to those where
+            `is_default_site` matches the provided value.
             """
 
-            return resolve_queryset(Site.objects.all(), info, **kwargs)
+            qs = Site.objects.all()
+
+            if (is_default := kwargs.get("is_default_site")) is not None:
+                qs = qs.filter(is_default_site=is_default)
+
+            return resolve_queryset(qs, info, **kwargs)
 
         def resolve_site(self, info, **kwargs) -> Optional[Site]:
             """

tests/test_grapple.py

@@ -742,6 +742,8 @@ def test_with_multisite(self):
 
 class SitesTest(TestCase):
     def setUp(self):
+        # Default site is created in testapp migration (002_create_homepage.py)
+
         self.site = wagtail_factories.SiteFactory(
             hostname="grapple.localhost", site_name="Grapple test site"
         )
@@ -784,6 +786,28 @@ def test_sites(self):
         self.assertEqual(type(executed["data"]["sites"]), list)
         self.assertEqual(len(executed["data"]["sites"]), Site.objects.count())
 
+    def test_sites_is_default_site_filter(self):
+        query = """
+        query($isDefaultSite: Boolean) {
+            sites(isDefaultSite: $isDefaultSite) {
+                isDefaultSite
+            }
+        }
+        """
+        total_non_default_sites = Site.objects.filter(is_default_site=False).count()
+        cases = [
+            (True, 1),
+            (False, total_non_default_sites),
+        ]
+
+        for value, expected_count in cases:
+            with self.subTest(isDefaultSite=value):
+                results = self.client.execute(
+                    query,
+                    variables={"isDefaultSite": value},
+                )
+                self.assertEqual(len(results["data"]["sites"]), expected_count)
+
     def test_site(self):
         query = """
         query($hostname: String) {