🐛 Extend generator for x-no-pagination extension (#96)

<!--
Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors.
All rights reserved.
SPDX-License-Identifier: Proprietary
-->
### Description

This change ensures the generator only generates pagination functions on
collections if the `x-no-pagination` extension flag is false or
non-existent.

### Test Coverage

<!--
Please put an `x` in the correct box e.g. `[x]` to indicate the testing
coverage of this change.
-->

- [X]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

---------

Co-authored-by: Kem-Gov <[email protected]>
Co-authored-by: Kem-Gov <[email protected]>

Author: Kem-Gov

.secrets.baseline

@@ -140,5 +140,5 @@
       }
     ]
   },
-  "generated_at": "2025-06-19T15:05:40Z"
+  "generated_at": "2025-06-21T22:43:26Z"
 }

changes/20250621234303.bugfix

@@ -0,0 +1 @@
+:bug: only generate pagination functions if `x-no-pagination` is false or non-existent

changes/20250622162325.feature

@@ -0,0 +1 @@
+Updated client due to schema changes

client/extension_entities.gen.go

@@ -1778,44 +1778,6 @@ func (o *UserCollection) FetchTitle() (string, error) {
 	return o.GetTitle(), nil
 }
 
-func (o *UserCollection) HasNext() bool {
-	if links, has := o.GetLinksOk(); has {
-		return links.HasNext()
-	}
-	return false
-}
-
-func (o *UserCollection) GetItemIterator() (IIterator, error) {
-	if o.HasEmbedded() {
-		embedded := o.GetEmbedded()
-		return NewUserIterator(embedded.GetItem())
-	}
-	links, err := o.FetchLinks()
-	if err != nil {
-		return nil, err
-	}
-	l, ok := links.(HalCollectionLinks)
-	if !ok {
-		return nil, fmt.Errorf("wrong link type [%T]; expected [HalCollectionLinks]", links)
-	}
-	return NewHalLinkDataIterator(l.GetItem())
-}
-
-func (o *UserCollection) GetItemCount() (count int64, err error) {
-	m, ok := o.GetMetadataOk()
-	if !ok {
-		err = fmt.Errorf("missing metadata: %v", o)
-		return
-	}
-	count = int64(m.GetCount())
-	return
-}
-
-// NewUserCollection returns a page.
-func NewUserCollectionCollection() IStaticPage {
-	return NewUserCollectionWithDefaults()
-}
-
 // ============================================================================================
 // This extends VhtInstanceItem and VhtInstanceCollection definitions
 // ============================================================================================

extensions/extension_entities.gen.go

@@ -1778,44 +1778,6 @@ func (o *UserCollection) FetchTitle() (string, error) {
 	return o.GetTitle(), nil
 }
 
-func (o *UserCollection) HasNext() bool {
-	if links, has := o.GetLinksOk(); has {
-		return links.HasNext()
-	}
-	return false
-}
-
-func (o *UserCollection) GetItemIterator() (IIterator, error) {
-	if o.HasEmbedded() {
-		embedded := o.GetEmbedded()
-		return NewUserIterator(embedded.GetItem())
-	}
-	links, err := o.FetchLinks()
-	if err != nil {
-		return nil, err
-	}
-	l, ok := links.(HalCollectionLinks)
-	if !ok {
-		return nil, fmt.Errorf("wrong link type [%T]; expected [HalCollectionLinks]", links)
-	}
-	return NewHalLinkDataIterator(l.GetItem())
-}
-
-func (o *UserCollection) GetItemCount() (count int64, err error) {
-	m, ok := o.GetMetadataOk()
-	if !ok {
-		err = fmt.Errorf("missing metadata: %v", o)
-		return
-	}
-	count = int64(m.GetCount())
-	return
-}
-
-// NewUserCollection returns a page.
-func NewUserCollectionCollection() IStaticPage {
-	return NewUserCollectionWithDefaults()
-}
-
 // ============================================================================================
 // This extends VhtInstanceItem and VhtInstanceCollection definitions
 // ============================================================================================

generator/codegen/collection_extensions.go

@@ -16,6 +16,7 @@ type Collection struct {
 	ItemRef       string
 	ModelRef      string
 	IteratorRef   string
+	NoPagination  bool
 }
 
 type Collections = []Collection
@@ -41,6 +42,24 @@ type CollectionParams = struct {
 	NotificationFeedCollections
 }
 
+type collectionOptions struct {
+	noPagination bool
+}
+
+type CollectionOption interface {
+	apply(*collectionOptions)
+}
+
+type noPaginationOption bool
+
+func (n noPaginationOption) apply(opts *collectionOptions) {
+	opts.noPagination = bool(n)
+}
+
+func WithNoPagination(n bool) CollectionOption {
+	return noPaginationOption(n)
+}
+
 const (
 	// Messages are a special case as they are a feed rather than a normal collection
 	notificationFeedRef = "NotificationFeed"
@@ -207,12 +226,21 @@ func getCollectionSchema(swagger *openapi3.T, appJSON *openapi3.MediaType, endpo
 	return
 }
 
-func newCollection(collectionRef, itemRef string) Collection {
+func newCollection(collectionRef, itemRef string, opts ...CollectionOption) Collection {
+	options := collectionOptions{
+		noPagination: false,
+	}
+
+	for _, opt := range opts {
+		opt.apply(&options)
+	}
+
 	return Collection{
 		CollectionRef: collectionRef,
 		ItemRef:       trimRefPrefix(itemRef),
 		ModelRef:      fmt.Sprintf("%sModel", strings.TrimSuffix(collectionRef, "Collection")),
 		IteratorRef:   fmt.Sprintf("%sIterator", strings.TrimSuffix(collectionRef, "Collection")),
+		NoPagination:  options.noPagination,
 	}
 }
 
@@ -313,7 +341,17 @@ func GetCollections(swagger *openapi3.T) (collections CollectionParams, err erro
 						continue
 					}
 
-					collectionSet.Add(newCollection(collectionRef, itemRef))
+					isNoPaginationCollection, subErr := isExtensionFlagSet(schemaVal.ExtensionProps, noPaginationFlag)
+					if subErr != nil {
+						err = subErr
+						return
+					}
+
+					if isNoPaginationCollection {
+						collectionSet.Add(newCollection(collectionRef, itemRef, WithNoPagination(true)))
+					} else {
+						collectionSet.Add(newCollection(collectionRef, itemRef))
+					}
 				}
 
 				if isMessagesCollection := strings.HasSuffix(endpoint, "messages"); isMessagesCollection {

generator/codegen/collection_extensions_test.go

@@ -92,4 +92,31 @@ func TestCollectionExtensions(t *testing.T) {
 		require.NoError(t, err)
 		assert.Equal(t, string(expected), string(actual))
 	})
+
+	t.Run("Test Successful Generation (with x-no-pagination flag set)", func(t *testing.T) {
+		tmpDir := t.TempDir()
+		d, err := GenerateDataStruct(ExtensionsConfig{
+			Input:             filepath.Join("testdata", "collections", "test-x-no-pagination.json"),
+			Template:          filepath.Join("templates", "entities.go.tmpl"),
+			Output:            filepath.Join(tmpDir, "test.go"),
+			ClientPackagePath: filepath.Join("..", "..", "client"),
+		})
+		require.NoError(t, err)
+
+		swagger, err := loadAPIDefinition(d.SpecPath)
+		require.NoError(t, err)
+
+		d.Params, err = GetCollections(swagger)
+		require.NoError(t, err)
+
+		err = GenerateTemplateFile(context.Background(), d)
+		assert.NoError(t, err)
+		assert.FileExists(t, d.DestinationPath)
+
+		expected, err := filesystem.ReadFile(filepath.Join("testdata", "collections", "test-x-no-pagination.gen.go"))
+		require.NoError(t, err)
+		actual, err := filesystem.ReadFile(d.DestinationPath)
+		require.NoError(t, err)
+		assert.Equal(t, string(expected), string(actual))
+	})
 }

generator/codegen/common.go

@@ -33,9 +33,10 @@ const (
 	schemaPrefix = "#/components/schemas/"
 	jsonMIME     = "application/json"
 	// See https://github.com/Arm-Debug/API-Uniform-Contract?tab=readme-ov-file#api-extensions
-	redactFlag     = "x-redact"
-	jobFlag        = "x-job"
-	collectionFlag = "x-collection"
+	redactFlag       = "x-redact"
+	jobFlag          = "x-job"
+	collectionFlag   = "x-collection"
+	noPaginationFlag = "x-no-pagination"
 )
 
 type Data struct {

generator/codegen/templates/entities.go.tmpl

@@ -102,6 +102,7 @@ func (o *{{ .CollectionRef }}) FetchTitle() (string, error) {
 	return o.GetTitle(), nil
 }
 
+{{ if not .NoPagination }}
 func (o *{{ .CollectionRef }}) HasNext() bool {
 	if links, has := o.GetLinksOk(); has {
 		return links.HasNext()
@@ -140,6 +141,7 @@ func New{{ .CollectionRef }}Collection() IStaticPage {
 	return New{{ .CollectionRef }}WithDefaults()
 }
 {{ end }}
+{{ end }}
 {{ range .Params.JobItems -}}
 // ============================================================================================
 // This extends {{ .JobItemSchema }} definitions