Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Carvel plugin to use an item offset rather than page offset. #4678

Merged
merged 1 commit into from
May 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (s *Server) GetAvailablePackageSummaries(ctx context.Context, request *core

// Retrieve additional parameters from the request
pageSize := request.GetPaginationOptions().GetPageSize()
pageOffset, err := paginate.PageOffsetFromAvailableRequest(request)
itemOffset, err := paginate.ItemOffsetFromPageToken(request.GetPaginationOptions().GetPageToken())
if err != nil {
return nil, err
}
Expand All @@ -58,7 +58,7 @@ func (s *Server) GetAvailablePackageSummaries(ctx context.Context, request *core
// Update the slice to be the correct page of results.
startAt := 0
if pageSize > 0 {
startAt = int(pageSize) * pageOffset
startAt = itemOffset
if startAt > len(pkgMetadatas) {
return nil, status.Errorf(codes.InvalidArgument, "invalid pagination arguments %v", request.GetPaginationOptions())
}
Expand Down Expand Up @@ -137,7 +137,7 @@ func (s *Server) GetAvailablePackageSummaries(ctx context.Context, request *core
// the results are a full page.
nextPageToken := ""
if pageSize > 0 && len(availablePackageSummaries) == int(pageSize) {
nextPageToken = fmt.Sprintf("%d", pageOffset+1)
nextPageToken = fmt.Sprintf("%d", itemOffset+int(pageSize))
}
response := &corev1.GetAvailablePackageSummariesResponse{
AvailablePackageSummaries: availablePackageSummaries,
Expand Down Expand Up @@ -275,7 +275,7 @@ func (s *Server) GetInstalledPackageSummaries(ctx context.Context, request *core

// Retrieve additional parameters from the request
pageSize := request.GetPaginationOptions().GetPageSize()
pageOffset, err := paginate.PageOffsetFromInstalledRequest(request)
itemOffset, err := paginate.ItemOffsetFromPageToken(request.GetPaginationOptions().GetPageToken())
if err != nil {
return nil, err
}
Expand All @@ -298,7 +298,7 @@ func (s *Server) GetInstalledPackageSummaries(ctx context.Context, request *core
if len(pkgInstalls) > 0 {
startAt := -1
if pageSize > 0 {
startAt = int(pageSize) * pageOffset
startAt = itemOffset
if startAt > len(pkgInstalls) {
return nil, status.Errorf(codes.InvalidArgument, "invalid pagination arguments %v", request.GetPaginationOptions())
}
Expand Down Expand Up @@ -430,7 +430,7 @@ func (s *Server) GetInstalledPackageSummaries(ctx context.Context, request *core
// the results are a full page.
nextPageToken := ""
if pageSize > 0 && len(installedPkgSummaries) == int(pageSize) {
nextPageToken = fmt.Sprintf("%d", pageOffset+1)
nextPageToken = fmt.Sprintf("%d", itemOffset+int(pageSize))
}
response := &corev1.GetInstalledPackageSummariesResponse{
InstalledPackageSummaries: installedPkgSummaries,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -623,7 +623,7 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
},
},
{
name: "it returns paginated carvel package summaries with an offset",
name: "it returns paginated carvel package summaries with an item offset (not a page offset)",
existingObjects: []runtime.Object{
&datapackagingv1alpha1.PackageMetadata{
TypeMeta: metav1.TypeMeta{
Expand Down Expand Up @@ -665,6 +665,26 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
ProviderName: "Tombi!",
},
},
&datapackagingv1alpha1.PackageMetadata{
TypeMeta: metav1.TypeMeta{
Kind: pkgMetadataResource,
APIVersion: datapackagingAPIVersion,
},
ObjectMeta: metav1.ObjectMeta{
Namespace: "default",
Name: "tunotherone.foo.example.com",
},
Spec: datapackagingv1alpha1.PackageMetadataSpec{
DisplayName: "Tunotherone!",
IconSVGBase64: "Tm90IHJlYWxseSBTVkcK",
ShortDescription: "Another awesome game from the 90's",
LongDescription: "Tunotherone! is another open world platform-adventure game with RPG elements.",
Categories: []string{"platforms", "rpg"},
Maintainers: []datapackagingv1alpha1.Maintainer{{Name: "person1"}, {Name: "person2"}},
SupportDescription: "Some support information",
ProviderName: "tunotherone",
},
},
&datapackagingv1alpha1.Package{
TypeMeta: metav1.TypeMeta{
Kind: pkgResource,
Expand Down Expand Up @@ -701,10 +721,28 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
ReleasedAt: metav1.Time{time.Date(1997, time.December, 25, 0, 0, 0, 0, time.UTC)},
},
},
&datapackagingv1alpha1.Package{
TypeMeta: metav1.TypeMeta{
Kind: pkgResource,
APIVersion: datapackagingAPIVersion,
},
ObjectMeta: metav1.ObjectMeta{
Namespace: "default",
Name: "tunotherone.foo.example.com.3.2.5",
},
Spec: datapackagingv1alpha1.PackageSpec{
RefName: "tunotherone.foo.example.com",
Version: "3.2.5",
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1997, time.December, 25, 0, 0, 0, 0, time.UTC)},
},
},
},
paginationOptions: corev1.PaginationOptions{
PageToken: "1",
PageSize: 1,
PageSize: 2,
},
expectedPackages: []*corev1.AvailablePackageSummary{
{
Expand All @@ -723,6 +761,22 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
ShortDescription: "An awesome game from the 90's",
Categories: []string{"platforms", "rpg"},
},
{
AvailablePackageRef: &corev1.AvailablePackageReference{
Context: defaultContext,
Plugin: &pluginDetail,
Identifier: "tunotherone.foo.example.com",
},
Name: "tunotherone.foo.example.com",
DisplayName: "Tunotherone!",
LatestVersion: &corev1.PackageAppVersion{
PkgVersion: "3.2.5",
AppVersion: "3.2.5",
},
IconUrl: "data:image/svg+xml;base64,Tm90IHJlYWxseSBTVkcK",
ShortDescription: "Another awesome game from the 90's",
Categories: []string{"platforms", "rpg"},
},
},
},
{
Expand Down