Merge pull request #17 from dsienkiewicz/9-redact-sensitive-data-on-s…

…ockets #9 Redact state of MainSocket from sensitive info
dsienkiewicz · Dec 5, 2023 · f5e4754 · f5e4754
2 parents 4f19351 + add0009
commit f5e4754
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -30,8 +30,8 @@ params = [
     app_name: "XtbClient",
     type: :demo,
     url: "wss://ws.xtb.com",
-    user: "<<USER_ID>>",
-    password: "<<PASSWORD>>"}
+    user: username,
+    password: password}
   ]
 
 {:ok, pid} = XtbClient.Connection.start_link(params)
@@ -46,8 +46,8 @@ params = [
     app_name: "XtbClient",
     type: :demo,
     url: "wss://ws.xtb.com",
-    user: "<<USER_ID>>",
-    password: "<<PASSWORD>>"}
+    user: username,
+    password: password}
   ]
 {:ok, cpid} = XtbClient.Connection.start_link(params)
 
@@ -100,8 +100,8 @@ params = [
     app_name: "XtbClient",
     type: :demo,
     url: "wss://ws.xtb.com",
-    user: "<<USER_ID>>",
-    password: "<<PASSWORD>>"}
+    user: username,
+    password: password}
   ]
 {:ok, cpid} = XtbClient.Connection.start_link(params)
 

diff --git a/lib/xtb_client/main_socket.ex b/lib/xtb_client/main_socket.ex
@@ -58,6 +58,24 @@ defmodule XtbClient.MainSocket do
               stream_session_id: nil,
               queries: %{},
               rate_limit: nil
+
+    defimpl Inspect do
+      def inspect(state, opts) do
+        Inspect.Map.inspect(
+          %{
+            url: state.url,
+            account_type: state.account_type,
+            user: "<<REDACTED>>",
+            password: "<<REDACTED>>",
+            app_name: state.app_name,
+            stream_session_id: state.stream_session_id,
+            queries: state.queries,
+            rate_limit: state.rate_limit
+          },
+          opts
+        )
+      end
+    end
   end
 
   @doc """