API: Use ICECandidateInit in AddICECandidate

backkem · backkem · commit 0e619e2fb235 · 2019-02-21T07:09:35.000+01:00
Resolves #358
diff --git a/icecandidateinit.go b/icecandidateinit.go
@@ -0,0 +1,9 @@
+package webrtc
+
+// ICECandidateInit is used to serialize ice candidates
+type ICECandidateInit struct {
+	Candidate        string  `json:"candidate"`
+	SDPMid           *string `json:"sdpMid,omitempty"`
+	SDPMLineIndex    *uint16 `json:"sdpMLineIndex,omitempty"`
+	UsernameFragment string  `json:"usernameFragment"`
+}
diff --git a/icecandidateinit_test.go b/icecandidateinit_test.go
@@ -0,0 +1,53 @@
+package webrtc
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestICECandidateInit_Serialization(t *testing.T) {
+	tt := []struct {
+		candidate  ICECandidateInit
+		serialized string
+	}{
+		{ICECandidateInit{
+			Candidate:        "candidate:abc123",
+			SDPMid:           refString("0"),
+			SDPMLineIndex:    refUint16(0),
+			UsernameFragment: "def",
+		}, `{"candidate":"candidate:abc123","sdpMid":"0","sdpMLineIndex":0,"usernameFragment":"def"}`},
+		{ICECandidateInit{
+			Candidate:        "candidate:abc123",
+			UsernameFragment: "def",
+		}, `{"candidate":"candidate:abc123","usernameFragment":"def"}`},
+	}
+
+	for i, tc := range tt {
+		b, err := json.Marshal(tc.candidate)
+		if err != nil {
+			t.Errorf("Failed to marshal %d: %v", i, err)
+		}
+		actualSerialized := string(b)
+		if actualSerialized != tc.serialized {
+			t.Errorf("%d expected %s got %s", i, tc.serialized, actualSerialized)
+		}
+
+		var actual ICECandidateInit
+		err = json.Unmarshal(b, &actual)
+		if err != nil {
+			t.Errorf("Failed to unmarshal %d: %v", i, err)
+		}
+
+		assert.Equal(t, tc.candidate, actual, "should match")
+	}
+}
+
+func refString(s string) *string {
+	return &s
+}
+
+func refUint16(i uint16) *uint16 {
+	return &i
+}
diff --git a/peerconnection.go b/peerconnection.go
@@ -1030,26 +1030,24 @@ func (pc *PeerConnection) RemoteDescription() *SessionDescription {
 
 // AddICECandidate accepts an ICE candidate string and adds it
 // to the existing set of candidates
-func (pc *PeerConnection) AddICECandidate(s string) error {
-	// TODO: AddICECandidate should take ICECandidateInit
+func (pc *PeerConnection) AddICECandidate(candidate ICECandidateInit) error {
 	if pc.RemoteDescription() == nil {
 		return &rtcerr.InvalidStateError{Err: ErrNoRemoteDescription}
 	}
 
-	s = strings.TrimPrefix(s, "candidate:")
-
-	attribute := sdp.NewAttribute("candidate", s)
+	candidateValue := strings.TrimPrefix(candidate.Candidate, "candidate:")
+	attribute := sdp.NewAttribute("candidate", candidateValue)
 	sdpCandidate, err := attribute.ToICECandidate()
 	if err != nil {
 		return err
 	}
 
-	candidate, err := newICECandidateFromSDP(sdpCandidate)
+	iceCandidate, err := newICECandidateFromSDP(sdpCandidate)
 	if err != nil {
 		return err
 	}
 
-	return pc.iceTransport.AddRemoteCandidate(candidate)
+	return pc.iceTransport.AddRemoteCandidate(iceCandidate)
 }
 
 // ICEConnectionState returns the ICE connection state of the
