Rename health check package and function names

Rename for consistency
yorkie-team · Aug 7, 2024 · 18e682c · 18e682c
1 parent 932cf62
commit 18e682c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/server/rpc/health/health.go → server/rpc/httphealth/httphealth.go b/server/rpc/health/health.go → server/rpc/httphealth/httphealth.go
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Package health uses http GET to provide a health check for the server.
-package health
+// Package httphealth uses http GET to provide a health check for the server.
+package httphealth
 
 import (
 	"encoding/json"
@@ -29,8 +29,8 @@ type CheckResponse struct {
 	Status string `json:"status"`
 }
 
-// NewHTTPHandler creates a new HTTP handler for health checks.
-func NewHTTPHandler(checker grpchealth.Checker) (string, http.Handler) {
+// NewHandler creates a new HTTP handler for health checks.
+func NewHandler(checker grpchealth.Checker) (string, http.Handler) {
 	const serviceName = "/healthz/"
 	check := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		if r.Method != http.MethodGet {

diff --git a/server/rpc/server.go b/server/rpc/server.go
@@ -36,7 +36,7 @@ import (
 	"github.com/yorkie-team/yorkie/server/backend"
 	"github.com/yorkie-team/yorkie/server/logging"
 	"github.com/yorkie-team/yorkie/server/rpc/auth"
-	"github.com/yorkie-team/yorkie/server/rpc/health"
+	"github.com/yorkie-team/yorkie/server/rpc/httphealth"
 	"github.com/yorkie-team/yorkie/server/rpc/interceptors"
 )
 
@@ -74,7 +74,7 @@ func NewServer(conf *Config, be *backend.Backend) (*Server, error) {
 	mux.Handle(v1connect.NewYorkieServiceHandler(newYorkieServer(yorkieServiceCtx, be), opts...))
 	mux.Handle(v1connect.NewAdminServiceHandler(newAdminServer(be, tokenManager), opts...))
 	mux.Handle(grpchealth.NewHandler(healthChecker))
-	mux.Handle(health.NewHTTPHandler(healthChecker))
+	mux.Handle(httphealth.NewHandler(healthChecker))
 	// TODO(hackerwins): We need to provide proper http server configuration.
 	return &Server{
 		conf: conf,

diff --git a/test/integration/health_test.go b/test/integration/health_test.go
@@ -27,7 +27,7 @@ import (
 	"connectrpc.com/grpchealth"
 	"github.com/stretchr/testify/assert"
 	"github.com/yorkie-team/yorkie/api/yorkie/v1/v1connect"
-	"github.com/yorkie-team/yorkie/server/rpc/health"
+	"github.com/yorkie-team/yorkie/server/rpc/httphealth"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
 	healthpb "google.golang.org/grpc/health/grpc_health_v1"
@@ -88,7 +88,7 @@ func TestHTTPHealthCheck(t *testing.T) {
 		}()
 		assert.Equal(t, resp.StatusCode, http.StatusOK)
 
-		var healthResp health.CheckResponse
+		var healthResp httphealth.CheckResponse
 		err = json.NewDecoder(resp.Body).Decode(&healthResp)
 		assert.NoError(t, err)
 		assert.Equal(t, healthResp.Status, grpchealth.StatusServing.String())
@@ -106,7 +106,7 @@ func TestHTTPHealthCheck(t *testing.T) {
 			}()
 			assert.Equal(t, resp.StatusCode, http.StatusOK)
 
-			var healthResp health.CheckResponse
+			var healthResp httphealth.CheckResponse
 			err = json.NewDecoder(resp.Body).Decode(&healthResp)
 			assert.NoError(t, err)
 			assert.Equal(t, healthResp.Status, grpchealth.StatusServing.String())