Merge pull request #58 from KianYang-Lee/ky-add-chan-to-signify-serve…

…r-readiness

Add channel to signify server readiness

server/server.go

@@ -27,10 +27,20 @@ type Server struct {
 	handler      *http.Server
 	addr         string
 	channels     []wasabi.Channel
+	ready        chan<- struct{}
 }
 
 type Option func(*Server)
 
+// WithReadinessChan sets ch to [Server] and will be closed once the [Server] is
+// ready to accept connection. Typically used in testing after calling [Run]
+// method and waiting for ch to close, before continuing with test logics.
+func WithReadinessChan(ch chan<- struct{}) Option {
+	return func(s *Server) {
+		s.ready = ch
+	}
+}
+
 // NewServer creates new instance of Wasabi server
 // port - port to listen on
 // returns new instance of Server
@@ -99,6 +109,11 @@ func (s *Server) Run() (err error) {
 
 	slog.Info("Starting app server on " + s.listener.Addr().String())
 
+	// Signals that server can accept connections
+	if s.ready != nil {
+		close(s.ready)
+	}
+
 	err = s.handler.Serve(s.listener)
 
 	if err != nil && err != http.ErrServerClosed {

server/server_test.go

@@ -227,7 +227,8 @@ func TestServer_Close_NoContext(t *testing.T) {
 
 func TestServer_Addr(t *testing.T) {
 	// Create a new Server instance
-	server := NewServer(":0")
+	done := make(chan struct{})
+	server := NewServer(":0", WithReadinessChan(done))
 	defer server.Close()
 
 	// Create a mock channel
@@ -243,30 +244,15 @@ func TestServer_Addr(t *testing.T) {
 	}
 
 	// Start the server in a separate goroutine
-	done := make(chan struct{})
-
-	// Run the server
-	for i := 0; i < 2; i++ {
-		go func() {
-			err := server.Run()
-			switch err {
-			case nil:
-			case ErrServerAlreadyRunning:
-				close(done)
-			default:
-				t.Errorf("Got unexpected error: %v", err)
-			}
-		}()
-	}
-
-	select {
-	case <-done:
-	case <-time.After(1 * time.Second):
-		t.Error("Expected server to start")
-	}
+	go func() {
+		err := server.Run()
+		if err != nil {
+			t.Errorf("Got unexpected error: %v", err)
+		}
+	}()
 
 	// Wait for the server to fully start
-	time.Sleep(1 * time.Millisecond)
+	<-done
 
 	addr := server.Addr()