wip: tweak args, add docs

pepsico-ecommerce · Mar 9, 2021 · 0bfc5dc · 0bfc5dc
1 parent 02b0d3d
commit 0bfc5dc
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 24 deletions.
diff --git a/lib/snowflex/connection.ex b/lib/snowflex/connection.ex
@@ -6,11 +6,16 @@ defmodule Snowflex.Connection do
 
   When used, the connection expects the `:otp_app` option. You may also define a standard timeout. This will default to 60 seconds.
 
+  If `keep_alive?` is set to `true`, each worker in the connection pool will
+  periodically send a dummy query to Snowflake to keep the authenticated
+  session from expiring.
+
   ```
   defmodule SnowflakeConnection do
     use Snowflex.Connection,
       otp_app: :my_app,
-      timeout: :timer.seconds(60)
+      timeout: :timer.seconds(60),
+      keep_alive?: true
   end
   ```
 
@@ -86,6 +91,7 @@ defmodule Snowflex.Connection do
       # setup compile time config
       otp_app = Keyword.fetch!(opts, :otp_app)
       timeout = Keyword.get(opts, :timeout, :timer.seconds(60))
+      keep_alive? = Keyword.get(opts, :keep_alive?, false)
 
       @otp_app otp_app
       @name __MODULE__
@@ -94,6 +100,8 @@ defmodule Snowflex.Connection do
         max: 10,
         min: 5
       ]
+      @keep_alive? keep_alive?
+      @heartbeat_interval :timer.hours(3)
 
       def child_spec(_) do
         config = Application.get_env(@otp_app, __MODULE__, [])
@@ -113,7 +121,7 @@ defmodule Snowflex.Connection do
           {:max_overflow, min_pool_size}
         ]
 
-        :poolboy.child_spec(@name, opts, connection)
+        :poolboy.child_spec(@name, opts, {connection, @keep_alive?, @heartbeat_interval})
       end
 
       @impl Snowflex.Connection

diff --git a/lib/snowflex/worker.ex b/lib/snowflex/worker.ex
@@ -28,19 +28,9 @@ defmodule Snowflex.Worker do
   ## GENSERVER CALL BACKS
 
   @impl GenServer
-  def init(connection_args) do
-    {keep_alive?, connection_args} = Keyword.pop(connection_args, :keep_alive?, false)
-
-    {heartbeat_interval, connection_args} =
-      Keyword.pop(connection_args, :heartbeat_interval, :timer.hours(3))
-
+  def init({connection_args, keep_alive?, heartbeat_interval}) do
     send(self(), {:start, connection_args, keep_alive?, heartbeat_interval})
-
-    {:ok,
-     %{
-       backoff: :backoff.init(2, 60),
-       state: :not_connected
-     }}
+    {:ok, %{backoff: :backoff.init(2, 60), state: :not_connected}}
   end
 
   @impl GenServer

diff --git a/test/snowflex/worker_test.exs b/test/snowflex/worker_test.exs
@@ -22,33 +22,29 @@ defmodule Snowflex.WorkerTest do
     end
 
     test "does not send a heartbeat if `keep_alive?` is false" do
-      start_supervised!({Snowflex.Worker, @connection_args})
+      start_supervised!({Snowflex.Worker, {@connection_args, false, 10}})
       Process.sleep(15)
 
       assert :meck.num_calls(:odbc, :sql_query, ["mock pid", 'SELECT 1']) == 0
     end
 
     test "sends heartbeat every interval if `keep_alive?` is true" do
-      connection_args = @connection_args ++ [keep_alive?: true, heartbeat_interval: 10]
-
       assert capture_log(fn ->
-               start_supervised!({Snowflex.Worker, connection_args})
+               start_supervised!({Snowflex.Worker, {@connection_args, true, 10}})
                Process.sleep(30)
              end) =~ "sending heartbeat"
 
       assert :meck.num_calls(:odbc, :sql_query, ["mock pid", 'SELECT 1']) > 1
     end
 
     test "postpones heartbeat if any other sql query is sent" do
-      connection_args = @connection_args ++ [keep_alive?: true, heartbeat_interval: 10]
-
       :meck.expect(:odbc, :sql_query, fn "mock pid", 'SELECT * FROM my_table' ->
         {:selected, ['name'], [{'dustin'}]}
       end)
 
       refute(
         capture_log(fn ->
-          worker = start_supervised!({Snowflex.Worker, connection_args})
+          worker = start_supervised!({Snowflex.Worker, {@connection_args, true, 10}})
           Process.sleep(7)
           Snowflex.Worker.sql_query(worker, "SELECT * FROM my_table")
           Process.sleep(7)
@@ -59,8 +55,6 @@ defmodule Snowflex.WorkerTest do
     end
 
     test "postpones heartbeat if any other params query is sent" do
-      connection_args = @connection_args ++ [keep_alive?: true, heartbeat_interval: 10]
-
       :meck.expect(:odbc, :param_query, fn "mock pid",
                                            'SELECT * FROM my_table WHERE name=?',
                                            [{{:sql_varchar, 250}, ['dustin']}] ->
@@ -69,7 +63,7 @@ defmodule Snowflex.WorkerTest do
 
       refute(
         capture_log(fn ->
-          worker = start_supervised!({Snowflex.Worker, connection_args})
+          worker = start_supervised!({Snowflex.Worker, {@connection_args, true, 10}})
           Process.sleep(7)
 
           Snowflex.Worker.param_query(worker, "SELECT * FROM my_table WHERE name=?", [