Merge pull request #964 from ably/error-log-stack-traces

Error log stack traces
ably · Jul 17, 2023 · a38b026 · a38b026
2 parents 28ffd6b + 25da9a9
commit a38b026
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 4 deletions.
diff --git a/lib/src/main/java/io/ably/lib/http/HttpCore.java b/lib/src/main/java/io/ably/lib/http/HttpCore.java
@@ -216,12 +216,14 @@ <T> T httpExecute(HttpURLConnection conn, String method, Param[] headers, Reques
             byte[] body = null;
             if(requestBody != null) {
                 body = prepareRequestBody(requestBody, conn);
+                // Check the logging level to avoid performance hit associated with building the message
                 if (Log.level <= Log.VERBOSE)
                     Log.v(TAG, System.lineSeparator() + new String(body));
             }
 
             /* log raw request details */
             Map<String, List<String>> requestProperties = conn.getRequestProperties();
+            // Check the logging level to avoid performance hit associated with building the message
             if (Log.level <= Log.VERBOSE) {
                 Log.v(TAG, "HTTP request: " + conn.getURL() + " " + method);
                 if (credentialsIncluded)
@@ -251,7 +253,6 @@ <T> T httpExecute(HttpURLConnection conn, String method, Param[] headers, Reques
                 rawHttpListener.onRawHttpResponse(id, method, response);
             }
         } catch(IOException ioe) {
-            ioe.printStackTrace();
             if(rawHttpListener != null) {
                 rawHttpListener.onRawHttpException(id, method, ioe);
             }
@@ -400,6 +401,7 @@ private Response readResponse(HttpURLConnection connection) throws IOException {
         for (Map.Entry<String, List<String>> entry : caseSensitiveHeaders.entrySet()) {
             if (entry.getKey() != null) {
                 response.headers.put(entry.getKey().toLowerCase(Locale.ROOT), entry.getValue());
+                // Check the logging level to avoid performance hit associated with building the message
                 if (Log.level <= Log.VERBOSE)
                     for (String val : entry.getValue())
                         Log.v(TAG, entry.getKey() + ": " + val);

diff --git a/lib/src/main/java/io/ably/lib/transport/ConnectionManager.java b/lib/src/main/java/io/ably/lib/transport/ConnectionManager.java
@@ -1136,6 +1136,7 @@ public void onMessage(ITransport transport, ProtocolMessage message) throws Ably
         if (transport != null && this.transport != transport) {
             return;
         }
+        // Check the logging level to avoid performance hit associated with building the message
         if (Log.level <= Log.VERBOSE) {
             Log.v(TAG, "onMessage() (transport = " + transport + "): " + message.action + ": " + new String(ProtocolSerializer.writeJSON(message)));
         }
@@ -1591,6 +1592,7 @@ protected boolean checkConnectivity() {
         try {
             return HttpHelpers.getUrlString(ably.httpCore, INTERNET_CHECK_URL).contains(INTERNET_CHECK_OK);
         } catch(AblyException e) {
+            Log.d(TAG, "Exception whilst checking connectivity", e);
             return false;
         }
     }

diff --git a/lib/src/main/java/io/ably/lib/transport/WebSocketTransport.java b/lib/src/main/java/io/ably/lib/transport/WebSocketTransport.java
@@ -110,12 +110,15 @@ public void send(ProtocolMessage msg) throws AblyException {
         try {
             if(channelBinaryMode) {
                 byte[] encodedMsg = ProtocolSerializer.writeMsgpack(msg);
+
+                // Check the logging level to avoid performance hit associated with building the message
                 if (Log.level <= Log.VERBOSE) {
                     ProtocolMessage decodedMsg = ProtocolSerializer.readMsgpack(encodedMsg);
                     Log.v(TAG, "send(): " + decodedMsg.action + ": " + new String(ProtocolSerializer.writeJSON(decodedMsg)));
                 }
                 wsConnection.send(encodedMsg);
             } else {
+                // Check the logging level to avoid performance hit associated with building the message
                 if (Log.level <= Log.VERBOSE)
                     Log.v(TAG, "send(): " + new String(ProtocolSerializer.writeJSON(msg)));
                 wsConnection.send(ProtocolSerializer.writeJSON(msg));

diff --git a/lib/src/main/java/io/ably/lib/types/Message.java b/lib/src/main/java/io/ably/lib/types/Message.java
@@ -274,7 +274,7 @@ public static Message[] fromEncodedArray(JsonArray messageArray, ChannelOptions
             }
             return messages;
         } catch(Exception e) {
-            e.printStackTrace();
+            Log.e(Message.class.getName(), e.getMessage(), e);
             throw MessageDecodeException.fromDescription(e.getMessage());
         }
     }
@@ -295,7 +295,7 @@ public static Message[] fromEncodedArray(String messagesArray, ChannelOptions ch
             JsonArray jsonArray = Serialisation.gson.fromJson(messagesArray, JsonArray.class);
             return fromEncodedArray(jsonArray, channelOptions);
         } catch(Exception e) {
-            e.printStackTrace();
+            Log.e(Message.class.getName(), e.getMessage(), e);
             throw MessageDecodeException.fromDescription(e.getMessage());
         }
     }
@@ -341,7 +341,7 @@ public Message deserialize(JsonElement json, Type typeOfT, JsonDeserializationCo
             try {
                 message.read((JsonObject)json);
             } catch (MessageDecodeException e) {
-                e.printStackTrace();
+                Log.e(Message.class.getName(), e.getMessage(), e);
                 throw new JsonParseException("Failed to deserialize Message from JSON.", e);
             }
             return message;