♻️ refactor: Migrate HealthChecker to v3 (gofiber#2884)

* Update pull_request_template.md * Update v3-changes.md * Update CONTRIBUTING.md (gofiber#2752) Grammar correction. * chore(encryptcookie)!: update default config (gofiber#2753) * chore(encryptcookie)!: update default config docs(encryptcookie): enhance documentation and examples BREAKING CHANGE: removed the hardcoded "csrf_" from the Except. * docs(encryptcookie): reads or modifies cookies * chore(encryptcookie): csrf config example * docs(encryptcookie): md table spacing * build(deps): bump actions/setup-go from 4 to 5 (gofiber#2754) Bumps [actions/setup-go](https://github.com/actions/setup-go) from 4 to 5. - [Release notes](https://github.com/actions/setup-go/releases) - [Commits](actions/setup-go@v4...v5) --- updated-dependencies: - dependency-name: actions/setup-go dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * 🩹 middleware/logger/: log client IP address by default (gofiber#2755) * middleware/logger: Log client IP address by default. * Update doc. * fix: don't constrain middlewares' context-keys to strings 🐛 (gofiber#2751) * Revert "Revert ":bug: requestid.Config.ContextKey is interface{} (gofiber#2369)" (gofiber#2742)" This reverts commit 28be17f. * fix: request ContextKey default value condition Should check for `nil` since it is `any`. * fix: don't constrain middlewares' context-keys to strings `context` recommends using "unexported type" as context keys to avoid collisions https://pkg.go.dev/github.com/gofiber/fiber/v2#Ctx.Locals. The official go blog also recommends this https://go.dev/blog/context. `fiber.Ctx.Locals(key any, value any)` correctly allows consumers to use unexported types or e.g. strings. But some fiber middlewares constrain their context-keys to `string` in their "default config structs", making it impossible to use unexported types. This PR removes the `string` _constraint_ from all middlewares, allowing to now use unexported types as per the official guidelines. However the default value is still a string, so it's not a breaking change, and anyone still using strings as context keys is not affected. * 📚 Update app.md for indentation (gofiber#2761) Update app.md for indentation * build(deps): bump github.com/google/uuid from 1.4.0 to 1.5.0 (gofiber#2762) Bumps [github.com/google/uuid](https://github.com/google/uuid) from 1.4.0 to 1.5.0. - [Release notes](https://github.com/google/uuid/releases) - [Changelog](https://github.com/google/uuid/blob/master/CHANGELOG.md) - [Commits](google/uuid@v1.4.0...v1.5.0) --- updated-dependencies: - dependency-name: github.com/google/uuid dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump github/codeql-action from 2 to 3 (gofiber#2763) Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2 to 3. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@v2...v3) --- updated-dependencies: - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Changing default log output (gofiber#2730) changing default log output Closes gofiber#2729 * Update hooks.md fix wrong hooks signature * 🩹 Fix: CORS middleware should use the defined AllowedOriginsFunc config when AllowedOrigins is empty (gofiber#2771) * 🐛 [Bug]: Adaptator + otelfiber issue gofiber#2641 (gofiber#2772) * 🩹🚨 - fix for redirect with query params (gofiber#2748) * redirect with query params did not work, fix it and add test for it * redirect middleware - fix test typo * ♻️ logger/middleware colorize logger error message gofiber#2593 (gofiber#2773) * ✨ feat: add liveness and readiness checks (gofiber#2509) * ✨ feat: add liveness and readiness checkers * 📝 docs: add docs for liveness and readiness * ✨ feat: add options method for probe checkers * ✅ tests: add tests for liveness and readiness * ♻️ refactor: change default endpoint values * ♻️ refactor: change default value for liveness endpoint * 📝 docs: add return status for liveness and readiness probes * ♻️ refactor: change probechecker to middleware * 📝 docs: move docs to middleware session * ♻️ refactor: apply gofumpt formatting * ♻️ refactor: remove unused parameter * split config and apply a review * apply reviews and add testcases * add benchmark * cleanup * rename middleware * fix linter * Update docs and config values * Revert change to IsReady * Updates based on code review * Update docs to match other middlewares --------- Co-authored-by: Muhammed Efe Cetin <[email protected]> Co-authored-by: Juan Calderon-Perez <[email protected]> Co-authored-by: Juan Calderon-Perez <[email protected]> * prepare release v2.52.0 - add more Parser tests * fix healthcheck.md * configure workflows for V2 branch * configure workflows for V2 branch * Fix default value to false in docs of QueryBool (gofiber#2811) fix default value to false in docs of QueryBool * update queryParser config * Update ctx.md * Update routing.md * merge v2 in v3 * merge v2 in v3 * lint fixes * 📚 Doc: Fix code snippet indentation in /docs/api/middleware/keyauth.md Removes an an extra level of indentation in line 51 of `keyauth.md` [here](https://github.com/gofiber/fiber/blob/v2/docs/api/middleware/keyauth.md?plain=1#L51) * fix: healthcheck middleware not working with route group (gofiber#2863) * fix: healthcheck middleware not working with route group * perf: change verification method to improve perf * Update healthcheck_test.go * test: add not matching route test for strict routing * add more test cases * correct tests * correct test helpers * correct tests * correct tests --------- Co-authored-by: Juan Calderon-Perez <[email protected]> Co-authored-by: René Werner <[email protected]> * merge v2 in v3 * Merge pull request from GHSA-fmg4-x8pw-hjhg * Enforce Wildcard Origins with AllowCredentials check * Expand unit-tests, fix issues with subdomains logic, update docs * Update cors.md * Added test using localhost, ipv4, and ipv6 address * improve documentation markdown --------- Co-authored-by: René Werner <[email protected]> * Update app.go prepare release v2.52.1 * fix cors domain normalize * fix sync-docs workflow * test: fix failing tests * fix sync-docs workflow * test: cors middleware use testify require * chore: fix lint warnings * chore: revert test isolation. * feat: migrate healthchecker to v3 * fix: use Get instead of Use for better router matching * docs: update docs to v3 info * fixed the fasthttp ctx race condition problem * Update middleware/cors/utils.go Co-authored-by: Renan Bastos <[email protected]> * fix sync_docs.sh * fix review comments/hints * fix review comments/hints * stabilize Test_Proxy_Timeout_Slow_Server test * stabilize Test_Proxy_.* tests * ignore bodyclose linter for tests use http.NoBody instead of nil * Add parallel benchmark * Update healthcheck_test.go * docs: add comments for next behavior when there are no other handlers defined * revert(tests): undo http.NoBody usage --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: RW <[email protected]> Co-authored-by: tokelo-12 <[email protected]> Co-authored-by: Jason McNeil <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: iRedMail <[email protected]> Co-authored-by: Benjamin Grosse <[email protected]> Co-authored-by: Mehmet Firat KOMURCU <[email protected]> Co-authored-by: Bruno <[email protected]> Co-authored-by: Muhammad Kholid B <[email protected]> Co-authored-by: gilwo <[email protected]> Co-authored-by: Muhammed Efe Cetin <[email protected]> Co-authored-by: Juan Calderon-Perez <[email protected]> Co-authored-by: Juan Calderon-Perez <[email protected]> Co-authored-by: Jongmin Kim <[email protected]> Co-authored-by: Giovanni Rivera <[email protected]> Co-authored-by: Renan Bastos <[email protected]>
grivera64 · Mar 16, 2024 · 39c6fd9 · 39c6fd9
1 parent 565cc03
commit 39c6fd9
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 200 deletions.
diff --git a/docs/api/middleware/healthcheck.md b/docs/api/middleware/healthcheck.md
@@ -39,27 +39,49 @@ import (
 After you initiate your [Fiber](https://github.com/gofiber/fiber) app, you can use the following possibilities:
 
 ```go
-// Provide a minimal config
-app.Use(healthcheck.New())
+// Provide a minimal config for liveness check
+app.Get(healthcheck.DefaultLivenessEndpoint, healthcheck.New())
+// Provide a minimal config for readiness check
+app.Get(healthcheck.DefaultReadinessEndpoint, healthcheck.New())
+// Provide a minimal config for check with custom endpoint
+app.Get("/live", healthcheck.New())
 
 // Or extend your config for customization
-app.Use(healthcheck.New(healthcheck.Config{
-    LivenessProbe: func(c fiber.Ctx) bool {
+app.Get(healthcheck.DefaultLivenessEndpoint, healthcheck.New(healthcheck.Config{
+    Probe: func(c fiber.Ctx) bool {
         return true
     },
-    LivenessEndpoint: "/live",
-    ReadinessProbe: func(c fiber.Ctx) bool {
-        return serviceA.Ready() && serviceB.Ready() && ...
+}))
+// And it works the same for readiness, just change the route
+app.Get(healthcheck.DefaultReadinessEndpoint, healthcheck.New(healthcheck.Config{
+    Probe: func(c fiber.Ctx) bool {
+        return true
+    },
+}))
+// With a custom route and custom probe
+app.Get("/live", healthcheck.New(healthcheck.Config{
+    Probe: func(c fiber.Ctx) bool {
+        return true
+    },
+}))
+
+// It can also be used with app.All, although it will only respond to requests with the GET method
+// in case of calling the route with any method which isn't GET, the return will be 404 Not Found when app.All is used
+// and 405 Method Not Allowed when app.Get is used
+app.All(healthcheck.DefaultReadinessEndpoint, healthcheck.New(healthcheck.Config{
+    Probe: func(c fiber.Ctx) bool {
+        return true
     },
-    ReadinessEndpoint: "/ready",
 }))
 ```
 
 ## Config
 
 ```go
 type Config struct {
-	// Next defines a function to skip this middleware when returned true.
+	// Next defines a function to skip this middleware when returned true. If this function returns true
+    // and no other handlers are defined for the route, Fiber will return a status 404 Not Found, since
+    // no other handlers were defined to return a different status.
 	//
 	// Optional. Default: nil
 	Next func(fiber.Ctx) bool
@@ -69,38 +91,17 @@ type Config struct {
 	// the application is in a state where it can handle requests (e.g., the server is up and running).
 	//
 	// Optional. Default: func(c fiber.Ctx) bool { return true }
-	LivenessProbe HealthChecker
-
-	// HTTP endpoint at which the liveness probe will be available.
-	//
-	// Optional. Default: "/livez"
-	LivenessEndpoint string
-
-	// Function used for checking the readiness of the application. Returns true if the application
-	// is ready to process requests and false otherwise. The readiness probe typically checks if all necessary
-	// services, databases, and other dependencies are available for the application to function correctly.
-	//
-	// Optional. Default: func(c fiber.Ctx) bool { return true }
-	ReadinessProbe HealthChecker
-
-	// HTTP endpoint at which the readiness probe will be available.
-	// Optional. Default: "/readyz"
-	ReadinessEndpoint string
+	Probe HealthChecker
 }
 ```
 
 ## Default Config
 
 The default configuration used by this middleware is defined as follows:
 ```go
-func defaultLivenessProbe(fiber.Ctx) bool { return true }
-
-func defaultReadinessProbe(fiber.Ctx) bool { return true }
+func defaultProbe(fiber.Ctx) bool { return true }
 
 var ConfigDefault = Config{
-	LivenessProbe:     defaultLivenessProbe,
-	ReadinessProbe:    defaultReadinessProbe,
-	LivenessEndpoint:  "/livez",
-	ReadinessEndpoint: "/readyz",
+	Probe:     defaultProbe,
 }
 ```
diff --git a/middleware/healthcheck/config.go b/middleware/healthcheck/config.go
@@ -6,7 +6,9 @@ import (
 
 // Config defines the configuration options for the healthcheck middleware.
 type Config struct {
-	// Next defines a function to skip this middleware when returned true.
+	// Next defines a function to skip this middleware when returned true. If this function returns true
+	// and no other handlers are defined for the route, Fiber will return a status 404 Not Found, since
+	// no other handlers were defined to return a different status.
 	//
 	// Optional. Default: nil
 	Next func(fiber.Ctx) bool
@@ -16,68 +18,27 @@ type Config struct {
 	// the application is in a state where it can handle requests (e.g., the server is up and running).
 	//
 	// Optional. Default: func(c fiber.Ctx) bool { return true }
-	LivenessProbe HealthChecker
-
-	// HTTP endpoint at which the liveness probe will be available.
-	//
-	// Optional. Default: "/livez"
-	LivenessEndpoint string
-
-	// Function used for checking the readiness of the application. Returns true if the application
-	// is ready to process requests and false otherwise. The readiness probe typically checks if all necessary
-	// services, databases, and other dependencies are available for the application to function correctly.
-	//
-	// Optional. Default: func(c fiber.Ctx) bool { return true }
-	ReadinessProbe HealthChecker
-
-	// HTTP endpoint at which the readiness probe will be available.
-	// Optional. Default: "/readyz"
-	ReadinessEndpoint string
+	Probe HealthChecker
 }
 
 const (
 	DefaultLivenessEndpoint  = "/livez"
 	DefaultReadinessEndpoint = "/readyz"
 )
 
-func defaultLivenessProbe(fiber.Ctx) bool { return true }
-
-func defaultReadinessProbe(fiber.Ctx) bool { return true }
-
-// ConfigDefault is the default config
-var ConfigDefault = Config{
-	LivenessProbe:     defaultLivenessProbe,
-	ReadinessProbe:    defaultReadinessProbe,
-	LivenessEndpoint:  DefaultLivenessEndpoint,
-	ReadinessEndpoint: DefaultReadinessEndpoint,
-}
+func defaultProbe(fiber.Ctx) bool { return true }
 
-// defaultConfig returns a default config for the healthcheck middleware.
-func defaultConfig(config ...Config) Config {
+func defaultConfigV3(config ...Config) Config {
 	if len(config) < 1 {
-		return ConfigDefault
+		return Config{
+			Probe: defaultProbe,
+		}
 	}
 
 	cfg := config[0]
 
-	if cfg.Next == nil {
-		cfg.Next = ConfigDefault.Next
-	}
-
-	if cfg.LivenessProbe == nil {
-		cfg.LivenessProbe = defaultLivenessProbe
-	}
-
-	if cfg.ReadinessProbe == nil {
-		cfg.ReadinessProbe = defaultReadinessProbe
-	}
-
-	if cfg.LivenessEndpoint == "" {
-		cfg.LivenessEndpoint = DefaultLivenessEndpoint
-	}
-
-	if cfg.ReadinessEndpoint == "" {
-		cfg.ReadinessEndpoint = DefaultReadinessEndpoint
+	if cfg.Probe == nil {
+		cfg.Probe = defaultProbe
 	}
 
 	return cfg

diff --git a/middleware/healthcheck/healthcheck.go b/middleware/healthcheck/healthcheck.go
@@ -1,36 +1,14 @@
 package healthcheck
 
 import (
-	"strings"
-
 	"github.com/gofiber/fiber/v3"
 )
 
 // HealthChecker defines a function to check liveness or readiness of the application
 type HealthChecker func(fiber.Ctx) bool
 
-// HealthCheckerHandler defines a function that returns a HealthChecker
-type HealthCheckerHandler func(HealthChecker) fiber.Handler
-
-func healthCheckerHandler(checker HealthChecker) fiber.Handler {
-	return func(c fiber.Ctx) error {
-		if checker == nil {
-			return c.Next()
-		}
-
-		if checker(c) {
-			return c.SendStatus(fiber.StatusOK)
-		}
-
-		return c.SendStatus(fiber.StatusServiceUnavailable)
-	}
-}
-
-func New(config ...Config) fiber.Handler {
-	cfg := defaultConfig(config...)
-
-	isLiveHandler := healthCheckerHandler(cfg.LivenessProbe)
-	isReadyHandler := healthCheckerHandler(cfg.ReadinessProbe)
+func NewHealthChecker(config ...Config) fiber.Handler {
+	cfg := defaultConfigV3(config...)
 
 	return func(c fiber.Ctx) error {
 		// Don't execute middleware if Next returns true
@@ -42,21 +20,10 @@ func New(config ...Config) fiber.Handler {
 			return c.Next()
 		}
 
-		prefixCount := len(strings.TrimRight(c.Route().Path, "/"))
-		if len(c.Path()) >= prefixCount {
-			checkPath := c.Path()[prefixCount:]
-			checkPathTrimmed := checkPath
-			if !c.App().Config().StrictRouting {
-				checkPathTrimmed = strings.TrimRight(checkPath, "/")
-			}
-			switch {
-			case checkPath == cfg.ReadinessEndpoint || checkPathTrimmed == cfg.ReadinessEndpoint:
-				return isReadyHandler(c)
-			case checkPath == cfg.LivenessEndpoint || checkPathTrimmed == cfg.LivenessEndpoint:
-				return isLiveHandler(c)
-			}
+		if cfg.Probe(c) {
+			return c.SendStatus(fiber.StatusOK)
 		}
 
-		return c.Next()
+		return c.SendStatus(fiber.StatusServiceUnavailable)
 	}
 }