Closes #10560: New global search (#10676)

* Initial work on new search backend

* Clean up search backends

* Return only the most relevant result per object

* Clear any pre-existing cached entries on cache()

* #6003: Implement global search functionality for custom field values

* Tweak field weights & document guidance

* Extend search() to accept a lookup type

* Move get_registry() out of SearchBackend

* Enforce object permissions when returning search results

* Add indexers for remaining models

* Avoid calling remove() on non-cacheable objects

* Use new search backend by default

* Extend search backend to filter by object type

* Clean up search view form

* Enable specifying lookup logic

* Add indexes for value field

* Remove object type selector from search bar

* Introduce SearchTable and enable HTMX for results

* Enable pagination

* Remove legacy search backend

* Cleanup

* Use a UUID for CachedValue primary key

* Refactoring search methods

* Define max search results limit

* Extend reindex command to support specifying particular models

* Add clear() and size to SearchBackend

* Optimize bulk caching performance

* Highlight matched portion of field value

* Performance improvements for reindexing

* Started on search tests

* Cleanup & docs

* Documentation updates

* Clean up SearchIndex

* Flatten search registry to register by app_label.model_name

* Clean up search backend classes

* Clean up RestrictedGenericForeignKey and RestrictedPrefetch

* Resolve migrations conflict

netbox/ipam/search.py

@@ -1,69 +1,139 @@
-import ipam.filtersets
-import ipam.tables
-from ipam.models import ASN, VLAN, VRF, Aggregate, IPAddress, Prefix, Service
+from . import models
 from netbox.search import SearchIndex, register_search
 
 
-@register_search()
-class VRFIndex(SearchIndex):
-    model = VRF
-    queryset = VRF.objects.prefetch_related('tenant', 'tenant__group')
-    filterset = ipam.filtersets.VRFFilterSet
-    table = ipam.tables.VRFTable
-    url = 'ipam:vrf_list'
-
-
-@register_search()
+@register_search
 class AggregateIndex(SearchIndex):
-    model = Aggregate
-    queryset = Aggregate.objects.prefetch_related('rir')
-    filterset = ipam.filtersets.AggregateFilterSet
-    table = ipam.tables.AggregateTable
-    url = 'ipam:aggregate_list'
-
-
-@register_search()
-class PrefixIndex(SearchIndex):
-    model = Prefix
-    queryset = Prefix.objects.prefetch_related(
-        'site', 'vrf__tenant', 'tenant', 'tenant__group', 'vlan', 'role'
+    model = models.Aggregate
+    fields = (
+        ('prefix', 100),
+        ('description', 500),
+        ('date_added', 2000),
     )
-    filterset = ipam.filtersets.PrefixFilterSet
-    table = ipam.tables.PrefixTable
-    url = 'ipam:prefix_list'
 
 
-@register_search()
-class IPAddressIndex(SearchIndex):
-    model = IPAddress
-    queryset = IPAddress.objects.prefetch_related('vrf__tenant', 'tenant', 'tenant__group')
-    filterset = ipam.filtersets.IPAddressFilterSet
-    table = ipam.tables.IPAddressTable
-    url = 'ipam:ipaddress_list'
-
-
-@register_search()
-class VLANIndex(SearchIndex):
-    model = VLAN
-    queryset = VLAN.objects.prefetch_related('site', 'group', 'tenant', 'tenant__group', 'role')
-    filterset = ipam.filtersets.VLANFilterSet
-    table = ipam.tables.VLANTable
-    url = 'ipam:vlan_list'
-
-
-@register_search()
+@register_search
 class ASNIndex(SearchIndex):
-    model = ASN
-    queryset = ASN.objects.prefetch_related('rir', 'tenant', 'tenant__group')
-    filterset = ipam.filtersets.ASNFilterSet
-    table = ipam.tables.ASNTable
-    url = 'ipam:asn_list'
+    model = models.ASN
+    fields = (
+        ('asn', 100),
+        ('description', 500),
+    )
 
 
-@register_search()
+@register_search
+class FHRPGroupIndex(SearchIndex):
+    model = models.FHRPGroup
+    fields = (
+        ('name', 100),
+        ('group_id', 2000),
+        ('description', 500),
+    )
+
+
+@register_search
+class IPAddressIndex(SearchIndex):
+    model = models.IPAddress
+    fields = (
+        ('address', 100),
+        ('dns_name', 300),
+        ('description', 500),
+    )
+
+
+@register_search
+class IPRangeIndex(SearchIndex):
+    model = models.IPRange
+    fields = (
+        ('start_address', 100),
+        ('end_address', 300),
+        ('description', 500),
+    )
+
+
+@register_search
+class L2VPNIndex(SearchIndex):
+    model = models.L2VPN
+    fields = (
+        ('name', 100),
+        ('slug', 110),
+        ('description', 500),
+    )
+
+
+@register_search
+class PrefixIndex(SearchIndex):
+    model = models.Prefix
+    fields = (
+        ('prefix', 100),
+        ('description', 500),
+    )
+
+
+@register_search
+class RIRIndex(SearchIndex):
+    model = models.RIR
+    fields = (
+        ('name', 100),
+        ('slug', 110),
+        ('description', 500),
+    )
+
+
+@register_search
+class RoleIndex(SearchIndex):
+    model = models.Role
+    fields = (
+        ('name', 100),
+        ('slug', 110),
+        ('description', 500),
+    )
+
+
+@register_search
+class RouteTargetIndex(SearchIndex):
+    model = models.RouteTarget
+    fields = (
+        ('name', 100),
+        ('description', 500),
+    )
+
+
+@register_search
 class ServiceIndex(SearchIndex):
-    model = Service
-    queryset = Service.objects.prefetch_related('device', 'virtual_machine')
-    filterset = ipam.filtersets.ServiceFilterSet
-    table = ipam.tables.ServiceTable
-    url = 'ipam:service_list'
+    model = models.Service
+    fields = (
+        ('name', 100),
+        ('description', 500),
+    )
+
+
+@register_search
+class VLANIndex(SearchIndex):
+    model = models.VLAN
+    fields = (
+        ('name', 100),
+        ('vid', 100),
+        ('description', 500),
+    )
+
+
+@register_search
+class VLANGroupIndex(SearchIndex):
+    model = models.VLANGroup
+    fields = (
+        ('name', 100),
+        ('slug', 110),
+        ('description', 500),
+        ('max_vid', 2000),
+    )
+
+
+@register_search
+class VRFIndex(SearchIndex):
+    model = models.VRF
+    fields = (
+        ('name', 100),
+        ('rd', 200),
+        ('description', 500),
+    )