Merge branch 'release/v1.3.7'

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 Notable changes to Mailpit will be documented in this file.
 
+## v1.3.7
+
+### Feature
+- Add Kubernetes API health (livez/readyz) endpoints
+
+### Libs
+- Upgrade to esbuild 0.17.5
+
+
 ## v1.3.6
 
 ### Bugfix

esbuild.config.js → esbuild.config.mjs

@@ -1,14 +1,13 @@
-const { build } = require('esbuild')
-const pluginVue = require('esbuild-plugin-vue-next')
-const { sassPlugin } = require('esbuild-sass-plugin');
+import * as esbuild from 'esbuild'
+import pluginVue from 'esbuild-plugin-vue-next'
+import { sassPlugin } from 'esbuild-sass-plugin'
 
 const doWatch = process.env.WATCH == 'true' ? true : false;
 const doMinify = process.env.MINIFY == 'true' ? true : false;
 
-build({
+const ctx = await esbuild.context({
     entryPoints: ["server/ui-src/app.js"],
     bundle: true,
-    watch: doWatch,
     minify: doMinify,
     sourcemap: false,
     outfile: "server/ui/dist/app.js",
@@ -20,3 +19,10 @@ build({
     },
     logLevel: "info"
 })
+
+if (doWatch) {
+    await ctx.watch()
+} else {
+    await ctx.rebuild()
+    ctx.dispose()
+}

install.sh

@@ -7,7 +7,7 @@ set -e
 
 VERSION=$(curl --silent --location --max-time "${TIMEOUT}" "https://api.github.com/repos/${GH_REPO}/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
 if [ $? -ne 0 ]; then
-    echo -ne "\nThere was an error trying to check what is the latest version of ssbak.\nPlease try again later.\n"
+    echo -ne "\nThere was an error trying to check what is the latest version of Mailpit.\nPlease try again later.\n"
     exit 1
 fi
 

package.json

@@ -3,9 +3,9 @@
   "version": "0.0.0",
   "private": true,
   "scripts": {
-    "build": "node esbuild.config.js",
-    "watch": "WATCH=true node esbuild.config.js",
-    "package": "MINIFY=true node esbuild.config.js"
+    "build": "node esbuild.config.mjs",
+    "watch": "WATCH=true node esbuild.config.mjs",
+    "package": "MINIFY=true node esbuild.config.mjs"
   },
   "dependencies": {
     "axios": "^1.2.1",
@@ -20,7 +20,7 @@
   "devDependencies": {
     "@popperjs/core": "^2.11.5",
     "@vue/compiler-sfc": "^3.2.37",
-    "esbuild": "^0.16.1",
+    "esbuild": "^0.17.5",
     "esbuild-plugin-vue-next": "^0.1.4",
     "esbuild-sass-plugin": "^2.3.2"
   }

server/handlers/k8healthz.go

@@ -0,0 +1,8 @@
+package handlers
+
+import "net/http"
+
+// Healthz is a liveness probe
+func HealthzHandler(w http.ResponseWriter, _ *http.Request) {
+	w.WriteHeader(http.StatusOK)
+}

server/handlers/k8sready.go

@@ -0,0 +1,17 @@
+package handlers
+
+import (
+	"net/http"
+	"sync/atomic"
+)
+
+// ReadyzHandler is a ready probe that signals k8s to be able to retrieve traffic
+func ReadyzHandler(isReady *atomic.Value) http.HandlerFunc {
+	return func(w http.ResponseWriter, _ *http.Request) {
+		if isReady == nil || !isReady.Load().(bool) {
+			http.Error(w, http.StatusText(http.StatusServiceUnavailable), http.StatusServiceUnavailable)
+			return
+		}
+		w.WriteHeader(http.StatusOK)
+	}
+}

server/server.go

@@ -3,24 +3,28 @@ package server
 import (
 	"compress/gzip"
 	"embed"
-	"io"
-	"io/fs"
-	"net/http"
-	"os"
-	"strings"
-
 	"github.com/axllent/mailpit/config"
 	"github.com/axllent/mailpit/server/apiv1"
+	"github.com/axllent/mailpit/server/handlers"
 	"github.com/axllent/mailpit/server/websockets"
 	"github.com/axllent/mailpit/utils/logger"
 	"github.com/gorilla/mux"
+	"io"
+	"io/fs"
+	"net/http"
+	"os"
+	"strings"
+	"sync/atomic"
 )
 
 //go:embed ui
 var embeddedFS embed.FS
 
 // Listen will start the httpd
 func Listen() {
+	isReady := &atomic.Value{}
+	isReady.Store(false)
+
 	serverRoot, err := fs.Sub(embeddedFS, "ui")
 	if err != nil {
 		logger.Log().Errorf("[http] %s", err)
@@ -33,6 +37,10 @@ func Listen() {
 
 	r := defaultRoutes()
 
+	// kubernetes probes
+	r.HandleFunc("/livez", handlers.HealthzHandler)
+	r.HandleFunc("/readyz", handlers.ReadyzHandler(isReady))
+
 	// web UI websocket
 	r.HandleFunc(config.Webroot+"api/events", apiWebsocket).Methods("GET")
 
@@ -51,13 +59,17 @@ func Listen() {
 		logger.Log().Info("[http] enabling web UI basic authentication")
 	}
 
+	// Mark the application here as ready
+	isReady.Store(true)
+
 	if config.UISSLCert != "" && config.UISSLKey != "" {
 		logger.Log().Infof("[http] starting secure server on https://%s%s", config.HTTPListen, config.Webroot)
 		logger.Log().Fatal(http.ListenAndServeTLS(config.HTTPListen, config.UISSLCert, config.UISSLKey, nil))
 	} else {
 		logger.Log().Infof("[http] starting server on http://%s%s", config.HTTPListen, config.Webroot)
 		logger.Log().Fatal(http.ListenAndServe(config.HTTPListen, nil))
 	}
+
 }
 
 func defaultRoutes() *mux.Router {