Handle errors when stopping the listener for gRPC server

Graceful shutdown of gRPC server

Author: mostafa

api/grpc_server.go

@@ -48,9 +48,11 @@ func (s *GRPCServer) Start() {
 }
 
 // Shutdown shuts down the gRPC server.
-func (s *GRPCServer) Shutdown(_ context.Context) {
-	s.listener.Close()
-	s.grpcServer.Stop()
+func (s *GRPCServer) Shutdown(context.Context) {
+	if err := s.listener.Close(); err != nil && !errors.Is(err, net.ErrClosed) {
+		s.API.Options.Logger.Err(err).Msg("failed to close listener")
+	}
+	s.grpcServer.GracefulStop()
 }
 
 // createGRPCAPI creates a new gRPC API server and listener.

api/grpc_server_test.go

@@ -39,5 +39,5 @@ func Test_GRPC_Server(t *testing.T) {
 	assert.Equal(t, config.Version, resp.GetVersion())
 	assert.Equal(t, config.VersionInfo(), resp.GetVersionInfo())
 
-	grpcServer.Shutdown(context.Background())
+	grpcServer.Shutdown(nil)
 }

api/http_server_test.go

@@ -85,6 +85,6 @@ func Test_HTTP_Server(t *testing.T) {
 	assert.Equal(t, len(config.Version), len(respBodyBytes))
 	assert.Equal(t, config.Version, string(respBodyBytes))
 
-	grpcServer.Shutdown(context.Background())
+	grpcServer.Shutdown(nil)
 	httpServer.Shutdown(context.Background())
 }

cmd/gatewayd_app.go

@@ -1109,7 +1109,7 @@ func (app *GatewayDApp) stopGracefully(runCtx context.Context, sig os.Signal) {
 	}
 
 	if app.grpcServer != nil {
-		app.grpcServer.Shutdown(runCtx)
+		app.grpcServer.Shutdown(nil)
 		logger.Info().Msg("Stopped gRPC Server")
 		span.AddEvent("Stopped gRPC Server")
 	}