XCOMMONS-3349: Make it easier to create webjar modules using node (#4206)

Author: manuelleduc

pom.xml

@@ -123,10 +123,6 @@
     <oracle.groupId>com.oracle.database.jdbc</oracle.groupId>
     <oracle.artifactId>ojdbc11</oracle.artifactId>
     <oracle.version>21.17.0.0</oracle.version>
-
-    <!-- Versions of Node related tools -->
-    <node.version>v22.16.0</node.version>
-    <npm.version>11.4.1</npm.version>
   </properties>
   <scm>
     <tag>HEAD</tag>
@@ -1199,6 +1195,11 @@
         <artifactId>xwiki-commons-tool-webjar-handlers</artifactId>
         <version>${commons.version}</version>
       </extension>
+      <extension>
+        <groupId>org.xwiki.commons</groupId>
+        <artifactId>xwiki-commons-tool-webjar-node-handlers</artifactId>
+        <version>${commons.version}</version>
+      </extension>
       <!-- Needed to add support for the "xar" packaging -->
       <extension>
         <groupId>org.xwiki.commons</groupId>
@@ -1701,7 +1702,7 @@
                 <!-- Forbid JAR extensions to have XAR runtime dependencies -->
                 <bannedDependencyType>
                   <dependencyType>xar</dependencyType>
-                  <projectPackaging>jar|webjar</projectPackaging>
+                  <projectPackaging>jar|webjar|webjar-node</projectPackaging>
                   <!-- Integration test modules are never going to be installed as extension, and they need to depend
                        on XAR modules -->
                   <projectArtifactId>^((?!-test-docker|.*-test-tests).)*$</projectArtifactId>

xwiki-platform-core/xwiki-platform-extension/xwiki-platform-extension-distribution/src/main/java/org/xwiki/extension/distribution/internal/job/step/AbstractExtensionDistributionStep.java

@@ -80,6 +80,7 @@ protected void install(ExtensionId extensionId, String namespace, boolean jarOnR
             ScriptExtensionRewriter rewriter = new ScriptExtensionRewriter();
             rewriter.installExtensionTypeOnRootNamespace("jar");
             rewriter.installExtensionTypeOnRootNamespace("webjar");
+            rewriter.installExtensionTypeOnRootNamespace("webjar-node");
             installRequest.setRewriter(rewriter);
         }
 

xwiki-platform-core/xwiki-platform-extension/xwiki-platform-extension-handlers/xwiki-platform-extension-handler-jar/src/main/java/org/xwiki/extension/jar/internal/validator/WebjarNodeExtensionValidator.java

@@ -0,0 +1,49 @@
+/*
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.xwiki.extension.jar.internal.validator;
+
+import javax.inject.Named;
+import javax.inject.Singleton;
+
+import org.xwiki.component.annotation.Component;
+import org.xwiki.extension.internal.validator.AbstractExtensionValidator;
+import org.xwiki.extension.jar.internal.handler.JarExtensionHandler;
+import org.xwiki.security.authorization.Right;
+
+/**
+ * Check rights for webjar extensions.
+ * 
+ * @version $Id$
+ * @since 17.5.0RC1
+ */
+@Component
+@Named(JarExtensionHandler.WEBJAR_NODE)
+@Singleton
+public class WebjarNodeExtensionValidator extends AbstractExtensionValidator
+{
+
+    /**
+     * Default constructor.
+     */
+    public WebjarNodeExtensionValidator()
+    {
+        this.entityRight = Right.ADMIN;
+    }
+}

xwiki-platform-core/xwiki-platform-extension/xwiki-platform-extension-handlers/xwiki-platform-extension-handler-jar/src/main/resources/META-INF/components.txt

@@ -1,2 +1,3 @@
 org.xwiki.extension.jar.internal.validator.JarExtensionValidator
 org.xwiki.extension.jar.internal.validator.WebjarExtensionValidator
+org.xwiki.extension.jar.internal.validator.WebjarNodeExtensionValidator

xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/pom.xml

@@ -27,7 +27,7 @@
     <artifactId>xwiki-platform-livedata</artifactId>
     <version>17.5.0-SNAPSHOT</version>
   </parent>
-  <packaging>webjar</packaging>
+  <packaging>webjar-node</packaging>
   <artifactId>xwiki-platform-livedata-webjar</artifactId>
   <name>XWiki Platform - Live Data - WebJar</name>
   <properties>
@@ -84,43 +84,19 @@
         <artifactId>maven-resources-plugin</artifactId>
         <executions>
           <execution>
-            <!-- We keep the Vue files and the build configuration files in separate folders in the source tree but
-              we need them in the same folder when building the Vue components. -->
-            <id>copy-vue-resources</id>
+            <!-- Copy the remaining less file. Can be removed once XWIKI-23080 is done. -->
+            <id>copy-less-resources</id>
             <phase>validate</phase>
             <goals>
               <goal>copy-resources</goal>
             </goals>
-            <configuration>
-              <outputDirectory>${project.build.directory}/vue</outputDirectory>
-              <resources>
-                <resource>
-                  <directory>src/main/vue</directory>
-                  <excludes>
-                    <exclude>dist</exclude>
-                    <exclude>node_modules</exclude>
-                  </excludes>
-                </resource>
-              </resources>
-            </configuration>
-          </execution>
-          <execution>
-            <!-- Copy the generated Vue components to the WebJar folder. -->
-            <id>copy-vue-components</id>
-            <phase>process-resources</phase>
-            <goals>
-              <goal>copy-resources</goal>
-            </goals>
             <configuration>
               <outputDirectory>
                 ${project.build.outputDirectory}/META-INF/resources/webjars/${project.artifactId}/${project.version}
               </outputDirectory>
               <resources>
                 <resource>
-                  <directory>${project.build.directory}/vue/dist</directory>
-                </resource>
-                <resource>
-                  <directory>${project.build.directory}/vue/src/</directory>
+                  <directory>${project.build.directory}/node-src/src/</directory>
                   <includes>
                     <include>variables.less</include>
                   </includes>
@@ -130,74 +106,6 @@
           </execution>
         </executions>
       </plugin>
-      <!-- Skip jsHint because we use ESLint through the frontend-maven-plugin -->
-      <plugin>
-        <groupId>org.xwiki.contrib</groupId>
-        <artifactId>jshint-maven-plugin</artifactId>
-        <executions>
-          <execution>
-            <id>default-lint</id>
-            <phase>none</phase>
-          </execution>
-        </executions>
-      </plugin>
-      <plugin>
-        <groupId>com.github.eirslett</groupId>
-        <artifactId>frontend-maven-plugin</artifactId>
-        <executions>
-          <execution>
-            <id>install-node-and-npm</id>
-            <goals>
-              <goal>install-node-and-npm</goal>
-            </goals>
-            <configuration>
-              <nodeVersion>${node.version}</nodeVersion>
-              <npmVersion>${npm.version}</npmVersion>
-            </configuration>
-          </execution>
-          <execution>
-            <id>npm-install</id>
-            <goals>
-              <goal>npm</goal>
-            </goals>
-            <configuration>
-              <arguments>ci</arguments>
-            </configuration>
-          </execution>
-          <execution>
-            <id>npm-run-lint</id>
-            <goals>
-              <goal>npm</goal>
-            </goals>
-            <configuration>
-              <arguments>run lint</arguments>
-            </configuration>
-            <phase>test</phase>
-          </execution>
-          <execution>
-            <id>npm-run-test</id>
-            <goals>
-              <goal>npm</goal>
-            </goals>
-            <configuration>
-              <arguments>run test:unit</arguments>
-            </configuration>
-            <phase>test</phase>
-          </execution>
-          <execution>
-            <id>npm-run-build</id>
-            <goals>
-              <goal>npm</goal>
-            </goals>
-            <configuration>
-              <arguments>run build</arguments>
-            </configuration>
-          </execution>
-        </executions>
-        <configuration>
-          <workingDirectory>${project.build.directory}/vue</workingDirectory>
-        </configuration>
-      </plugin>
     </plugins>
   </build>
 </project>

xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/vue/.gitattributes renamed to xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/node/.gitattributes

@@ -27,7 +27,7 @@
     <artifactId>xwiki-platform-notifications</artifactId>
     <version>17.5.0-SNAPSHOT</version>
   </parent>
-  <packaging>webjar</packaging>
+  <packaging>webjar-node</packaging>
   <artifactId>xwiki-platform-notifications-webjar</artifactId>
   <name>XWiki Platform - Notifications - WebJar</name>
   <properties>
@@ -61,106 +61,4 @@
       <scope>runtime</scope>
     </dependency>
   </dependencies>
-  <build>
-    <plugins>
-      <plugin>
-        <artifactId>maven-resources-plugin</artifactId>
-        <executions>
-          <execution>
-            <id>copy-vue-resources</id>
-            <phase>validate</phase>
-            <goals>
-              <goal>copy-resources</goal>
-            </goals>
-            <configuration>
-              <outputDirectory>${project.build.directory}/vue</outputDirectory>
-              <resources>
-                <resource>
-                  <directory>src/main/vue</directory>
-                  <excludes>
-                    <exclude>dist</exclude>
-                    <exclude>node_modules</exclude>
-                  </excludes>
-                </resource>
-              </resources>
-            </configuration>
-          </execution>
-          <execution>
-            <!-- Copy the generated Vue components to the WebJar folder. -->
-            <id>copy-vue-components</id>
-            <phase>process-resources</phase>
-            <goals>
-              <goal>copy-resources</goal>
-            </goals>
-            <configuration>
-              <outputDirectory>${project.build.outputDirectory}/META-INF/resources/webjars/${project.artifactId}/${project.version}</outputDirectory>
-              <resources>
-                <resource>
-                  <directory>${project.build.directory}/vue/dist</directory>
-                </resource>
-              </resources>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
-      <!-- Skip jsHint because we use ESLint through the frontend-maven-plugin -->
-      <plugin>
-        <groupId>org.xwiki.contrib</groupId>
-        <artifactId>jshint-maven-plugin</artifactId>
-        <executions>
-          <execution>
-            <id>default-lint</id>
-            <phase>none</phase>
-          </execution>
-        </executions>
-      </plugin>
-      <plugin>
-        <groupId>com.github.eirslett</groupId>
-        <artifactId>frontend-maven-plugin</artifactId>
-        <executions>
-          <execution>
-            <id>install-node-and-npm</id>
-            <goals>
-              <goal>install-node-and-npm</goal>
-            </goals>
-            <configuration>
-              <nodeVersion>${node.version}</nodeVersion>
-              <npmVersion>${npm.version}</npmVersion>
-            </configuration>
-          </execution>
-          <execution>
-            <id>npm-install</id>
-            <goals>
-              <goal>npm</goal>
-            </goals>
-            <configuration>
-              <arguments>ci</arguments>
-            </configuration>
-          </execution>
-          <execution>
-            <id>npm-run-build</id>
-            <goals>
-              <goal>npm</goal>
-            </goals>
-            <configuration>
-              <arguments>run build</arguments>
-            </configuration>
-          </execution>
-          <execution>
-            <id>npm-run-lint</id>
-            <goals>
-              <goal>npm</goal>
-            </goals>
-            <configuration>
-              <arguments>run lint</arguments>
-            </configuration>
-            <phase>test</phase>
-          </execution>
-        </executions>
-        <configuration>
-          <workingDirectory>${project.build.directory}/vue</workingDirectory>
-        </configuration>
-      </plugin>
-    </plugins>
-  </build>
 </project>

xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/vue/env.d.ts renamed to xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/node/env.d.ts

@@ -7,7 +7,7 @@
     "dev": "vite",
     "build": "run-p type-check \"build-only {@}\" --",
     "preview": "vite preview",
-    "test:unit": "vitest --run",
+    "test:unit": "vitest --run --passWithNoTests",
     "build-only": "vite build",
     "type-check": "vue-tsc --build",
     "lint": "eslint . --fix",

xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/vue/eslint.config.ts renamed to xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/node/eslint.config.ts

@@ -1213,6 +1213,7 @@ $namespace##
   #if ($extensionConfig.installJAROnRoot)
     #set ($discard = $installPlanRequest.rewriter.installExtensionTypeOnRootNamespace('jar'))
     #set ($discard = $installPlanRequest.rewriter.installExtensionTypeOnRootNamespace('webjar'))
+    #set ($discard = $installPlanRequest.rewriter.installExtensionTypeOnRootNamespace('webjar-node'))
   #end
   #set ($discard = $extensionManager.createInstallPlan($installPlanRequest))
   #handleExtensionJobStartFailure('extensions.install.error.prepareFailure')

xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/vue/package-lock.json renamed to xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/node/package-lock.json

@@ -67,6 +67,7 @@ public void executeInternal() throws MojoExecutionException
         ScriptExtensionRewriter rewriter = new ScriptExtensionRewriter();
         rewriter.installExtensionTypeOnRootNamespace("jar");
         rewriter.installExtensionTypeOnRootNamespace("webjar");
+        rewriter.installExtensionTypeOnRootNamespace("webjar-node");
         installRequest.setRewriter(rewriter);
 
         // Use superadmin as pages author

xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/vue/package.json renamed to xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/src/main/node/package.json

@@ -35,7 +35,7 @@
  * @version $Id$
  * @since 9.5RC1
  */
-@Component(hints = { "jar", "webjar" })
+@Component(hints = { "jar", "webjar", "webjar-node" })
 @Singleton
 public class MavenBuildJarExtensionHandler extends AbstractExtensionHandler
 {