Move Workload to core package (#1274)

Author: eleftherias

cmd/thv/app/list.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/stacklok/toolhive/pkg/core"
 	"github.com/stacklok/toolhive/pkg/logger"
 	"github.com/stacklok/toolhive/pkg/workloads"
 )
@@ -80,7 +81,7 @@ func listCmdFunc(cmd *cobra.Command, _ []string) error {
 }
 
 // printJSONOutput prints workload information in JSON format
-func printJSONOutput(workloadList []workloads.Workload) error {
+func printJSONOutput(workloadList []core.Workload) error {
 	// Marshal to JSON
 	jsonData, err := json.MarshalIndent(workloadList, "", "  ")
 	if err != nil {
@@ -94,7 +95,7 @@ func printJSONOutput(workloadList []workloads.Workload) error {
 
 // printMCPServersOutput prints MCP servers configuration in JSON format
 // This format is compatible with client configuration files
-func printMCPServersOutput(workloadList []workloads.Workload) error {
+func printMCPServersOutput(workloadList []core.Workload) error {
 	// Create a map to hold the MCP servers configuration
 	mcpServers := make(map[string]map[string]string)
 
@@ -120,7 +121,7 @@ func printMCPServersOutput(workloadList []workloads.Workload) error {
 }
 
 // printTextOutput prints workload information in text format
-func printTextOutput(workloadList []workloads.Workload) {
+func printTextOutput(workloadList []core.Workload) {
 	// Create a tabwriter for pretty output
 	w := tabwriter.NewWriter(os.Stdout, 0, 0, 3, ' ', 0)
 	fmt.Fprintln(w, "NAME\tPACKAGE\tSTATUS\tURL\tPORT\tTOOL TYPE\tGROUP\tCREATED AT")

docs/server/docs.go

@@ -10,6 +10,7 @@ import (
 	"github.com/go-chi/chi/v5"
 
 	"github.com/stacklok/toolhive/pkg/container/runtime"
+	"github.com/stacklok/toolhive/pkg/core"
 	thverrors "github.com/stacklok/toolhive/pkg/errors"
 	"github.com/stacklok/toolhive/pkg/groups"
 	"github.com/stacklok/toolhive/pkg/logger"
@@ -122,7 +123,7 @@ func (s *WorkloadRoutes) listWorkloads(w http.ResponseWriter, r *http.Request) {
 //	@Tags			workloads
 //	@Produce		json
 //	@Param			name	path		string	true	"Workload name"
-//	@Success		200		{object}	workloads.Workload
+//	@Success		200		{object}	core.Workload
 //	@Failure		404		{string}	string	"Not Found"
 //	@Router			/api/v1beta/workloads/{name} [get]
 func (s *WorkloadRoutes) getWorkload(w http.ResponseWriter, r *http.Request) {
@@ -534,7 +535,7 @@ func (*WorkloadRoutes) exportWorkload(w http.ResponseWriter, r *http.Request) {
 //	@Description	Response containing a list of workloads
 type workloadListResponse struct {
 	// List of container information for each workload
-	Workloads []workloads.Workload `json:"workloads"`
+	Workloads []core.Workload `json:"workloads"`
 }
 
 // createRequest represents the request to create a new workload

docs/server/swagger.json

@@ -0,0 +1,42 @@
+// Package core provides the core domain model for the ToolHive system.
+package core
+
+import (
+	"time"
+
+	"github.com/stacklok/toolhive/pkg/container/runtime"
+	"github.com/stacklok/toolhive/pkg/transport/types"
+)
+
+// Workload is a domain model representing a workload in the system.
+// This is used in our API to hide details of the underlying runtime.
+type Workload struct {
+	// Name is the name of the workload.
+	// It is used as a unique identifier.
+	Name string `json:"name"`
+	// Package specifies the Workload Package used to create this Workload.
+	Package string `json:"package"`
+	// URL is the URL of the workload exposed by the ToolHive proxy.
+	URL string `json:"url"`
+	// Port is the port on which the workload is exposed.
+	// This is embedded in the URL.
+	Port int `json:"port"`
+	// ToolType is the type of tool this workload represents.
+	// For now, it will always be "mcp" - representing an MCP server.
+	ToolType string `json:"tool_type"`
+	// TransportType is the type of transport used for this workload.
+	TransportType types.TransportType `json:"transport_type"`
+	// Status is the current status of the workload.
+	Status runtime.WorkloadStatus `json:"status"`
+	// StatusContext provides additional context about the workload's status.
+	// The exact meaning is determined by the status and the underlying runtime.
+	StatusContext string `json:"status_context,omitempty"`
+	// CreatedAt is the timestamp when the workload was created.
+	CreatedAt time.Time `json:"created_at"`
+	// Labels are the container labels (excluding standard ToolHive labels)
+	Labels map[string]string `json:"labels,omitempty"`
+	// Group is the name of the group this workload belongs to, if any.
+	Group string `json:"group,omitempty"`
+	// ToolsFilter is the filter on tools applied to the workload.
+	ToolsFilter []string `json:"tools,omitempty"`
+}

docs/server/swagger.yaml

@@ -13,6 +13,7 @@ import (
 	"github.com/gofrs/flock"
 
 	rt "github.com/stacklok/toolhive/pkg/container/runtime"
+	"github.com/stacklok/toolhive/pkg/core"
 	"github.com/stacklok/toolhive/pkg/logger"
 )
 
@@ -89,8 +90,8 @@ func (f *fileStatusManager) CreateWorkloadStatus(ctx context.Context, workloadNa
 }
 
 // GetWorkload retrieves the status of a workload by its name.
-func (f *fileStatusManager) GetWorkload(ctx context.Context, workloadName string) (Workload, error) {
-	result := Workload{Name: workloadName}
+func (f *fileStatusManager) GetWorkload(ctx context.Context, workloadName string) (core.Workload, error) {
+	result := core.Workload{Name: workloadName}
 	fileFound := false
 
 	err := f.withFileReadLock(ctx, workloadName, func(statusFilePath string) error {
@@ -114,15 +115,15 @@ func (f *fileStatusManager) GetWorkload(ctx context.Context, workloadName string
 		return nil
 	})
 	if err != nil {
-		return Workload{}, err
+		return core.Workload{}, err
 	}
 
 	// If file was found and workload is running, get additional info from runtime
 	if fileFound && result.Status == rt.WorkloadStatusRunning {
 		// TODO: Find discrepancies between the file and runtime workload.
 		runtimeResult, err := f.getWorkloadFromRuntime(ctx, workloadName)
 		if err != nil {
-			return Workload{}, err
+			return core.Workload{}, err
 		}
 		// Use runtime data but preserve file-based status info
 		fileStatus := result.Status
@@ -144,7 +145,7 @@ func (f *fileStatusManager) GetWorkload(ctx context.Context, workloadName string
 	return f.getWorkloadFromRuntime(ctx, workloadName)
 }
 
-func (f *fileStatusManager) ListWorkloads(ctx context.Context, listAll bool, labelFilters []string) ([]Workload, error) {
+func (f *fileStatusManager) ListWorkloads(ctx context.Context, listAll bool, labelFilters []string) ([]core.Workload, error) {
 	// Parse the filters into a format we can use for matching.
 	parsedFilters, err := parseLabelFilters(labelFilters)
 	if err != nil {
@@ -170,7 +171,7 @@ func (f *fileStatusManager) ListWorkloads(ctx context.Context, listAll bool, lab
 	}
 
 	// Create result map to avoid duplicates and merge data
-	workloadMap := make(map[string]Workload)
+	workloadMap := make(map[string]core.Workload)
 
 	// First, add all runtime workloads
 	for _, container := range runtimeContainers {
@@ -198,7 +199,7 @@ func (f *fileStatusManager) ListWorkloads(ctx context.Context, listAll bool, lab
 	}
 
 	// Convert map to slice and apply filters
-	var workloads []Workload
+	var workloads []core.Workload
 	for _, workload := range workloadMap {
 		// Apply listAll filter
 		if !listAll && workload.Status != rt.WorkloadStatusRunning {
@@ -386,17 +387,17 @@ func (*fileStatusManager) writeStatusFile(statusFilePath string, statusFile work
 }
 
 // getWorkloadFromRuntime retrieves workload information from the runtime.
-func (f *fileStatusManager) getWorkloadFromRuntime(ctx context.Context, workloadName string) (Workload, error) {
+func (f *fileStatusManager) getWorkloadFromRuntime(ctx context.Context, workloadName string) (core.Workload, error) {
 	info, err := f.runtime.GetWorkloadInfo(ctx, workloadName)
 	if err != nil {
-		return Workload{}, fmt.Errorf("failed to get workload info from runtime: %w", err)
+		return core.Workload{}, fmt.Errorf("failed to get workload info from runtime: %w", err)
 	}
 
 	return WorkloadFromContainerInfo(&info)
 }
 
 // getWorkloadsFromFiles retrieves all workloads from status files.
-func (f *fileStatusManager) getWorkloadsFromFiles() (map[string]Workload, error) {
+func (f *fileStatusManager) getWorkloadsFromFiles() (map[string]core.Workload, error) {
 	// Ensure base directory exists
 	if err := f.ensureBaseDir(); err != nil {
 		return nil, fmt.Errorf("failed to ensure base directory: %w", err)
@@ -408,7 +409,7 @@ func (f *fileStatusManager) getWorkloadsFromFiles() (map[string]Workload, error)
 		return nil, fmt.Errorf("failed to list status files: %w", err)
 	}
 
-	workloads := make(map[string]Workload)
+	workloads := make(map[string]core.Workload)
 	for _, file := range files {
 		// Extract workload name from filename (remove .json extension)
 		workloadName := strings.TrimSuffix(filepath.Base(file), ".json")
@@ -421,7 +422,7 @@ func (f *fileStatusManager) getWorkloadsFromFiles() (map[string]Workload, error)
 		}
 
 		// Create workload from file data
-		workload := Workload{
+		workload := core.Workload{
 			Name:          workloadName,
 			Status:        statusFile.Status,
 			StatusContext: statusFile.StatusContext,

pkg/api/v1/workloads.go

@@ -15,6 +15,7 @@ import (
 
 	rt "github.com/stacklok/toolhive/pkg/container/runtime"
 	"github.com/stacklok/toolhive/pkg/container/runtime/mocks"
+	"github.com/stacklok/toolhive/pkg/core"
 	"github.com/stacklok/toolhive/pkg/logger"
 )
 
@@ -379,7 +380,7 @@ func TestFileStatusManager_ListWorkloads(t *testing.T) {
 		setupRuntimeMock func(*mocks.MockRuntime)
 		expectedCount    int
 		expectedError    string
-		checkWorkloads   func([]Workload)
+		checkWorkloads   func([]core.Workload)
 	}{
 		{
 			name:    "empty directory",
@@ -403,7 +404,7 @@ func TestFileStatusManager_ListWorkloads(t *testing.T) {
 				m.EXPECT().ListWorkloads(gomock.Any()).Return([]rt.ContainerInfo{}, nil)
 			},
 			expectedCount: 1,
-			checkWorkloads: func(workloads []Workload) {
+			checkWorkloads: func(workloads []core.Workload) {
 				assert.Equal(t, "test-workload", workloads[0].Name)
 				assert.Equal(t, rt.WorkloadStatusStarting, workloads[0].Status)
 			},
@@ -442,7 +443,7 @@ func TestFileStatusManager_ListWorkloads(t *testing.T) {
 				m.EXPECT().ListWorkloads(gomock.Any()).Return([]rt.ContainerInfo{info}, nil)
 			},
 			expectedCount: 1,
-			checkWorkloads: func(workloads []Workload) {
+			checkWorkloads: func(workloads []core.Workload) {
 				assert.Equal(t, "running-workload", workloads[0].Name)
 				assert.Equal(t, rt.WorkloadStatusRunning, workloads[0].Status)
 			},
@@ -540,10 +541,10 @@ func TestFileStatusManager_ListWorkloads(t *testing.T) {
 				m.EXPECT().ListWorkloads(gomock.Any()).Return(containers, nil)
 			},
 			expectedCount: 2,
-			checkWorkloads: func(workloads []Workload) {
+			checkWorkloads: func(workloads []core.Workload) {
 				// Find the merged workload
-				var mergedWorkload *Workload
-				var runtimeOnlyWorkload *Workload
+				var mergedWorkload *core.Workload
+				var runtimeOnlyWorkload *core.Workload
 				for i := range workloads {
 					switch workloads[i].Name {
 					case "merge-workload":