Support for project output artifacts #4495

sdedic · 2022-08-10T19:43:12Z

This PR actually consists of a series of features. I should probably make separate requests for that, but ... that would prolong the review process, I believe.

The overall goal was to add a project query to get the project's output in form of an identifiable artifact(s) and their supposed (not built yet) or existing locations - and expose the analysis result through LSP.

Overview:

ProjectActionContext

This one I wanted for a long time already. Many project APIs or services are likely to be affected by project configurations - and it's rather hard to invoke the services for a specific configuration, which is not the active one. By default UI works against the active configuration, which is fine, but API access should have an option to specify it.
Adding configurations to all APIs is hard, and sometimes it is even impossible when the execution goes through some uncooperative layers.; the ProjectActionContext is a way how to pass the information 'out of band'.

I needed to pass specifically project action to distinguish different types of build; for example Micronaut plugins (gradle, maven) support a regular build, and a native-image build, that produces different output(s).

Important note for reviewers: while the ProjectActionContext allows to specify a profile or user properties, which can be ignored by the underlying project system, and give almost complete control over project model evaluation to the caller (at least for gradle and maven), I am not 100% sure if the properties + profiles is a good idea. A conservative approach would be to insist on creating a ProjectConfiguration for the profile+properties setup and use that.

Reviewers, share your opinion on this; these ProjectActionContext properties could be eventually added (compatibly) later.

ProjectArtifactsQuery

this is a project query as usual, asking for project output with GAV coordinates (if applicable). I am almost sure the ArtifactSpec will satisfy PHP, too ... but I still keep it private until Gradle implementation is complete.

The Filter specification does not cover all query cases, but works for the basic ones. When one wants "any output" and a specific output type / classifier.

Micronaut support for native image build

Added a project action and project action mapping for Maven to execute native-image build of the micronaut app. The action becomes available (and is configurable in project customizer) when one adds Micronaut plugin to the maven project build configuration.

Maven fixes

During implementation I've realized that the native-build action, contributed to the Maven by MavenActionsProvider is not visible in the customizer. I was little shocked when I realized that the customizer essentially hardcodes the list of (standard) actions and only displays user-defined ones in addition to the hardcoded list. I've corrected the behaviour of M2Configuration in that it lists just config-specific mappings, the others are retrieved through ActionToGoalUtils.
I've also realized that the declarative actions lack proper support for I18N; so I've added a convenience lookup in Bundle.proeprties using the action's (profile's) id, and in additiona specifying displayName that starts with '#' also makes a lookup, with the possbility to identify the Bundle path as well.

sdedic · 2022-08-11T06:23:13Z

added @lkishalmi since I'm going to make equivalent changes for Gradle in a separate PR. Please comment on the APIs.

dbalek

Proposed API looks sane to me.

lkishalmi

Well, not finished with the review, just made some comments.

lkishalmi · 2022-08-11T18:27:12Z

ide/projectapi/src/org/netbeans/api/project/ProjectActionContext.java

+     * contexts, individually for each project, to be active.
+     * @return the target project.
+     */
+    public @NonNull Project getProject() {


There are many possible null returns in this class. That should be avoided unless it brings a meaning.

this particular one does not ;)) the others were addressed in a1c2f1b

lkishalmi · 2022-08-11T18:28:52Z

ide/projectapi/src/org/netbeans/api/project/ProjectActionContext.java

+     * @return Lookup with additional information or {@code null}.
+     */
+    public @CheckForNull Lookup getLookup() {
+        return lookup;


Can return Lookup.EMPTY

Hm, with all those nulls (including this one), I intended to signal explicitly "no value". For example, if no Lookup + properties + profiles are present the implementation can take a great shortcut (= no customization to the project model or services).

Well if those shortcuts are important, then probably I'd intorduce a "boolean isShortcutAllowed()" method here to do the necessary checks inside here. Of course I assume that you can do shortcuts if no lookup + properties + profiles are present.

The little trouble is that it is the project implementation that decides which part may potentially affect the project data evaluation ... all stuff except the Lookup can be checked for 'no ops' (empty), the Lookup is ... well, peculiar. Eventually I could document that the exact value Lookup.EMPTY may be used for optimizations.

Addressed in a1c2f1b

lkishalmi · 2022-08-11T18:29:30Z

ide/projectapi/src/org/netbeans/api/project/ProjectActionContext.java

+     * @return user properties, or {@code null} if unspecified.
+     */
+    public @CheckForNull Map<String, String> getProperties() {
+        return properties == null ? null : Collections.unmodifiableMap(properties);


Collections.emtyMap()

Addressed in a1c2f1b

lkishalmi · 2022-08-11T18:29:54Z

ide/projectapi/src/org/netbeans/api/project/ProjectActionContext.java

+     * @return applied profiles or {@code null} if unspecified.
+     */
+    public @CheckForNull Set<String> getProfiles() {
+        return profiles == null ? null : Collections.unmodifiableSet(profiles);


Collections.emptySet()

Addressed in a1c2f1b

jtulach

Personally, I don't find adding new implementation and friend dependencies attractive.

jtulach · 2022-08-15T09:27:58Z

enterprise/micronaut/nbproject/project.xml

+                    </run-dependency>
+                </dependency>
+                <dependency>
+                    <code-name-base>org.netbeans.modules.maven.embedder</code-name-base>


These modules don't provide real API. Depending on them from foreign "micronaut" module is strange. Also adding a dependency on Maven support, when "micronaut" supports both, Maven and Gradle is strange.

re. depending from Micronaut no Gradle | Maven - agreed, a solution would be to create eager micronaut-maven + micronaut-gradle modules.

re. no real API - hm, I need to use the maven model types, i.e. org.apache.maven.model.PluginExecution. These are currently exposed to the module system by maven.emebdder. Is there a better way how to import those types ?

Well. I gave a few thoughts to some abstraction, but ... even if I make some declarative support in the layer, the Micronaut will not be entirely indepenent: it would need to provide dual declarations anyway, since maven + gradle identifiers for the native-image plugin differ; so maybe there would not be a formal dependency, but actual yes.

I thought about supporting some 'declarative' query, such as "give me a variable Foo", that would be registered in project type's XML area and translated to plugin-execution-goal-configuration (maven) or extension-property for gradle. But I'd fear that this query need not to satisfy further usecases from different future project-neutral queries: not all data are just variables to be picked up.

I'd better wait with such support after more users appear, but this could be the an abstract way to query project's setup.

jtulach · 2022-08-15T09:29:38Z

enterprise/micronaut/src/org/netbeans/modules/micronaut/maven/BuildActions.java

+            }
+            ActionProvider ap = project.getLookup().lookup(ActionProvider.class);
+            return 
+                    nbmp.getMavenProject().getPlugin("io.micronaut.build:micronaut-maven-plugin") != null &&


I was hoping this (presence of some plugin) could be specified declaratively. Isn't there already a support for a plugin to trigger some configuration and configurations adding some actions?

Hmmm, good catch, will try to use plain isActionEnabled.

Addressed in 2917d2b The project action ID is enabled based on plugin's presence, so the UI action will enable/disable itself accordingly.

jtulach · 2022-08-15T09:35:46Z

...pendency/src/org/netbeans/modules/project/dependency/spi/ProjectArtifactsImplementation.java

+     * @param all
+     * @return 
+     */
+    public Result findArtifacts(ProjectArtifactsQuery.Filter query);


I prefer singletonizer SPI over ProjectArtifactsImplementation and Result inner class.

addressed in 70dcb7f

jtulach · 2022-08-15T09:36:33Z

...dency/src/org/netbeans/modules/project/dependency/spi/ProjectDependenciesImplementation.java

@@ -32,16 +29,9 @@
 * @author sdedic
 */
 public interface ProjectDependenciesImplementation {


Removing methods from spi package? Isn't that an API change?

This "API" was never published, even as a friend.

jtulach · 2022-08-15T09:39:25Z

ide/projectapi/src/org/netbeans/api/project/ProjectUtils.java

+     * @throws IOException when the selected configuration cannot be persisted.
+     * @since 1.89
+     */
+    public <C extends ProjectConfiguration> boolean setActiveConfiguration(@NonNull Project p, @NonNull C cfg) throws IOException {


This would type the same without generics.

The project API itself is using generics ... (?)

jtulach · 2022-08-15T09:39:51Z

java/java.lsp.server/nbcode/integration/nbproject/project.xml

+                    <build-prerequisite/>
+                    <compile-dependency/>
+                    <run-dependency>
+                        <implementation-version/>


Implementation dependency!?

Yes, since the project.dependency is still not public - planning to open it before NB16

jtulach · 2022-08-15T09:41:01Z

...integration/src/org/netbeans/modules/nbcode/integration/commands/ProjectMetadataCommand.java

+        CompletableFuture result = new CompletableFuture();
+        METADATA_PROCESSOR.post(() -> {
+            try {
+                ArtifactsResult arts = ProjectArtifactsQuery.findArtifacts(p, filter);


All the changes just to get name of artifact to VSCode TypeScript side...

erm. not just the name, but also the location of the potential output. Yes, it's large, but NetBeans Project APIs themselves lack a description of usual project metadata, some identifier etc. The location of to-be-compiled output could be useful for packaging steps in NB, too.

jtulach · 2022-08-15T09:41:48Z

java/maven.embedder/nbproject/project.xml

@@ -182,6 +182,7 @@
                <friend>io.github.jeddict.runtime</friend>
                <friend>io.github.jeddict.rest.generator</friend>
                <!-- XXX <subpackages> not permitted by schema -->
+                <friend>org.netbeans.modules.micronaut</friend>


I don't like this. micronaut module shall not have direct dependency on Maven (embedder).

would be gradle+maven micronaut bridge modules more approppriate ?

jtulach · 2022-08-15T09:42:27Z

java/maven/src/org/netbeans/modules/maven/api/NbMavenProject.java

+     * prescribe different profiles, properties etc than have been used for the default model.
+     * 
+     * @param context the loading context
+     * @return evaluated project


Missing versioning, I assume.

sdedic · 2022-08-18T12:38:59Z

One more reviewer / approver would be awesome...

ppisl · 2022-08-18T13:33:52Z

ide/project.dependency/src/org/netbeans/modules/project/dependency/ArtifactSpec.java

+     * the file is the library consumed, e.g. from a local repository. For outputs, the artifact
+     * represents the build output, usually in project's build directory. Note that FileObject for 
+     * a dependency and its corresponding Project may not be the same.
+     * 


Probably there should be mentioned, that it can return null, if the local file doesn't exist?

sdedic · 2022-08-19T11:30:33Z

2 approvals; going to merge soon, after rebasing to master (minor clash) + consolidating fixes (less clutter).

…figuration.

…r declarative project actions.

sdedic added kind:bug Bug report or fix enhancement API Change [ci] enable extra API related tests LSP [ci] enable Language Server Protocol tests Maven [ci] enable "build tools" tests Micronaut [ci] enable enterprise job labels Aug 10, 2022

sdedic requested a review from dbalek August 10, 2022 19:43

sdedic self-assigned this Aug 10, 2022

sdedic force-pushed the sdedic/projectArtifact branch from 599b74a to 826ebec Compare August 10, 2022 19:45

sdedic requested a review from lkishalmi August 11, 2022 06:22

dbalek approved these changes Aug 11, 2022

View reviewed changes

sdedic requested a review from jlahoda August 11, 2022 11:20

lkishalmi reviewed Aug 11, 2022

View reviewed changes

jtulach reviewed Aug 15, 2022

View reviewed changes

sdedic marked this pull request as ready for review August 17, 2022 15:23

sdedic requested a review from jtulach August 17, 2022 19:52

ppisl reviewed Aug 18, 2022

View reviewed changes

ppisl approved these changes Aug 18, 2022

View reviewed changes

sdedic added 9 commits August 19, 2022 13:41

ProjectActionContext added, convenience methods to get/set active con…

4d53daa

…figuration.

Separate (private) API to query project artifacts.

f912e81

Allow to customize project models for actions.

f936182

ProjectArtifactsQuery implemented for Maven.

b37af90

Refactored to "Singletonizer" pattern

18872fe

Customizer displays provider-contributed actions. Support for I18N fo…

1b14252

…r declarative project actions.

Micronaut support for native-image build.

39f01f2

NBCode can extract project output artifacts.

538be20

Added file: resource handling, used during tests

adfae72

sdedic force-pushed the sdedic/projectArtifact branch from a063662 to adfae72 Compare August 19, 2022 11:48

Resolved conflicts with master.

223c2f4

lkishalmi mentioned this pull request Aug 19, 2022

[Preview] Gradle project introspection #4517

Closed

sdedic merged commit a0f621d into apache:master Aug 20, 2022

Support for project output artifacts #4495

Support for project output artifacts #4495

Conversation

sdedic commented Aug 10, 2022

ProjectActionContext

ProjectArtifactsQuery

Micronaut support for native image build

Maven fixes

sdedic commented Aug 11, 2022

dbalek left a comment

Choose a reason for hiding this comment

lkishalmi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtulach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdedic Aug 17, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdedic commented Aug 18, 2022

ppisl Aug 18, 2022 • edited

Choose a reason for hiding this comment

sdedic commented Aug 19, 2022

sdedic Aug 17, 2022 •

edited

ppisl Aug 18, 2022 •

edited