aboutsummaryrefslogtreecommitdiffstats
path: root/http/server.go
blob: b74e39ba3804d30239d42a5a199a475b656224c6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
// Package http provides utilities for managing HTTP servers and listeners.
//
// It supports opening multiple network listeners from configuration,
// running multiple HTTP servers concurrently with graceful shutdown,
// and integrates structured logging with context.
//
// This package is designed to be used with context cancellation for concurrency control.

package http

import (
	"context"
	"errors"
	"fmt"
	"io/fs"
	"net"
	"os"
	"strings"
	"sync"

	"golang.org/x/sync/errgroup"
)

// Listeners is a slice of net.Listener interfaces representing multiple network listeners.
type Listeners []net.Listener

// CloseAll closes all listeners in the slice.
// It aggregates all errors returned by individual Close calls using errors.Join.
//
// If no errors occur, it returns nil.
func (ls Listeners) CloseAll() error {
	var errs []error
	for _, l := range ls {
		if err := l.Close(); err != nil {
			errs = append(errs, err)
		}
	}
	if len(errs) > 0 {
		return errors.Join(errs...)
	}
	return nil
}

type NetType int

const (
	NetTCP NetType = iota
	NetTCP4
	NetTCP6
	NetUnix
	NetUnixPacket
)

func (n NetType) String() string {
	switch n {
	case NetTCP:
		return "tcp"
	case NetTCP4:
		return "tcp4"
	case NetTCP6:
		return "tcp6"
	case NetUnix:
		return "unix"
	case NetUnixPacket:
		return "unixpacket"
	default:
		return fmt.Sprintf("NetType(%d)", n)
	}
}

func (n *NetType) Set(s string) error {
	switch strings.ToLower(s) {
	case "tcp":
		*n = NetTCP
	case "tcp4":
		*n = NetTCP4
	case "tcp6":
		*n = NetTCP6
	case "unix":
		*n = NetUnix
	case "unixpacket":
		*n = NetUnixPacket
	default:
		return fmt.Errorf("invalid NetType %q", s)
	}
	return nil
}

func (n *NetType) UnmarshalText(b []byte) error {
	return n.Set(string(b))
}

func (n NetType) MarshalText() ([]byte, error) {
	return n.AppendText(nil)
}

func (n NetType) AppendText(dst []byte) ([]byte, error) {
	return append(dst, n.String()...), nil
}

// ServerConfig defines a single network listener configuration.
//
// Network is the network type, e.g., "tcp".
// Address is the socket address, e.g., ":8080".
type ServerConfig struct {
	Network NetType
	Address string
	Mode    fs.FileMode
}

// OpenConfigListeners opens network listeners as specified by the provided ServerConfig slice.
//
// It attempts to open all listeners concurrently and returns them if all succeed.
//
// If any listener fails to open, it closes all previously opened listeners and returns an error.
//
// The context controls cancellation of the opening process.
func OpenConfigListners(ctx context.Context, config []ServerConfig) (Listeners, error) {
	lns := make(Listeners, 0, len(config))
	var mu sync.Mutex
	g, ctx := errgroup.WithContext(ctx)

	for _, cfg := range config {
		g.Go(func() error {
			ln, err := listenConfig(ctx, cfg)
			if err != nil {
				return err
			}

			mu.Lock()
			lns = append(lns, ln)
			mu.Unlock()
			return nil
		})
	}
	if err := g.Wait(); err != nil {
		_ = lns.CloseAll()
		return nil, err
	}
	return lns, nil
}

func listenConfig(ctx context.Context, cfg ServerConfig) (net.Listener, error) {
	network := cfg.Network

	var lc net.ListenConfig
	ln, err := lc.Listen(ctx, network.String(), cfg.Address)
	if err != nil {
		return nil, fmt.Errorf("failed to listen on %s %s: %w", network, cfg.Address, err)
	}
	if _, ok := ln.(*net.UnixListener); cfg.Mode != 0 && ok {
		if err := os.Chmod(cfg.Address, cfg.Mode); err != nil {
			ln.Close()
			return nil, fmt.Errorf("chmod failed on %s: %w", cfg.Address, err)
		}
	}
	return ln, nil
}

func OpenListeners(ctx context.Context, config []ServerConfig) (Listeners, error) {
	lns, err := getSystemdListeners()
	if err != nil {
		return nil, fmt.Errorf("systemd socket activation failed: %w", err)
	}
	if lns != nil {
		// Systemd is in charge; we don't honor ServerConfig here
		return lns, nil
	}

	return OpenConfigListners(ctx, config)
}