Refactor item and launch sorting; improve error handling in API calls (#8)

* Refactor item and launch sorting; improve error handling in API calls

* Add context utilities and middleware for handling query parameters

Author: avarabyeu

go.mod

@@ -4,7 +4,7 @@ go 1.24.4
 
 require (
 	github.com/mark3labs/mcp-go v0.32.0
-	github.com/reportportal/goRP/v5 v5.1.2
+	github.com/reportportal/goRP/v5 v5.1.3
 	github.com/stretchr/testify v1.10.0
 	github.com/urfave/cli/v3 v3.3.8
 	github.com/yosida95/uritemplate/v3 v3.0.2

go.sum

@@ -14,8 +14,8 @@ github.com/mark3labs/mcp-go v0.32.0 h1:fgwmbfL2gbd67obg57OfV2Dnrhs1HtSdlY/i5fn7M
 github.com/mark3labs/mcp-go v0.32.0/go.mod h1:rXqOudj/djTORU/ThxYx8fqEVj/5pvTuuebQ2RC7uk4=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/reportportal/goRP/v5 v5.1.2 h1:scAj806S65P6HCDx/YMiOJtw2mPU0w2LUx0cxeBbEVg=
-github.com/reportportal/goRP/v5 v5.1.2/go.mod h1:Au44IuWeL3UBHyve7U64kNDQMtlrYBp8aeiHjgPDrGs=
+github.com/reportportal/goRP/v5 v5.1.3 h1:0uLbch6Qwkd2Zcy4RtAVR2HSLlBjtiIX4YgH7wk7ZE0=
+github.com/reportportal/goRP/v5 v5.1.3/go.mod h1:d2O3iaBElP/OA9p92xcmIuwmVaXX4HY9lT/YpmL5t6g=
 github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M=
 github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA=
 github.com/spf13/cast v1.8.0 h1:gEN9K4b8Xws4EX0+a0reLmhq8moKn7ntRlQYgjPeCDk=

internal/reportportal/ctx_utils.go

@@ -0,0 +1,23 @@
+package mcpreportportal
+
+import (
+	"context"
+	"net/url"
+)
+
+type contextKey string
+
+var contextKeyQueryParams = contextKey(
+	"queryParams",
+) // Key for storing query parameters in the context
+
+func WithQueryParams(ctx context.Context, queryParams url.Values) context.Context {
+	// Create a new context with the query parameters
+	return context.WithValue(ctx, contextKeyQueryParams, queryParams)
+}
+
+func QueryParamsFromContext(ctx context.Context) (url.Values, bool) {
+	// Retrieve the query parameters from the context
+	queryParams, ok := ctx.Value(contextKeyQueryParams).(url.Values)
+	return queryParams, ok
+}

internal/reportportal/ctx_utils_test.go

@@ -0,0 +1,62 @@
+package mcpreportportal
+
+import (
+	"context"
+	"net/url"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestWithAndQueryParamsFromContext(t *testing.T) {
+	ctx := context.Background()
+	params := url.Values{}
+	params.Add("foo", "bar")
+	params.Add("baz", "qux")
+
+	ctxWithParams := WithQueryParams(ctx, params)
+	retrieved, ok := QueryParamsFromContext(ctxWithParams)
+	assert.True(t, ok)
+	assert.Equal(t, params, retrieved)
+
+	// Test with context that does not have query params
+	_, ok = QueryParamsFromContext(context.Background())
+	assert.False(t, ok)
+}
+
+func TestQueryParamsFromContext_Absent(t *testing.T) {
+	ctx := context.Background()
+	val, ok := QueryParamsFromContext(ctx)
+	assert.False(t, ok)
+	assert.Nil(t, val)
+}
+
+func TestQueryParamsFromContext_PresentNil(t *testing.T) {
+	ctx := WithQueryParams(context.Background(), nil)
+	val, ok := QueryParamsFromContext(ctx)
+	assert.True(t, ok)
+	assert.Nil(t, val)
+}
+
+func TestQueryParamsFromContext_PresentEmpty(t *testing.T) {
+	params := url.Values{}
+	ctx := WithQueryParams(context.Background(), params)
+	val, ok := QueryParamsFromContext(ctx)
+	assert.True(t, ok)
+	assert.Equal(t, params, val)
+}
+
+func TestWithQueryParams_Overwrite(t *testing.T) {
+	params1 := url.Values{}
+	params1.Add("foo", "bar")
+	ctx := WithQueryParams(context.Background(), params1)
+
+	params2 := url.Values{}
+	params2.Add("baz", "qux")
+	ctx = WithQueryParams(ctx, params2)
+
+	val, ok := QueryParamsFromContext(ctx)
+	assert.True(t, ok)
+	assert.Equal(t, params2, val)
+	assert.NotEqual(t, params1, val)
+}

internal/reportportal/items.go

@@ -4,13 +4,16 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"log/slog"
 
 	"github.com/mark3labs/mcp-go/mcp"
 	"github.com/mark3labs/mcp-go/server"
 	"github.com/reportportal/goRP/v5/pkg/gorp"
 	"github.com/yosida95/uritemplate/v3"
 )
 
+const itemsDefaultSorting = "startTime,DESC" // default sorting order for test items
+
 // TestItemResources is a struct that encapsulates the ReportPortal client.
 type TestItemResources struct {
 	client           *gorp.Client // Client to interact with the ReportPortal API
@@ -42,6 +45,7 @@ func (lr *TestItemResources) toolListLaunchTestItems() (tool mcp.Tool, handler s
 				mcp.Description("Page size"),
 			),
 		), func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+			slog.Debug("START PROCESSING")
 			project, err := extractProject(request)
 			if err != nil {
 				return mcp.NewToolResultError(err.Error()), nil
@@ -55,14 +59,14 @@ func (lr *TestItemResources) toolListLaunchTestItems() (tool mcp.Tool, handler s
 			}
 
 			// Fetch test items from ReportPortal using the provided page details
-			items, _, err := lr.client.TestItemAPI.GetTestItemsV2(ctx, project).
+			items, rs, err := lr.client.TestItemAPI.GetTestItems(ctx, project).
 				FilterEqLaunchId(int32(launchId)). //nolint:gosec
 				PagePage(page).
 				PageSize(pageSize).
-				PageSort(defaultSorting).
+				PageSort(itemsDefaultSorting).
 				Execute()
 			if err != nil {
-				return mcp.NewToolResultError(err.Error()), nil
+				return mcp.NewToolResultError(extractResponseError(err, rs)), nil
 			}
 
 			// Serialize the launches into JSON format

internal/reportportal/launches.go

@@ -16,10 +16,10 @@ import (
 )
 
 const (
-	firstPage       = 1                       // Default starting page for pagination
-	singleResult    = 1                       // Default number of results per page
-	defaultPageSize = 20                      // Default number of items per page
-	defaultSorting  = "startTime,number,DESC" // default sorting order for API requests
+	firstPage              = 1                       // Default starting page for pagination
+	singleResult           = 1                       // Default number of results per page
+	defaultPageSize        = 20                      // Default number of items per page
+	launchesDefaultSorting = "startTime,number,DESC" // default sorting order for launches
 )
 
 // LaunchResources is a struct that encapsulates the ReportPortal client.
@@ -60,7 +60,7 @@ func (lr *LaunchResources) toolListLaunches() (tool mcp.Tool, handler server.Too
 			launches, _, err := lr.client.LaunchAPI.GetProjectLaunches(ctx, project).
 				PagePage(page).
 				PageSize(pageSize).
-				PageSort(defaultSorting).
+				PageSort(launchesDefaultSorting).
 				Execute()
 			if err != nil {
 				return mcp.NewToolResultError(err.Error()), nil
@@ -140,7 +140,7 @@ func (lr *LaunchResources) toolGetLastLaunchByName() (mcp.Tool, server.ToolHandl
 				FilterEqName(launchName).
 				PagePage(firstPage).
 				PageSize(singleResult).
-				PageSort(defaultSorting).
+				PageSort(launchesDefaultSorting).
 				Execute()
 			if err != nil {
 				return mcp.NewToolResultError(err.Error()), nil

internal/reportportal/middleware.go

@@ -0,0 +1,17 @@
+package mcpreportportal
+
+import "net/http"
+
+func QueryParamsMiddleware(rq *http.Request) {
+	paramsFromContext, ok := QueryParamsFromContext(rq.Context())
+	if ok && paramsFromContext != nil {
+		// If query parameters are present in the context, add them to the request URL
+		query := rq.URL.Query()
+		for key, values := range paramsFromContext {
+			for _, value := range values {
+				query.Add(key, value)
+			}
+		}
+		rq.URL.RawQuery = query.Encode() // Encode the updated query parameters into the request URL
+	}
+}

internal/reportportal/middleware_test.go

@@ -0,0 +1,27 @@
+package mcpreportportal
+
+import (
+	"net/http"
+	"net/url"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestQueryParamsMiddleware(t *testing.T) {
+	params := url.Values{}
+	params.Add("a", "1")
+	params.Add("b", "2")
+	params.Add("b", "3")
+
+	req, _ := http.NewRequest("GET", "http://example.com/path?x=9", nil)
+	ctx := WithQueryParams(req.Context(), params)
+	req = req.WithContext(ctx)
+
+	QueryParamsMiddleware(req)
+
+	got := req.URL.Query()
+	assert.Equal(t, []string{"9"}, got["x"])
+	assert.Equal(t, []string{"1"}, got["a"])
+	assert.Equal(t, []string{"2", "3"}, got["b"])
+}

internal/reportportal/server.go

@@ -32,6 +32,7 @@ func NewServer(
 
 	// Create a new ReportPortal client
 	rpClient := gorp.NewClient(hostUrl, token)
+	rpClient.APIClient.GetConfig().Middleware = QueryParamsMiddleware
 
 	launches := NewLaunchResources(rpClient, defaultProject)
 	s.AddTool(launches.toolListLaunches())

internal/reportportal/utils.go

@@ -1,7 +1,9 @@
 package mcpreportportal
 
 import (
+	"io"
 	"math"
+	"net/http"
 
 	"github.com/mark3labs/mcp-go/mcp"
 )
@@ -34,3 +36,11 @@ func extractPaging(request mcp.CallToolRequest) (int32, int32) {
 	//nolint:gosec // the int32 is confirmed
 	return int32(page), int32(pageSize)
 }
+
+func extractResponseError(err error, rs *http.Response) string {
+	errText := err.Error()
+	if errContent, rErr := io.ReadAll(rs.Body); rErr == nil {
+		errText = errText + ": " + string(errContent)
+	}
+	return errText
+}