[#1716] Filter by multiple zone types

Author: msiodelski

api/swagger.in.yaml

@@ -116,7 +116,7 @@ definitions:
         $ref: '#/definitions/VersionDetails'
       currentStable:
         type: array
-        items: 
+        items:
           $ref: '#/definitions/VersionDetails'
       latestSecure:
         type: array
@@ -180,15 +180,14 @@ definitions:
   DNSZoneType:
     type: string
     enum: &DNSZONETYPE
+      - builtin
       - delegation-only
       - forward
       - hint
-      - master
       - mirror
       - primary
       - redirect
       - secondary
-      - slave
       - static-stub
       - stub
 
@@ -244,5 +243,9 @@ parameters:
     in: query
     description: >-
       Limit returned list of entities (e.g. zones) to the ones of a given type.
-    type: string
-    enum: *DNSZONETYPE
+      Multiple zone types can be specified. If unspecified, all zone types are returned.
+    type: array
+    items:
+      type: string
+      enum: *DNSZONETYPE
+    collectionFormat: multi

backend/server/database/migrations/63_zone_type_index.go

@@ -0,0 +1,18 @@
+package dbmigs
+
+import "github.com/go-pg/migrations/v8"
+
+func init() {
+	migrations.MustRegisterTx(func(db migrations.DB) error {
+		_, err := db.Exec(`
+			-- Create an index on the type column of the local_zone table.
+			CREATE INDEX local_zone_type_idx ON local_zone(type);
+		`)
+		return err
+	}, func(db migrations.DB) error {
+		_, err := db.Exec(`
+			DROP INDEX IF EXISTS local_zone_type_idx;
+		`)
+		return err
+	})
+}

backend/server/database/migrations_test.go

@@ -21,7 +21,7 @@ import (
 
 // Current schema version. This value must be bumped up every
 // time the schema is updated.
-const expectedSchemaVersion int64 = 62
+const expectedSchemaVersion int64 = 63
 
 // Common function which tests a selected migration action.
 func testMigrateAction(t *testing.T, db *dbops.PgDB, expectedOldVersion, expectedNewVersion int64, action ...string) {

backend/server/database/model/zone.go

@@ -2,6 +2,7 @@ package dbmodel
 
 import (
 	"context"
+	"iter"
 	"slices"
 	"strings"
 	"time"
@@ -20,6 +21,59 @@ const (
 	ZoneRelationLocalZonesApp = "LocalZones.Daemon.App"
 )
 
+type ZoneType string
+
+const (
+	ZoneTypeBuiltin        ZoneType = "builtin"
+	ZoneTypeDelegationOnly ZoneType = "delegation-only"
+	ZoneTypeForward        ZoneType = "forward"
+	ZoneTypeHint           ZoneType = "hint"
+	ZoneTypeMirror         ZoneType = "mirror"
+	ZoneTypePrimary        ZoneType = "primary"
+	ZoneTypeRedirect       ZoneType = "redirect"
+	ZoneTypeSecondary      ZoneType = "secondary"
+	ZoneTypeStaticStub     ZoneType = "static-stub"
+	ZoneTypeStub           ZoneType = "stub"
+)
+
+// Holds a set of zone types by which the zones should be filtered.
+// If there are no types specified, all zones are returned.
+// Otherwise, the zones matching the enabled filters are returned.
+type GetZonesFilterZoneTypes struct {
+	types map[ZoneType]bool
+}
+
+// Instantiates the zone types filter.
+func NewGetZonesFilterZoneTypes() *GetZonesFilterZoneTypes {
+	return &GetZonesFilterZoneTypes{
+		types: make(map[ZoneType]bool),
+	}
+}
+
+// Enables a filter for a specific zone type. The zones of the matching
+// type are returned.
+func (f *GetZonesFilterZoneTypes) Enable(zoneType ZoneType) {
+	f.types[zoneType] = true
+}
+
+// Returns true if any filter is specified (enabled or disabled).
+func (f *GetZonesFilterZoneTypes) IsAnySpecified() bool {
+	return len(f.types) > 0
+}
+
+// Returns an iterator over the enabled zone types.
+func (f *GetZonesFilterZoneTypes) GetEnabled() iter.Seq[ZoneType] {
+	return func(yield func(ZoneType) bool) {
+		for zoneType, enabled := range f.types {
+			if enabled {
+				if !yield(zoneType) {
+					return
+				}
+			}
+		}
+	}
+}
+
 // Filter used in the GetZones function for complex filtering of
 // the zones returned from the database.
 type GetZonesFilter struct {
@@ -38,11 +92,19 @@ type GetZonesFilter struct {
 	// Filter by partial or exact zone serial.
 	Serial *string
 	// Filter by zone type (e.g., primary or secondary).
-	Type *string
+	Types *GetZonesFilterZoneTypes
 	// Filter by partial zone name, app name or view.
 	Text *string
 }
 
+// Convenience function to enable a zone type filter.
+func (f *GetZonesFilter) EnableZoneType(zoneType ZoneType) {
+	if f.Types == nil {
+		f.Types = NewGetZonesFilterZoneTypes()
+	}
+	f.Types.Enable(zoneType)
+}
+
 // Represents a zone in a database. The same zone can be shared between
 // many DNS servers. Associations with different servers is are created
 // by adding LocalZone instances to the zone.
@@ -123,7 +185,7 @@ func AddZones(dbi pg.DBI, zones ...*Zone) error {
 // would be negligible.
 func GetZones(db pg.DBI, filter *GetZonesFilter, relations ...ZoneRelation) ([]*Zone, int, error) {
 	var zones []*Zone
-	q := db.Model(&zones)
+	q := db.Model(&zones).Distinct()
 	// Add relations.
 	for _, relation := range relations {
 		q = q.Relation(string(relation))
@@ -132,62 +194,72 @@ func GetZones(db pg.DBI, filter *GetZonesFilter, relations ...ZoneRelation) ([]*
 	q = q.OrderExpr("rname ASC")
 
 	// Filtering is optional.
-	if filter != nil {
-		// Limit the number of zones returned.
-		if filter.Limit != nil {
-			q = q.Limit(*filter.Limit)
+	if filter == nil {
+		count, err := q.SelectAndCount()
+		if err != nil {
+			return nil, count, errors.Wrapf(err, "failed to select unfiltered zones from the database")
 		}
-		// Paging from the last returned zone name.
-		if filter.LowerBound != nil {
-			labels := dns.SplitDomainName(*filter.LowerBound)
-			slices.Reverse(labels)
-			lowerBound := strings.Join(labels, ".")
-			q = q.Where("rname > ?", lowerBound)
-		}
-		// Paging from offset.
-		if filter.Offset != nil {
-			q = q.Offset(*filter.Offset)
-		}
-		// Join relations required for filtering.
-		if filter.Serial != nil || filter.Class != nil || filter.Type != nil || filter.AppID != nil || filter.AppType != nil || filter.Text != nil {
-			q = q.Join("JOIN local_zone AS lz").JoinOn("lz.zone_id = zone.id")
-			if filter.AppID != nil || filter.AppType != nil || filter.Text != nil {
-				q = q.Join("JOIN daemon AS d").JoinOn("d.id = lz.daemon_id").
-					Join("JOIN app AS a").JoinOn("a.id = d.app_id")
-			}
-		}
-		// Filter by serial.
-		if filter.Serial != nil {
-			q = q.Where("lz.serial::text ILIKE ?", "%"+*filter.Serial+"%")
-		}
-		// Filter by class.
-		if filter.Class != nil {
-			q = q.Where("lz.class = ?", *filter.Class)
-		}
-		// Filter by type.
-		if filter.Type != nil {
-			q = q.Where("lz.type = ?", *filter.Type)
-		}
-		// Filter by app ID.
-		if filter.AppID != nil {
-			q = q.Where("a.id = ?", *filter.AppID)
-		}
-		// Filter by app type.
-		if filter.AppType != nil {
-			q = q.Where("a.type = ?", *filter.AppType)
+		return zones, count, nil
+	}
+
+	// Limit the number of zones returned.
+	if filter.Limit != nil {
+		q = q.Limit(*filter.Limit)
+	}
+	// Paging from the last returned zone name.
+	if filter.LowerBound != nil {
+		labels := dns.SplitDomainName(*filter.LowerBound)
+		slices.Reverse(labels)
+		lowerBound := strings.Join(labels, ".")
+		q = q.Where("rname > ?", lowerBound)
+	}
+	// Paging from offset.
+	if filter.Offset != nil {
+		q = q.Offset(*filter.Offset)
+	}
+	// Join relations required for filtering.
+	if filter.Serial != nil || filter.Class != nil || filter.Types != nil && filter.Types.IsAnySpecified() || filter.AppID != nil || filter.AppType != nil || filter.Text != nil {
+		q = q.Join("JOIN local_zone AS lz").JoinOn("lz.zone_id = zone.id")
+		if filter.AppID != nil || filter.AppType != nil || filter.Text != nil {
+			q = q.Join("JOIN daemon AS d").JoinOn("d.id = lz.daemon_id").
+				Join("JOIN app AS a").JoinOn("a.id = d.app_id")
 		}
-		// Filter by zone name, app name or local zone view using partial matching.
-		if filter.Text != nil {
-			q = q.WhereGroup(func(q *pg.Query) (*pg.Query, error) {
-				return q.WhereOr("zone.name ILIKE ?", "%"+*filter.Text+"%").
-					WhereOr("a.name ILIKE ?", "%"+*filter.Text+"%").
-					WhereOr("lz.view ILIKE ?", "%"+*filter.Text+"%"), nil
-			})
+	}
+	// Filter by serial.
+	if filter.Serial != nil {
+		q = q.Where("lz.serial::text ILIKE ?", "%"+*filter.Serial+"%")
+	}
+	// Filter by class.
+	if filter.Class != nil {
+		q = q.Where("lz.class = ?", *filter.Class)
+	}
+	// Filter by zone types.
+	if filter.Types != nil {
+		types := slices.Collect(filter.Types.GetEnabled())
+		if len(types) > 0 {
+			q = q.WhereIn("lz.type IN (?)", types)
 		}
 	}
+	// Filter by app ID.
+	if filter.AppID != nil {
+		q = q.Where("a.id = ?", *filter.AppID)
+	}
+	// Filter by app type.
+	if filter.AppType != nil {
+		q = q.Where("a.type = ?", *filter.AppType)
+	}
+	// Filter by zone name, app name or local zone view using partial matching.
+	if filter.Text != nil {
+		q = q.WhereGroup(func(q *pg.Query) (*pg.Query, error) {
+			return q.WhereOr("zone.name ILIKE ?", "%"+*filter.Text+"%").
+				WhereOr("a.name ILIKE ?", "%"+*filter.Text+"%").
+				WhereOr("lz.view ILIKE ?", "%"+*filter.Text+"%"), nil
+		})
+	}
+	// Select and count the zones.
 	count, err := q.SelectAndCount()
 	if err != nil {
-		return nil, count, errors.Wrapf(err, "failed to select zones from the database")
+		return nil, count, errors.Wrapf(err, "failed to select filtered zones from the database")
 	}
 	return zones, count, nil
 }