Adding a handler for end of calls (#393)

* Adding a handler for end of calls

* Fixing bugs

Author: nishadmusthafa

pkg/service/service.go

@@ -218,3 +218,7 @@ func (s *Service) DeregisterTransferSIPParticipantTopic(sipCallId string) {
 		s.rpcSIPServer.DeregisterTransferSIPParticipantTopic(sipCallId)
 	}
 }
+
+func (s *Service) OnCallEnd(ctx context.Context, callInfo *livekit.SIPCallInfo, reason string) {
+	s.log.Infow("SIP call ended", "callID", callInfo.CallId, "reason", reason)
+}

pkg/sip/inbound.go

@@ -825,6 +825,11 @@ func (c *inboundCall) close(error bool, status CallStatus, reason string) {
 
 	c.s.DeregisterTransferSIPParticipant(c.cc.ID())
 
+	// Call the handler asynchronously to avoid blocking
+	if c.s.handler != nil {
+		go c.s.handler.OnCallEnd(context.Background(), c.state.callInfo, reason)
+	}
+
 	c.cancel()
 }
 

pkg/sip/outbound.go

@@ -298,6 +298,11 @@ func (c *outboundCall) close(err error, status CallStatus, description string, r
 		c.c.cmu.Unlock()
 
 		c.c.DeregisterTransferSIPParticipant(string(c.cc.ID()))
+
+		// Call the handler asynchronously to avoid blocking
+		if c.c.handler != nil {
+			go c.c.handler.OnCallEnd(context.Background(), c.state.callInfo, description)
+		}
 	})
 }
 

pkg/sip/server.go

@@ -106,6 +106,8 @@ type Handler interface {
 
 	RegisterTransferSIPParticipantTopic(sipCallId string) error
 	DeregisterTransferSIPParticipantTopic(sipCallId string)
+
+	OnCallEnd(ctx context.Context, callInfo *livekit.SIPCallInfo, reason string)
 }
 
 type Server struct {

pkg/sip/service_test.go

@@ -57,6 +57,7 @@ func expectNoResponse(t *testing.T, tx sip.ClientTransaction) {
 type TestHandler struct {
 	GetAuthCredentialsFunc func(ctx context.Context, call *rpc.SIPCall) (AuthInfo, error)
 	DispatchCallFunc       func(ctx context.Context, info *CallInfo) CallDispatch
+	OnCallEndFunc          func(ctx context.Context, callInfo *livekit.SIPCallInfo, reason string)
 }
 
 func (h TestHandler) GetAuthCredentials(ctx context.Context, call *rpc.SIPCall) (AuthInfo, error) {
@@ -80,6 +81,12 @@ func (h TestHandler) DeregisterTransferSIPParticipantTopic(sipCallId string) {
 	// no-op
 }
 
+func (h TestHandler) OnCallEnd(ctx context.Context, callInfo *livekit.SIPCallInfo, reason string) {
+	if h.OnCallEndFunc != nil {
+		h.OnCallEndFunc(ctx, callInfo, reason)
+	}
+}
+
 func testInvite(t *testing.T, h Handler, hidden bool, from, to string, test func(tx sip.ClientTransaction)) {
 	sipPort := rand.Intn(testPortSIPMax-testPortSIPMin) + testPortSIPMin
 	localIP, err := config.GetLocalIP()
@@ -169,3 +176,73 @@ func TestService_AuthDrop(t *testing.T) {
 		expectNoResponse(t, tx)
 	})
 }
+
+func TestService_OnCallEnd(t *testing.T) {
+	const (
+		expectedCallID = "test-call-id"
+		expectedReason = "test-reason"
+	)
+
+	callEnded := make(chan struct{})
+	var receivedCallInfo *livekit.SIPCallInfo
+	var receivedReason string
+
+	h := &TestHandler{
+		GetAuthCredentialsFunc: func(ctx context.Context, call *rpc.SIPCall) (AuthInfo, error) {
+			return AuthInfo{Result: AuthAccept}, nil
+		},
+		DispatchCallFunc: func(ctx context.Context, info *CallInfo) CallDispatch {
+			return CallDispatch{
+				Result: DispatchAccept,
+				Room: RoomConfig{
+					RoomName: "test-room",
+					Participant: ParticipantConfig{
+						Identity: "test-participant",
+					},
+				},
+			}
+		},
+		OnCallEndFunc: func(ctx context.Context, callInfo *livekit.SIPCallInfo, reason string) {
+			receivedCallInfo = callInfo
+			receivedReason = reason
+			close(callEnded)
+		},
+	}
+
+	// Create a new service
+	sipPort := rand.Intn(testPortSIPMax-testPortSIPMin) + testPortSIPMin
+
+	mon, err := stats.NewMonitor(&config.Config{MaxCpuUtilization: 0.9})
+	require.NoError(t, err)
+
+	log := logger.NewTestLogger(t)
+	s, err := NewService("", &config.Config{
+		SIPPort:       sipPort,
+		SIPPortListen: sipPort,
+		RTPPort:       rtcconfig.PortRange{Start: testPortRTPMin, End: testPortRTPMax},
+	}, mon, log, func(projectID string) rpc.IOInfoClient { return nil })
+	require.NoError(t, err)
+	require.NotNil(t, s)
+	t.Cleanup(s.Stop)
+
+	s.SetHandler(h)
+	require.NoError(t, s.Start())
+
+	// Call OnCallEnd directly
+	h.OnCallEnd(context.Background(), &livekit.SIPCallInfo{
+		CallId: expectedCallID,
+	}, expectedReason)
+
+	// Wait for OnCallEnd to be called
+	select {
+	case <-callEnded:
+		// Success
+	case <-time.After(time.Second):
+		t.Fatal("OnCallEnd was not called")
+	}
+
+	// Verify the parameters passed to OnCallEnd
+	require.NotNil(t, receivedCallInfo, "CallInfo should not be nil")
+	require.Equal(t, expectedCallID, receivedCallInfo.CallId, "CallInfo.CallId should match")
+	require.Equal(t, expectedReason, receivedReason, "Reason should match")
+}