Merge pull request #18410 from influxdata/18391/cors_v1

fix(handler): allow CORS in v2 compatibility endpoints

CHANGELOG.md

@@ -6,6 +6,7 @@ v1.8.1 [unreleased]
 ### Bugfixes
 
 -	[#17638](https://github.com/influxdata/influxdb/pull/17638): Verify precision in write requests.
+-	[#18410](https://github.com/influxdata/influxdb/pull/18410): Enable CORS in InfluxDB 2.0 compatibility APIs.
 -	[#18429](https://github.com/influxdata/influxdb/pull/18429): Add option to authenticate prometheus remote read
 
 v1.8.0 [unreleased]

services/httpd/handler.go

@@ -194,6 +194,10 @@ func NewHandler(c Config) *Handler {
 			"write", // Data-ingest route.
 			"POST", "/api/v2/write", true, writeLogEnabled, h.serveWriteV2,
 		},
+		Route{ // Enable CORS
+			"write-options",
+			"OPTIONS", "/api/v2/write", false, true, h.serveOptions,
+		},
 		Route{
 			"prometheus-write", // Prometheus remote write
 			"POST", "/api/v1/prom/write", false, true, h.servePromWrite,
@@ -218,6 +222,14 @@ func NewHandler(c Config) *Handler {
 			"status-head",
 			"HEAD", "/status", false, true, authWrapper(h.serveStatus),
 		},
+		Route{ // Health
+			"health",
+			"GET", "/health", false, true, authWrapper(h.serveHealth),
+		},
+		Route{ // Enable CORS
+			"health-options",
+			"OPTIONS", "/health", false, true, h.serveOptions,
+		},
 		Route{
 			"prometheus-metrics",
 			"GET", "/metrics", false, true, authWrapper(promhttp.Handler().ServeHTTP),
@@ -269,6 +281,10 @@ func NewHandler(c Config) *Handler {
 		"flux-read",
 		"POST", "/api/v2/query", true, true, nil,
 	}
+	fluxRouteCors := Route{
+		"flux-read-options",
+		"OPTIONS", "/api/v2/query", false, true, h.serveOptions,
+	}
 
 	if !c.FluxEnabled {
 		fluxRoute.HandlerFunc = func(w http.ResponseWriter, r *http.Request) {
@@ -277,7 +293,7 @@ func NewHandler(c Config) *Handler {
 	} else {
 		fluxRoute.HandlerFunc = h.serveFluxQuery
 	}
-	h.AddRoutes(fluxRoute)
+	h.AddRoutes(fluxRoute, fluxRouteCors)
 
 	return h
 }
@@ -1000,6 +1016,24 @@ func (h *Handler) servePing(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+// serveHealth maps v2 health endpoint to ping endpoint
+func (h *Handler) serveHealth(w http.ResponseWriter, r *http.Request) {
+	resp := map[string]interface{}{
+		"name":    "influxdb",
+		"message": "ready for queries and writes",
+		"status":  "pass",
+		"checks":  []string{},
+		"version": h.Version,
+	}
+	b, _ := json.Marshal(resp)
+	h.writeHeader(w, http.StatusOK)
+	w.Header().Set("Content-Type", "application/json; charset=utf-8")
+	if _, err := w.Write(b); err != nil {
+		h.httpError(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+}
+
 // serveStatus has been deprecated.
 func (h *Handler) serveStatus(w http.ResponseWriter, r *http.Request) {
 	h.Logger.Info("WARNING: /status has been deprecated.  Use /ping instead.")
@@ -1836,6 +1870,7 @@ func cors(inner http.Handler) http.Handler {
 				`Authorization`,
 				`Content-Length`,
 				`Content-Type`,
+				`User-Agent`,
 				`X-CSRF-Token`,
 				`X-HTTP-Method-Override`,
 			}, ", "))

services/httpd/handler_test.go

@@ -35,6 +35,7 @@ import (
 	"github.com/influxdata/influxdb/models"
 	"github.com/influxdata/influxdb/monitor"
 	"github.com/influxdata/influxdb/monitor/diagnostics"
+	"github.com/influxdata/influxdb/pkg/testing/assert"
 	"github.com/influxdata/influxdb/prometheus/remote"
 	"github.com/influxdata/influxdb/query"
 	"github.com/influxdata/influxdb/services/httpd"
@@ -1476,6 +1477,29 @@ func TestHandler_Ping(t *testing.T) {
 	}
 }
 
+// Ensure the handler handles health requests correctly.
+func TestHandler_Health(t *testing.T) {
+	h := NewHandler(false)
+	w := httptest.NewRecorder()
+	h.ServeHTTP(w, MustNewRequest("GET", "/health", nil))
+	if w.Code != http.StatusOK {
+		t.Fatalf("unexpected status: %d", w.Code)
+	}
+
+	var got map[string]interface{}
+	if err := json.Unmarshal(w.Body.Bytes(), &got); err != nil {
+		t.Fatal(err)
+	}
+
+	assert.Equal(t, got["name"], "influxdb", "invalid name")
+	assert.Equal(t, got["message"], "ready for queries and writes", "invalid message")
+	assert.Equal(t, got["status"], "pass", "invalid status")
+	assert.Equal(t, got["version"], "0.0.0", "invalid version")
+	if _, present := got["checks"]; !present {
+		t.Fatal("missing checks")
+	}
+}
+
 // Ensure the handler returns the version correctly from the different endpoints.
 func TestHandler_Version(t *testing.T) {
 	h := NewHandler(false)