https://github.com/ainvaltin/httpsrv

Package httpsrv implements minimalist "framework" to manage http server lifetime.
https://github.com/ainvaltin/httpsrv

http server

Last synced: 10 months ago
JSON representation

Package httpsrv implements minimalist "framework" to manage http server lifetime.

• Host: GitHub
• URL: https://github.com/ainvaltin/httpsrv
• Owner: ainvaltin
• License: mit
• Created: 2022-12-28T12:25:48.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-11T10:57:58.000Z (over 2 years ago)
• Last Synced: 2025-05-31T15:20:18.609Z (10 months ago)
• Topics: http, server
• Language: Go
• Homepage:
• Size: 75.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Go Reference](https://pkg.go.dev/badge/github.com/ainvaltin/httpsrv.svg)](https://pkg.go.dev/github.com/ainvaltin/httpsrv)

# httpsrv

Package `httpsrv` implements minimalist "framework" to manage http server lifetime.

Setting up server and managing it's lifetime is repetitive and it is easy to

introduce subtle bugs. This library aims to solve these problems for http server

while being router agnostic and "errgroup pattern" friendly.

Simple example of using this package:

```go

func main() {

	ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt)

	defer stop()

	mux := http.NewServeMux()

	mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {

		fmt.Fprint(w, "Hello, World!")

	})

	err := httpsrv.Run(ctx, &http.Server{Addr: "127.0.0.1:8080", Handler: mux})

	fmt.Println("server exited:", err)

}

```

## errgroup pattern

Simply put "errgroup pattern" is a organization of the service code so that all

subprocesses of the service are launched as members of the same

[errgroup](https://pkg.go.dev/golang.org/x/sync/errgroup) and their lifetime is

controlled by the context of the group. This means that when one of the group members

exits with error the group's context gets cancelled and all other group members

get signal to (gracefully) exit too. Group reports the first error as the reason

service stopped.

Rules for a func starting a subprocess are:

 - every group member lifetime is controlled by group's context - when it gets cancelled

 the subprocess should exit (gracefully) ASAP;

 - subprocess always returns non-nil error (most of the time it would be the `ctx.Err()`

 ie the subprocess exits because the context controlling it's lifetime has been cancelled).

See the [example project](./examples/errgroup/) for more.

## Possible improvements

- support user defined panic handlers so that if none of the handlers mark panic as "handled"

then service will be shut down (IOW configurable `ShutdownOnPanic`);