Skip to content

Commit d83744d

Browse files
author
Johannes Eriksson
committed
fix: apply theme in V14 legacy mode (#13107)
This PR brings in the parts of 204d2cf that set a DOM flag to enable theme initialization in generated-flow-imports.js. It is only activated in V14 legacy bootstrap mode. Fixes #13041
1 parent 2ff9b1c commit d83744d

10 files changed

Lines changed: 84 additions & 40 deletions

File tree

‎flow-server/src/main/java/com/vaadin/flow/server/BootstrapHandler.java‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,8 @@ protected static class BootstrapContext {
182182
private JsonObject applicationParameters;
183183
private BootstrapUriResolver uriResolver;
184184

185+
private boolean initTheme = true;
186+
185187
/**
186188
* Creates a new context instance using the given parameters.
187189
*
@@ -274,6 +276,25 @@ public VaadinSession getSession() {
274276
return session;
275277
}
276278

279+
/**
280+
* Should custom theme be initialized.
281+
*
282+
* @return true if theme should be initialized
283+
*/
284+
public boolean isInitTheme() {
285+
return initTheme;
286+
}
287+
288+
/**
289+
* Set if custom theme should be initialized.
290+
*
291+
* @param initTheme
292+
* enable or disable theme initialisation
293+
*/
294+
public void setInitTheme(boolean initTheme) {
295+
this.initTheme = initTheme;
296+
}
297+
277298
/**
278299
* Gets the UI.
279300
*
@@ -662,6 +683,17 @@ public Document getBootstrapPage(BootstrapContext context) {
662683

663684
document.outputSettings().prettyPrint(false);
664685

686+
// In V14 legacy bootstrap mode, the theme is initialized in
687+
// target/frontend/generated-flow-imports.js but not in normal
688+
// bootstrap mode and for exported webcomponents; set a flag in
689+
// the DOM only if initialization is needed.
690+
if (config.useV14Bootstrap() && context.isInitTheme()) {
691+
head.prependElement("script").attr("type", "text/javascript")
692+
.appendChild(new DataNode(
693+
"window.Vaadin = window.Vaadin || {}; window.Vaadin.theme = window.Vaadin.theme || {};"
694+
+ "window.Vaadin.theme.flowBootstrap = true;"));
695+
}
696+
665697
BootstrapUtils.getInlineTargets(context)
666698
.ifPresent(targets -> handleInlineTargets(context, head,
667699
document.body(), targets));

‎flow-server/src/main/java/com/vaadin/flow/server/communication/WebComponentBootstrapHandler.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ private WebComponentBootstrapContext(VaadinRequest request,
7878
Function<VaadinRequest, String> callback) {
7979
super(request, response, ui.getInternals().getSession(), ui,
8080
callback);
81+
setInitTheme(false);
8182
}
8283

8384
@Override

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,19 @@ abstract class AbstractUpdateImports implements Runnable {
9595

9696
private final File tokenFile;
9797

98-
private boolean productionMode;
98+
private final boolean productionMode;
99+
100+
protected final boolean useLegacyV14Bootstrap;
99101

100102
AbstractUpdateImports(File frontendDirectory, File npmDirectory,
101-
File generatedDirectory, File tokenFile, boolean productionMode) {
103+
File generatedDirectory, File tokenFile, boolean productionMode,
104+
boolean useLegacyV14Bootstrap) {
102105
frontendDir = frontendDirectory;
103106
npmDir = npmDirectory;
104107
generatedDir = generatedDirectory;
105108
this.tokenFile = tokenFile;
106109
this.productionMode = productionMode;
110+
this.useLegacyV14Bootstrap = useLegacyV14Bootstrap;
107111
}
108112

109113
@Override
@@ -113,7 +117,7 @@ public void run() {
113117
lines.addAll(getExportLines());
114118
lines.addAll(getThemeLines());
115119
lines.addAll(getCssLines());
116-
if (!productionMode) {
120+
if (!productionMode && useLegacyV14Bootstrap) {
117121
// This is only needed for v14bootstrap mode
118122
lines.add(TaskGenerateBootstrap.DEVMODE_GIZMO_IMPORT);
119123
}

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

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ public static class Builder implements Serializable {
124124
/**
125125
* Is in client-side bootstrapping mode.
126126
*/
127-
private boolean useDeprecatedV14Bootstrapping;
127+
private boolean useLegacyV14Bootstrap;
128128

129129
/**
130130
* The node.js version to be used when node.js is installed
@@ -406,7 +406,7 @@ public Builder copyLocalResources(File localResourcesFolder) {
406406
* @return the builder, for chaining
407407
*/
408408
public Builder useV14Bootstrap(boolean useDeprecatedV14Bootstrapping) {
409-
this.useDeprecatedV14Bootstrapping = useDeprecatedV14Bootstrapping;
409+
this.useLegacyV14Bootstrap = useDeprecatedV14Bootstrapping;
410410
return this;
411411
}
412412

@@ -726,8 +726,7 @@ private NodeTasks(Builder builder) {
726726
frontendDependencies = new FrontendDependenciesScanner.FrontendDependenciesScannerFactory()
727727
.createScanner(!builder.useByteCodeScanner, classFinder,
728728
builder.generateEmbeddableWebComponents,
729-
builder.useDeprecatedV14Bootstrapping,
730-
featureFlags);
729+
builder.useLegacyV14Bootstrap, featureFlags);
731730

732731
if (builder.generateEmbeddableWebComponents) {
733732
FrontendWebComponentGenerator generator = new FrontendWebComponentGenerator(
@@ -774,7 +773,7 @@ private NodeTasks(Builder builder) {
774773
addGenerateTsConfigTask(builder);
775774
}
776775

777-
if (!builder.useDeprecatedV14Bootstrapping) {
776+
if (!builder.useLegacyV14Bootstrap) {
778777
addBootstrapTasks(builder);
779778

780779
TaskGenerateHilla hillaTask = builder.lookup
@@ -831,21 +830,20 @@ private NodeTasks(Builder builder) {
831830
builder.npmFolder, builder.webappResourcesDirectory,
832831
builder.resourceOutputDirectory,
833832
new File(builder.generatedFolder, IMPORTS_NAME),
834-
builder.useDeprecatedV14Bootstrapping,
835-
builder.flowResourcesFolder, pwaConfiguration,
836-
builder.frontendGeneratedFolder, builder.buildDirectory));
833+
builder.useLegacyV14Bootstrap, builder.flowResourcesFolder,
834+
pwaConfiguration, builder.frontendGeneratedFolder,
835+
builder.buildDirectory));
837836
}
838837

839838
if (builder.enableImportsUpdate) {
840-
commands.add(
841-
new TaskUpdateImports(classFinder, frontendDependencies,
842-
finder -> getFallbackScanner(builder, finder,
843-
featureFlags),
844-
builder.npmFolder, builder.generatedFolder,
845-
builder.frontendDirectory, builder.tokenFile,
846-
builder.tokenFileData, builder.enablePnpm,
847-
builder.buildDirectory, builder.productionMode,
848-
featureFlags));
839+
commands.add(new TaskUpdateImports(classFinder,
840+
frontendDependencies,
841+
finder -> getFallbackScanner(builder, finder, featureFlags),
842+
builder.npmFolder, builder.generatedFolder,
843+
builder.frontendDirectory, builder.tokenFile,
844+
builder.tokenFileData, builder.enablePnpm,
845+
builder.buildDirectory, builder.productionMode,
846+
builder.useLegacyV14Bootstrap, featureFlags));
849847

850848
commands.add(new TaskUpdateThemeImport(builder.npmFolder,
851849
frontendDependencies.getThemeDefinition(),
@@ -929,8 +927,7 @@ private FrontendDependenciesScanner getFallbackScanner(Builder builder,
929927
return new FrontendDependenciesScanner.FrontendDependenciesScannerFactory()
930928
.createScanner(true, finder,
931929
builder.generateEmbeddableWebComponents,
932-
builder.useDeprecatedV14Bootstrapping,
933-
featureFlags);
930+
builder.useLegacyV14Bootstrap, featureFlags);
934931
} else {
935932
return null;
936933
}

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

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ public class TaskUpdateImports extends NodeUpdater {
7676
private final JsonObject tokenFileData;
7777

7878
private final boolean enablePnpm;
79-
private boolean productionMode;
79+
private final boolean productionMode;
80+
private final boolean useLegacyV14Bootstrap;
8081

8182
private class UpdateMainImportsFile extends AbstractUpdateImports {
8283
private static final String EXPORT_MODULES_DEF = "export declare const addCssBlock: (block: string, before?: boolean) => void;";
@@ -88,9 +89,10 @@ private class UpdateMainImportsFile extends AbstractUpdateImports {
8889

8990
UpdateMainImportsFile(ClassFinder classFinder, File frontendDirectory,
9091
File npmDirectory, File generatedDirectory,
91-
File fallBackImports, File tokenFile, boolean productionMode) {
92+
File fallBackImports, File tokenFile, boolean productionMode,
93+
boolean useLegacyV14Bootstrap) {
9294
super(frontendDirectory, npmDirectory, generatedDirectory,
93-
tokenFile, productionMode);
95+
tokenFile, productionMode, useLegacyV14Bootstrap);
9496
generatedFlowImports = new File(generatedDirectory, IMPORTS_NAME);
9597
generatedFlowDefinitions = new File(generatedDirectory,
9698
IMPORTS_D_TS_NAME);
@@ -150,6 +152,12 @@ protected Collection<String> getThemeLines() {
150152
&& !"".equals(themeDef.getName());
151153
// There is no application theme in use, write theme includes
152154
// here. Otherwise they are written by the theme
155+
if (useLegacyV14Bootstrap && hasApplicationTheme) {
156+
lines.add("import {applyTheme} from 'generated/theme.js';");
157+
lines.add("if (window.Vaadin.theme.flowBootstrap) {");
158+
lines.add(" applyTheme(document);");
159+
lines.add("}");
160+
}
153161
if (!theme.getHeaderInlineContents().isEmpty()) {
154162
lines.add("");
155163
if (hasApplicationTheme) {
@@ -233,10 +241,10 @@ private class UpdateFallBackImportsFile extends AbstractUpdateImports {
233241

234242
UpdateFallBackImportsFile(ClassFinder classFinder,
235243
File frontendDirectory, File npmDirectory,
236-
File generatedDirectory, File tokenFile,
237-
boolean productionMode) {
244+
File generatedDirectory, File tokenFile, boolean productionMode,
245+
boolean useLegacyV14Bootstrap) {
238246
super(frontendDirectory, npmDirectory, generatedDirectory,
239-
tokenFile, productionMode);
247+
tokenFile, productionMode, useLegacyV14Bootstrap);
240248
generatedFallBack = new File(generatedDirectory,
241249
FrontendUtils.FALLBACK_IMPORTS_NAME);
242250
finder = classFinder;
@@ -353,7 +361,7 @@ File getGeneratedFallbackFile() {
353361
File npmFolder, File generatedPath, File frontendDirectory,
354362
File tokenFile, JsonObject tokenFileData, boolean enablePnpm,
355363
String buildDir, boolean productionMode,
356-
FeatureFlags featureFlags) {
364+
boolean useLegacyV14Bootstrap, FeatureFlags featureFlags) {
357365
super(finder, frontendDepScanner, npmFolder, generatedPath, null,
358366
buildDir, featureFlags);
359367
this.frontendDirectory = frontendDirectory;
@@ -362,6 +370,7 @@ File getGeneratedFallbackFile() {
362370
this.tokenFileData = tokenFileData;
363371
this.enablePnpm = enablePnpm;
364372
this.productionMode = productionMode;
373+
this.useLegacyV14Bootstrap = useLegacyV14Bootstrap;
365374
}
366375

367376
@Override
@@ -370,15 +379,15 @@ public void execute() {
370379
if (fallbackScanner != null) {
371380
UpdateFallBackImportsFile fallBackUpdate = new UpdateFallBackImportsFile(
372381
finder, frontendDirectory, npmFolder, generatedFolder,
373-
tokenFile, productionMode);
382+
tokenFile, productionMode, useLegacyV14Bootstrap);
374383
fallBackUpdate.run();
375384
fallBack = fallBackUpdate.getGeneratedFallbackFile();
376385
updateBuildFile(fallBackUpdate);
377386
}
378387

379388
UpdateMainImportsFile mainUpdate = new UpdateMainImportsFile(finder,
380389
frontendDirectory, npmFolder, generatedFolder, fallBack,
381-
tokenFile, productionMode);
390+
tokenFile, productionMode, useLegacyV14Bootstrap);
382391
mainUpdate.run();
383392
}
384393

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,8 @@ public void setup() throws Exception {
8585
ClassFinder classFinder = getClassFinder();
8686
updater = new TaskUpdateImports(classFinder, getScanner(classFinder),
8787
finder -> null, tmpRoot, generatedPath, frontendDirectory, null,
88-
null, false, TARGET, true, Mockito.mock(FeatureFlags.class)) {
88+
null, false, TARGET, true, false,
89+
Mockito.mock(FeatureFlags.class)) {
8990
@Override
9091
Logger log() {
9192
return logger;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ private class UpdateImports extends AbstractUpdateImports {
9595
FrontendDependenciesScanner scanner, File npmDirectory,
9696
File tokenFile, boolean productionMode) {
9797
super(frontendDirectory, npmDirectory, generatedPath, tokenFile,
98-
productionMode);
98+
productionMode, false);
9999
this.scanner = scanner;
100100
finder = classFinder;
101101
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,6 @@ private TaskUpdateImports createUpdater() throws IOException {
147147
return new TaskUpdateImports(classFinder,
148148
getScanner(classFinder, featureFlags), finder -> null, tmpRoot,
149149
generatedPath, frontendDirectory, null, null, false, TARGET,
150-
true, featureFlags);
150+
true, false, featureFlags);
151151
}
152152
}

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ public void extraComponentsInCP_componentsAreNotDiscoveredByMainScannerWrittenBy
123123
finder -> new FrontendDependenciesScannerFactory()
124124
.createScanner(true, finder, true),
125125
tmpRoot, generatedPath, frontendDirectory, tokenFile,
126-
fallBackData, false, TARGET, true,
126+
fallBackData, false, TARGET, true, false,
127127
Mockito.mock(FeatureFlags.class)) {
128128
@Override
129129
Logger log() {
@@ -262,7 +262,7 @@ public void emptyByteCodeScannerData_themeIsDiscovered_fallbackIsGenerated()
262262
finder -> new FrontendDependenciesScannerFactory()
263263
.createScanner(true, finder, true),
264264
tmpRoot, generatedPath, frontendDirectory, tokenFile, null,
265-
false, TARGET, true, Mockito.mock(FeatureFlags.class)) {
265+
false, TARGET, true, false, Mockito.mock(FeatureFlags.class)) {
266266
@Override
267267
Logger log() {
268268
return logger;
@@ -332,7 +332,7 @@ public void noFallBackScanner_fallbackIsNotGenerated() throws IOException {
332332
new FrontendDependenciesScannerFactory().createScanner(false,
333333
classFinder, true),
334334
finder -> null, tmpRoot, generatedPath, frontendDirectory,
335-
tokenFile, null, false, TARGET, true,
335+
tokenFile, null, false, TARGET, true, false,
336336
Mockito.mock(FeatureFlags.class)) {
337337
@Override
338338
Logger log() {
@@ -378,7 +378,7 @@ public void noFallBackScanner_fallbackIsNotImportedEvenIfTheFileExists()
378378
new FrontendDependenciesScannerFactory().createScanner(false,
379379
classFinder, true),
380380
finder -> null, tmpRoot, generatedPath, frontendDirectory,
381-
tokenFile, null, false, TARGET, true,
381+
tokenFile, null, false, TARGET, true, false,
382382
Mockito.mock(FeatureFlags.class)) {
383383
@Override
384384
Logger log() {
@@ -415,7 +415,7 @@ public void tokenFileIsStable() throws Exception {
415415
finder -> new FrontendDependenciesScannerFactory()
416416
.createScanner(true, finder, true),
417417
tmpRoot, generatedPath, frontendDirectory, tokenFile,
418-
fallBackData, false, TARGET, true,
418+
fallBackData, false, TARGET, true, false,
419419
Mockito.mock(FeatureFlags.class)) {
420420
@Override
421421
Logger log() {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ public ThemeDefinition getThemeDefinition() {
149149
};
150150
updater = new TaskUpdateImports(finder, deps, cf -> null, tmpRoot,
151151
generatedPath, frontendDirectory, null, null, false, TARGET,
152-
true, Mockito.mock(FeatureFlags.class));
152+
true, false, Mockito.mock(FeatureFlags.class));
153153
}
154154

155155
@Test

0 commit comments

Comments
 (0)