gnodet-bot commented on code in PR #13249: URL: https://github.com/apache/maven/pull/13249#discussion_r4084627803
########## api/maven-api-spi/src/main/java/org/apache/maven/api/spi/LifecycleProcessor.java: ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.api.spi; + +import org.apache.maven.api.Lifecycle; +import org.apache.maven.api.annotations.Consumer; +import org.apache.maven.api.annotations.Experimental; +import org.apache.maven.api.annotations.Nonnull; +import org.apache.maven.api.di.Named; + +/** + * SPI for transforming Maven lifecycles at session initialisation time. + * + * <p>A {@code LifecycleProcessor} receives each built-in (or extension-contributed) lifecycle + * and may return a modified version of it — for example to inject additional phases into the + * lifecycle DAG. Multiple processors are applied in order; each one receives the output of the + * previous one. + * + * <p>Processors are called each time the lifecycle phase map is rebuilt (potentially multiple + * times per build). Implementations must be stateless and idempotent — the same lifecycle + * input must always produce the same output. They receive the output of the previous processor + * in the chain. + * + * <p>Example — injecting a {@code docker-push} phase after {@code deploy}: + * <pre>{@code + * @Named + * public class DockerLifecycleProcessor implements LifecycleProcessor { + * public Lifecycle process(Lifecycle lifecycle) { + * if (!Lifecycle.DEFAULT.equals(lifecycle.id())) return lifecycle; + * // Use PhaseEnrichedLifecycle (from impl/maven-core) to inject custom phases + * return new PhaseEnrichedLifecycle(lifecycle, + * List.of(new PhaseEnrichedLifecycle.InjectedPhase("docker-push", null, "deploy", null))); Review Comment: ⚠️ **SPI Javadoc example leaks an internal implementation class** `PhaseEnrichedLifecycle` lives in `org.apache.maven.internal.impl` (module `impl/maven-core`). The SPI interface (`api/maven-api-spi`) does not depend on `impl/maven-core` — the comment itself acknowledges this with `"// Use PhaseEnrichedLifecycle (from impl/maven-core)"`. External SPI implementors would need to add a compile dependency on `maven-core` to write the example shown here, which violates the `internal.*` contract. Options: 1. **Remove the code example** and document the concept in prose, linking to `ReactorXmlLifecycleProcessor` as a reference implementation: `"See {@code ReactorXmlLifecycleProcessor} in impl/maven-core for a concrete example."` 2. **Promote `PhaseEnrichedLifecycle` to the SPI layer** — move it to `api/maven-api-spi` or `api/maven-api-core` as an `@Experimental` type if you want it to be part of the public surface. 3. **Add a factory method to the interface** or a companion utility class in `api/maven-api-spi` that wraps `PhaseEnrichedLifecycle` internally (keeping the impl detail hidden). ```suggestion * <p>Example — injecting a {@code docker-push} phase after {@code deploy}: * <pre> * {@literal @}Named * public class DockerLifecycleProcessor implements LifecycleProcessor { * public Lifecycle process(Lifecycle lifecycle) { * if (!Lifecycle.DEFAULT.equals(lifecycle.id())) return lifecycle; * // Wrap the lifecycle using a concrete implementation from impl/maven-core, * // e.g. PhaseEnrichedLifecycle — see ReactorXmlLifecycleProcessor for a * // full working example. * return lifecycle; // replace with your enriched lifecycle * } * } * </pre> ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
