Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MNG-8541] Support throwing Exception from Mojo#execute #2066

Merged
merged 2 commits into from
Jan 29, 2025

Conversation

laeubi
Copy link
Contributor

@laeubi laeubi commented Jan 28, 2025

JIRA issue: MNG-8541

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MNG-XXX] SUMMARY,
    where you replace MNG-XXX and SUMMARY with the appropriate JIRA issue.
  • Also format the first line of the commit message like [MNG-XXX] SUMMARY.
    Best practice is to use the JIRA issue title in both the pull request title and in the first line of the commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the Core IT successfully.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@@ -35,11 +35,12 @@
@ThreadSafe
public interface Mojo {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a small incoherence between the javadoc on the class which talks about MojoException, which is not the only exception thrown anymore.
Going through AI, It came up with:

/**
 * Represents the contract for Mojos to interact with the Maven infrastructure.
 * Implementations of this interface define specific build-process behaviors
 * that are triggered during a Maven build lifecycle.
 *
 * The primary entry point is the {@link #execute()} method, which encapsulates
 * the behavior of the Mojo and serves as the integration point with Maven.
 * This method may throw an {@link Exception} to signal any issues that prevent
 * successful execution of the Mojo.
 *
 * <p>Annotations:</p>
 * <ul>
 *   <li>{@link Experimental}: Indicates that this interface or its implementation
 *       may still be evolving and could change in future versions.</li>
 *   <li>{@link FunctionalInterface}: Denotes that this is a functional interface,
 *       allowing implementations as lambda expressions or method references.</li>
 *   <li>{@link Consumer}: Signifies that this type is intended to be implemented
 *       or extended by Maven plugins or extensions and consumed by Maven itself.</li>
 *   <li>{@link ThreadSafe}: Implies that implementations of this interface must
 *       be safe to invoke from multiple threads concurrently.</li>
 * </ul>
 *
 * @since 4.0.0
 */
@Experimental
@FunctionalInterface
@Consumer
@ThreadSafe
public interface Mojo {
    /**
     * Executes the behavior defined by this {@code Mojo}. This method is invoked
     * during the Maven build lifecycle to perform the Mojo's designated task.
     *
     * <p>Implementations should handle any task-specific logic and may communicate
     * errors by throwing an {@link Exception}. Error conditions should provide
     * sufficient detail to aid troubleshooting.</p>
     *
     * @throws Exception if any issue occurs that prevents the successful execution
     *                   of the Mojo
     */
    void execute() throws Exception;
}

which looks better to me. Wdyt ?

@@ -228,8 +232,14 @@ private static class MojoWrapper implements Mojo {
}

@Override
public void execute() {
mojoV4.execute();
public void execute() throws org.apache.maven.plugin.MojoExecutionException {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why FQCN?

*
* @throws MojoException if a problem occurs
* @throws Exception if any problem occurs that prevents the mojo from its
* execution
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this sentence is correct English. Either grab the one I pasted below, or rephrase it if a problem occurs that prevents the mojo from executing ... ?

@gnodet gnodet changed the title MNG-8541 - Support throwing Exception from Mojo#execute [MNG-8541] Support throwing Exception from Mojo#execute Jan 28, 2025
@gnodet gnodet added this to the 4.0.0-rc-3 milestone Jan 29, 2025
@gnodet gnodet merged commit 74c950b into apache:master Jan 29, 2025
13 checks passed
@laeubi
Copy link
Contributor Author

laeubi commented Jan 29, 2025

@gnodet thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants