Remove Shutdown Hooks and Dump Admin State on Startup (#474)

Signed-off-by: Adrian Cole <[email protected]>
Co-authored-by: Adrian Cole <[email protected]>

Author: codefromthecrypt

Makefile

@@ -173,7 +173,7 @@ build/format: go.mod $(all_sources)
 	@$(go) mod tidy
 	@$(go) run $(nwa) add --mute -t .licenseheader -T raw "**/*.go"
 	@$(go) run $(gofumpt) -l -w .
-	# gofumpt organizes imports, but does not handle local grouping.
+	@# gofumpt organizes imports, but does not handle local grouping.
 	@$(go) run $(gosimports) -local github.com/tetratelabs/ -w $(shell find . -name '*.go' -type f)
 	@mkdir -p $(@D) && touch $@
 

USAGE.md

@@ -3,8 +3,8 @@ To run Envoy, execute `func-e run -c your_envoy_config.yaml`. This
 downloads and installs the latest version of Envoy for you.
 
 To list versions of Envoy you can use, execute `func-e versions -a`. To
-choose one, invoke `func-e use 1.34.2`. This installs into
-`$FUNC_E_HOME/versions/1.34.2`, if not already present. You may also use
+choose one, invoke `func-e use 1.34.3`. This installs into
+`$FUNC_E_HOME/versions/1.34.3`, if not already present. You may also use
 minor version, such as `func-e use 1.34`.
 
 You may want to override `$ENVOY_VERSIONS_URL` to supply custom builds or

api/func-e.go

@@ -90,8 +90,8 @@ type runOpts struct {
 // Run downloads Envoy and runs it as a process with the arguments
 // passed to it. Use RunOption for configuration options.
 //
-// This blocks until the context is done or the process exits. The error might be
-// context.Canceled if the context is done or an error from the process.
+// On success, this blocks and returns nil when either `ctx` is done, or the
+// process exits with status zero.
 func Run(ctx context.Context, args []string, options ...RunOption) error {
 	// TODO: we need a real API and it being an interface in this package, initialized in the root
 	// directory like wazero does. That this stitches the impl makes it not an API package and causes

api/func-e_run_test.go

@@ -1,4 +1,4 @@
-// Copyright 2025 Tetrate
+// Copyright func-e contributors
 // SPDX-License-Identifier: Apache-2.0
 
 package api
@@ -14,8 +14,8 @@ func TestRun(t *testing.T) {
 	e2e.TestRun(context.Background(), t, fakeFuncEFactory{})
 }
 
-func TestRun_MinimalListener(t *testing.T) {
-	e2e.TestRun_MinimalListener(context.Background(), t, fakeFuncEFactory{})
+func TestRun_RunDirectory(t *testing.T) {
+	e2e.TestRun_RunDirectory(context.Background(), t, fakeFuncEFactory{})
 }
 
 func TestRun_InvalidConfig(t *testing.T) {
@@ -25,3 +25,8 @@ func TestRun_InvalidConfig(t *testing.T) {
 func TestRun_StaticFile(t *testing.T) {
 	e2e.TestRun_StaticFile(context.Background(), t, fakeFuncEFactory{})
 }
+
+func TestRun_CtrlCs(t *testing.T) {
+	// This doesn't call ctrl-c, rather cancels the context multiple times
+	e2e.TestRun_CtrlCs(context.Background(), t, fakeFuncEFactory{})
+}

api/func-e_test.go

@@ -1,4 +1,4 @@
-// Copyright 2025 Tetrate
+// Copyright func-e contributors
 // SPDX-License-Identifier: Apache-2.0
 
 package api
@@ -48,8 +48,10 @@ type fakeFuncE struct {
 
 // Interrupt cancels the context created in Run as we don't want to actually interrupt the calling test!
 func (f *fakeFuncE) Interrupt(context.Context) error {
-	f.cancelFunc()
-	f.cancelFunc = nil
+	if f.cancelFunc != nil {
+		f.cancelFunc()
+		// Don't set to nil in case interrupt is called multiple times (ctrl+c twice)
+	}
 	return nil
 }
 

e2e/func-e_run_test.go

@@ -1,4 +1,4 @@
-// Copyright 2025 Tetrate
+// Copyright func-e contributors
 // SPDX-License-Identifier: Apache-2.0
 
 package e2e
@@ -14,8 +14,8 @@ func TestRun(t *testing.T) {
 	e2e.TestRun(context.Background(), t, funcEFactory{})
 }
 
-func TestRun_MinimalListener(t *testing.T) {
-	e2e.TestRun_MinimalListener(context.Background(), t, funcEFactory{})
+func TestRun_RunDirectory(t *testing.T) {
+	e2e.TestRun_RunDirectory(context.Background(), t, funcEFactory{})
 }
 
 func TestRun_InvalidConfig(t *testing.T) {
@@ -25,3 +25,7 @@ func TestRun_InvalidConfig(t *testing.T) {
 func TestRun_StaticFile(t *testing.T) {
 	e2e.TestRun_StaticFile(context.Background(), t, funcEFactory{})
 }
+
+func TestRun_CtrlCs(t *testing.T) {
+	e2e.TestRun_CtrlCs(context.Background(), t, funcEFactory{})
+}

go.mod

@@ -7,7 +7,6 @@ require (
 	github.com/stretchr/testify v1.10.0
 	github.com/ulikunitz/xz v0.5.12
 	github.com/urfave/cli/v2 v2.27.7
-	golang.org/x/sync v0.16.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 

go.sum

@@ -45,8 +45,6 @@ github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 h1:FnBeRrxr7OU4VvAz
 github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
 github.com/yusufpapurcu/wmi v1.2.4 h1:zFUKzehAFReQwLys1b/iSMl+JQGSCSjtVqQn9bBrPo0=
 github.com/yusufpapurcu/wmi v1.2.4/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0=
-golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw=
-golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
 golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201204225414-ed752295db88/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

internal/api/run.go

@@ -13,7 +13,6 @@ import (
 	"time"
 
 	"github.com/tetratelabs/func-e/internal/envoy"
-	"github.com/tetratelabs/func-e/internal/envoy/shutdown"
 	"github.com/tetratelabs/func-e/internal/globals"
 	"github.com/tetratelabs/func-e/internal/version"
 )
@@ -53,7 +52,9 @@ func EnsurePatchVersion(ctx context.Context, o *globals.GlobalOpts, v version.Ve
 	return vv, nil
 }
 
-// Run runs Envoy with the given arguments
+// Run runs Envoy with the given arguments.
+// Returns nil when Envoy exits cleanly, including when interrupted by signals (SIGINT/SIGTERM).
+// This matches Envoy's behavior of returning exit code 0 on graceful shutdown.
 func Run(ctx context.Context, o *globals.GlobalOpts, args []string) error {
 	if err := initializeRunOpts(ctx, o); err != nil {
 		return err
@@ -77,11 +78,6 @@ func Run(ctx context.Context, o *globals.GlobalOpts, args []string) error {
 	r.ErrFile = stderrLog
 	r.Err = io.MultiWriter(o.EnvoyErr, stderrLog)
 
-	for _, hook := range shutdown.DefaultShutdownHooks {
-		if err := hook(r); err != nil {
-			fmt.Fprintf(r.Out, "failed to enable shutdown hook: %s\n", err) //nolint:errcheck
-		}
-	}
 	return r.Run(ctx, args)
 }
 

internal/cmd/run.go

@@ -31,9 +31,7 @@ Envoy interprets the '[arguments...]' and runs in the current working
 directory (aka $PWD) until func-e is interrupted (ex Ctrl+C, Ctrl+Break).
 
 Envoy's process ID and console output write to "envoy.pid", stdout.log" and
-"stderr.log" in the run directory (` + fmt.Sprintf("`%s`", runDirectoryExpression) + `).
-When interrupted, shutdown hooks write files including network and process
-state. On exit, these archive into ` + fmt.Sprintf("`%s.tar.gz`", runDirectoryExpression),
+"stderr.log" in the run directory (` + fmt.Sprintf("`%s`", runDirectoryExpression) + `).`,
 		Before: func(c *cli.Context) error {
 			if err := api.EnsureEnvoyVersion(c.Context, o); err != nil {
 				return NewValidationError(err.Error())