Modularize Block Factory (#8499)

* Modularize Block Factory

* Import lakeFS module

* Rename imports

cmd/lakefs/cmd/run.go

@@ -18,6 +18,7 @@ import (
 	"github.com/go-co-op/gocron"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
+	blockfactory "github.com/treeverse/lakefs/modules/block/factory"
 	"github.com/treeverse/lakefs/pkg/actions"
 	"github.com/treeverse/lakefs/pkg/api"
 	"github.com/treeverse/lakefs/pkg/auth"
@@ -26,7 +27,6 @@ import (
 	authremote "github.com/treeverse/lakefs/pkg/auth/remoteauthenticator"
 	"github.com/treeverse/lakefs/pkg/authentication"
 	"github.com/treeverse/lakefs/pkg/block"
-	"github.com/treeverse/lakefs/pkg/block/factory"
 	"github.com/treeverse/lakefs/pkg/catalog"
 	"github.com/treeverse/lakefs/pkg/config"
 	"github.com/treeverse/lakefs/pkg/gateway"
@@ -201,7 +201,7 @@ var runCmd = &cobra.Command{
 			stats.WithLogger(logger.WithField("service", "stats_collector")))
 
 		// init block store
-		blockStore, err := factory.BuildBlockAdapter(ctx, bufferedCollector, cfg)
+		blockStore, err := blockfactory.BuildBlockAdapter(ctx, bufferedCollector, cfg)
 		if err != nil {
 			logger.WithError(err).Fatal("Failed to create block adapter")
 		}

go.work

@@ -2,5 +2,6 @@ go 1.23
 
 use (
 	.
+	./modules/block/factory
 	./webui
 )

modules/block/factory/build.go

@@ -0,0 +1,19 @@
+package factory
+
+import (
+	"context"
+
+	"github.com/treeverse/lakefs/pkg/block"
+	"github.com/treeverse/lakefs/pkg/block/factory"
+	"github.com/treeverse/lakefs/pkg/block/params"
+	"github.com/treeverse/lakefs/pkg/stats"
+)
+
+func BuildBlockAdapter(ctx context.Context, statsCollector stats.Collector, c params.AdapterConfig) (block.Adapter, error) {
+	adapter, err := factory.BuildBlockAdapter(ctx, statsCollector, c)
+	if err != nil {
+		return nil, err
+	}
+
+	return block.NewMetricsAdapter(adapter), nil
+}

modules/block/factory/go.mod

@@ -0,0 +1,5 @@
+module github.com/treeverse/lakefs/modules/block/factory
+
+go 1.23
+
+// This module uses the go.work file to get all package dependencies from lakefs

modules/block/factory/go.work

@@ -0,0 +1,6 @@
+go 1.23
+
+use (
+	.
+	../../..
+)

pkg/block/factory/build.go

@@ -27,15 +27,6 @@ const (
 )
 
 func BuildBlockAdapter(ctx context.Context, statsCollector stats.Collector, c params.AdapterConfig) (block.Adapter, error) {
-	adapter, err := buildBlockAdapter(ctx, statsCollector, c)
-	if err != nil {
-		return nil, err
-	}
-
-	return block.NewMetricsAdapter(adapter), nil
-}
-
-func buildBlockAdapter(ctx context.Context, statsCollector stats.Collector, c params.AdapterConfig) (block.Adapter, error) {
 	blockstore := strings.ToLower(c.BlockstoreType())
 	logging.FromContext(ctx).
 		WithField("type", blockstore).

pkg/catalog/catalog.go

@@ -25,7 +25,7 @@ import (
 	"github.com/rs/xid"
 	"github.com/treeverse/lakefs/pkg/batch"
 	"github.com/treeverse/lakefs/pkg/block"
-	"github.com/treeverse/lakefs/pkg/block/factory"
+	blockfactory "github.com/treeverse/lakefs/pkg/block/factory"
 	"github.com/treeverse/lakefs/pkg/config"
 	"github.com/treeverse/lakefs/pkg/graveler"
 	"github.com/treeverse/lakefs/pkg/graveler/branch"
@@ -307,7 +307,7 @@ func makeBranchApproximateOwnershipParams(cfg config.ApproximatelyCorrectOwnersh
 
 func New(ctx context.Context, cfg Config) (*Catalog, error) {
 	ctx, cancelFn := context.WithCancel(ctx)
-	adapter, err := factory.BuildBlockAdapter(ctx, nil, cfg.Config)
+	adapter, err := blockfactory.BuildBlockAdapter(ctx, nil, cfg.Config)
 	if err != nil {
 		cancelFn()
 		return nil, fmt.Errorf("build block adapter: %w", err)

pkg/config/config_test.go

@@ -12,8 +12,8 @@ import (
 	awsconfig "github.com/aws/aws-sdk-go-v2/config"
 	"github.com/go-test/deep"
 	"github.com/spf13/viper"
+	blockfactory "github.com/treeverse/lakefs/modules/block/factory"
 	"github.com/treeverse/lakefs/pkg/block"
-	"github.com/treeverse/lakefs/pkg/block/factory"
 	"github.com/treeverse/lakefs/pkg/block/gs"
 	"github.com/treeverse/lakefs/pkg/block/local"
 	"github.com/treeverse/lakefs/pkg/config"
@@ -112,7 +112,7 @@ func TestConfig_BuildBlockAdapter(t *testing.T) {
 	t.Run("local block adapter", func(t *testing.T) {
 		c, err := newConfigFromFile("testdata/valid_config.yaml")
 		testutil.Must(t, err)
-		adapter, err := factory.BuildBlockAdapter(ctx, nil, c)
+		adapter, err := blockfactory.BuildBlockAdapter(ctx, nil, c)
 		testutil.Must(t, err)
 		metricsAdapter, ok := adapter.(*block.MetricsAdapter)
 		if !ok {
@@ -127,7 +127,7 @@ func TestConfig_BuildBlockAdapter(t *testing.T) {
 		c, err := newConfigFromFile("testdata/valid_s3_adapter_config.yaml")
 		testutil.Must(t, err)
 
-		_, err = factory.BuildBlockAdapter(ctx, nil, c)
+		_, err = blockfactory.BuildBlockAdapter(ctx, nil, c)
 		var errProfileNotExists awsconfig.SharedConfigProfileNotExistError
 		if !errors.As(err, &errProfileNotExists) {
 			t.Fatalf("expected a config.SharedConfigProfileNotExistError, got '%v'", err)
@@ -137,7 +137,7 @@ func TestConfig_BuildBlockAdapter(t *testing.T) {
 	t.Run("gs block adapter", func(t *testing.T) {
 		c, err := newConfigFromFile("testdata/valid_gs_adapter_config.yaml")
 		testutil.Must(t, err)
-		adapter, err := factory.BuildBlockAdapter(ctx, nil, c)
+		adapter, err := blockfactory.BuildBlockAdapter(ctx, nil, c)
 		testutil.Must(t, err)
 
 		metricsAdapter, ok := adapter.(*block.MetricsAdapter)