listergen: document assumptions from indexer

stevekuznetsov · stevekuznetsov · commit 009c42fa6ef3 · 2022-11-03T10:30:42.000-06:00
Signed-off-by: Steve Kuznetsov &lt;skuznets@redhat.com&gt;
diff --git a/pkg/internal/listergen/lister.go b/pkg/internal/listergen/lister.go
@@ -84,6 +84,13 @@ type {{.kind.String | lowerFirst }}ClusterLister struct {
 }
 
 // New{{.kind.String}}ClusterLister returns a new {{.kind.String}}ClusterLister.
+// We assume that the indexer:
+// - is fed by a cross-workspace LIST+WATCH
+// - uses kcpcache.MetaClusterNamespaceKeyFunc as the key function
+// - has the kcpcache.ClusterIndex as an index
+{{ if  .kind.IsNamespaced -}}
+// - has the kcpcache.ClusterAndNamespaceIndex as an index
+{{end -}}
 func New{{.kind.String}}ClusterLister(indexer cache.Indexer) *{{.kind.String | lowerFirst}}ClusterLister {
 	return &{{.kind.String | lowerFirst}}ClusterLister{indexer: indexer}
 }

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,13 @@ type {{.kind.String \| lowerFirst }}ClusterLister struct {`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`// New{{.kind.String}}ClusterLister returns a new {{.kind.String}}ClusterLister.`
	`87`	`+// We assume that the indexer:`
	`88`	`+// - is fed by a cross-workspace LIST+WATCH`
	`89`	`+// - uses kcpcache.MetaClusterNamespaceKeyFunc as the key function`
	`90`	`+// - has the kcpcache.ClusterIndex as an index`
	`91`	`+{{ if .kind.IsNamespaced -}}`
	`92`	`+// - has the kcpcache.ClusterAndNamespaceIndex as an index`
	`93`	`+{{end -}}`
`87`	`94`	`func New{{.kind.String}}ClusterLister(indexer cache.Indexer) *{{.kind.String \| lowerFirst}}ClusterLister {`
`88`	`95`	`return &{{.kind.String \| lowerFirst}}ClusterLister{indexer: indexer}`
`89`	`96`	`}`