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

Update default timeouts #64

Merged
merged 5 commits into from
May 16, 2023
Merged

Update default timeouts #64

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2c30c82
Update default timeouts
starbelly Apr 12, 2023
c47044c
Close conn on recv error (optional)
starbelly Apr 13, 2023
5f91aaf
Update callbacks
starbelly Apr 18, 2023
34f99c4
Doc close_on_recv_error
starbelly May 2, 2023
d7ff069
fix typo
starbelly May 15, 2023
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
2 changes: 1 addition & 1 deletion VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.8.6
0.8.7
34 changes: 25 additions & 9 deletions lib/mllp/client.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ defmodule MLLP.ClientContract do
reply_timeout: non_neg_integer() | :infinity,
socket_opts: [:gen_tcp.option()],
telemetry_module: nil,
close_on_recv_error: boolean(),
tls: [:ssl.tls_client_option()]
]

Expand Down Expand Up @@ -146,6 +147,7 @@ defmodule MLLP.Client do
tcp: module() | nil,
tls_opts: Keyword.t(),
socket_opts: Keyword.t(),
close_on_recv_error: boolean(),
backoff: any()
}

Expand All @@ -163,6 +165,7 @@ defmodule MLLP.Client do
send_opts: %{},
tls_opts: [],
socket_opts: [],
close_on_recv_error: true,
backoff: nil

alias __MODULE__, as: State
Expand Down Expand Up @@ -219,10 +222,11 @@ defmodule MLLP.Client do
This option will only be used if `use_backoff` is set to `false`.

* `:reply_timeout` - Optionally specify a timeout value for receiving a response. Must be a positive integer or
`:infinity`. Defaults to `:infinity`.
`:infinity`. Defaults to 60 seconds.

* `:socket_opts` - A list of socket options as supported by [`:gen_tcp`](`:gen_tcp`).
Note that `:binary`, `:packet`, and `:active` can not be overridden.
Note that `:binary`, `:packet`, and `:active` can not be overridden. Default options are enumerated below.
- send_timeout: Defaults to 60 seconds

* `:tls` - A list of tls options as supported by [`:ssl`](`:ssl`). When using TLS it is highly recommended you
set `:verify` to `:verify_peer`, select a CA trust store using the `:cacertfile` or `:cacerts` options.
Expand Down Expand Up @@ -271,19 +275,19 @@ defmodule MLLP.Client do
## Options

* `:reply_timeout` - Optionally specify a timeout value for receiving a response. Must be a positive integer or
`:infinity`. Defaults to `:infinity`.
`:infinity`. Defaults to 60 seconds.
"""
@spec send(
pid :: pid,
payload :: HL7.Message.t() | String.t() | binary(),
options :: ClientContract.send_options(),
timeout :: non_neg_integer()
timeout :: non_neg_integer() | :infinity
vikas15bhardwaj marked this conversation as resolved.
Show resolved Hide resolved
) ::
{:ok, String.t()}
| MLLP.Ack.ack_verification_result()
| {:error, ClientContract.client_error()}

def send(pid, payload, options \\ %{}, timeout \\ 5000)
def send(pid, payload, options \\ %{}, timeout \\ :infinity)

def send(pid, %HL7.Message{} = payload, options, timeout) do
raw_message = to_string(payload)
Expand Down Expand Up @@ -313,7 +317,7 @@ defmodule MLLP.Client do
Given the synchronous nature of MLLP/HL7 this function is mainly useful for
testing purposes.
"""
def send_async(pid, payload, timeout \\ 5000)
def send_async(pid, payload, timeout \\ :infinity)

def send_async(pid, %HL7.Message{} = payload, timeout) do
GenServer.call(pid, {:send_async, to_string(payload)}, timeout)
Expand Down Expand Up @@ -407,7 +411,11 @@ defmodule MLLP.Client do
state
)

new_state = maintain_reconnect_timer(state)
new_state =
vikas15bhardwaj marked this conversation as resolved.
Show resolved Hide resolved
state
|> maybe_close()
|> maintain_reconnect_timer()

reply = {:error, new_error(:recv, reason)}
{:reply, reply, new_state}
end
Expand Down Expand Up @@ -478,6 +486,14 @@ defmodule MLLP.Client do
System.convert_time_unit(t, from, to)
end

defp maybe_close(%{close_on_recv_error: true} = state) do
state
|> stop_connection(:timeout, "recv error, closing connection to cleanup")
|> attempt_connection()
end

defp maybe_close(state), do: state

defp recv_ack(state, timeout) do
recv_ack(state, {timeout, 0}, <<>>)
end
Expand Down Expand Up @@ -635,11 +651,11 @@ defmodule MLLP.Client do
@default_opts %{
telemetry_module: MLLP.DefaultTelemetry,
tls_opts: [],
socket_opts: []
socket_opts: [send_timeout: 60_000]
vikas15bhardwaj marked this conversation as resolved.
Show resolved Hide resolved
}

@default_send_opts %{
reply_timeout: :infinity
reply_timeout: 60_000
}

defp maybe_set_default_options(opts) do
Expand Down
90 changes: 70 additions & 20 deletions test/client_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,12 @@ defmodule ClientTest do

expect(MLLP.TCPMock, :connect, fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}],
[
:binary,
{:packet, 0},
{:active, false},
{:send_timeout, 60_000}
],
2000 ->
{:ok, socket}
end)
Expand All @@ -102,7 +107,12 @@ defmodule ClientTest do

expect(MLLP.TCPMock, :connect, fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}],
[
:binary,
{:packet, 0},
{:active, false},
{:send_timeout, 60_000}
],
2000 ->
{:error, "error"}
end)
Expand Down Expand Up @@ -144,12 +154,15 @@ defmodule ClientTest do
MLLP.TCPMock
|> expect(
:connect,
fn ^address, ^port, [:binary, {:packet, 0}, {:active, false}], 2000 ->
fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}, {:send_timeout, 60_000}],
2000 ->
{:ok, socket}
end
)
|> expect(:send, fn ^socket, ^packet -> :ok end)
|> expect(:recv, fn ^socket, 0, :infinity -> {:ok, tcp_reply} end)
|> expect(:recv, fn ^socket, 0, 60_000 -> {:ok, tcp_reply} end)

{:ok, client} = Client.start_link(address, port, tcp: MLLP.TCPMock, use_backoff: true)

Expand Down Expand Up @@ -179,13 +192,16 @@ defmodule ClientTest do
MLLP.TCPMock
|> expect(
:connect,
fn ^address, ^port, [:binary, {:packet, 0}, {:active, false}], 2000 ->
fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}, {:send_timeout, 60_000}],
2000 ->
{:ok, socket}
end
)
|> expect(:send, fn ^socket, ^packet -> :ok end)
|> expect(:recv, fn ^socket, 0, :infinity -> {:ok, ack_frag1} end)
|> expect(:recv, fn ^socket, 0, :infinity -> {:ok, ack_frag2} end)
|> expect(:recv, fn ^socket, 0, 60_000 -> {:ok, ack_frag1} end)
|> expect(:recv, fn ^socket, 0, 60_000 -> {:ok, ack_frag2} end)

{:ok, client} = Client.start_link(address, port, tcp: MLLP.TCPMock, use_backoff: true)

Expand All @@ -202,9 +218,9 @@ defmodule ClientTest do

MLLP.TCPMock
|> expect(:send, fn ^socket, ^packet -> :ok end)
|> expect(:recv, fn ^socket, 0, :infinity -> {:ok, ack_frag1} end)
|> expect(:recv, fn ^socket, 0, :infinity -> {:ok, ack_frag2} end)
|> expect(:recv, fn ^socket, 0, :infinity -> {:ok, ack_frag3} end)
|> expect(:recv, fn ^socket, 0, 60_000 -> {:ok, ack_frag1} end)
|> expect(:recv, fn ^socket, 0, 60_000 -> {:ok, ack_frag2} end)
|> expect(:recv, fn ^socket, 0, 60_000 -> {:ok, ack_frag3} end)

assert(
{:ok, :application_accept, expected_ack} ==
Expand Down Expand Up @@ -232,7 +248,10 @@ defmodule ClientTest do
MLLP.TCPMock
|> expect(
:connect,
fn ^address, ^port, [:binary, {:packet, 0}, {:active, false}], 2000 ->
fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}, {:send_timeout, 60_000}],
2000 ->
{:ok, socket}
end
)
Expand All @@ -245,9 +264,15 @@ defmodule ClientTest do
Process.sleep(1)
{:ok, ack_frag2}
end)
|> expect(:close, fn ^socket -> :ok end)
|> expect(:connect, fn _, _, _, _ -> {:ok, socket} end)

{:ok, client} =
Client.start_link(address, port, tcp: MLLP.TCPMock, use_backoff: true, reply_timeout: 3)
Client.start_link(address, port,
tcp: MLLP.TCPMock,
use_backoff: true,
reply_timeout: 3
)

expected_err = %MLLP.Client.Error{context: :recv, reason: :timeout, message: "timed out"}

Expand All @@ -271,12 +296,22 @@ defmodule ClientTest do
MLLP.TCPMock
|> expect(
:connect,
fn ^address, ^port, [:binary, {:packet, 0}, {:active, false}], 2000 ->
2,
fn ^address,
^port,
[
:binary,
{:packet, 0},
{:active, false},
{:send_timeout, 60_000}
],
2000 ->
{:ok, socket}
end
)
|> expect(:send, fn ^socket, ^packet -> :ok end)
|> expect(:recv, fn ^socket, 0, :infinity -> {:ok, tcp_reply1} end)
|> expect(:recv, fn ^socket, 0, 60_000 -> {:ok, tcp_reply1} end)
|> expect(:close, fn ^socket -> :ok end)

{:ok, client} = Client.start_link(address, port, tcp: MLLP.TCPMock, use_backoff: true)

Expand All @@ -303,12 +338,15 @@ defmodule ClientTest do
MLLP.TCPMock
|> expect(
:connect,
fn ^address, ^port, [:binary, {:packet, 0}, {:active, false}], 2000 ->
fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}, {:send_timeout, 60_000}],
2000 ->
{:ok, socket}
end
)
|> expect(:send, fn ^socket, ^packet -> :ok end)
|> expect(:recv, fn ^socket, 0, :infinity -> {:ok, MLLP.Envelope.wrap_message("NACK")} end)
|> expect(:recv, fn ^socket, 0, 60_000 -> {:ok, MLLP.Envelope.wrap_message("NACK")} end)

{:ok, client} = Client.start_link(address, port, tcp: MLLP.TCPMock)

Expand All @@ -326,7 +364,10 @@ defmodule ClientTest do
MLLP.TCPMock
|> expect(
:connect,
fn ^address, ^port, [:binary, {:packet, 0}, {:active, false}], 2000 ->
fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}, {:send_timeout, 60_000}],
2000 ->
{:ok, socket}
end
)
Expand Down Expand Up @@ -356,7 +397,10 @@ defmodule ClientTest do
MLLP.TCPMock
|> expect(
:connect,
fn ^address, ^port, [:binary, {:packet, 0}, {:active, false}], 2000 ->
fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}, {:send_timeout, 60_000}],
2000 ->
{:ok, socket}
end
)
Expand All @@ -378,7 +422,10 @@ defmodule ClientTest do
MLLP.TCPMock
|> expect(
:connect,
fn ^address, ^port, [:binary, {:packet, 0}, {:active, false}], 2000 ->
fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}, {:send_timeout, 60_000}],
2000 ->
{:ok, socket}
end
)
Expand All @@ -400,7 +447,10 @@ defmodule ClientTest do
MLLP.TCPMock
|> expect(
:connect,
fn ^address, ^port, [:binary, {:packet, 0}, {:active, false}], 2000 ->
fn ^address,
^port,
[:binary, {:packet, 0}, {:active, false}, {:send_timeout, 60_000}],
2000 ->
{:ok, socket}
end
)
Expand Down