enhance(log): do not return log object for POST and PUT requests (#879)

ecrupper · web-flow · commit f8c795f7aa03 · 2023-06-09T09:50:07.000-05:00
diff --git a/api/log/create_service.go b/api/log/create_service.go
@@ -61,8 +61,6 @@ import (
 // responses:
 //   '201':
 //     description: Successfully created the service logs
-//     schema:
-//       "$ref": "#/definitions/Log"
 //   '400':
 //     description: Unable to create the service logs
 //     schema:
@@ -113,7 +111,7 @@ func CreateServiceLog(c *gin.Context) {
 	input.SetRepoID(r.GetID())
 
 	// send API call to create the logs
-	l, err := database.FromContext(c).CreateLog(input)
+	err = database.FromContext(c).CreateLog(input)
 	if err != nil {
 		retErr := fmt.Errorf("unable to create logs for service %s: %w", entry, err)
 
@@ -122,5 +120,5 @@ func CreateServiceLog(c *gin.Context) {
 		return
 	}
 
-	c.JSON(http.StatusCreated, l)
+	c.JSON(http.StatusCreated, nil)
 }
diff --git a/api/log/create_step.go b/api/log/create_step.go
@@ -61,8 +61,6 @@ import (
 // responses:
 //   '201':
 //     description: Successfully created the logs for step
-//     schema:
-//       "$ref": "#/definitions/Log"
 //   '400':
 //     description: Unable to create the logs for a step
 //     schema:
@@ -113,7 +111,7 @@ func CreateStepLog(c *gin.Context) {
 	input.SetRepoID(r.GetID())
 
 	// send API call to create the logs
-	l, err := database.FromContext(c).CreateLog(input)
+	err = database.FromContext(c).CreateLog(input)
 	if err != nil {
 		retErr := fmt.Errorf("unable to create logs for step %s: %w", entry, err)
 
@@ -122,5 +120,5 @@ func CreateStepLog(c *gin.Context) {
 		return
 	}
 
-	c.JSON(http.StatusCreated, l)
+	c.JSON(http.StatusCreated, nil)
 }
diff --git a/api/log/update_service.go b/api/log/update_service.go
@@ -124,7 +124,7 @@ func UpdateServiceLog(c *gin.Context) {
 	}
 
 	// send API call to update the log
-	l, err = database.FromContext(c).UpdateLog(l)
+	err = database.FromContext(c).UpdateLog(l)
 	if err != nil {
 		retErr := fmt.Errorf("unable to update logs for service %s: %w", entry, err)
 
@@ -133,5 +133,5 @@ func UpdateServiceLog(c *gin.Context) {
 		return
 	}
 
-	c.JSON(http.StatusOK, l)
+	c.JSON(http.StatusOK, nil)
 }
diff --git a/api/log/update_step.go b/api/log/update_step.go
@@ -124,7 +124,7 @@ func UpdateStepLog(c *gin.Context) {
 	}
 
 	// send API call to update the log
-	l, err = database.FromContext(c).UpdateLog(l)
+	err = database.FromContext(c).UpdateLog(l)
 	if err != nil {
 		retErr := fmt.Errorf("unable to update logs for step %s: %w", entry, err)
 
@@ -133,5 +133,5 @@ func UpdateStepLog(c *gin.Context) {
 		return
 	}
 
-	c.JSON(http.StatusOK, l)
+	c.JSON(http.StatusOK, nil)
 }
diff --git a/api/service/plan.go b/api/service/plan.go
@@ -61,7 +61,7 @@ func PlanServices(database database.Interface, p *pipeline.Build, b *library.Bui
 		l.SetData([]byte{})
 
 		// send API call to create the service logs
-		_, err = database.CreateLog(l)
+		err = database.CreateLog(l)
 		if err != nil {
 			return services, fmt.Errorf("unable to create service logs for service %s: %w", s.GetName(), err)
 		}
diff --git a/api/step/plan.go b/api/step/plan.go
@@ -88,7 +88,7 @@ func planStep(database database.Interface, b *library.Build, c *pipeline.Contain
 	l.SetData([]byte{})
 
 	// send API call to create the step logs
-	_, err = database.CreateLog(l)
+	err = database.CreateLog(l)
 	if err != nil {
 		return nil, fmt.Errorf("unable to create logs for step %s: %w", s.GetName(), err)
 	}
diff --git a/database/log/count_build_test.go b/database/log/count_build_test.go
@@ -43,12 +43,12 @@ func TestLog_Engine_CountLogsForBuild(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	_, err := _sqlite.CreateLog(_service)
+	err := _sqlite.CreateLog(_service)
 	if err != nil {
 		t.Errorf("unable to create test service log for sqlite: %v", err)
 	}
 
-	_, err = _sqlite.CreateLog(_step)
+	err = _sqlite.CreateLog(_step)
 	if err != nil {
 		t.Errorf("unable to create test step log for sqlite: %v", err)
 	}
diff --git a/database/log/count_test.go b/database/log/count_test.go
@@ -37,12 +37,12 @@ func TestLog_Engine_CountLogs(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	_, err := _sqlite.CreateLog(_service)
+	err := _sqlite.CreateLog(_service)
 	if err != nil {
 		t.Errorf("unable to create test service log for sqlite: %v", err)
 	}
 
-	_, err = _sqlite.CreateLog(_step)
+	err = _sqlite.CreateLog(_step)
 	if err != nil {
 		t.Errorf("unable to create test step log for sqlite: %v", err)
 	}
diff --git a/database/log/create.go b/database/log/create.go
@@ -14,7 +14,7 @@ import (
 )
 
 // CreateLog creates a new log in the database.
-func (e *engine) CreateLog(l *library.Log) (*library.Log, error) {
+func (e *engine) CreateLog(l *library.Log) error {
 	// check what the log entry is for
 	switch {
 	case l.GetServiceID() > 0:
@@ -33,7 +33,7 @@ func (e *engine) CreateLog(l *library.Log) (*library.Log, error) {
 	// https://pkg.go.dev/github.com/go-vela/types/database#Log.Validate
 	err := log.Validate()
 	if err != nil {
-		return nil, err
+		return err
 	}
 
 	// compress log data for the resource
@@ -43,14 +43,15 @@ func (e *engine) CreateLog(l *library.Log) (*library.Log, error) {
 	if err != nil {
 		switch {
 		case l.GetServiceID() > 0:
-			return nil, fmt.Errorf("unable to compress log for service %d for build %d: %w", l.GetServiceID(), l.GetBuildID(), err)
+			return fmt.Errorf("unable to compress log for service %d for build %d: %w", l.GetServiceID(), l.GetBuildID(), err)
 		case l.GetStepID() > 0:
-			return nil, fmt.Errorf("unable to compress log for step %d for build %d: %w", l.GetStepID(), l.GetBuildID(), err)
+			return fmt.Errorf("unable to compress log for step %d for build %d: %w", l.GetStepID(), l.GetBuildID(), err)
 		}
 	}
 
 	// send query to the database
-	result := e.client.Table(constants.TableLog).Create(log)
-
-	return log.ToLibrary(), result.Error
+	return e.client.
+		Table(constants.TableLog).
+		Create(log).
+		Error
 }
diff --git a/database/log/create_test.go b/database/log/create_test.go
@@ -73,7 +73,7 @@ VALUES ($1,$2,$3,$4,$5,$6) RETURNING "id"`).
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
 			for _, log := range test.logs {
-				_, err := test.database.CreateLog(log)
+				err := test.database.CreateLog(log)
 
 				if test.failure {
 					if err == nil {
diff --git a/database/log/delete_test.go b/database/log/delete_test.go
@@ -29,7 +29,7 @@ func TestLog_Engine_DeleteLog(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	_, err := _sqlite.CreateLog(_log)
+	err := _sqlite.CreateLog(_log)
 	if err != nil {
 		t.Errorf("unable to create test log for sqlite: %v", err)
 	}
diff --git a/database/log/get_service_test.go b/database/log/get_service_test.go
@@ -42,7 +42,7 @@ func TestLog_Engine_GetLogForService(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	_, err := _sqlite.CreateLog(_log)
+	err := _sqlite.CreateLog(_log)
 	if err != nil {
 		t.Errorf("unable to create test log for sqlite: %v", err)
 	}
diff --git a/database/log/get_step_test.go b/database/log/get_step_test.go
@@ -42,7 +42,7 @@ func TestLog_Engine_GetLogForStep(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	_, err := _sqlite.CreateLog(_log)
+	err := _sqlite.CreateLog(_log)
 	if err != nil {
 		t.Errorf("unable to create test log for sqlite: %v", err)
 	}
diff --git a/database/log/get_test.go b/database/log/get_test.go
@@ -35,7 +35,7 @@ func TestLog_Engine_GetLog(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	_, err := _sqlite.CreateLog(_log)
+	err := _sqlite.CreateLog(_log)
 	if err != nil {
 		t.Errorf("unable to create test log for sqlite: %v", err)
 	}
diff --git a/database/log/interface.go b/database/log/interface.go
@@ -31,7 +31,7 @@ type LogInterface interface {
 	// CountLogsForBuild defines a function that gets the count of logs by build ID.
 	CountLogsForBuild(*library.Build) (int64, error)
 	// CreateLog defines a function that creates a new log.
-	CreateLog(*library.Log) (*library.Log, error)
+	CreateLog(*library.Log) error
 	// DeleteLog defines a function that deletes an existing log.
 	DeleteLog(*library.Log) error
 	// GetLog defines a function that gets a log by ID.
@@ -45,5 +45,5 @@ type LogInterface interface {
 	// ListLogsForBuild defines a function that gets a list of logs by build ID.
 	ListLogsForBuild(*library.Build, int, int) ([]*library.Log, int64, error)
 	// UpdateLog defines a function that updates an existing log.
-	UpdateLog(*library.Log) (*library.Log, error)
+	UpdateLog(*library.Log) error
 }
diff --git a/database/log/list_build_test.go b/database/log/list_build_test.go
@@ -54,12 +54,12 @@ func TestLog_Engine_ListLogsForBuild(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	_, err := _sqlite.CreateLog(_service)
+	err := _sqlite.CreateLog(_service)
 	if err != nil {
 		t.Errorf("unable to create test service log for sqlite: %v", err)
 	}
 
-	_, err = _sqlite.CreateLog(_step)
+	err = _sqlite.CreateLog(_step)
 	if err != nil {
 		t.Errorf("unable to create test step log for sqlite: %v", err)
 	}
diff --git a/database/log/list_test.go b/database/log/list_test.go
@@ -48,12 +48,12 @@ func TestLog_Engine_ListLogs(t *testing.T) {
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	_, err := _sqlite.CreateLog(_service)
+	err := _sqlite.CreateLog(_service)
 	if err != nil {
 		t.Errorf("unable to create test service log for sqlite: %v", err)
 	}
 
-	_, err = _sqlite.CreateLog(_step)
+	err = _sqlite.CreateLog(_step)
 	if err != nil {
 		t.Errorf("unable to create test step log for sqlite: %v", err)
 	}
diff --git a/database/log/update.go b/database/log/update.go
@@ -14,7 +14,7 @@ import (
 )
 
 // UpdateLog updates an existing log in the database.
-func (e *engine) UpdateLog(l *library.Log) (*library.Log, error) {
+func (e *engine) UpdateLog(l *library.Log) error {
 	// check what the log entry is for
 	switch {
 	case l.GetServiceID() > 0:
@@ -33,7 +33,7 @@ func (e *engine) UpdateLog(l *library.Log) (*library.Log, error) {
 	// https://pkg.go.dev/github.com/go-vela/types/database#Log.Validate
 	err := log.Validate()
 	if err != nil {
-		return nil, err
+		return err
 	}
 
 	// compress log data for the resource
@@ -43,14 +43,15 @@ func (e *engine) UpdateLog(l *library.Log) (*library.Log, error) {
 	if err != nil {
 		switch {
 		case l.GetServiceID() > 0:
-			return nil, fmt.Errorf("unable to compress log for service %d for build %d: %w", l.GetServiceID(), l.GetBuildID(), err)
+			return fmt.Errorf("unable to compress log for service %d for build %d: %w", l.GetServiceID(), l.GetBuildID(), err)
 		case l.GetStepID() > 0:
-			return nil, fmt.Errorf("unable to compress log for step %d for build %d: %w", l.GetStepID(), l.GetBuildID(), err)
+			return fmt.Errorf("unable to compress log for step %d for build %d: %w", l.GetStepID(), l.GetBuildID(), err)
 		}
 	}
 
 	// send query to the database
-	result := e.client.Table(constants.TableLog).Save(log)
-
-	return log.ToLibrary(), result.Error
+	return e.client.
+		Table(constants.TableLog).
+		Save(log).
+		Error
 }
diff --git a/database/log/update_test.go b/database/log/update_test.go
@@ -47,12 +47,12 @@ WHERE "id" = $6`).
 	_sqlite := testSqlite(t)
 	defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()
 
-	_, err := _sqlite.CreateLog(_service)
+	err := _sqlite.CreateLog(_service)
 	if err != nil {
 		t.Errorf("unable to create test service log for sqlite: %v", err)
 	}
 
-	_, err = _sqlite.CreateLog(_step)
+	err = _sqlite.CreateLog(_step)
 	if err != nil {
 		t.Errorf("unable to create test step log for sqlite: %v", err)
 	}
@@ -82,7 +82,7 @@ WHERE "id" = $6`).
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
 			for _, log := range test.logs {
-				_, err = test.database.UpdateLog(log)
+				err = test.database.UpdateLog(log)
 
 				if test.failure {
 					if err == nil {
diff --git a/mock/server/log.go b/mock/server/log.go
@@ -51,12 +51,7 @@ func getServiceLog(c *gin.Context) {
 
 // addServiceLog returns mock JSON for a http GET.
 func addServiceLog(c *gin.Context) {
-	data := []byte(LogResp)
-
-	var body library.Log
-	_ = json.Unmarshal(data, &body)
-
-	c.JSON(http.StatusCreated, body)
+	c.JSON(http.StatusCreated, nil)
 }
 
 // updateServiceLog has a param :service returns mock JSON for a http PUT.
@@ -73,12 +68,7 @@ func updateServiceLog(c *gin.Context) {
 		return
 	}
 
-	data := []byte(LogResp)
-
-	var body library.Log
-	_ = json.Unmarshal(data, &body)
-
-	c.JSON(http.StatusOK, body)
+	c.JSON(http.StatusOK, nil)
 }
 
 // removeServiceLog has a param :service returns mock JSON for a http DELETE.
@@ -122,12 +112,7 @@ func getStepLog(c *gin.Context) {
 
 // addStepLog returns mock JSON for a http GET.
 func addStepLog(c *gin.Context) {
-	data := []byte(LogResp)
-
-	var body library.Log
-	_ = json.Unmarshal(data, &body)
-
-	c.JSON(http.StatusCreated, body)
+	c.JSON(http.StatusCreated, nil)
 }
 
 // updateStepLog has a param :step returns mock JSON for a http PUT.
@@ -144,12 +129,7 @@ func updateStepLog(c *gin.Context) {
 		return
 	}
 
-	data := []byte(LogResp)
-
-	var body library.Log
-	_ = json.Unmarshal(data, &body)
-
-	c.JSON(http.StatusOK, body)
+	c.JSON(http.StatusOK, nil)
 }
 
 // removeStepLog has a param :step returns mock JSON for a http DELETE.

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ func UpdateServiceLog(c *gin.Context) {`
`124`	`124`	`}`
`125`	`125`
`126`	`126`	`// send API call to update the log`
`127`		`- l, err = database.FromContext(c).UpdateLog(l)`
	`127`	`+ err = database.FromContext(c).UpdateLog(l)`
`128`	`128`	`if err != nil {`
`129`	`129`	`retErr := fmt.Errorf("unable to update logs for service %s: %w", entry, err)`
`130`	`130`
`@@ -133,5 +133,5 @@ func UpdateServiceLog(c *gin.Context) {`
`133`	`133`	`return`
`134`	`134`	`}`
`135`	`135`
`136`		`- c.JSON(http.StatusOK, l)`
	`136`	`+ c.JSON(http.StatusOK, nil)`
`137`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ func UpdateStepLog(c *gin.Context) {`
`124`	`124`	`}`
`125`	`125`
`126`	`126`	`// send API call to update the log`
`127`		`- l, err = database.FromContext(c).UpdateLog(l)`
	`127`	`+ err = database.FromContext(c).UpdateLog(l)`
`128`	`128`	`if err != nil {`
`129`	`129`	`retErr := fmt.Errorf("unable to update logs for step %s: %w", entry, err)`
`130`	`130`
`@@ -133,5 +133,5 @@ func UpdateStepLog(c *gin.Context) {`
`133`	`133`	`return`
`134`	`134`	`}`
`135`	`135`
`136`		`- c.JSON(http.StatusOK, l)`
	`136`	`+ c.JSON(http.StatusOK, nil)`
`137`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ func PlanServices(database database.Interface, p pipeline.Build, b library.Bui`
`61`	`61`	`l.SetData([]byte{})`
`62`	`62`
`63`	`63`	`// send API call to create the service logs`
`64`		`- _, err = database.CreateLog(l)`
	`64`	`+ err = database.CreateLog(l)`
`65`	`65`	`if err != nil {`
`66`	`66`	`return services, fmt.Errorf("unable to create service logs for service %s: %w", s.GetName(), err)`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ func planStep(database database.Interface, b library.Build, c pipeline.Contain`
`88`	`88`	`l.SetData([]byte{})`
`89`	`89`
`90`	`90`	`// send API call to create the step logs`
`91`		`- _, err = database.CreateLog(l)`
	`91`	`+ err = database.CreateLog(l)`
`92`	`92`	`if err != nil {`
`93`	`93`	`return nil, fmt.Errorf("unable to create logs for step %s: %w", s.GetName(), err)`
`94`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,12 +43,12 @@ func TestLog_Engine_CountLogsForBuild(t *testing.T) {`
`43`	`43`	`_sqlite := testSqlite(t)`
`44`	`44`	`defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()`
`45`	`45`
`46`		`- _, err := _sqlite.CreateLog(_service)`
	`46`	`+ err := _sqlite.CreateLog(_service)`
`47`	`47`	`if err != nil {`
`48`	`48`	`t.Errorf("unable to create test service log for sqlite: %v", err)`
`49`	`49`	`}`
`50`	`50`
`51`		`- _, err = _sqlite.CreateLog(_step)`
	`51`	`+ err = _sqlite.CreateLog(_step)`
`52`	`52`	`if err != nil {`
`53`	`53`	`t.Errorf("unable to create test step log for sqlite: %v", err)`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,12 +37,12 @@ func TestLog_Engine_CountLogs(t *testing.T) {`
`37`	`37`	`_sqlite := testSqlite(t)`
`38`	`38`	`defer func() { _sql, _ := _sqlite.client.DB(); _sql.Close() }()`
`39`	`39`
`40`		`- _, err := _sqlite.CreateLog(_service)`
	`40`	`+ err := _sqlite.CreateLog(_service)`
`41`	`41`	`if err != nil {`
`42`	`42`	`t.Errorf("unable to create test service log for sqlite: %v", err)`
`43`	`43`	`}`
`44`	`44`
`45`		`- _, err = _sqlite.CreateLog(_step)`
	`45`	`+ err = _sqlite.CreateLog(_step)`
`46`	`46`	`if err != nil {`
`47`	`47`	`t.Errorf("unable to create test step log for sqlite: %v", err)`
`48`	`48`	`}`