Merge pull request #719 from iotaledger/remove/snap-endpoint-target-slot

Remove target slot from `CreateSnapshot` endpoint
iotaledger · Apr 25, 2024 · 3659144 · 3659144
2 parents 054bd7d + 62d963e
commit 3659144
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 40 deletions.
diff --git a/api/management.go b/api/management.go
@@ -57,12 +57,6 @@ type (
 		Epoch iotago.EpochIndex `serix:""`
 	}
 
-	// CreateSnapshotRequest defines the request of a create snapshot REST API call.
-	CreateSnapshotRequest struct {
-		// The slot of the snapshot.
-		Slot iotago.SlotIndex `serix:""`
-	}
-
 	// CreateSnapshotResponse defines the response of a create snapshot REST API call.
 	CreateSnapshotResponse struct {
 		// The slot of the snapshot.

diff --git a/api/management_test.go b/api/management_test.go
@@ -68,13 +68,6 @@ func Test_ManagementAPIDeSerialize(t *testing.T) {
 			},
 			Target: &api.PruneDatabaseResponse{},
 		},
-		{
-			Name: "ok - CreateSnapshotRequest",
-			Source: &api.CreateSnapshotRequest{
-				Slot: 1,
-			},
-			Target: &api.CreateSnapshotRequest{},
-		},
 		{
 			Name: "ok - CreateSnapshotResponse",
 			Source: &api.CreateSnapshotResponse{
@@ -185,15 +178,6 @@ func Test_ManagementAPIJSONSerialization(t *testing.T) {
 			},
 			Target: `{
 	"epoch": 1
-}`,
-		},
-		{
-			Name: "ok - CreateSnapshotRequest",
-			Source: &api.CreateSnapshotRequest{
-				Slot: 1,
-			},
-			Target: `{
-	"slot": 1
 }`,
 		},
 		{

diff --git a/nodeclient/http_api_client_test.go b/nodeclient/http_api_client_test.go
@@ -76,11 +76,13 @@ func mockGetJSONWithParams(route string, status int, body interface{}, params ma
 
 //nolint:unparam // false positive
 func mockPostJSON(route string, status int, req interface{}, resp interface{}) {
-	gock.New(nodeAPIUrl).
-		Post(route).
-		MatchHeader("Content-Type", api.MIMEApplicationJSON).
-		BodyString(string(lo.PanicOnErr(mockAPI.JSONEncode(req)))).
-		Reply(status).
+	mock := gock.New(nodeAPIUrl).Post(route)
+	if req != nil {
+		mock.MatchHeader("Content-Type", api.MIMEApplicationJSON).
+			BodyString(string(lo.PanicOnErr(mockAPI.JSONEncode(req))))
+	}
+
+	mock.Reply(status).
 		SetHeader("Content-Type", api.MIMEApplicationJSON).
 		BodyString(string(lo.PanicOnErr(mockAPI.JSONEncode(resp))))
 }

diff --git a/nodeclient/management_client.go b/nodeclient/management_client.go
@@ -26,7 +26,7 @@ type (
 		// PruneDatabaseByDepth prunes the database by depth.
 		PruneDatabaseByDepth(ctx context.Context, depth iotago.EpochIndex) (*api.PruneDatabaseResponse, error)
 		// CreateSnapshot creates a snapshot.
-		CreateSnapshot(ctx context.Context, slot iotago.SlotIndex) (*api.CreateSnapshotResponse, error)
+		CreateSnapshot(ctx context.Context) (*api.CreateSnapshotResponse, error)
 	}
 
 	managementClient struct {
@@ -147,14 +147,10 @@ func (client *managementClient) PruneDatabaseByDepth(ctx context.Context, depth
 }
 
 // CreateSnapshot creates a snapshot.
-func (client *managementClient) CreateSnapshot(ctx context.Context, slot iotago.SlotIndex) (*api.CreateSnapshotResponse, error) {
-	req := &api.CreateSnapshotRequest{
-		Slot: slot,
-	}
-
+func (client *managementClient) CreateSnapshot(ctx context.Context) (*api.CreateSnapshotResponse, error) {
 	res := new(api.CreateSnapshotResponse)
 	//nolint:bodyclose
-	if _, err := client.DoWithRequestHeaderHook(ctx, http.MethodPost, api.ManagementRouteSnapshotsCreate, RequestHeaderHookAcceptJSON, req, res); err != nil {
+	if _, err := client.DoWithRequestHeaderHook(ctx, http.MethodPost, api.ManagementRouteSnapshotsCreate, RequestHeaderHookAcceptJSON, nil, res); err != nil {
 		return nil, err
 	}
 

diff --git a/nodeclient/management_client_test.go b/nodeclient/management_client_test.go
@@ -267,28 +267,24 @@ func TestManagementClient_PruneDatabaseByDepth(t *testing.T) {
 func TestManagementClient_CreateSnapshot(t *testing.T) {
 	defer gock.Off()
 
-	slot := iotago.SlotIndex(1)
-
 	originRes := &api.CreateSnapshotResponse{
 		Slot:     1,
 		FilePath: "filePath",
 	}
 
-	req := &api.CreateSnapshotRequest{Slot: slot}
-
 	originRoutes := &api.RoutesResponse{
 		Routes: []iotago.PrefixedStringUint8{api.ManagementPluginName},
 	}
 
 	mockGetJSON(api.RouteRoutes, 200, originRoutes)
-	mockPostJSON(api.ManagementRouteSnapshotsCreate, 200, req, originRes)
+	mockPostJSON(api.ManagementRouteSnapshotsCreate, 200, nil, originRes)
 
 	client := nodeClient(t)
 
 	management, err := client.Management(context.TODO())
 	require.NoError(t, err)
 
-	resp, err := management.CreateSnapshot(context.Background(), slot)
+	resp, err := management.CreateSnapshot(context.Background())
 	require.NoError(t, err)
 	require.EqualValues(t, originRes, resp)
 }