javaandroidsonarqubecode-analysissonar-runner

Either log or rethrow this exception

Possible duplicate of Sonar complaining about logging and rethrowing the exception.

This is my code in a class:

try
    {
        this.processDeepLinkData(data);
    }
    catch (final Exception e)
    {
        // Error while parsing data
        // Nothing we can do
        Logger.error(TAG, "Exception thrown on processDeepLinkData. Msg: " + e.getMessage());
    }

and my Logger class:

    import android.content.Context;
    import android.util.Log;
    import com.crashlytics.android.Crashlytics;

    public final class Logger
    {
        /**
         * Convenience method.
         *
         * @see Logger#log(String, String)
         */
        public static void error(final String tag, final String msg)
        {
            if (Logger.DEBUG)
            {
                Log.e(tag, "" + msg);
            }
            else
            {
                Logger.log(tag, "" + msg);
            }
        }

        private static void log(final String tag, final String msg)
        {
            Crashlytics.log(tag + ": " + msg);
        }
}

Sonar is pointing to catch (final Exception e) and says Either log or rethrow this exception. What do you think?

Solution

  • If you look at the description of rule RSPEC-1166, especially the title:

    Exception handlers should preserve the original exception

    In your case you are only taking care of the message of the exception, thus not preserving the original exception (including its stacktrace). Thus your resulting logs will hide the root cause of the failure.

    This rule detects that you are not using the caught exception as an entire object in the catch block.

    Suitable fixes

    This might not be suitable in your case: