Dedicated ClientConfig for the DBOS Client

Author: maxdml

dbos/client.go

@@ -5,12 +5,20 @@ import (
 	"encoding/gob"
 	"errors"
 	"fmt"
+	"log/slog"
 	"math"
 	"time"
 
 	"github.com/google/uuid"
+	"github.com/jackc/pgx/v5/pgxpool"
 )
 
+type ClientConfig struct {
+	DatabaseURL  string        // Connection URL for the PostgreSQL database
+	Logger       *slog.Logger  // Optional custom logger
+	SystemDBPool *pgxpool.Pool // Optional existing connection pool for the system database
+}
+
 // Client provides a programmatic way to interact with your DBOS application from external code.
 // It manages the underlying DBOSContext and provides methods for workflow operations
 // without requiring direct management of the context lifecycle.
@@ -35,16 +43,20 @@ type client struct {
 //
 // Example:
 //
-//	config := dbos.Config{
+//	config := dbos.ClientConfig{
 //	    DatabaseURL: "postgres://user:pass@localhost:5432/dbname",
-//	    AppName:     "my-app",
 //	}
 //	client, err := dbos.NewClient(context.Background(), config)
 //	if err != nil {
 //	    log.Fatal(err)
 //	}
-func NewClient(ctx context.Context, config Config) (Client, error) {
-	dbosCtx, err := NewDBOSContext(ctx, config)
+func NewClient(ctx context.Context, config ClientConfig) (Client, error) {
+	dbosCtx, err := NewDBOSContext(ctx, Config{
+		DatabaseURL:  config.DatabaseURL,
+		AppName:      "dbos-client",
+		Logger:       config.Logger,
+		SystemDBPool: config.SystemDBPool,
+	})
 	if err != nil {
 		return nil, err
 	}

dbos/client_test.go

@@ -65,9 +65,8 @@ func TestEnqueue(t *testing.T) {
 
 	// Setup client - this will enqueue tasks
 	databaseURL := getDatabaseURL()
-	config := Config{
+	config := ClientConfig{
 		DatabaseURL: databaseURL,
-		AppName:     "test-app",
 	}
 	client, err := NewClient(context.Background(), config)
 	require.NoError(t, err)
@@ -325,9 +324,8 @@ func TestCancelResume(t *testing.T) {
 
 	// Setup client - this will enqueue tasks
 	databaseURL := getDatabaseURL()
-	config := Config{
+	config := ClientConfig{
 		DatabaseURL: databaseURL,
-		AppName:     "test-app",
 	}
 	client, err := NewClient(context.Background(), config)
 	require.NoError(t, err)
@@ -577,9 +575,8 @@ func TestForkWorkflow(t *testing.T) {
 
 	// Setup client
 	databaseURL := getDatabaseURL()
-	config := Config{
+	config := ClientConfig{
 		DatabaseURL: databaseURL,
-		AppName:     "test-app",
 	}
 	client, err := NewClient(context.Background(), config)
 	require.NoError(t, err)
@@ -719,9 +716,8 @@ func TestListWorkflows(t *testing.T) {
 
 	// Setup client
 	databaseURL := getDatabaseURL()
-	config := Config{
+	config := ClientConfig{
 		DatabaseURL: databaseURL,
-		AppName:     "test-app",
 	}
 	client, err := NewClient(context.Background(), config)
 	require.NoError(t, err)