decoupling CodexClient from the rest of the system

Author: marcinczenko

cmd/download/main.go

@@ -7,7 +7,7 @@ import (
 	"os"
 	"path"
 
-	"go-codex-client/communities" // Import the local communities package
+	"go-codex-client/codexclient"
 
 	"github.com/codex-storage/codex-go-bindings/codex"
 )
@@ -25,7 +25,7 @@ func main() {
 	}
 
 	// Create Codex client
-	client, err := communities.NewCodexClient(codex.Config{
+	client, err := codexclient.NewCodexClient(codex.Config{
 		LogFormat:      codex.LogFormatNoColors,
 		MetricsEnabled: false,
 		BlockRetries:   5,

cmd/upload/main.go

@@ -8,7 +8,7 @@ import (
 	"os"
 	"path"
 
-	"go-codex-client/communities" // Import the local communities package
+	"go-codex-client/codexclient"
 
 	"github.com/codex-storage/codex-go-bindings/codex"
 )
@@ -34,7 +34,7 @@ func main() {
 
 	fmt.Printf("Uploading %s (%d bytes) to Codex...\n", *file, len(data))
 	// Create Codex client and upload
-	client, err := communities.NewCodexClient(codex.Config{
+	client, err := codexclient.NewCodexClient(codex.Config{
 		LogFormat:      codex.LogFormatNoColors,
 		MetricsEnabled: false,
 		BlockRetries:   5,

communities/codex_client.go renamed to codexclient/codex_client.go

@@ -1,17 +1,21 @@
-/* Package communities
+/* Package codexclientpackage codexclient
+
 *
 * Provides a CodexClient type that you can use to conveniently
 * upload buffers to Codex.
 *
  */
-package communities
+
+package codexclient
 
 import (
 	"bytes"
 	"context"
 	"fmt"
 	"io"
 
+	"go-codex-client/codexmanifest"
+
 	"github.com/codex-storage/codex-go-bindings/codex"
 )
 
@@ -58,7 +62,7 @@ func (c *CodexClient) Download(cid string, output io.Writer) error {
 	return c.DownloadWithContext(context.Background(), cid, output)
 }
 
-func (c *CodexClient) TriggerDownload(cid string) (codex.Manifest, error) {
+func (c *CodexClient) TriggerDownload(cid string) (codexmanifest.CodexManifest, error) {
 	return c.TriggerDownloadWithContext(context.Background(), cid)
 }
 
@@ -89,12 +93,34 @@ func (c *CodexClient) LocalDownloadWithContext(ctx context.Context, cid string,
 	return c.LocalDownload(cid, output)
 }
 
-func (c *CodexClient) FetchManifestWithContext(ctx context.Context, cid string) (codex.Manifest, error) {
-	return c.node.DownloadManifest(cid)
+func (c *CodexClient) FetchManifestWithContext(ctx context.Context, cid string) (codexmanifest.CodexManifest, error) {
+	manifest, err := c.node.DownloadManifest(cid)
+	if err != nil {
+		return codexmanifest.CodexManifest{}, err
+	}
+	return codexmanifest.CodexManifest{
+		Cid:         manifest.Cid,
+		TreeCid:     manifest.TreeCid,
+		DatasetSize: manifest.DatasetSize,
+		BlockSize:   manifest.BlockSize,
+		Filename:    manifest.Filename,
+		Mimetype:    manifest.Mimetype,
+	}, nil
 }
 
-func (c *CodexClient) TriggerDownloadWithContext(ctx context.Context, cid string) (codex.Manifest, error) {
-	return c.node.Fetch(cid)
+func (c *CodexClient) TriggerDownloadWithContext(ctx context.Context, cid string) (codexmanifest.CodexManifest, error) {
+	manifest, err := c.node.Fetch(cid)
+	if err != nil {
+		return codexmanifest.CodexManifest{}, err
+	}
+	return codexmanifest.CodexManifest{
+		Cid:         manifest.Cid,
+		TreeCid:     manifest.TreeCid,
+		DatasetSize: manifest.DatasetSize,
+		BlockSize:   manifest.BlockSize,
+		Filename:    manifest.Filename,
+		Mimetype:    manifest.Mimetype,
+	}, nil
 }
 
 // UploadArchive is a convenience method for uploading archive data

communities/codex_client_integration_test.go renamed to codexclient/codex_client_integration_test.go

@@ -1,7 +1,7 @@
 //go:build codex_integration
 // +build codex_integration
 
-package communities_test
+package codexclient_test
 
 import (
 	"bytes"
@@ -16,19 +16,21 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
+	"go-codex-client/codexclient"
+	"go-codex-client/codextestutils"
 	"go-codex-client/communities"
 )
 
 // CodexClientIntegrationTestSuite demonstrates testify's suite functionality for CodexClient integration tests
 type CodexClientIntegrationTestSuite struct {
 	suite.Suite
-	client *communities.CodexClient
+	client communities.CodexClientInterface
 }
 
 // SetupSuite runs once before all tests in the suite
 func (suite *CodexClientIntegrationTestSuite) SetupSuite() {
 	var err error
-	suite.client, err = communities.NewCodexClient(codex.Config{
+	suite.client, err = codexclient.NewCodexClient(codex.Config{
 		DataDir:        suite.T().TempDir(),
 		LogFormat:      codex.LogFormatNoColors,
 		MetricsEnabled: false,
@@ -107,7 +109,7 @@ func (suite *CodexClientIntegrationTestSuite) TestIntegration_CheckNonExistingCI
 }
 
 func (suite *CodexClientIntegrationTestSuite) TestIntegration_TriggerDownload() {
-	client := NewCodexClientTest(suite.T())
+	client := codextestutils.NewCodexClientTest(suite.T())
 
 	// Generate random payload to ensure proper round-trip verification
 	payload := make([]byte, 1024)

communities/codex_client_test.go renamed to codexclient/codex_client_test.go

@@ -1,4 +1,7 @@
-package communities_test
+//go:build codex_integration
+// +build codex_integration
+
+package codexclient_test
 
 import (
 	"bytes"
@@ -12,10 +15,11 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
-	"go-codex-client/communities"
+	"go-codex-client/codexclient"
+	"go-codex-client/codextestutils"
 )
 
-func upload(client communities.CodexClient, t *testing.T, buf *bytes.Buffer) string {
+func upload(client codexclient.CodexClient, t *testing.T, buf *bytes.Buffer) string {
 	filename := "hello.txt"
 	cid, err := client.Upload(buf, filename)
 	if err != nil {
@@ -32,12 +36,12 @@ func upload(client communities.CodexClient, t *testing.T, buf *bytes.Buffer) str
 // CodexClientTestSuite demonstrates testify's suite functionality for CodexClient tests
 type CodexClientTestSuite struct {
 	suite.Suite
-	client *communities.CodexClient
+	client *codexclient.CodexClient
 }
 
 // SetupTest runs before each test method
 func (suite *CodexClientTestSuite) SetupTest() {
-	suite.client = NewCodexClientTest(suite.T())
+	suite.client = codextestutils.NewCodexClientTest(suite.T())
 }
 
 // TearDownTest runs after each test method

codexmanifest/codex_manifest.go

@@ -0,0 +1,11 @@
+package codexmanifest
+
+type CodexManifest struct {
+	Cid         string
+	TreeCid     string
+	DatasetSize int
+	BlockSize   int
+	Filename    string
+	Mimetype    string
+	Protected   bool
+}

communities/testutil_test.go renamed to codextestutils/codex_test_utils.go

@@ -1,14 +1,16 @@
-package communities_test
+//go:build codex_integration
+
+package codextestutils
 
 import (
-	"go-codex-client/communities"
+	"go-codex-client/codexclient"
 	"testing"
 
 	"github.com/codex-storage/codex-go-bindings/codex"
 )
 
-func NewCodexClientTest(t *testing.T) *communities.CodexClient {
-	client, err := communities.NewCodexClient(codex.Config{
+func NewCodexClientTest(t *testing.T) *codexclient.CodexClient {
+	client, err := codexclient.NewCodexClient(codex.Config{
 		DataDir:        t.TempDir(),
 		LogFormat:      codex.LogFormatNoColors,
 		MetricsEnabled: false,

communities/codex_archive_downloader_integration_test.go

@@ -17,6 +17,7 @@ import (
 	"github.com/stretchr/testify/suite"
 	"go.uber.org/zap"
 
+	"go-codex-client/codexclient"
 	"go-codex-client/communities"
 	"go-codex-client/protobuf"
 )
@@ -25,14 +26,14 @@ import (
 // against a real Codex instance
 type CodexArchiveDownloaderIntegrationSuite struct {
 	suite.Suite
-	client       *communities.CodexClient
+	client       communities.CodexClientInterface
 	uploadedCIDs []string // Track uploaded CIDs for cleanup
 }
 
 // SetupSuite runs once before all tests in the suite
 func (suite *CodexArchiveDownloaderIntegrationSuite) SetupSuite() {
 	var err error
-	suite.client, err = communities.NewCodexClient(codex.Config{
+	suite.client, err = codexclient.NewCodexClient(codex.Config{
 		LogFormat:      codex.LogFormatNoColors,
 		MetricsEnabled: false,
 		BlockRetries:   5,