Uploaded image for project: 'Rules Repository'
  1. Rules Repository
  2. RSPEC-2737

"catch" clauses should do more than rethrow

    XMLWordPrintable

    Details

    • Message:
      Add logic to this catch clause or eliminate it and rethrow the exception automatically.
    • Default Severity:
      Minor
    • Impact:
      Low
    • Likelihood:
      Low
    • Default Quality Profiles:
      Sonar way
    • Targeted languages:
      ABAP, Flex
    • Covered Languages:
      C#, C, C++, Java, JavaScript, Objective-C, PHP, PL/SQL, Python, Swift, T-SQL, TypeScript, VB.Net
    • Irrelevant for Languages:
      Cobol, Go, HTML, PL/I, RPG, VB6, XML
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      5min
    • Analysis Level:
      Syntactic Analysis
    • Analysis Scope:
      Main Sources
    • Common Rule:
      Yes
    • ReSharper:
      RedundantCatchClause
    • TSLint-SonarTS:
      no-useless-catch
    • Quick-fixes:
      Hide

      Remove redundant catch: removes the redundant catch, or if it was the only catch and there is no finally block then the whole try statement is replaced by the statements in the try block.

      Show
      Remove redundant catch: removes the redundant catch, or if it was the only catch and there is no finally block then the whole try statement is replaced by the statements in the try block.

      Description

      A catch clause that only rethrows the caught exception has the same effect as omitting the catch altogether and letting it bubble up automatically, but with more code and the additional detriment of leaving maintainers scratching their heads.

      Such clauses should either be eliminated or populated with the appropriate logic.

      Noncompliant Code Example

      string s = "";
try
{
  s = File.ReadAllText(fileName);
}
catch (Exception e)  // Noncompliant
{ 
  throw;
}

      Compliant Solution

      string s = "";
try 
{
  s = File.ReadAllText(fileName);
}
catch (Exception e) // Compliant
{  
  logger.LogError(e);
  throw;
}

      or

      string s = File.ReadAllText(fileName);

        Attachments

          Issue Links

          is duplicated by

          Code Smell Detection - RSPEC-1164 Exceptions should not be caught and immediately rethrown

          • Closed
          is implemented by

          New Feature - A new feature of the product, which has yet to be developed. SONARABAP-359 Rule: "catch" clauses should do more than rethrow

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. SONARFLEX-129 Rule: "catch" clauses should do more than rethrow

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. SONARSLANG-65 Rule S2737: "catch" clauses should do more than rethrow

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. CPP-1545 Rule: "catch" clauses should do more than rethrow

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARPHP-748 Rule S2737: "catch" clauses should do more than rethrow

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARPLSQL-683 Rule S2737: "EXCEPTION WHEN ... THEN" clauses should do more than "RAISE"

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARPY-275 Rule S2737: "catch" clauses should do more than rethrow

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARSWIFT-358 Rule: "catch" clauses should do more than rethrow

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARTSQL-114 Rule: "CATCH" clauses should do more than rethrow

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARVBSIX-265 Rule: "catch" clauses should do more than rethrow

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARJAVA-1472 Rule 2737: "catch" clauses should do more than rethrow

          • Major - Major loss of function.
          • Closed
          links to

          Web Link Is implemented by SonarJS/issues/951

          Web Link Is implemented by SonarTS/issues/542

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              ann.campbell.2 Ann Campbell
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated: