[
https://issues.apache.org/jira/browse/GROOVY-12763?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18144708#comment-18144708
]
ASF GitHub Bot commented on GROOVY-12763:
-----------------------------------------
daniellansun commented on code in PR #3298:
URL: https://github.com/apache/groovy/pull/3298#discussion_r4571272458
##########
src/main/java/groovy/concurrent/AsyncScope.java:
##########
@@ -46,6 +46,15 @@
* task completes exceptionally, all sibling tasks are cancelled
* immediately. The first failure becomes the primary exception;
* subsequent failures are added as suppressed exceptions.
+ * <p>
+ * A failure is rethrown as the exception the task threw, including a
+ * checked exception, as {@code await} does.
+ *
+ * @apiNote {@link #close()} and {@code withScope} declare no checked
+ * exceptions but can still throw one. Java callers that need to handle a
+ * checked failure should catch {@code Exception} and test its type, as
+ * the Java compiler rejects a {@code catch} of a checked exception the
+ * try block does not declare.
Review Comment:
Nice addition—documenting the sneaky-throw behavior explicitly via
`@apiNote` on `AsyncScope` and `close()` is very helpful for pure Java callers
of `groovy-concurrent-java`, where `javac` rejects catching undeclared checked
exceptions per JLS §11.2.3.
Two small optional doc refinements if helpful:
1. **Cross-referencing on `withScope` overloads:** Adding a short `@apiNote`
pointer on the `withScope` methods back to the class-level note would let IDE
hover tooltips on `AsyncScope.withScope(...)` surface this caveat directly to
Java callers.
2. **Contrasting `withScope` with Java `try-with-resources`:** When a scope
body and a child task fail with (or `await`) the same exception instance,
`withScope` safely guards `if (closeError != bodyError)` at line 186, whereas
Java's `try (var scope = AsyncScope.create())` emits an unconditional
`primary.addSuppressed(closeError)` (`JDK-8317229`) and would throw
`IllegalArgumentException: Self-suppression not permitted` now that `close()`
rethrows the raw failure unwrapped.
> Async scopes, defer and generators wrap checked exceptions instead of
> rethrowing them as await does
> ---------------------------------------------------------------------------------------------------
>
> Key: GROOVY-12763
> URL: https://issues.apache.org/jira/browse/GROOVY-12763
> Project: Groovy
> Issue Type: Bug
> Reporter: Paul King
> Priority: Major
>
> {{await}} rethrows a checked exception from an async task unchanged, but five
> other async paths wrap it, so the caller sees a different exception from the
> one the code threw. Unchecked exceptions and {{Error}}s pass through
> unwrapped on every path.
> {code:groovy}
> import groovy.concurrent.*
> // rethrown as is: java.lang.Exception
> await async { throw new Exception('boom') }
> // java.lang.RuntimeException, cause java.lang.Exception
> AsyncScope.withScope { s -> s.async { throw new Exception('boom') }; null }
> // java.lang.reflect.UndeclaredThrowableException, cause java.lang.Exception
> AsyncScope.withScope { s -> throw new Exception('boom') }
> // java.lang.RuntimeException, cause java.lang.Exception
> await async { defer { throw new Exception('boom') }; 1 }
> // java.lang.reflect.UndeclaredThrowableException, cause java.lang.Exception
> def g = async { yield return 1; throw new Exception('boom') }
> for (x in g) {}
> {code}
> The five paths, as of 6.0.0:
> * *Scope child failure*: {{DefaultAsyncScope.close()}} wraps a checked
> failure in {{RuntimeException}}. Its javadoc says "the first failure is
> rethrown".
> * *{{withScope}} body*: the Closure is coerced to {{Function}}, which wraps a
> checked exception in {{UndeclaredThrowableException}}. The same applies to
> {{withScope}} with a timeout.
> * *{{defer}} action*: {{AsyncSupport.executeDeferScope}} wraps it in
> {{RuntimeException}}.
> * *Generator body*: the Closure-to-{{Consumer}} coercion wraps it in
> {{UndeclaredThrowableException}} ({{GeneratorBridge}}).
> * *{{Flow.Publisher}} consumed with {{for await}}*: an {{onError}} carrying a
> checked exception is rethrown as {{RuntimeException}}
> ({{FlowPublisherAdapter}}).
> Expected: the original exception in all five cases, as with {{await}}.
> GROOVY-9381 lists exception transparency as a design principle ("callers see
> the same exceptions they would in synchronous code"), and GROOVY-12459 made a
> failing {{for await}} producer surface its checked exception rather than a
> wrapper. Kotlin's {{coroutineScope}} and C#'s {{await}} also rethrow the
> original exception.
> Proposed fix:
> * Rethrow the original exception at the three {{RuntimeException}} wrap sites.
> * In {{withScope}} and the generator, remove an
> {{UndeclaredThrowableException}} only when its cause is a checked exception,
> which is the layer the closure coercion adds. An
> {{UndeclaredThrowableException}} around an unchecked exception, or another
> wrapper the code itself threw, is kept.
> * Suppressed exceptions from scope close are kept.
> * Add an {{@apiNote}} to {{AsyncScope}} and {{close()}}: both declare no
> checked exceptions but can now throw one, so Java callers catch {{Exception}}
> and test its type.
> A wrapper that a child task or {{defer}} action throws itself, such as
> {{ExecutionException}}, is removed as {{await}} removes it. On 6.0.0 the
> extra {{RuntimeException}} happened to hide that. Whether {{await}} should
> remove only the layers the runtime added is left for a separate discussion.
> Compatibility: code that catches {{RuntimeException}} or
> {{UndeclaredThrowableException}} around these calls and then reads
> {{getCause()}} will now receive the checked exception directly.
> {{AsyncAwaitTest.testScopeCloseWithCheckedExceptionWrapped}} asserted the old
> wrapping and changes with the fix. This needs a release note.
> Known limitation: a checked exception that the code itself wrapped in an
> {{UndeclaredThrowableException}} and threw from a {{withScope}} or generator
> body is also unwrapped, because it can't be told apart from the coercion
> layer. Removing that limitation needs new entry points that avoid closure
> coercion (a generator body type declaring {{throws Throwable}}, and a
> {{Closure}} overload of {{withScope}}); that is left for a later release.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)