Azure / azure-c-shared-utility

Azure C SDKs common code
Other
111 stars 203 forks source link

Misleading error message in adapters\tlsio_openssl.c : on_underlying_io_open_complete #611

Closed Cavaler closed 1 year ago

Cavaler commented 1 year ago

Currently the only error message reads:

LogError("Invalid tlsio_state. Expected state is TLSIO_STATE_OPENING_UNDERLYING_IO.");

But actually it is inside check for this very state! This error should read something like:

LogError("Invalid open_result. Expected result is IO_OPEN_OK.");

And original message should be moved in 'else' clause in outermost if.

Cavaler commented 1 year ago
adapters/tlsio_openssl.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/adapters/tlsio_openssl.c b/adapters/tlsio_openssl.c
index 1832994c..0350fc99 100644
--- a/adapters/tlsio_openssl.c
+++ b/adapters/tlsio_openssl.c
@@ -846,9 +846,13 @@ static void on_underlying_io_open_complete(void* context, IO_OPEN_RESULT open_re
         {
             tls_io_instance->tlsio_state = TLSIO_STATE_NOT_OPEN;
             indicate_open_complete(tls_io_instance, IO_OPEN_ERROR);
-            LogError("Invalid tlsio_state. Expected state is TLSIO_STATE_OPENING_UNDERLYING_IO.");
+            LogError("Invalid open_result. Expected result is IO_OPEN_OK.");
         }
     }
+    else
+    {
+        LogError("Invalid tlsio_state. Expected state is TLSIO_STATE_OPENING_UNDERLYING_IO.");
+    }
 }

 static void on_underlying_io_error(void* context)
ericwolz commented 1 year ago

612

ericwolz commented 1 year ago

Thanks, PR submitted.