added HEAD support for some endpoints

Author: eeisegn

CHANGELOG.md

@@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Upcoming changes...
 
+## [1.2.3] - 2023-08-25
+### Added
+- Added HEAD support for the following endpoints:
+  - `/`, `/api/`, `/api/health`, `/api/health-check`
+
 ## [1.2.2] - 2023-08-24
 ### Added
 - Added support for `/api/kb/details` endpoint
@@ -66,3 +71,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [1.2.0]: https://github.com/scanoss/api.go/compare/v1.1.0...v1.2.0
 [1.2.1]: https://github.com/scanoss/api.go/compare/v1.2.0...v1.2.1
 [1.2.2]: https://github.com/scanoss/api.go/compare/v1.2.1...v1.2.2
+[1.2.3]: https://github.com/scanoss/api.go/compare/v1.2.2...v1.2.3

pkg/protocol/rest/server.go

@@ -58,9 +58,13 @@ func RunServer(config *myconfig.ServerConfig) error {
 	// Set up the endpoint routing
 	router := mux.NewRouter().StrictSlash(true)
 	router.HandleFunc("/", service.WelcomeMsg).Methods(http.MethodGet)
+	router.HandleFunc("/", service.HeadResponse).Methods(http.MethodHead)
 	router.HandleFunc("/api/", service.WelcomeMsg).Methods(http.MethodGet)
+	router.HandleFunc("/api/", service.HeadResponse).Methods(http.MethodHead)
 	router.HandleFunc("/api/health", service.HealthCheck).Methods(http.MethodGet)
+	router.HandleFunc("/api/health", service.HeadResponse).Methods(http.MethodHead)
 	router.HandleFunc("/api/health-check", service.HealthCheck).Methods(http.MethodGet)
+	router.HandleFunc("/api/health-check", service.HeadResponse).Methods(http.MethodHead)
 	router.HandleFunc("/api/metrics/{type}", service.MetricsHandler).Methods(http.MethodGet)
 	router.HandleFunc("/api/file_contents/{md5}", apiService.FileContents).Methods(http.MethodGet)
 	router.HandleFunc("/api/kb/details", apiService.KBDetails).Methods(http.MethodGet)

pkg/service/utils_service.go

@@ -95,6 +95,12 @@ func HealthCheck(w http.ResponseWriter, r *http.Request) {
 	printResponse(w, fmt.Sprintln(`{"alive": true}`), zlog.S, true)
 }
 
+// HeadResponse responds with the HEAD OK Status for the requested path.
+func HeadResponse(w http.ResponseWriter, r *http.Request) {
+	zlog.S.Debugf("%v HEAD request from %v", r.URL.Path, r.RemoteAddr)
+	w.WriteHeader(http.StatusOK)
+}
+
 // MetricsHandler responds with the metrics for the requested type.
 func MetricsHandler(w http.ResponseWriter, r *http.Request) {
 	vars := mux.Vars(r)

pkg/service/utils_service_test.go

@@ -193,3 +193,23 @@ func TestApiService(t *testing.T) {
 
 	printResponse(w, "test message", zs, false)
 }
+
+func TestHeadResponse(t *testing.T) {
+	err := zlog.NewSugaredDevLogger()
+	if err != nil {
+		t.Fatalf("an error '%s' was not expected when opening a sugared logger", err)
+	}
+	defer zlog.SyncZap()
+	req := httptest.NewRequest(http.MethodHead, "http://localhost/api/health", nil)
+	w := httptest.NewRecorder()
+	HeadResponse(w, req)
+	resp := w.Result()
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		t.Fatalf("an error was not expected when reading from request: %v", err)
+	}
+	assert.Equal(t, http.StatusOK, resp.StatusCode)
+	fmt.Println("Status: ", resp.StatusCode)
+	fmt.Println("Type: ", resp.Header.Get("Content-Type"))
+	fmt.Println("Body: ", string(body))
+}

tests/curl_commands.txt

@@ -20,6 +20,8 @@ curl -X GET  http://localhost:5443/api/license/obligations/MIT > obligations.txt
 
 curl -X GET  http://localhost:5443/api/api/health-check
 
+curl --head  http://localhost:5443/api/health-check
+
 # Service Metrics
 
 curl -X GET  http://localhost:5443/api/api/metrics/all

tests/healthcheck_test.go

@@ -48,6 +48,13 @@ func (s *E2EHealthSuite) TestHappyWelcomeMsg() {
 	fmt.Println("Status: ", resp.StatusCode)
 	fmt.Println("Type: ", resp.Header.Get("Content-Type"))
 	fmt.Println("Body: ", bodyStr)
+
+	resp2, err := c.Head(fmt.Sprintf("%v/", hostPort))
+	if err != nil {
+		s.Failf("an error was not expected when sending request.", "error: %v", err)
+	}
+	s.Equal(http.StatusOK, resp2.StatusCode)
+	fmt.Println("Status: ", resp.StatusCode)
 }
 
 func (s *E2EHealthSuite) TestHappyHealthcheck() {
@@ -66,6 +73,14 @@ func (s *E2EHealthSuite) TestHappyHealthcheck() {
 	fmt.Println("Status: ", resp.StatusCode)
 	fmt.Println("Type: ", resp.Header.Get("Content-Type"))
 	fmt.Println("Body: ", bodyStr)
+
+	// Test the HEAD call also
+	resp2, err := c.Head(fmt.Sprintf("%v/api/health-check", hostPort))
+	if err != nil {
+		s.Failf("an error was not expected when sending request.", "error: %v", err)
+	}
+	s.Equal(http.StatusOK, resp2.StatusCode)
+	fmt.Println("Status: ", resp.StatusCode)
 }
 
 func (s *E2EHealthSuite) TestMetrics() {