deploy: 661cc23

Author: jwoertink

Cable.html

@@ -323,7 +323,7 @@ <h2>
   <dl>
 
       <dt class="entry-const" id="HABITAT_SETTINGS">
-        <strong>HABITAT_SETTINGS</strong> = <code>[{decl: route : <span class="t">String</span> <span class="o">=</span> <span class="t">Cable</span>.message(<span class="n">:default_mount_path</span>), example: <span class="s">&quot;/cable&quot;</span>, validation: <span class="n">nil</span>}, {decl: token : <span class="t">String</span> <span class="o">=</span> <span class="s">&quot;token&quot;</span>, example: <span class="s">&quot;token&quot;</span>, validation: <span class="n">nil</span>}, {decl: url : <span class="t">String</span> <span class="o">=</span> <span class="t">ENV</span>[<span class="s">&quot;CABLE_BACKEND_URL&quot;</span>], example: <span class="s">&quot;redis://localhost:6379&quot;</span>, validation: <span class="n">nil</span>}, {decl: disable_sec_websocket_protocol_header : <span class="t">Bool</span> <span class="o">=</span> <span class="n">false</span>, example: <span class="n">nil</span>, validation: <span class="n">nil</span>}, {decl: backend_class : <span class="t">Cable</span><span class="t">::</span><span class="t">BackendCore</span>.<span class="k">class</span> <span class="o">=</span> <span class="t">Cable</span><span class="t">::</span><span class="t">BackendRegistry</span>, example: <span class="s">&quot;Cable::RedisBackend&quot;</span>, validation: <span class="n">nil</span>}, {decl: backend_ping_interval : <span class="t">Time</span><span class="t">::</span><span class="t">Span</span> <span class="o">=</span> <span class="n">15</span>.seconds, example: <span class="n">nil</span>, validation: <span class="n">nil</span>}, {decl: restart_error_allowance : <span class="t">Int32</span> <span class="o">=</span> <span class="n">20</span>, example: <span class="n">nil</span>, validation: <span class="n">nil</span>}, {decl: on_error : <span class="t">Proc</span>(<span class="t">Exception</span>, <span class="t">String</span>, <span class="t">Nil</span>) <span class="o">=</span> <span class="o">-&gt;</span>(exception : <span class="t">Exception</span>, message : <span class="t">String</span>) <span class="k">do</span>
+        <strong>HABITAT_SETTINGS</strong> = <code>[{decl: route : <span class="t">String</span> <span class="o">=</span> <span class="t">Cable</span>.message(<span class="n">:default_mount_path</span>), example: <span class="s">&quot;/cable&quot;</span>, validation: <span class="n">nil</span>}, {decl: token : <span class="t">String</span> <span class="o">=</span> <span class="s">&quot;token&quot;</span>, example: <span class="s">&quot;token&quot;</span>, validation: <span class="n">nil</span>}, {decl: url : <span class="t">String</span> <span class="o">=</span> <span class="t">ENV</span>[<span class="s">&quot;CABLE_BACKEND_URL&quot;</span>], example: <span class="s">&quot;redis://localhost:6379&quot;</span>, validation: <span class="n">nil</span>}, {decl: disable_sec_websocket_protocol_header : <span class="t">Bool</span> <span class="o">=</span> <span class="n">false</span>, example: <span class="n">nil</span>, validation: <span class="n">nil</span>}, {decl: backend_class : <span class="t">Cable</span><span class="t">::</span><span class="t">BackendCore</span>.<span class="k">class</span> <span class="o">=</span> <span class="t">Cable</span><span class="t">::</span><span class="t">BackendRegistry</span>, example: <span class="s">&quot;Cable::RedisBackend&quot;</span>, validation: <span class="n">nil</span>}, {decl: backend_ping_interval : <span class="t">Time</span><span class="t">::</span><span class="t">Span</span> <span class="o">=</span> <span class="n">15</span>.seconds, example: <span class="n">nil</span>, validation: <span class="n">nil</span>}, {decl: restart_error_allowance : <span class="t">Int32</span> <span class="o">=</span> <span class="n">20</span>, example: <span class="n">nil</span>, validation: <span class="n">nil</span>}, {decl: on_error : <span class="t">Proc</span>(<span class="t">Exception</span>, <span class="t">String</span>, <span class="t">Cable</span><span class="t">::</span><span class="t">Connection</span> <span class="o">|</span> <span class="t">::</span><span class="t">Nil</span>, <span class="t">Nil</span>) <span class="o">=</span> <span class="o">-&gt;</span>(exception : <span class="t">Exception</span>, message : <span class="t">String</span>, connection : <span class="t">Cable</span><span class="t">::</span><span class="t">Connection</span> <span class="o">|</span> <span class="t">::</span><span class="t">Nil</span>) <span class="k">do</span>
   <span class="t">Cable</span><span class="t">::</span><span class="t">Logger</span>.error(exception: exception) <span class="k">do</span> message <span class="k">end</span>
 <span class="k">end</span>, example: <span class="n">nil</span>, validation: <span class="n">nil</span>}] <span class="k">of</span> <span class="t">Nil</span></code>
       </dt>

Cable/HabitatSettings.html

@@ -292,12 +292,12 @@ <h2>
       </li>
 
       <li class="entry-summary">
-        <a href="#on_error%3AProc%28Exception%2CString%2CNil%29-class-method" class="signature"><strong>.on_error</strong> : Proc(Exception, String, Nil)</a>
+        <a href="#on_error%3AProc%28Exception%2CString%2CCable%3A%3AConnection%7CNil%2CNil%29-class-method" class="signature"><strong>.on_error</strong> : Proc(Exception, String, Cable::Connection | Nil, Nil)</a>
 
       </li>
 
       <li class="entry-summary">
-        <a href="#on_error%3D%28value%3AProc%28Exception%2CString%2CNil%29%29-class-method" class="signature"><strong>.on_error=</strong>(value : Proc(Exception, String, Nil))</a>
+        <a href="#on_error%3D%28value%3AProc%28Exception%2CString%2CCable%3A%3AConnection%7CNil%2CNil%29%29-class-method" class="signature"><strong>.on_error=</strong>(value : Proc(Exception, String, Cable::Connection | Nil, Nil))</a>
 
       </li>
 
@@ -580,12 +580,12 @@ <h2>
       </div>
     </div>
 
-    <div class="entry-detail" id="on_error:Proc(Exception,String,Nil)-class-method">
+    <div class="entry-detail" id="on_error:Proc(Exception,String,Cable::Connection|Nil,Nil)-class-method">
       <div class="signature">
 
-        def self.<strong>on_error</strong> : Proc(Exception, String, Nil)
+        def self.<strong>on_error</strong> : Proc(Exception, String, <a href="../Cable/Connection.html">Cable::Connection</a> | Nil, Nil)
 
-        <a class="method-permalink" href="#on_error%3AProc%28Exception%2CString%2CNil%29-class-method">#</a>
+        <a class="method-permalink" href="#on_error%3AProc%28Exception%2CString%2CCable%3A%3AConnection%7CNil%2CNil%29-class-method">#</a>
       </div>
 
       <br/>
@@ -594,12 +594,12 @@ <h2>
       </div>
     </div>
 
-    <div class="entry-detail" id="on_error=(value:Proc(Exception,String,Nil))-class-method">
+    <div class="entry-detail" id="on_error=(value:Proc(Exception,String,Cable::Connection|Nil,Nil))-class-method">
       <div class="signature">
 
-        def self.<strong>on_error=</strong>(value : Proc(Exception, String, Nil))
+        def self.<strong>on_error=</strong>(value : Proc(Exception, String, <a href="../Cable/Connection.html">Cable::Connection</a> | Nil, Nil))
 
-        <a class="method-permalink" href="#on_error%3D%28value%3AProc%28Exception%2CString%2CNil%29%29-class-method">#</a>
+        <a class="method-permalink" href="#on_error%3D%28value%3AProc%28Exception%2CString%2CCable%3A%3AConnection%7CNil%2CNil%29%29-class-method">#</a>
       </div>
 
       <br/>

index.html

@@ -271,13 +271,14 @@ <h3><a id="configure-cable-settings" class="anchor" href="#configure-cable-setti
   settings.backend_class <span class="o">=</span> <span class="t">Cable</span><span class="t">::</span><span class="t">RedisBackend</span>
   settings.backend_ping_interval <span class="o">=</span> <span class="n">15</span>.seconds
   settings.restart_error_allowance <span class="o">=</span> <span class="n">20</span>
-  settings.on_error <span class="o">=</span> <span class="o">-&gt;</span>(error : <span class="t">Exception</span>, message : <span class="t">String</span>) <span class="k">do</span>
+  settings.on_error <span class="o">=</span> <span class="o">-&gt;</span>(error : <span class="t">Exception</span>, message : <span class="t">String</span>, connection : <span class="t">Cable</span><span class="t">::</span><span class="t">Connection</span>?) <span class="k">do</span>
     <span class="c"># or whichever error reportings you&#39;re using</span>
     <span class="t">Bugsnag</span>.report(error) <span class="k">do</span> <span class="o">|</span>event<span class="o">|</span>
       event.app.app_type <span class="o">=</span> <span class="s">&quot;lucky&quot;</span>
       event.meta_data <span class="o">=</span> {
         <span class="s">&quot;error_class&quot;</span> <span class="o">=&gt;</span> <span class="t">JSON</span><span class="t">::</span><span class="t">Any</span>.new(error.<span class="k">class</span>.name),
         <span class="s">&quot;message&quot;</span>     <span class="o">=&gt;</span> <span class="t">JSON</span><span class="t">::</span><span class="t">Any</span>.new(message),
+        <span class="s">&quot;token&quot;</span>       <span class="o">=&gt;</span> <span class="t">JSON</span><span class="t">::</span><span class="t">Any</span>.new(connection.try(<span class="o">&amp;</span>.token).to_s),
       }
     <span class="k">end</span>
   <span class="k">end</span>
@@ -444,7 +445,7 @@ <h2><a id="error-handling" class="anchor" href="#error-handling">
 <p>You can setup a hook to report errors to any 3rd party service you choose.</p>
 <pre><code class="language-crystal"><span class="c"># config/cable.cr</span>
 <span class="t">Cable</span>.configure <span class="k">do</span> <span class="o">|</span>settings<span class="o">|</span>
-  settings.on_error <span class="o">=</span> <span class="o">-&gt;</span>(exception : <span class="t">Exception</span>, message : <span class="t">String</span>) <span class="k">do</span>
+  settings.on_error <span class="o">=</span> <span class="o">-&gt;</span>(exception : <span class="t">Exception</span>, message : <span class="t">String</span>, connection : <span class="t">Cable</span><span class="t">::</span><span class="t">Connection</span>?) <span class="k">do</span>
     <span class="c"># new 3rd part service handler</span>
     <span class="t">ExceptionService</span>.notify(exception, message: message)
     <span class="c"># default logic</span>
@@ -453,12 +454,12 @@ <h2><a id="error-handling" class="anchor" href="#error-handling">
 <span class="k">end</span></code></pre>
 <p><strong>Default Handler</strong></p>
 <pre><code class="language-crystal"><span class="t">Habitat</span>.create <span class="k">do</span>
-  setting on_error : <span class="t">Proc</span>(<span class="t">Exception</span>, <span class="t">String</span>, <span class="t">Nil</span>) <span class="o">=</span> <span class="o">-&gt;</span>(exception : <span class="t">Exception</span>, message : <span class="t">String</span>) <span class="k">do</span>
+  setting on_error : <span class="t">Proc</span>(<span class="t">Exception</span>, <span class="t">String</span>, <span class="t">Cable</span><span class="t">::</span><span class="t">Connection</span>?, <span class="t">Nil</span>) <span class="o">=</span> <span class="o">-&gt;</span>(exception : <span class="t">Exception</span>, message : <span class="t">String</span>, connection : <span class="t">Cable</span><span class="t">::</span><span class="t">Connection</span>?) <span class="k">do</span>
     <span class="t">Cable</span><span class="t">::</span><span class="t">Logger</span>.error(exception: exception) { message }
   <span class="k">end</span>
 <span class="k">end</span></code></pre>
 <blockquote>
-<p><span class="flag purple">NOTE</span>  The message field will contain details regarding which class/method raised the error</p>
+<p><span class="flag purple">NOTE</span>  The message field will contain details regarding which class/method raised the error. The connection parameter provides access to the <code><a href="Cable/Connection.html">Cable::Connection</a></code> instance (when available), including the <code>token</code>, <code>connection_identifier</code>, and any fields defined via <code>identified_by</code> or <code>owned_by</code>.</p>
 </blockquote>
 <h2><a id="client-side" class="anchor" href="#client-side">
   <svg class="octicon-link" aria-hidden="true">