gracefulhttp

gracefulhttp

This package extends the functionality of the standard http.Server in Go to include best practice configurations and graceful shutdown.

• Smoothly stop accepting new connections while processing existing requests to completion.
• Set a customizable timeout for graceful shutdown, with a default of 5 seconds.
• Forcibly close ongoing connections after the timeout expires.
• Support graceful shutdown for HTTP and HTTPS servers.
• Apply best practice configurations inspired by Cloudflare for timeout management and TLS setup (Read more).

Installation

go get github.com/aoliveti/gracefulhttp

Usage

package main

import (
	"context"
	"errors"
	"log"
	"net/http"
	"os/signal"

	"github.com/aoliveti/gracefulhttp"
	"golang.org/x/sys/unix"
)

func main() {
	ctx, cancel := signal.NotifyContext(context.Background(), unix.SIGINT, unix.SIGTERM)
	defer cancel()

	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		_, _ = w.Write([]byte("Hello world!"))
	})

	srv := gracefulhttp.Bind(":8080", nil)

	log.Println("starting server...")

	err := srv.ListenAndServeWithShutdown(ctx)
	if err != nil && !errors.Is(err, context.DeadlineExceeded) {
		log.Fatal(err)
	}

	log.Println("graceful shutdown completed successfully")
}

You can instantiate a GracefulServer in two different ways:

gracefulhttp.GracefulServer{
    Server: http.Server{
        Addr:    ":8080",
        Handler: nil,
    },
}

or by using the Bind() function:

func Bind(addr string, handler http.Handler) *GracefulServer

Listen and serve

To start the HTTP server with the provided address and handler, you need to use this function:

func (s *GracefulServer) ListenAndServeWithShutdown(ctx context.Context, opts ...GracefulServerOption) error

If instead you need to start a server that accepts connections over HTTPS, you must ensure to provide files containing a certificate and matching private key for the server. You should use this function:

func (s *GracefulServer) ListenAndServeTLSWithShutdown(ctx context.Context, certFile string, keyFile string, opts ...GracefulServerOption) error

It's possible to pass options to set timeouts and TLS configuration. Here's a summary table:

Build and Test

Building the Project

You can build the project using the provided Makefile. Simply run:

make

Running Tests

To run tests, use the following command:

make test

Before running the tests, a certificate and key are generated using OpenSSL and placed in the certs directory. The generated certificate and key are used for testing HTTPS functions.

For detailed documentation on OpenSSL, visit https://www.openssl.org/

License

The library is released under the MIT license. See LICENSE file.