improve graceful shutdown of http server

Update Makefile 'run' to call go run directly on the website.

Add HasGitDiff() to ci cmd, to avoid dirty git.

Author: jlarfors

Makefile

@@ -1,5 +1,6 @@
 
-CI_CMD := go run ./cmd/ci/*.go
+CI_CMD := go run ./cmd/ci/ci.go
+WEBSITE_CMD := go run ./cmd/website/website.go
 
 .PHONY: init
 init:
@@ -11,7 +12,7 @@ dev:
 
 .PHONY: run
 run:
-	$(CI_CMD) -run
+	$(WEBSITE_CMD)
 
 .PHONY: pr
 pr:

README.md

@@ -40,7 +40,7 @@ Things you need to install:
 To start a local development server:
 
 ```bash
-go run ./cmd/ci/*.go -dev
+make dev
 
 # Open your browser at http://localhost:3000
 ```
@@ -50,11 +50,9 @@ go run ./cmd/ci/*.go -dev
 Before pushing any code changes, make sure that it builds
 
 ```bash
-go run ./cmd/ci/*.go -pr
+make pr
 ```
 
-> You can preview the built app with `npm run preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production.
-
 ## Releasing
 
 Pushing to the `main` branch deploys the changes to the staging environment <https://staging.verifa.io>

TODO.md

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"bytes"
 	"context"
 	"errors"
 	"flag"
@@ -48,7 +49,7 @@ const (
 var gitCommit = "dev"
 
 func main() {
-	var dev, build, lint, test, run, preview, pr bool
+	var dev, build, lint, test, preview, pr bool
 	var deploy string
 	flag.BoolVar(&dev, "dev", false, "run the website locally")
 	flag.BoolVar(&build, "build", false, "build the website locally")
@@ -60,7 +61,6 @@ func main() {
 		"",
 		"deploy the website to this env (staging or prod)",
 	)
-	flag.BoolVar(&run, "run", false, "run the website locally")
 	flag.BoolVar(&preview, "preview", false, "run a local preview environment")
 	flag.BoolVar(&pr, "pr", false, "run the pull request checks")
 	flag.Parse()
@@ -83,26 +83,24 @@ func main() {
 	)
 	defer stop()
 
-	if lint {
-		Lint(ctx)
-	}
-	if test {
-		Test(ctx)
-	}
 	if dev {
 		Dev(ctx)
 	}
-	if run {
-		Run(ctx)
-	}
 	if build {
 		_ = KoBuild(ctx, WithKoLocal())
 	}
 	if preview {
 		Preview(ctx)
 	}
+	if lint {
+		Lint(ctx)
+	}
+	if test {
+		Test(ctx)
+	}
 	if pr {
 		PullRequest(ctx)
+		HasGitDiff(ctx)
 	}
 	if deploy != "" {
 		Deploy(ctx, deploy)
@@ -115,11 +113,6 @@ func Dev(ctx context.Context) {
 	<-ctx.Done()
 }
 
-func Run(ctx context.Context) {
-	iferr(Generate(ctx))
-	iferr(Go(ctx, "run", "./cmd/website/main.go"))
-}
-
 func Watch(ctx context.Context) {
 	fmt.Println("👀 watching for changes")
 
@@ -308,6 +301,21 @@ func PullRequest(ctx context.Context) {
 	fmt.Println("✅ pull request checks passed")
 }
 
+// HasGitDiff displays the git diff and errors if there is a diff
+func HasGitDiff(ctx context.Context) {
+	cmd := exec.CommandContext(ctx, "git", "--no-pager", "diff")
+	slog.Info("exec", slog.String("cmd", cmd.String()))
+	b, err := cmd.CombinedOutput()
+	iferr(err)
+	if len(b) == 0 {
+		return
+	}
+	buf := bytes.NewBuffer(b)
+	fmt.Println("❌ git diff is not empty:")
+	fmt.Println(buf.String())
+	os.Exit(1)
+}
+
 func Deploy(ctx context.Context, deploy string) {
 	var cloudRunService string
 	switch deploy {

cmd/ci/ci.go

@@ -1,17 +1,21 @@
 package main
 
 import (
+	"context"
 	"flag"
 	"log/slog"
 	"os"
+	"os/signal"
 
 	"github.com/verifa/website"
 )
 
-var buildGitCommit = "dev"
+var (
+	buildGitCommit = "dev"
+	isProduction   bool
+)
 
 func main() {
-	var isProduction bool
 	flag.BoolVar(
 		&isProduction,
 		"prod",
@@ -20,11 +24,21 @@ func main() {
 	)
 	flag.Parse()
 
-	if err := website.Run(website.Site{
+	if err := run(); err != nil {
+		slog.Error("running website", "error", err)
+		os.Exit(1)
+	}
+}
+
+func run() error {
+	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
+	defer cancel()
+
+	if err := website.Run(ctx, website.Site{
 		Commit:       buildGitCommit,
 		IsProduction: isProduction,
 	}); err != nil {
-		slog.Error("starting website", "error", err)
-		os.Exit(1)
+		return err
 	}
+	return nil
 }

cmd/website/website.go

@@ -1,9 +1,11 @@
 package website
 
 import (
+	"context"
 	"crypto/md5"
 	"embed"
 	"encoding/hex"
+	"errors"
 	"fmt"
 	"io/fs"
 	"log/slog"
@@ -13,6 +15,7 @@ import (
 	"net/url"
 	"path/filepath"
 	"strings"
+	"sync"
 	"time"
 
 	"github.com/go-chi/chi/v5"
@@ -48,14 +51,7 @@ type Site struct {
 	IsProduction bool
 }
 
-func Run(site Site) error {
-	slog.Info(
-		"starting website",
-		"commit",
-		site.Commit,
-		"production",
-		site.IsProduction,
-	)
+func Run(ctx context.Context, site Site) error {
 	// Parse posts.
 	posts, err := ParsePosts(postsFS)
 	if err != nil {
@@ -635,17 +631,47 @@ func Run(site Site) error {
 		w.Header().Set("Content-Type", "text/html")
 		_ = page(site, pageInfo, notFound()).Render(r.Context(), w)
 	})
-	server := &http.Server{
+	httpServer := &http.Server{
 		ReadHeaderTimeout: 3 * time.Second,
 		Handler:           router,
 	}
 	l, err := net.Listen("tcp", ":3000")
 	if err != nil {
 		return fmt.Errorf("listening: %w", err)
 	}
-	if err := server.Serve(l); err != nil {
-		return fmt.Errorf("starting server: %w", err)
-	}
+	defer l.Close()
+
+	slog.Info(
+		"website started",
+		"commit",
+		site.Commit,
+		"production",
+		site.IsProduction,
+		"address",
+		l.Addr().String(),
+	)
+
+	go func() {
+		if err := httpServer.Serve(l); err != nil {
+			if errors.Is(err, http.ErrServerClosed) {
+				return
+			}
+			slog.Error("serving website", "error", err)
+		}
+	}()
+	var wg sync.WaitGroup
+	wg.Add(1)
+	go func() {
+		defer wg.Done()
+		<-ctx.Done()
+		slog.Info("shutting down http server")
+		shutdownCtx, cancel := context.WithTimeout(ctx, 5*time.Second)
+		defer cancel()
+		if err := httpServer.Shutdown(shutdownCtx); err != nil {
+			slog.Error("shutting down http server", "error", err)
+		}
+	}()
+	wg.Wait()
 	return nil
 }