XCOMMONS-3470: Easier importmap declaration for webjars #4737

manuelleduc · 2025-11-03T14:46:42Z

Jira URL

Changes

Description

decide if json is the right configuration choice (maybe xml is best on a pom? or a custom syntax)
enhance the format to fir the expressivness of the webjar url API
move parsing to commons to be able to reuse it on maven validators

Clarifications

Screenshots & Video

Executed Tests

Expected merging strategy

Prefers squash: Yes
Backport on branches:
*

...rtmap/src/main/java/org/xwiki/javascript/importmap/internal/JavascriptImportmapResolver.java

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

tmortagne · 2025-11-03T16:46:42Z

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

    <xwiki.minification.skip>true</xwiki.minification.skip>
+    <xwiki.javascript.modules.importmap>
+    {
+      "xwiki-livedata": "org.xwiki.platform:xwiki-platform-livedata-webjar/main.es.js",


I'm wondering if it's not a bit too simple, I mean you might need more information that just the extension id and path (the webjars URL API can take custom parameters, for example).

More than what "xwiki-livedata": "org.xwiki.platform:xwiki-platform-livedata-webjar/main.es.js?myparam=42" could do?

@tmortagne what I'm concerned with for now is that I have no idea how to load this parameter programmatically in the accessProperty method (here https://github.com/xwiki/xwiki-platform/pull/4737/files#diff-56da785aaad1d5f483a61edaa411ef6836fbddfbb368b32d3349a0abb80e923cR167).
See also this message where I try to describe the problem https://matrix.to/#/!zdPfnFC0pUfwN5kZ4LKP2dXZ2jC266yFWKNeqgmJd4E/$Juhc3kpzhi9XiQbQ2iSckpO6wM-qfq4kD_2w31kVUyA?via=matrix.xwiki.com&via=matrix.org&via=uni-wuppertal.de

Right, I forgot to mention that only the Maven properties which name starts with "xwiki.extension." are extracted from the pom.xml to be exposed as Extension property. So you will need something which looks more like xwiki.extension.javascript.modules.importmap I guess.

More than what "xwiki-livedata": "org.xwiki.platform:xwiki-platform-livedata-webjar/main.es.js?myparam=42" could do?

Since you use JSON, it might be less error-prone to fully use JSON syntax to define all this.

I changed the format to also support namespace and parameters.
moduleA is an example of the compact and straighforward declaration of a simple webjar with a path.
But as you can see with moduleB, the string can be replaced with an object with 4 keys:

webjarId and path are mandatory

namespace and params are optionals

{ "moduleA": "org.xwiki.js/thepath.js", "moduleB": { "webjarId": "org.xwiki.js", "path": "path.js", "namespace": "s1", "params": { "key": "value" } } }

mflorea

I'm looking forward to using this feature.

.../src/main/java/org/xwiki/javascript/importmap/internal/JavascriptImportmapEventListener.java

...rtmap/src/main/java/org/xwiki/javascript/importmap/internal/JavascriptImportmapResolver.java

- Adapt to resolve per-wiki - change the configuration key to be compatible with the extensions API

manuelleduc · 2025-11-10T14:25:14Z

...rtmap/src/main/java/org/xwiki/javascript/importmap/internal/JavascriptImportmapResolver.java

+        .configure(SORT_PROPERTIES_ALPHABETICALLY, true)
+        .build();
+
+    private static final JavascriptImportmapParser JAVASCRIPT_IMPORTMAP_PARSER = new JavascriptImportmapParser();


The parser cannot be a component as I'd also like it to be usable in the maven enforcers who do not have access to components injection.

pom.xml

manuelleduc · 2025-11-13T12:51:41Z

...-tool-enforcer-importmap/src/main/java/org/xwiki/tool/enforcer/JavascriptImportMapCheck.java

+import java.util.Map;
+import java.util.Objects;
+
+import javax.inject.Named;


@tmortagne if jakarta is used instead, the enforcer is not found.
Mentioning it in case this is not a know issue.

I guess it's more something to report to the enforcer plugin (this is not an XWiki component/feature).

manuelleduc · 2025-11-14T10:34:08Z

...-tool-enforcer-importmap/src/main/java/org/xwiki/tool/enforcer/JavascriptImportMapCheck.java

+                var isSelf =
+                    areDependenciesEquals(model.getGroupId(), model.getArtifactId(), groupIdWebjar, artifactIdWebjar);
+                if (isSelf) {
+                    continue;


One last issue: I'm not sure how to find out if the path exists when the map defines the current artifact itself since the target directory is not populated when the check is performed.

Solved by changing the enforcer's phase, see https://github.com/xwiki/xwiki-platform/pull/4737/files#diff-2f81214bd08060b9f2f1bdd7cb0dda0e7109ccadbf852cda6ddb864abc29c8e3R214

tmortagne reviewed Nov 3, 2025

View reviewed changes

...rtmap/src/main/java/org/xwiki/javascript/importmap/internal/JavascriptImportmapResolver.java Show resolved Hide resolved

manuelleduc self-assigned this Nov 3, 2025

manuelleduc commented Nov 3, 2025

View reviewed changes

xwiki-platform-core/xwiki-platform-livedata/xwiki-platform-livedata-webjar/pom.xml Outdated Show resolved Hide resolved

tmortagne reviewed Nov 3, 2025

View reviewed changes

mflorea reviewed Nov 4, 2025

View reviewed changes

.../src/main/java/org/xwiki/javascript/importmap/internal/JavascriptImportmapEventListener.java Outdated Show resolved Hide resolved

.../src/main/java/org/xwiki/javascript/importmap/internal/JavascriptImportmapEventListener.java Outdated Show resolved Hide resolved

manuelleduc commented Nov 4, 2025

View reviewed changes

...rtmap/src/main/java/org/xwiki/javascript/importmap/internal/JavascriptImportmapResolver.java Show resolved Hide resolved

manuelleduc changed the title ~~XWIKI-23609: Easier importmap declaration for webjars~~ XCOMMONS-3470: Easier importmap declaration for webjars Nov 10, 2025

manuelleduc mentioned this pull request Nov 10, 2025

XCOMMONS-3470: Easier importmap declaration for webjars xwiki/xwiki-commons#1504

Merged

manuelleduc added 6 commits November 10, 2025 12:42

--wip-- [skip ci]

46178ab

--wip-- [skip ci]

2342833

--wip-- [skip ci]

9329f6f

--wip-- [skip ci]

bc69034

XWIKI-23609: Easier importmap declaration for webjars

8c26c55

- Adapt to resolve per-wiki - change the configuration key to be compatible with the extensions API

--wip-- [skip ci]

b9d41e8

manuelleduc force-pushed the XWIKI-23609 branch from bd27042 to b9d41e8 Compare November 10, 2025 13:11

manuelleduc added 2 commits November 10, 2025 14:13

--wip-- [skip ci]

7df2a5d

--wip-- [skip ci]

20bd2a0

manuelleduc commented Nov 10, 2025

View reviewed changes

manuelleduc requested a review from tmortagne November 10, 2025 14:26

manuelleduc added 6 commits November 13, 2025 11:33

Merge remote-tracking branch 'origin/master' into XCOMMONS-3470

fb58f1c

--wip-- [skip ci]

2de8ee0

Merge remote-tracking branch 'origin/master' into XCOMMONS-3470

ec5901d

--wip-- [skip ci]

2f0e5c4

--wip-- [skip ci]

ad37d22

--wip-- [skip ci]

44cb9e9

manuelleduc commented Nov 13, 2025

View reviewed changes

pom.xml Outdated Show resolved Hide resolved

manuelleduc added 4 commits November 13, 2025 12:50

--wip-- [skip ci]

41433cd

--wip-- [skip ci]

1248cbd

--wip-- [skip ci]

63ea231

--wip-- [skip ci]

84c5fb6

manuelleduc commented Nov 13, 2025

View reviewed changes

manuelleduc added 4 commits November 14, 2025 10:00

Merge remote-tracking branch 'origin/master' into XCOMMONS-3470

8296b5f

--wip-- [skip ci]

669219c

Merge remote-tracking branch 'origin/master' into XCOMMONS-3470

2677bf8

add path validity check

d69aa54

manuelleduc commented Nov 14, 2025

View reviewed changes

allow check path validity in the current module

d4db531

manuelleduc marked this pull request as ready for review November 14, 2025 10:47

manuelleduc added 2 commits November 21, 2025 14:03

Merge remote-tracking branch 'origin/master' into XCOMMONS-3470

094e3a0

--wip-- [skip ci]

a2d7f9d

manuelleduc merged commit f294505 into xwiki:master Nov 21, 2025
2 checks passed

Uh oh!

XCOMMONS-3470: Easier importmap declaration for webjars #4737

XCOMMONS-3470: Easier importmap declaration for webjars #4737

Conversation

manuelleduc commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Jira URL

Changes

Description

Clarifications

Screenshots & Video

Executed Tests

Expected merging strategy

Uh oh!

Uh oh!

Uh oh!

tmortagne Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

manuelleduc Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

manuelleduc Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tmortagne Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tmortagne Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

manuelleduc Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

mflorea left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

manuelleduc Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

manuelleduc Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

tmortagne Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

manuelleduc Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

manuelleduc Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

manuelleduc commented Nov 3, 2025 •

edited

Loading

tmortagne Nov 3, 2025 •

edited

Loading

manuelleduc Nov 3, 2025 •

edited

Loading

tmortagne Nov 3, 2025 •

edited

Loading

manuelleduc Nov 14, 2025 •

edited

Loading