feat: update endpoint name and title (frain-dev#1945)

Author: jirevwe

api/dashboard_integration_test.go

@@ -367,7 +367,7 @@ func (s *DashboardIntegrationTestSuite) TestGetDashboardSummary() {
 	endpoint := &datastore.Endpoint{
 		UID:          "abc",
 		ProjectID:    s.DefaultProject.UID,
-		Title:        "test-app",
+		Name:         "test-app",
 		Secrets:      datastore.Secrets{},
 		SupportEmail: "test@suport.com",
 		CreatedAt:    time.Now(),
@@ -691,7 +691,7 @@ func (s *EndpointIntegrationTestSuite) Test_GetEndpoint_ValidEndpoint() {
 	dbEndpoint, err := endpointRepo.FindEndpointByID(context.Background(), endpointID, s.DefaultProject.UID)
 	require.NoError(s.T(), err)
 	require.Equal(s.T(), endpoint.UID, dbEndpoint.UID)
-	require.Equal(s.T(), endpoint.Title, dbEndpoint.Title)
+	require.Equal(s.T(), endpoint.Name, dbEndpoint.Name)
 }
 
 func (s *EndpointIntegrationTestSuite) Test_GetEndpoints_ValidEndpoints() {
@@ -759,8 +759,8 @@ func (s *EndpointIntegrationTestSuite) Test_CreateEndpoint() {
 	endpointRepo := postgres.NewEndpointRepo(s.ConvoyApp.A.DB, s.ConvoyApp.A.Cache)
 	dbEndpoint, err := endpointRepo.FindEndpointByID(context.Background(), endpoint.UID, s.DefaultProject.UID)
 	require.NoError(s.T(), err)
-	require.Equal(s.T(), endpointTitle, dbEndpoint.Title)
-	require.Equal(s.T(), endpointURL, dbEndpoint.TargetURL)
+	require.Equal(s.T(), endpointTitle, dbEndpoint.Name)
+	require.Equal(s.T(), endpointURL, dbEndpoint.Url)
 }
 
 func (s *EndpointIntegrationTestSuite) Test_CreateEndpoint_NoName() {
@@ -849,9 +849,9 @@ func (s *EndpointIntegrationTestSuite) Test_UpdateEndpoint() {
 	dbEndpoint, err := endpointRepo.FindEndpointByID(context.Background(), endpointID, s.DefaultProject.UID)
 	require.NoError(s.T(), err)
 	require.Equal(s.T(), endpoint.UID, dbEndpoint.UID)
-	require.Equal(s.T(), title, dbEndpoint.Title)
+	require.Equal(s.T(), title, dbEndpoint.Name)
 	require.Equal(s.T(), supportEmail, dbEndpoint.SupportEmail)
-	require.Equal(s.T(), endpointURL, dbEndpoint.TargetURL)
+	require.Equal(s.T(), endpointURL, dbEndpoint.Url)
 }
 
 func (s *EndpointIntegrationTestSuite) Test_DeleteEndpoint() {
@@ -920,8 +920,8 @@ func (s *EndpointIntegrationTestSuite) Test_CreateEndpoint_With_Custom_Authentic
 	var endpoint datastore.Endpoint
 	parseResponse(s.T(), w.Result(), &endpoint)
 
-	require.Equal(s.T(), title, endpoint.Title)
-	require.Equal(s.T(), endpointURL, endpoint.TargetURL)
+	require.Equal(s.T(), title, endpoint.Name)
+	require.Equal(s.T(), endpointURL, endpoint.Url)
 	require.Equal(s.T(), datastore.EndpointAuthenticationType("api_key"), endpoint.Authentication.Type)
 	require.Equal(s.T(), "x-api-key", endpoint.Authentication.ApiKey.HeaderName)
 	require.Equal(s.T(), "testapikey", endpoint.Authentication.ApiKey.HeaderValue)
@@ -1121,7 +1121,7 @@ func (s *EventIntegrationTestSuite) Test_CreateEndpointEvent_With_App_ID_Valid_E
 	// Create an Endpoint with an app ID
 	endpoint := &datastore.Endpoint{
 		UID:       endpointID,
-		Title:     fmt.Sprintf("TestEndpoint-%s", endpointID),
+		Name:      fmt.Sprintf("TestEndpoint-%s", endpointID),
 		ProjectID: s.DefaultProject.UID,
 		AppID:     appID,
 		Secrets: datastore.Secrets{

api/migrations.go

@@ -2,6 +2,7 @@ package api
 
 import (
 	v20240101 "github.com/frain-dev/convoy/api/migrations/v20240101"
+	v20240306 "github.com/frain-dev/convoy/api/migrations/v20240306"
 	"github.com/subomi/requestmigrations"
 )
 
@@ -14,4 +15,10 @@ var migrations = requestmigrations.MigrationStore{
 		&v20240101.UpdateEndpointRequestMigration{},
 		&v20240101.UpdateEndpointResponseMigration{},
 	},
+	"2024-03-06": requestmigrations.Migrations{
+		&v20240306.CreateEndpointResponseMigration{},
+		&v20240306.GetEndpointResponseMigration{},
+		&v20240306.GetEndpointsResponseMigration{},
+		&v20240306.UpdateEndpointResponseMigration{},
+	},
 }

api/migrations/v20240306/common.go

@@ -0,0 +1,40 @@
+package v20240306
+
+import (
+	"github.com/fatih/structs"
+)
+
+func migrateEndpoint(oldPayload, newPayload interface{}) error {
+	oldStruct := structs.New(oldPayload)
+	newStruct := structs.New(newPayload)
+
+	var err error
+	for _, f := range oldStruct.Fields() {
+		if f.IsZero() {
+			continue
+		}
+
+		value := f.Value()
+		jsonTag := f.Tag("json")
+
+		switch jsonTag {
+		case "url":
+			err = newStruct.Field("TargetURL").Set(value)
+			if err != nil {
+				return err
+			}
+		case "name":
+			err = newStruct.Field("Title").Set(value)
+			if err != nil {
+				return err
+			}
+		default:
+			err = newStruct.Field(f.Name()).Set(value)
+			if err != nil {
+				return err
+			}
+		}
+	}
+
+	return nil
+}

api/migrations/v20240306/create_endpoint_migration.go

@@ -0,0 +1,81 @@
+package v20240306
+
+import (
+	"encoding/json"
+	"github.com/frain-dev/convoy/datastore"
+	"net/http"
+	"time"
+
+	"github.com/frain-dev/convoy/api/models"
+	"github.com/frain-dev/convoy/util"
+	"gopkg.in/guregu/null.v4"
+)
+
+type oldEndpointResponse struct {
+	UID                string            `json:"uid" db:"id"`
+	ProjectID          string            `json:"project_id" db:"project_id"`
+	OwnerID            string            `json:"owner_id,omitempty" db:"owner_id"`
+	TargetURL          string            `json:"target_url" db:"target_url"`
+	Title              string            `json:"title" db:"title"`
+	Secrets            datastore.Secrets `json:"secrets" db:"secrets"`
+	AdvancedSignatures bool              `json:"advanced_signatures" db:"advanced_signatures"`
+	Description        string            `json:"description" db:"description"`
+	SlackWebhookURL    string            `json:"slack_webhook_url,omitempty" db:"slack_webhook_url"`
+	SupportEmail       string            `json:"support_email,omitempty" db:"support_email"`
+	AppID              string            `json:"-" db:"app_id"` // Deprecated but necessary for backward compatibility
+
+	HttpTimeout uint64                   `json:"http_timeout" db:"http_timeout"`
+	RateLimit   int                      `json:"rate_limit" db:"rate_limit"`
+	Events      int64                    `json:"events,omitempty" db:"event_count"`
+	Status      datastore.EndpointStatus `json:"status" db:"status"`
+
+	RateLimitDuration uint64                            `json:"rate_limit_duration" db:"rate_limit_duration"`
+	Authentication    *datastore.EndpointAuthentication `json:"authentication" db:"authentication"`
+
+	CreatedAt time.Time `json:"created_at,omitempty" db:"created_at,omitempty" swaggertype:"string"`
+	UpdatedAt time.Time `json:"updated_at,omitempty" db:"updated_at,omitempty" swaggertype:"string"`
+	DeletedAt null.Time `json:"deleted_at,omitempty" db:"deleted_at" swaggertype:"string"`
+}
+
+type CreateEndpointResponseMigration struct{}
+
+func (c *CreateEndpointResponseMigration) Migrate(b []byte, h http.Header) ([]byte, http.Header, error) {
+	var serverResponse util.ServerResponse
+	err := json.Unmarshal(b, &serverResponse)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	if len(serverResponse.Data) == 0 {
+		// nothing to transform.
+		return b, h, nil
+	}
+
+	var endpointResp *models.EndpointResponse
+	err = json.Unmarshal(serverResponse.Data, &endpointResp)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	endpoint := endpointResp.Endpoint
+
+	var old oldEndpointResponse
+	err = migrateEndpoint(&endpoint, &old)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	b, err = json.Marshal(old)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	serverResponse.Data = b
+
+	sb, err := json.Marshal(serverResponse)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	return sb, h, nil
+}

api/migrations/v20240306/create_endpoint_migration_test.go

@@ -0,0 +1,54 @@
+package v20240306
+
+import (
+	"encoding/json"
+	"github.com/frain-dev/convoy/datastore"
+	"github.com/frain-dev/convoy/util"
+	"net/http"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func Test_Migrate(t *testing.T) {
+	tests := []struct {
+		name    string
+		payload *datastore.Endpoint
+	}{
+		{
+			name: "should_migrate_name_and_url",
+			payload: &datastore.Endpoint{
+				Name: "test-endpoint",
+				Url:  "https://google.com",
+			},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			var header http.Header = map[string][]string{"X-Convoy-version": {"2024-01-01"}}
+
+			payloadBytes, err := json.Marshal(tc.payload)
+			require.NoError(t, err)
+
+			serv := &util.ServerResponse{
+				Status: true,
+				Data:   payloadBytes,
+			}
+
+			body, err := json.Marshal(serv)
+			require.NoError(t, err)
+
+			migration := GetEndpointResponseMigration{}
+			res, _, err := migration.Migrate(body, header)
+			require.NoError(t, err)
+
+			var endpoint map[string]any
+			err = json.Unmarshal(res, &endpoint)
+			require.NoError(t, err)
+
+			require.Equal(t, endpoint["data"].(map[string]any)["target_url"], tc.payload.Url)
+			require.Equal(t, endpoint["data"].(map[string]any)["title"], tc.payload.Name)
+		})
+	}
+}

api/migrations/v20240306/get_endpoint_migration.go

@@ -0,0 +1,56 @@
+package v20240306
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	"github.com/frain-dev/convoy/api/models"
+	"github.com/frain-dev/convoy/util"
+)
+
+type GetEndpointResponseMigration struct{}
+
+func (c *GetEndpointResponseMigration) Migrate(b []byte, h http.Header) ([]byte, http.Header, error) {
+	var serverResponse util.ServerResponse
+	err := json.Unmarshal(b, &serverResponse)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	if len(serverResponse.Data) == 0 {
+		// nothing to transform.
+		return b, h, nil
+	}
+
+	var endpointResp *models.EndpointResponse
+	err = json.Unmarshal(serverResponse.Data, &endpointResp)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	endpoint := endpointResp.Endpoint
+
+	var old oldEndpointResponse
+	err = migrateEndpoint(&endpoint, &old)
+	if err != nil {
+		fmt.Printf("err: %+v\n", err)
+		return nil, nil, err
+	}
+
+	b, err = json.Marshal(old)
+	if err != nil {
+		fmt.Printf("err2: %+v\n", err)
+		return nil, nil, err
+	}
+
+	serverResponse.Data = b
+
+	sb, err := json.Marshal(serverResponse)
+	if err != nil {
+		fmt.Printf("err3: %+v\n", err)
+		return nil, nil, err
+	}
+
+	return sb, h, nil
+}

api/migrations/v20240306/get_endpoints_migration.go

@@ -0,0 +1,75 @@
+package v20240306
+
+import (
+	"encoding/json"
+	"net/http"
+
+	"github.com/frain-dev/convoy/api/models"
+	"github.com/frain-dev/convoy/util"
+)
+
+type GetEndpointsResponseMigration struct{}
+
+func (g *GetEndpointsResponseMigration) Migrate(b []byte, h http.Header) ([]byte, http.Header, error) {
+	var serverResponse util.ServerResponse
+	err := json.Unmarshal(b, &serverResponse)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	var pResp models.PagedResponse
+	err = json.Unmarshal(serverResponse.Data, &pResp)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	if pResp.Content == nil {
+		// nothing to transform.
+		return b, h, nil
+	}
+
+	endpoints, ok := pResp.Content.([]any)
+	if !ok {
+		// invalid type.
+		return b, h, nil
+	}
+
+	var res []oldEndpointResponse
+
+	for _, endpointPayload := range endpoints {
+		endpointBytes, err := json.Marshal(endpointPayload)
+		if err != nil {
+			return nil, nil, err
+		}
+
+		var endpointResp models.EndpointResponse
+		err = json.Unmarshal(endpointBytes, &endpointResp)
+		if err != nil {
+			return nil, nil, err
+		}
+
+		var old oldEndpointResponse
+		endpoint := endpointResp.Endpoint
+
+		err = migrateEndpoint(&endpoint, &old)
+		if err != nil {
+			return nil, nil, err
+		}
+
+		res = append(res, old)
+	}
+
+	pResp.Content = res
+	b, err = json.Marshal(pResp)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	serverResponse.Data = json.RawMessage(b)
+	sb, err := json.Marshal(serverResponse)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	return sb, h, nil
+}