Cancellation exception handled incorrectly

Reports ProcessCanceledException and CancellationException handled incorrectly.

ProcessCanceledException and its inheritors must not be caught, swallowed, logged, or handled in any way. Instead, it must be rethrown so that the IntelliJ Platform infrastructure can handle it correctly.

CancellationException must not be caught, swallowed, logged, or handled in any way in coroutine context. Instead, it must be rethrown so that the coroutines infrastructure can handle it correctly.

Inspection reports both explicit ProcessCanceledException (including inheritors) and CancellationExceptioncatching, as well as catching RuntimeException, Exception and Throwable covering cancellation exceptions.

// bad:
try {
  // ...
} catch (ProcessCanceledException e) { // exception should not be swallowed
}

// bad:
try {
  // ...
} catch (ProcessCanceledException e) {
  LOG.error("Error occurred", e); // exception should not be logged
  throw e;
}


// good:
try {
  // ...
} catch (ProcessCanceledException e) {
  // additional actions
  throw e;
}

// bad:
cs.launch {
  try {
    // ...
  } catch (e: CancellationException) { // exception should not be swallowed
  }
}

// bad:
suspend fun suspendingFunction() {
  try {
    // ...
  } catch (ProcessCanceledException e) {
    LOG.error("Error occurred", e); // exception should not be logged
    throw e;
  }
}


// good:
cs.launch {
  try {
    // ...
  } catch (ProcessCanceledException e) {
    // additional actions
    throw e;
  }
}

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

IncorrectCancellationExceptionHandling

Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Plugin DevKit | Code

New in 2023.2

Inspection Details
By default bundled with:	IntelliJ IDEA 2024.3, Qodana for JVM 2024.3,
Can be installed with plugin:	Plugin DevKit, 243.23126

Last modified: 03 December 2024