Skip to content

Commit 2c8b727

Browse files
authored
feat: Use React/Lit auto-detection to add Hilla components (#18597)
Adds Hilla components to package.json automatically in build time, so that developers don't need to swap hilla-react and hilla-lit artifacts in the pom dependencies. Related-to #18564, vaadin/hilla#2015
1 parent f16ca05 commit 2c8b727

4 files changed

Lines changed: 152 additions & 3 deletions

File tree

‎flow-server/src/main/java/com/vaadin/flow/server/frontend/NodeUpdater.java‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@
3737
import org.slf4j.Logger;
3838
import org.slf4j.LoggerFactory;
3939

40-
import com.vaadin.experimental.FeatureFlags;
41-
import com.vaadin.flow.internal.hilla.EndpointRequestUtil;
4240
import com.vaadin.flow.server.Constants;
4341
import com.vaadin.flow.server.frontend.scanner.ClassFinder;
4442
import com.vaadin.flow.server.frontend.scanner.FrontendDependencies;
@@ -306,6 +304,7 @@ Map<String, String> getDefaultDependencies() {
306304
dependencies
307305
.putAll(readDependencies("vaadin-router", "dependencies"));
308306
}
307+
putHillaComponentsDependencies(options, dependencies, "dependencies");
309308
return dependencies;
310309
}
311310

@@ -343,6 +342,7 @@ Map<String, String> getDefaultDevDependencies() {
343342
Map<String, String> defaults = new HashMap<>();
344343
defaults.putAll(readDependencies("default", "devDependencies"));
345344
defaults.putAll(readDependencies("vite", "devDependencies"));
345+
putHillaComponentsDependencies(options, defaults, "devDependencies");
346346

347347
return defaults;
348348
}
@@ -573,4 +573,30 @@ private JsonObject generateVersionsFromPackageJson(JsonObject packageJson)
573573

574574
return versionsJson;
575575
}
576+
577+
/**
578+
* Adds Hilla components to package.json if Hilla is used in the project.
579+
*
580+
* @param options
581+
* build options
582+
* @param dependencies
583+
* to be added into package.json
584+
* @param packageJsonKey
585+
* the key inside package.json containing the sub-list of
586+
* dependencies to read and add
587+
* @see <a href=
588+
* "https://github.com/vaadin/hilla/tree/main/packages/java/hilla/src/main/resources/com/vaadin/flow/server/frontend/dependencies/hilla/components</a>
589+
*/
590+
private static void putHillaComponentsDependencies(Options options,
591+
Map<String, String> dependencies, String packageJsonKey) {
592+
if (FrontendUtils.isHillaUsed(options.getFrontendDirectory())) {
593+
if (options.isReactRouterEnabled()) {
594+
dependencies.putAll(readDependencies("hilla/components/react",
595+
packageJsonKey));
596+
} else {
597+
dependencies.putAll(readDependencies("hilla/components/lit",
598+
packageJsonKey));
599+
}
600+
}
601+
}
576602
}

‎flow-server/src/test/java/com/vaadin/flow/server/frontend/NodeUpdaterTest.java‎

Lines changed: 88 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838

3939
import com.vaadin.experimental.FeatureFlags;
4040
import com.vaadin.flow.di.Lookup;
41+
import com.vaadin.flow.internal.hilla.EndpointRequestUtil;
4142
import com.vaadin.flow.server.Constants;
4243
import com.vaadin.flow.server.frontend.scanner.ClassFinder;
4344
import com.vaadin.flow.server.frontend.scanner.FrontendDependencies;
@@ -63,12 +64,14 @@ public class NodeUpdaterTest {
6364

6465
private ClassFinder finder;
6566

67+
private Options options;
68+
6669
@Before
6770
public void setUp() throws IOException {
6871
npmFolder = temporaryFolder.newFolder();
6972
FeatureFlags featureFlags = Mockito.mock(FeatureFlags.class);
7073
finder = Mockito.mock(ClassFinder.class);
71-
Options options = new Options(Mockito.mock(Lookup.class), npmFolder)
74+
options = new Options(Mockito.mock(Lookup.class), npmFolder)
7275
.withBuildDirectory(TARGET).withFeatureFlags(featureFlags);
7376

7477
nodeUpdater = new NodeUpdater(finder,
@@ -467,6 +470,90 @@ public void testGetPlatformPinnedDependencies_VaadinAndVaadinCoreVersionsArePres
467470
Assert.assertTrue(pinnedVersions.hasKey("@vaadin/vaadin-grid-pro"));
468471
}
469472

473+
@Test
474+
public void getDefaultDependencies_reactRouterIsUsed_addsHillaReactComponents() {
475+
boolean reactRouterEnabled = options.isReactRouterEnabled();
476+
try (MockedStatic<FrontendUtils> mock = Mockito
477+
.mockStatic(FrontendUtils.class)) {
478+
mock.when(() -> FrontendUtils.isHillaUsed(Mockito.any(File.class)))
479+
.thenReturn(true);
480+
options.withReactRouter(true);
481+
Map<String, String> defaultDeps = nodeUpdater
482+
.getDefaultDependencies();
483+
Assert.assertFalse(
484+
"Lit component added unexpectedly for react-router",
485+
defaultDeps.containsKey("@vaadin/hilla-lit-form"));
486+
Assert.assertTrue(
487+
"React component should be added when react-router is used",
488+
defaultDeps.containsKey("@vaadin/hilla-react-auth"));
489+
Assert.assertTrue(
490+
defaultDeps.containsKey("@vaadin/hilla-react-crud"));
491+
Assert.assertTrue(
492+
defaultDeps.containsKey("@vaadin/hilla-react-form"));
493+
494+
Map<String, String> defaultDevDeps = nodeUpdater
495+
.getDefaultDevDependencies();
496+
Assert.assertFalse(
497+
"Lit dev dependency added unexpectedly for react-router",
498+
defaultDevDeps.containsKey("lit-dev-dependency"));
499+
Assert.assertTrue(
500+
"React dev dependency should be added when react-router is used",
501+
defaultDevDeps.containsKey("react-dev-dependency"));
502+
} finally {
503+
options.withReactRouter(reactRouterEnabled);
504+
}
505+
}
506+
507+
@Test
508+
public void getDefaultDependencies_vaadinRouterIsUsed_addsHillaLitComponents() {
509+
boolean reactRouterEnabled = options.isReactRouterEnabled();
510+
try (MockedStatic<FrontendUtils> mock = Mockito
511+
.mockStatic(FrontendUtils.class)) {
512+
mock.when(() -> FrontendUtils.isHillaUsed(Mockito.any(File.class)))
513+
.thenReturn(true);
514+
options.withReactRouter(false);
515+
Map<String, String> defaultDeps = nodeUpdater
516+
.getDefaultDependencies();
517+
Assert.assertTrue(
518+
"Lit component should be when vaadin-router is used",
519+
defaultDeps.containsKey("@vaadin/hilla-lit-form"));
520+
Assert.assertFalse(
521+
"React component added unexpectedly for vaadin-router",
522+
defaultDeps.containsKey("@vaadin/hilla-react-form"));
523+
524+
Map<String, String> defaultDevDeps = nodeUpdater
525+
.getDefaultDevDependencies();
526+
Assert.assertFalse(
527+
"React dev dependency added unexpectedly for vaadin-router",
528+
defaultDevDeps.containsKey("react-dev-dependency"));
529+
Assert.assertTrue(
530+
"Lit dev dependency should be added when vaadin-router is used",
531+
defaultDevDeps.containsKey("lit-dev-dependency"));
532+
} finally {
533+
options.withReactRouter(reactRouterEnabled);
534+
}
535+
}
536+
537+
@Test
538+
public void getDefaultDependencies_hillaIsNotUsed_doesntAddHillaComponents() {
539+
Map<String, String> defaultDeps = nodeUpdater.getDefaultDependencies();
540+
Assert.assertFalse(
541+
"Lit component added unexpectedly when Hilla isn't used",
542+
defaultDeps.containsKey("@vaadin/hilla-lit-form"));
543+
Assert.assertFalse(
544+
"React component added unexpectedly when Hilla isn't used",
545+
defaultDeps.containsKey("@vaadin/hilla-react-auth"));
546+
547+
Map<String, String> defaultDevDeps = nodeUpdater
548+
.getDefaultDevDependencies();
549+
Assert.assertFalse(
550+
"React dev dependency added unexpectedly when Hilla isn't used",
551+
defaultDevDeps.containsKey("react-dev-dependency"));
552+
Assert.assertFalse(
553+
"Lit dev dependency added unexpectedly when Hilla isn't used",
554+
defaultDevDeps.containsKey("lit-dev-dependency"));
555+
}
556+
470557
private String getPolymerVersion(JsonObject object) {
471558
JsonObject deps = object.get("dependencies");
472559
String version = deps.getString("@polymer/polymer");
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "hilla-components-dependencies",
3+
"version": "1.0.0",
4+
"description": "A list of Hilla Lit components that are added by Flow automatically to package.json",
5+
"main": "index.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"author": "",
10+
"license": "Apache-2.0",
11+
"dependencies": {
12+
"@vaadin/hilla-lit-form": "24.4.0-alpha2"
13+
},
14+
"devDependencies": {
15+
"lit-dev-dependency": "1.0.0"
16+
}
17+
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "hilla-components-dependencies",
3+
"version": "1.0.0",
4+
"description": "A list of Hilla React components that are added by Flow automatically to package.json",
5+
"main": "index.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"author": "",
10+
"license": "Apache-2.0",
11+
"dependencies": {
12+
"@vaadin/hilla-react-auth": "24.4.0-alpha2",
13+
"@vaadin/hilla-react-crud": "24.4.0-alpha2",
14+
"@vaadin/hilla-react-form": "24.4.0-alpha2"
15+
},
16+
"devDependencies": {
17+
"react-dev-dependency": "1.0.0"
18+
}
19+
}

0 commit comments

Comments
 (0)