Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: update URL if Vite reload happens during navigation (#12375)
Fixes #12179
- Loading branch information
Showing
7 changed files
with
115 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
flow-server/src/main/java/com/vaadin/flow/server/frontend/TaskGenerateViteDevMode.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| * Copyright 2000-2021 Vaadin Ltd. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
| package com.vaadin.flow.server.frontend; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
|
|
||
| import org.apache.commons.io.IOUtils; | ||
|
|
||
| /** | ||
| * Generate <code>vite-devmode.ts</code> if it is missing in frontend/generated | ||
| * folder. | ||
| * <p> | ||
| * For internal use only. May be renamed or removed in a future release. | ||
| * | ||
| * @since | ||
| */ | ||
| public class TaskGenerateViteDevMode extends AbstractTaskClientGenerator { | ||
|
|
||
| private final File frontendDirectory; | ||
|
|
||
| /** | ||
| * Create a task to generate <code>index.js</code> if necessary. | ||
| * | ||
| * @param frontendDirectory | ||
| * frontend directory is to check if the file already exists | ||
| * there. | ||
| * @param generatedImports | ||
| * the flow generated imports file to include in the | ||
| * <code>index.js</code> | ||
| * @param outputDirectory | ||
| * the build output directory | ||
| */ | ||
| TaskGenerateViteDevMode(File frontendDirectory) { | ||
| this.frontendDirectory = frontendDirectory; | ||
| } | ||
|
|
||
| @Override | ||
| protected File getGeneratedFile() { | ||
| return new File(new File(frontendDirectory, FrontendUtils.GENERATED), | ||
| FrontendUtils.VITE_DEVMODE_TS); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean shouldGenerate() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getFileContent() throws IOException { | ||
| return IOUtils.toString( | ||
| getClass().getResourceAsStream(FrontendUtils.VITE_DEVMODE_TS), | ||
| UTF_8); | ||
| } | ||
|
|
||
| } |
18 changes: 18 additions & 0 deletions
18
flow-server/src/main/resources/com/vaadin/flow/server/frontend/vite-devmode.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // @ts-ignore | ||
| if (import.meta.hot) { | ||
| // @ts-ignore | ||
| const hot = import.meta.hot; | ||
| let pendingNavigationTo: string | undefined = undefined; | ||
|
|
||
| window.addEventListener('vaadin-router-go', (routerEvent: any) => { | ||
| pendingNavigationTo = routerEvent.detail.pathname + routerEvent.detail.search; | ||
| }); | ||
| hot.on('vite:beforeFullReload', (payload: any) => { | ||
| if (pendingNavigationTo) { | ||
| // Force reload with the new URL | ||
| location.href = pendingNavigationTo; | ||
| // Prevent Vite from reloading | ||
| payload.path = '/_fake/path.html'; | ||
| } | ||
| }); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters