✨ [pagination] Added an unwrap function to retrieve raw collection types

Author: acabarbaye

changes/20241030192708.feature

@@ -0,0 +1 @@
+:sparkles: `[pagination]` Added an unwrap function to retrieve raw collection types

changes/20241030192749.bugfix

@@ -0,0 +1 @@
+:bug: `[artefacts]` fix artefact collection unwrapping

utils/artefacts/artefacts.go

@@ -232,18 +232,23 @@ func (m *ArtefactManager) fetchJobArtefactsNextPage(ctx context.Context, current
 		err = fmt.Errorf("%w: function to retrieve artefact managers was not properly defined", commonerrors.ErrUndefined)
 		return
 	}
-	page, ok := paginationUtils.ToClientPage(currentPage).(*client.ArtefactManagerCollection)
+	unwrappedPage := paginationUtils.UnwrapPage(currentPage)
+	if unwrappedPage == nil {
+		err = fmt.Errorf("%w: returned artefact managers page is empty", commonerrors.ErrUnexpected)
+		return
+	}
+	page, ok := unwrappedPage.(*client.ArtefactManagerCollection)
 	if !ok {
-		err = fmt.Errorf("%w: returned build job page [%T] is not of the expected type [%v]", commonerrors.ErrUnexpected, currentPage, "*BuildJobCollection")
+		err = fmt.Errorf("%w: returned artefact managers page[%T] is not of the expected type [%v]", commonerrors.ErrUnexpected, currentPage, "*ArtefactManagerCollection")
 		return
 	}
 	links, has := page.GetLinksOk()
 	if !has {
-		err = fmt.Errorf("%w: returned page of build jobs has no links", commonerrors.ErrUnexpected)
+		err = fmt.Errorf("%w: returned page of artefact managers has no links", commonerrors.ErrUnexpected)
 		return
 	}
 	if !links.HasNext() {
-		err = fmt.Errorf("%w: returned page of build job has no `next` link", commonerrors.ErrUnexpected)
+		err = fmt.Errorf("%w: returned page of artefact managers has no `next` link", commonerrors.ErrUnexpected)
 		return
 	}
 	link := links.GetNext()

utils/pagination/iterator.go

@@ -62,3 +62,19 @@ func newClientIteratorMapper(iterator pagination.IIterator) client.IIterator {
 		iterator: iterator,
 	}
 }
+
+// UnwrapIterator tends to unwraps the iterator mappers to retrieve the raw iterator.
+func UnwrapIterator(iterator any) any {
+	if iterator == nil {
+		return nil
+	}
+	wrappedIteratorMapper, ok := iterator.(*iteratorMapper)
+	if ok {
+		return UnwrapIterator(wrappedIteratorMapper.iterator)
+	}
+	wrappedClientIteratorMapper, ok := iterator.(*clientIteratorMapper)
+	if ok {
+		return UnwrapIterator(wrappedClientIteratorMapper.iterator)
+	}
+	return iterator
+}

utils/pagination/iterator_test.go

@@ -118,3 +118,23 @@ func TestToIterator(t *testing.T) {
 		})
 	}
 }
+
+func TestUnwrapIterator(t *testing.T) {
+	var rawIterator client.IIterator
+	rawIterator, err := client.NewArtefactManagerIterator([]client.ArtefactManagerItem{})
+	require.NoError(t, err)
+	require.NotNil(t, rawIterator)
+	u, ok := rawIterator.(*client.ArtefactManagerIterator)
+	assert.True(t, ok)
+	assert.NotNil(t, u)
+	wrappedIt := ToClientIterator(ToIterator(ToClientIterator(ToIterator(rawIterator))))
+	require.NotNil(t, wrappedIt)
+	u, ok = wrappedIt.(*client.ArtefactManagerIterator)
+	assert.False(t, ok)
+	assert.Nil(t, u)
+	unwrappedIt := UnwrapIterator(wrappedIt)
+	require.NotNil(t, unwrappedIt)
+	u, ok = unwrappedIt.(*client.ArtefactManagerIterator)
+	assert.True(t, ok)
+	assert.NotNil(t, u)
+}

utils/pagination/page.go

@@ -78,3 +78,19 @@ func newClientPageMapper(page pagination.IStaticPage) client.IStaticPage {
 		page: page,
 	}
 }
+
+// UnwrapPage tends to unwraps the page mappers to retrieve the raw page object.
+func UnwrapPage(page any) any {
+	if page == nil {
+		return nil
+	}
+	wrappedPageMapper, ok := page.(*pageMapper)
+	if ok {
+		return UnwrapPage(wrappedPageMapper.page)
+	}
+	wrappedClientPageMapper, ok := page.(*clientPageMapper)
+	if ok {
+		return UnwrapPage(wrappedClientPageMapper.page)
+	}
+	return UnwrapIterator(page)
+}

utils/pagination/page_test.go

@@ -129,3 +129,23 @@ func TestToPage(t *testing.T) {
 		})
 	}
 }
+
+func TestUnwrapPage(t *testing.T) {
+	var rawPage client.IStaticPage
+	assert.Nil(t, rawPage)
+	rawPage = client.NewArtefactManagerCollectionWithDefaults()
+	require.NotNil(t, rawPage)
+	u, ok := rawPage.(*client.ArtefactManagerCollection)
+	assert.True(t, ok)
+	assert.NotNil(t, u)
+	wrappedPage := ToPage(ToClientPage(ToPage(ToClientPage(ToPage(rawPage)))))
+	require.NotNil(t, wrappedPage)
+	u, ok = wrappedPage.(*client.ArtefactManagerCollection)
+	assert.False(t, ok)
+	assert.Nil(t, u)
+	unwrappedPage := UnwrapPage(wrappedPage)
+	require.NotNil(t, unwrappedPage)
+	u, ok = unwrappedPage.(*client.ArtefactManagerCollection)
+	assert.True(t, ok)
+	assert.NotNil(t, u)
+}

utils/pagination/stream.go

@@ -86,3 +86,19 @@ func newClientStreamMapper(stream pagination.IStaticPageStream) client.IMessageS
 		stream: stream,
 	}
 }
+
+// UnwrapStream tends to unwraps the stream mappers to retrieve the raw stream.
+func UnwrapStream(stream any) any {
+	if stream == nil {
+		return nil
+	}
+	wrappedStreamMapper, ok := stream.(*streamMapper)
+	if ok {
+		return UnwrapStream(wrappedStreamMapper.stream)
+	}
+	wrappedClientStreamMapper, ok := stream.(*clientStreamMapper)
+	if ok {
+		return UnwrapStream(wrappedClientStreamMapper.stream)
+	}
+	return UnwrapPage(stream)
+}

utils/pagination/stream_test.go

@@ -125,3 +125,20 @@ func TestToStream(t *testing.T) {
 		})
 	}
 }
+func TestUnwrapStream(t *testing.T) {
+	rawStream := client.NewNotificationFeedMessageStream()
+	require.NotNil(t, rawStream)
+	u, ok := rawStream.(*client.NotificationFeed)
+	assert.True(t, ok)
+	assert.NotNil(t, u)
+	wrappedStream := ToStream(ToClientStream(ToStream(ToClientStream(ToStream(rawStream)))))
+	require.NotNil(t, wrappedStream)
+	u, ok = wrappedStream.(*client.NotificationFeed)
+	assert.False(t, ok)
+	assert.Nil(t, u)
+	unwrappedStream := UnwrapStream(wrappedStream)
+	require.NotNil(t, unwrappedStream)
+	u, ok = unwrappedStream.(*client.NotificationFeed)
+	assert.True(t, ok)
+	assert.NotNil(t, u)
+}