[Bugfix] [Platform] Proper Path handler in StorageV2 (#1793)

Author: ajanikow

CHANGELOG.md

@@ -43,6 +43,7 @@
 - (Maintenance) Switch License to 2025
 - (Feature) Migrate Storage V1 to CE
 - (Feature) Improve Helm Chart Manager
+- (Bugfix) (Platform) Proper Path handler in StorageV2
 
 ## [1.2.43](https://github.com/arangodb/kube-arangodb/tree/1.2.43) (2024-10-14)
 - (Feature) ArangoRoute CRD

integrations/storage/v2/definition/helpers.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2024-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -83,3 +83,25 @@ func Receive(ctx context.Context, client StorageV2Client, key string, out io.Wri
 
 	return bytes, nil
 }
+
+func List(ctx context.Context, client StorageV2Client, prefix string) ([]*StorageV2Object, error) {
+	var r []*StorageV2Object
+
+	res, err := client.ListObjects(ctx, &StorageV2ListObjectsRequest{
+		Path: &StorageV2Path{
+			Path: prefix,
+		},
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	if err := ugrpc.Recv[*StorageV2ListObjectsResponse](res, func(response *StorageV2ListObjectsResponse) error {
+		r = append(r, response.GetFiles()...)
+		return nil
+	}); err != nil {
+		return nil, err
+	}
+
+	return r, nil
+}

integrations/storage/v2/shared/s3/io.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2024-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -22,7 +22,8 @@ package s3
 
 import (
 	"context"
-	"fmt"
+	"path"
+	"strings"
 
 	"github.com/aws/aws-sdk-go/service/s3"
 	"github.com/aws/aws-sdk-go/service/s3/s3iface"
@@ -39,8 +40,12 @@ type ios struct {
 	downloader *s3manager.Downloader
 }
 
-func (i *ios) key(key string) string {
-	return fmt.Sprintf("%s%s", i.config.BucketPrefix, key)
+func (i *ios) key(keys ...string) string {
+	return path.Join(strings.TrimPrefix(i.config.BucketPrefix, "/"), path.Join(keys...))
+}
+
+func (i *ios) clean(key string) string {
+	return strings.TrimPrefix(strings.TrimPrefix(key, i.key()), "/")
 }
 
 func (i *ios) Write(ctx context.Context, key string) (pbImplStorageV2Shared.Writer, error) {

integrations/storage/v2/shared/s3/list.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2024-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -23,7 +23,6 @@ package s3
 import (
 	"context"
 	"io"
-	"strings"
 	"sync"
 
 	"github.com/aws/aws-sdk-go/service/s3"
@@ -86,7 +85,7 @@ func (l *listIterator) Next(ctx context.Context) ([]pbImplStorageV2Shared.File,
 		info.LastUpdatedAt = util.TypeOrDefault(obj.LastModified)
 
 		results = append(results, pbImplStorageV2Shared.File{
-			Key:  strings.TrimPrefix(*obj.Key, l.parent.key(l.key)),
+			Key:  l.parent.clean(*obj.Key),
 			Info: info,
 		})
 

integrations/storage/v2/storage.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2024-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -235,9 +235,6 @@ func (i *implementation) ListObjects(req *pbStorageV2.StorageV2ListObjectsReques
 	log := logger.Str("func", "ReadObject").Str("path", req.GetPath().GetPath())
 	ctx := server.Context()
 	path := req.GetPath().GetPath()
-	if path == "" {
-		return status.Errorf(codes.InvalidArgument, "path missing")
-	}
 
 	lister, err := i.io.List(ctx, path)
 	if err != nil {

integrations/storage/v2/storage_test.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2024-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,7 +26,6 @@ import (
 	"crypto/rand"
 	"fmt"
 	"sort"
-	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -36,27 +35,8 @@ import (
 	pbStorageV2 "github.com/arangodb/kube-arangodb/integrations/storage/v2/definition"
 	"github.com/arangodb/kube-arangodb/pkg/util"
 	"github.com/arangodb/kube-arangodb/pkg/util/errors"
-	ugrpc "github.com/arangodb/kube-arangodb/pkg/util/grpc"
 )
 
-func listAllFilesHelper(t *testing.T, ctx context.Context, h pbStorageV2.StorageV2Client, prefix string) []*pbStorageV2.StorageV2Object {
-	var r []*pbStorageV2.StorageV2Object
-
-	res, err := h.ListObjects(ctx, &pbStorageV2.StorageV2ListObjectsRequest{
-		Path: &pbStorageV2.StorageV2Path{
-			Path: prefix,
-		},
-	})
-	require.NoError(t, err)
-
-	require.NoError(t, ugrpc.Recv[*pbStorageV2.StorageV2ListObjectsResponse](res, func(response *pbStorageV2.StorageV2ListObjectsResponse) error {
-		r = append(r, response.GetFiles()...)
-		return nil
-	}))
-
-	return r
-}
-
 func Test_List(t *testing.T) {
 	ctx, c := context.WithCancel(context.Background())
 	defer c()
@@ -163,27 +143,30 @@ func testFileListing(t *testing.T, ctx context.Context, h pbStorageV2.StorageV2C
 		})
 
 		t.Run("List", func(t *testing.T) {
-			revcFiles := listAllFilesHelper(t, ctx, h, prefix)
+			revcFiles, err := pbStorageV2.List(ctx, h, prefix)
+			require.NoError(t, err)
 
 			require.Len(t, revcFiles, len(files))
 
 			for id := range files {
-				require.EqualValues(t, strings.TrimPrefix(files[id], prefix), revcFiles[id].GetPath().GetPath())
+				require.EqualValues(t, files[id], revcFiles[id].GetPath().GetPath())
 				require.EqualValues(t, revcFiles[id].GetInfo().GetSize(), len(data))
 			}
 		})
 
 		t.Run("ListSubFolder", func(t *testing.T) {
-			revcFiles := listAllFilesHelper(t, ctx, h, fmt.Sprintf("%spath0000/", prefix))
+			revcFiles, err := pbStorageV2.List(ctx, h, fmt.Sprintf("%spath0000/", prefix))
+			require.NoError(t, err)
 
 			require.Len(t, revcFiles, 1)
 
-			require.EqualValues(t, "file", revcFiles[0].GetPath().GetPath())
+			require.EqualValues(t, fmt.Sprintf("%spath0000/file", prefix), revcFiles[0].GetPath().GetPath())
 			require.EqualValues(t, len(data), revcFiles[0].GetInfo().GetSize())
 		})
 
 		t.Run("ListMisSubFolder", func(t *testing.T) {
-			revcFiles := listAllFilesHelper(t, ctx, h, fmt.Sprintf("%snon-existent/", prefix))
+			revcFiles, err := pbStorageV2.List(ctx, h, fmt.Sprintf("%snon-existent/", prefix))
+			require.NoError(t, err)
 
 			require.Len(t, revcFiles, 0)
 		})
@@ -281,7 +264,8 @@ func testS3BucketFileHandling(t *testing.T, ctx context.Context, h pbStorageV2.S
 		})
 
 		t.Run("List Objects", func(t *testing.T) {
-			revcFiles := listAllFilesHelper(t, ctx, h, prefix)
+			revcFiles, err := pbStorageV2.List(ctx, h, "/")
+			require.NoError(t, err)
 
 			t.Logf("Size: %d", len(revcFiles))
 		})