chore: configurable request timeout

README.md

@@ -151,6 +151,8 @@ You can specify configuration options either via a config file (default: `config
 | `server.port`               | `WAKAPI_PORT`               | `3000`         | Port to listen on                                                   |
 | `server.listen_ipv4`        | `WAKAPI_LISTEN_IPV4`        | `127.0.0.1`    | IPv4 network address to listen on (leave blank to disable IPv4)     |
 | `server.listen_ipv6`        | `WAKAPI_LISTEN_IPV6`        | `::1`          | IPv6 network address to listen on (leave blank to disable IPv6)     |
+| `server.listen_socket`      | `WAKAPI_LISTEN_SOCKET`      | -              | UNIX socket to listen on (leave blank to disable UNIX socket)       |
+| `server.timeout_sec`        | `WAKAPI_TIMEOUT_SEC`        | `30`           | Request timeout in seconds       |
 | `server.tls_cert_path`      | `WAKAPI_TLS_CERT_PATH`      | -              | Path of SSL server certificate (leave blank to not use HTTPS)       |
 | `server.tls_key_path`       | `WAKAPI_TLS_KEY_PATH`       | -              | Path of SSL server private key (leave blank to not use HTTPS)       |
 | `server.base_path`          | `WAKAPI_BASE_PATH`          | `/`            | Web base path (change when running behind a proxy under a sub-path) |

config.default.yml

@@ -3,6 +3,8 @@ env: production
 server:
   listen_ipv4: 127.0.0.1              # leave blank to disable ipv4
   listen_ipv6: ::1                    # leave blank to disable ipv6
+  listen_socket:                      # leave blank to disable unix sockets
+  timeout_sec: 30                     # request timeout
   tls_cert_path:                      # leave blank to not use https
   tls_key_path:                       # leave blank to not use https
   port: 3000

config/config.go

@@ -95,13 +95,15 @@ type dbConfig struct {
 }
 
 type serverConfig struct {
-	Port        int    `default:"3000" env:"WAKAPI_PORT"`
-	ListenIpV4  string `yaml:"listen_ipv4" default:"127.0.0.1" env:"WAKAPI_LISTEN_IPV4"`
-	ListenIpV6  string `yaml:"listen_ipv6" default:"::1" env:"WAKAPI_LISTEN_IPV6"`
-	BasePath    string `yaml:"base_path" default:"/" env:"WAKAPI_BASE_PATH"`
-	PublicUrl   string `yaml:"public_url" default:"http://localhost:3000" env:"WAKAPI_PUBLIC_URL"`
-	TlsCertPath string `yaml:"tls_cert_path" default:"" env:"WAKAPI_TLS_CERT_PATH"`
-	TlsKeyPath  string `yaml:"tls_key_path" default:"" env:"WAKAPI_TLS_KEY_PATH"`
+	Port         int    `default:"3000" env:"WAKAPI_PORT"`
+	ListenIpV4   string `yaml:"listen_ipv4" default:"127.0.0.1" env:"WAKAPI_LISTEN_IPV4"`
+	ListenIpV6   string `yaml:"listen_ipv6" default:"::1" env:"WAKAPI_LISTEN_IPV6"`
+	ListenSocket string `yaml:"listen_socket" default:"" env:"WAKAPI_LISTEN_SOCKET"`
+	TimeoutSec   int    `yaml:"timeout_sec" default:"30" env:"WAKAPI_TIMEOUT_SEC"`
+	BasePath     string `yaml:"base_path" default:"/" env:"WAKAPI_BASE_PATH"`
+	PublicUrl    string `yaml:"public_url" default:"http://localhost:3000" env:"WAKAPI_PUBLIC_URL"`
+	TlsCertPath  string `yaml:"tls_cert_path" default:"" env:"WAKAPI_TLS_CERT_PATH"`
+	TlsKeyPath   string `yaml:"tls_key_path" default:"" env:"WAKAPI_TLS_KEY_PATH"`
 }
 
 type sentryConfig struct {
@@ -350,8 +352,8 @@ func Load(version string) *Config {
 	}
 
 	// some validation checks
-	if config.Server.ListenIpV4 == "" && config.Server.ListenIpV6 == "" {
-		logbuch.Fatal("either of listen_ipv4 or listen_ipv6 must be set")
+	if config.Server.ListenIpV4 == "" && config.Server.ListenIpV6 == "" && config.Server.ListenSocket == "" {
+		logbuch.Fatal("either of listen_ipv4 or listen_ipv6 or listen_socket must be set")
 	}
 	if config.Db.MaxConn <= 0 {
 		logbuch.Fatal("you must allow at least one database connection")

main.go

@@ -4,6 +4,7 @@ import (
 	"embed"
 	"io/fs"
 	"log"
+	"net"
 	"net/http"
 	"os"
 	"strconv"
@@ -188,6 +189,14 @@ func main() {
 	rootRouter := router.PathPrefix("/").Subrouter()
 	apiRouter := router.PathPrefix("/api").Subrouter().StrictSlash(true)
 
+	// https://github.com/gorilla/mux/issues/416
+	router.NotFoundHandler = router.NewRoute().BuildOnly().HandlerFunc(http.NotFound).GetHandler()
+	router.NotFoundHandler = middlewares.NewLoggingMiddleware(logbuch.Info, []string{
+		"/assets",
+		"/favicon",
+		"/service-worker.js",
+	})(router.NotFoundHandler)
+
 	// Globally used middlewares
 	router.Use(middlewares.NewPrincipalMiddleware())
 	router.Use(middlewares.NewLoggingMiddleware(logbuch.Info, []string{"/assets"}))
@@ -233,7 +242,7 @@ func main() {
 }
 
 func listen(handler http.Handler) {
-	var s4, s6 *http.Server
+	var s4, s6, sSocket *http.Server
 
 	// IPv4
 	if config.Server.ListenIpV4 != "" {
@@ -241,8 +250,8 @@ func listen(handler http.Handler) {
 		s4 = &http.Server{
 			Handler:      handler,
 			Addr:         bindString4,
-			ReadTimeout:  10 * time.Second,
-			WriteTimeout: 10 * time.Second,
+			ReadTimeout:  time.Duration(config.Server.TimeoutSec) * time.Second,
+			WriteTimeout: time.Duration(config.Server.TimeoutSec) * time.Second,
 		}
 	}
 
@@ -252,8 +261,17 @@ func listen(handler http.Handler) {
 		s6 = &http.Server{
 			Handler:      handler,
 			Addr:         bindString6,
-			ReadTimeout:  10 * time.Second,
-			WriteTimeout: 10 * time.Second,
+			ReadTimeout:  time.Duration(config.Server.TimeoutSec) * time.Second,
+			WriteTimeout: time.Duration(config.Server.TimeoutSec) * time.Second,
+		}
+	}
+
+	// UNIX domain socket
+	if config.Server.ListenSocket != "" {
+		sSocket = &http.Server{
+			Handler:      handler,
+			ReadTimeout:  time.Duration(config.Server.TimeoutSec) * time.Second,
+			WriteTimeout: time.Duration(config.Server.TimeoutSec) * time.Second,
 		}
 	}
 
@@ -274,6 +292,18 @@ func listen(handler http.Handler) {
 				}
 			}()
 		}
+		if sSocket != nil {
+			logbuch.Info("--> Listening for HTTPS on %s... ✅", config.Server.ListenSocket)
+			go func() {
+				unixListener, err := net.Listen("unix", config.Server.ListenSocket)
+				if err != nil {
+					logbuch.Fatal(err.Error())
+				}
+				if err := sSocket.ServeTLS(unixListener, config.Server.TlsCertPath, config.Server.TlsKeyPath); err != nil {
+					logbuch.Fatal(err.Error())
+				}
+			}()
+		}
 	} else {
 		if s4 != nil {
 			logbuch.Info("--> Listening for HTTP on %s... ✅", s4.Addr)
@@ -291,6 +321,18 @@ func listen(handler http.Handler) {
 				}
 			}()
 		}
+		if sSocket != nil {
+			logbuch.Info("--> Listening for HTTP on %s... ✅", config.Server.ListenSocket)
+			go func() {
+				unixListener, err := net.Listen("unix", config.Server.ListenSocket)
+				if err != nil {
+					logbuch.Fatal(err.Error())
+				}
+				if err := sSocket.Serve(unixListener); err != nil {
+					logbuch.Fatal(err.Error())
+				}
+			}()
+		}
 	}
 
 	<-make(chan interface{}, 1)

version.txt

@@ -1 +1 @@
-1.28.3
+1.29.1