Bump version to 1.6.0 and update docs

CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## v1.6.0
+
+July 2022.
+
+* Adds sentinel support.
+
+* Obfuscates username and password in the state, to prevent them from appearing
+  verbatim in logs and stack traces. They can be provided as 0-ary functions
+  returning the actual secret when applied.
+
+* Fix a crash that happens when reconnect fails twice with two different
+  reasons. This bug was introduced in v1.5.0.
+
 ## v1.5.1
 
 May 2022.
@@ -13,7 +26,7 @@ May 2022.
   The option `reconnect_sleep` now applies to the time between a
   successful connect and the first reconnect attemt, if the connection is lost
   just after connecting. However, there is no delay before reconnecting
-  if the connection has been up for at least `reconnect_sleep' milliseconds.
+  if the connection has been up for at least `reconnect_sleep` milliseconds.
 
 ## v1.5.0
 

README.md

@@ -8,10 +8,10 @@ Non-blocking Redis client with focus on performance and robustness.
 
 This fork is the official continuation of `wooga/eredis`.
 It includes several improvements, such as
-TLS support and TCP error handling corrections. See [CHANGELOG.md](CHANGELOG.md)
-for details.
+TLS support, Sentinel support and TCP error handling corrections.
+See [CHANGELOG.md](CHANGELOG.md) for details.
 
-Note: This client connects to a standalone Redis node/sentinel cluster.
+Note: This client connects to a standalone Redis node, optionally using Sentinel.
 For *Redis Cluster*, you need
 [eredis_cluster](https://github.com/Nordix/eredis_cluster) or
 [ecredis](https://github.com/HalloAppInc/ecredis).
@@ -23,6 +23,7 @@ Supported Redis features:
  * Pipelining
  * Authentication & multiple DBs
  * Pubsub
+ * TLS
  * Sentinel support
 
 Generated API documentation: [doc/eredis.md](doc/eredis.md)

doc/eredis.md

@@ -41,7 +41,7 @@ host() = string() | {local, string()}
 
 
 <pre><code>
-option() = {host, string() | {local, string()}} | {port, <a href="inet.md#type-port_number">inet:port_number()</a>} | {database, integer()} | {password, string()} | {reconnect_sleep, <a href="#type-reconnect_sleep">reconnect_sleep()</a>} | {connect_timeout, integer()} | {socket_options, list()} | {tls, [<a href="ssl.md#type-tls_client_option">ssl:tls_client_option()</a>]} | {name, <a href="#type-registered_name">registered_name()</a>} | {sentinel, list()}
+option() = {host, string() | {local, string()}} | {port, <a href="inet.md#type-port_number">inet:port_number()</a>} | {database, integer()} | {username, iodata() | fun(() -&gt; iodata()) | undefined} | {password, iodata() | fun(() -&gt; iodata()) | undefined} | {reconnect_sleep, <a href="#type-reconnect_sleep">reconnect_sleep()</a>} | {connect_timeout, integer()} | {socket_options, list()} | {tls, [<a href="ssl.md#type-tls_client_option">ssl:tls_client_option()</a>]} | {name, <a href="#type-registered_name">registered_name()</a>} | {sentinel, list()}
 </code>
 </pre>
 
@@ -278,7 +278,10 @@ start_link(Options::<a href="#type-options">options()</a>) -&gt; {ok, pid()} | {
 
 
 
-<dd>String; default: no username
+<dd>A 0-ary function that returns the username
+  (the preferred way to provide username as it prevents the actual secret from
+  appearing in logs and stacktraces), a string or iodata or the
+  atom <code>undefined</code> for no username; default <code>undefined</code>
 </dd>
 
 
@@ -287,7 +290,10 @@ start_link(Options::<a href="#type-options">options()</a>) -&gt; {ok, pid()} | {
 
 
 
-<dd>String; default: no password
+<dd>A 0-ary function that returns the password
+  (the preferred way to provide password as it prevents the actual secret from
+  appearing in logs and stacktraces), a string or iodata or the
+  atom <code>undefined</code> for no username; default <code>undefined</code>
 </dd>
 
 

doc/eredis_sub.md

@@ -29,7 +29,7 @@ channel() = binary()
 
 
 <pre><code>
-option() = {host, string() | {local, string()}} | {port, <a href="inet.md#type-port_number">inet:port_number()</a>} | {database, integer()} | {password, string()} | {reconnect_sleep, <a href="#type-reconnect_sleep">reconnect_sleep()</a>} | {connect_timeout, integer()} | {socket_options, list()} | {tls, [<a href="ssl.md#type-tls_client_option">ssl:tls_client_option()</a>]} | {name, <a href="#type-registered_name">registered_name()</a>} | {sentinel, list()}
+option() = {host, string() | {local, string()}} | {port, <a href="inet.md#type-port_number">inet:port_number()</a>} | {database, integer()} | {username, iodata() | fun(() -&gt; iodata()) | undefined} | {password, iodata() | fun(() -&gt; iodata()) | undefined} | {reconnect_sleep, <a href="#type-reconnect_sleep">reconnect_sleep()</a>} | {connect_timeout, integer()} | {socket_options, list()} | {tls, [<a href="ssl.md#type-tls_client_option">ssl:tls_client_option()</a>]} | {name, <a href="#type-registered_name">registered_name()</a>} | {sentinel, list()}
 </code>
 </pre>
 
@@ -259,7 +259,9 @@ start_link(Options::<a href="#type-sub_options">sub_options()</a>) -&gt; {ok, Pi
 
 
 
-<dd>String; default: no username
+<dd>A 0-ary function that returns the username
+  (the preferred way to provide username as it prevents the actual secret from
+  appearing in logs and stacktraces), a string or iodata or the atom<code>undefined</code> for no username; default <code>undefined</code>
 </dd>
 
 
@@ -268,7 +270,9 @@ start_link(Options::<a href="#type-sub_options">sub_options()</a>) -&gt; {ok, Pi
 
 
 
-<dd>String; default: no password
+<dd>A 0-ary function that returns the password
+  (the preferred way to provide password as it prevents the actual secret from
+  appearing in logs and stacktraces), a string or iodata or the atom<code>undefined</code> for no username; default <code>undefined</code>
 </dd>
 
 

mix.exs

@@ -2,7 +2,7 @@ defmodule Eredis.Mixfile do
   use Mix.Project
 
   @source_url "https://github.com/Nordix/eredis/"
-  @version "1.5.1"
+  @version "1.6.0"
 
   def project do
     [

src/eredis.app.src

@@ -1,8 +1,8 @@
 {application,eredis,
              [{description,"Erlang Redis Client"},
-              {vsn,"1.5.1"},
+              {vsn,"1.6.0"},
               {modules,[eredis,eredis_client,eredis_parser,eredis_sub,
-                        eredis_sub_client]},
+                        eredis_sub_client, eredis_sentinel]},
               {registered,[]},
               {applications,[kernel,stdlib]},
               {maintainers,["Bjorn Svensson", "Viktor Soderqvist"]},

src/eredis.erl

@@ -50,12 +50,12 @@ start_link() ->
 %% <dt>`{database, Database}'</dt><dd>Integer; 0 for the default database</dd>
 %% <dt>`{username, Username}'</dt><dd>A 0-ary function that returns the username
 %% (the preferred way to provide username as it prevents the actual secret from
-%% appearing in logs and stacktraces), a string or iodata or the atom
-%% `undefined' for no username; default `undefined'</dd>
+%% appearing in logs and stacktraces), a string or iodata or the
+%% atom `undefined' for no username; default `undefined'</dd>
 %% <dt>`{password, Password}'</dt><dd>A 0-ary function that returns the password
 %% (the preferred way to provide password as it prevents the actual secret from
-%% appearing in logs and stacktraces), a string or iodata or the atom
-%% `undefined' for no username; default `undefined'</dd>
+%% appearing in logs and stacktraces), a string or iodata or the
+%% atom `undefined' for no username; default `undefined'</dd>
 %% <dt>`{reconnect_sleep, ReconnectSleep}'</dt><dd>Integer of milliseconds to
 %% sleep between reconnect attempts; default: 100</dd>
 %% <dt>`{connect_timeout, Timeout}'</dt><dd>Timeout value in milliseconds to use