Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ignore duplicated remote candidates #38

Merged
merged 1 commit into from
Apr 18, 2024
Merged

Ignore duplicated remote candidates #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 31 additions & 12 deletions lib/ex_ice/priv/ice_agent.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,27 +262,29 @@ defmodule ExICE.Priv.ICEAgent do
end

@spec add_remote_candidate(t(), String.t()) :: t()
def add_remote_candidate(%__MODULE__{eoc: true} = ice_agent, remote_cand) do
Logger.warning(
"Received remote candidate after end-of-candidates. Ignoring. Candidate: #{inspect(remote_cand)}"
)
def add_remote_candidate(%__MODULE__{eoc: true} = ice_agent, remote_cand_str) do
Logger.warning("""
Received remote candidate after end-of-candidates. Ignoring.
Candidate: #{remote_cand_str}\
""")

ice_agent
end

def add_remote_candidate(
%__MODULE__{remote_ufrag: nil, remote_pwd: nil} = ice_agent,
remote_cand
remote_cand_str
) do
Logger.warning(
"Received remote candidate but there are no remote credentials. Ignoring. Candidate: #{inspect(remote_cand)}"
)
Logger.warning("""
Received remote candidate but there are no remote credentials. Ignoring.
Candidate: #{remote_cand_str}\
""")

ice_agent
end

def add_remote_candidate(ice_agent, remote_cand) do
Logger.debug("New remote candidate: #{inspect(remote_cand)}")
def add_remote_candidate(ice_agent, remote_cand_str) do
Logger.debug("New remote candidate: #{remote_cand_str}")

resolve_address = fn
remote_cand when is_binary(remote_cand.address) ->
Expand All @@ -303,18 +305,34 @@ defmodule ExICE.Priv.ICEAgent do
{:ok, remote_cand}
end

with {_, {:ok, remote_cand}} <- {:unmarshal, ExICE.Candidate.unmarshal(remote_cand)},
{_, {:ok, remote_cand}} <- {:resolve_address, resolve_address.(remote_cand)} do
uniq? = fn remote_cands, remote_cand ->
not Enum.any?(remote_cands, fn cand ->
cand.address == remote_cand.address and cand.port == remote_cand.port
end)
end

with {_, {:ok, remote_cand}} <- {:unmarshal, ExICE.Candidate.unmarshal(remote_cand_str)},
{_, {:ok, remote_cand}} <- {:resolve_address, resolve_address.(remote_cand)},
{_, true} <- {:uniq, uniq?.(Map.values(ice_agent.remote_cands), remote_cand)} do
ice_agent = do_add_remote_candidate(ice_agent, remote_cand)
Logger.debug("Successfully added remote candidate.")

ice_agent
|> update_connection_state()
|> update_ta_timer()
else
{:uniq, false} ->
Logger.warning("""
Duplicated remote candidate. Ignoring.
Candidate: #{remote_cand_str}\
""")

ice_agent

{operation, {:error, reason}} ->
Logger.warning("""
Invalid remote candidate. Couldn't #{operation}, reason: #{inspect(reason)}. Ignoring.
Candidate: #{remote_cand_str}\
""")

ice_agent
Expand Down Expand Up @@ -1926,6 +1944,7 @@ defmodule ExICE.Priv.ICEAgent do
end

defp send_keepalive(ice_agent, pair) do
Logger.debug("Sending keepalive")
type = %Type{class: :indication, method: :binding}
local_cand = Map.fetch!(ice_agent.local_cands, pair.local_cand_id)
remote_cand = Map.fetch!(ice_agent.remote_cands, pair.remote_cand_id)
Expand Down
17 changes: 16 additions & 1 deletion test/priv/ice_agent_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,13 @@ defmodule ExICE.Priv.ICEAgentTest do
if_discovery_module: IfDiscovery.Mock,
transport_module: Transport.Mock
)
|> ICEAgent.set_remote_credentials("remoteufrag", "remotepwd")

%{ice_agent: ice_agent}
end

test "with correct remote candidate", %{ice_agent: ice_agent} do
remote_cand = ExICE.Candidate.new(:host, address: {192, 168, 0, 2}, port: 8445)
ice_agent = ICEAgent.set_remote_credentials(ice_agent, "remoteufrag", "remotepwd")
ice_agent = ICEAgent.add_remote_candidate(ice_agent, ExICE.Candidate.marshal(remote_cand))

assert [%ExICE.Candidate{} = r_cand] = Map.values(ice_agent.remote_cands)
Expand All @@ -89,6 +89,21 @@ defmodule ExICE.Priv.ICEAgentTest do
assert %{} == ice_agent.remote_cands
end

test "with duplicated remote candidate", %{ice_agent: ice_agent} do
remote_cand = ExICE.Candidate.new(:host, address: {192, 168, 0, 2}, port: 8445)
serialized_remote_cand = ExICE.Candidate.marshal(remote_cand)
ice_agent = ICEAgent.add_remote_candidate(ice_agent, serialized_remote_cand)
ice_agent = ICEAgent.add_remote_candidate(ice_agent, serialized_remote_cand)
assert map_size(ice_agent.remote_cands) == 1
end

test "without remote credentials", %{ice_agent: ice_agent} do
ice_agent = %{ice_agent | remote_ufrag: nil, remote_pwd: nil}
remote_cand = ExICE.Candidate.new(:host, address: {192, 168, 0, 2}, port: 8445)
ice_agent = ICEAgent.add_remote_candidate(ice_agent, ExICE.Candidate.marshal(remote_cand))
assert %{} == ice_agent.remote_cands
end

test "after setting end-of-candidates", %{ice_agent: ice_agent} do
remote_cand = ExICE.Candidate.new(:host, address: {192, 168, 0, 2}, port: 8445)
ice_agent = ICEAgent.end_of_candidates(ice_agent)
Expand Down
Loading