Class FrontendUtils
java.lang.Object
io.jmix.flowui.devserver.frontend.FrontendUtils
A class for static methods and definitions that might be used in different
locations.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Thrown when the command execution fails.static class
Thrown when detecting the version of a tool fails. -
Field Summary
Modifier and TypeFieldDescriptionstatic final String
File name of the bootstrap file that is generated in frontendGENERATED
folder.static final String
static final String
static final String
A key in a Json object for chunks list.static final String
A key in a Json object for css imports data.static final String
Path of the folder containing application frontend source files, it needs to be relative to theDEFAULT_NODE_DIR
By default it is/frontend
in the project folder.static final String
Default folder for the node related content.static final String
Default generated path for generated frontend files.static final String
static final String
The entry-point key used for the exported bundle.static final String
File name of the feature flags file that is generated in frontendGENERATED
folder.static final String
static final String
Default folder used for source and generated folders.static final String
static final String
A special prefix used to map imports placed in theDEFAULT_FRONTEND_DIR
.static final String
The prefix used to import files generated by Flow.static final String
Default folder for client-side generated files inside the project root frontend folder.static final String
static final String
static final String
The TypeScript definitions for theIMPORTS_NAME
file.static final String
Name of the file that contains application imports, javascript, theme and style annotations.static final String
File name of the index.html in client side.static final String
File name of the index.js in client side.static final String
File name of the index.ts in client side.static final String
File name of the index.tsx in client side.static final String
The folder inside the 'generated' folder where frontend resources from jars are copied.static final String
The location where javascript files present in jar resources are copied and can be imported from.static final String
The location where javascript files present in jar resources are copied and can be imported from, relative to the frontend folder.static final String
A key in a Json object for js modules data.static final String
Location for the installed node packages.static final String
static final String
A parameter for overriding theDEFAULT_FRONTEND_DIR
folder.static final String
Set totrue
to ignore node/npm tool version checks.static final String
static final String
static final String
static final String
static final String
A parameter informing about the location of theTOKEN_FILE
.static final String
static final String
static final String
The name of the service worker source file for InjectManifest method of the workbox plugin.static final String
The JavaScript version of the service worker file, for checking if a user has a JavaScript version of a custom service worker file already.static final String
static final String
static final String
File used to enable npm mode.static final String
static final String
The name of the vite configuration file.static final String
File name of Vite helper used in development mode.static final String
The name of the generated vite configuration file.static final String
File name of the web component bootstrap file that is generated in frontendGENERATED
folder.static final String
File name of the web-component.html in client side.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
commandToString
(String baseDir, List<String> command) Pretty prints a command line order.static void
static void
Intentionally send to console instead to log, useful when executing external processes.static void
static CompletableFuture<com.vaadin.flow.internal.Pair<String,
String>> consumeProcessStreams
(Process process) Reads input and error stream from the give process asynchronously.static ProcessBuilder
createProcessBuilder
(List<String> command) Creates a process builder for the given list of program and arguments.static void
deleteDirectory
(File directory) Recursively delete given directory and contents.static void
deleteNodeModules
(File nodeModules) Try to remove thenode_modules
directory, if it exists inside the given base directory.static String
executeCommand
(List<String> command) Executes a given command as a native process.static int
findFreePort
(int rangeStart, int rangeEnd) static File
getFlowGeneratedFolder
(File frontendFolder) Gets the folder where Flow generated frontend files are placed.static File
getFlowGeneratedImports
(File frontendFolder) Gets the location of the generated import file for Flow.static File
getFlowGeneratedWebComponentsFolder
(File frontendFolder) Gets the folder where exported web components are generated.static InputStream
getFrontendFileFromDevModeHandler
(com.vaadin.flow.server.VaadinService service, String path) Get the contents of a frontend file from the running dev server.static File
getFrontendGeneratedFolder
(File frontendDirectory) static String
getFrontendServletPath
(jakarta.servlet.ServletContext servletContext) Gets the servlet path (excluding the context path) for the servlet used for serving the VAADIN frontend bundle.static String
getIndexHtmlContent
(com.vaadin.flow.server.VaadinService service) Gets the content of thefrontend/index.html
file which is served by vite in dev-mode and read from classpath in production mode.static File
getJarResourcesFolder
(File frontendDirectory) Get the front-end resources folder.static String
getJarResourceString
(String jarImport, com.vaadin.flow.server.frontend.scanner.ClassFinder finder) Get resource from JAR package.static File
static String
Get the Operating System name from theos.name
system property.static com.vaadin.flow.server.frontend.FrontendVersion
getPackageVersionFromJson
(elemental.json.JsonObject sourceJson, String pkg, String versionOrigin) Tries to parse the given package's frontend version or if it doesn't exist, returnsnull
.static File
getProjectBaseDir
(com.vaadin.flow.server.startup.ApplicationConfiguration configuration) static File
getProjectFrontendDir
(com.vaadin.flow.server.AbstractConfiguration configuration) Get directory where project's frontend files are located.static URL
getResource
(String name) static InputStream
getResourceAsStream
(String name) static String
getUnixPath
(Path source) Get path as a String in Unix form.static String
getUnixRelativePath
(Path source, Path target) Get relative path from a source path to a target path in Unix form.static File
Gets vaadin home directory (".vaadin"
folder in the user home dir).protected static com.vaadin.flow.server.frontend.FrontendVersion
getVersion
(String tool, List<String> versionCommand) static String
getWebComponentHtmlContent
(com.vaadin.flow.server.VaadinService service) Gets the content of thefrontend/web-component.html
file which is served by vite in dev-mode and read from classpath in production mode.static boolean
Check if the current os is Windows.static void
static void
static com.vaadin.flow.server.frontend.FrontendVersion
parseFrontendVersion
(String versionString) Parse the version number of node/npm from version output string.static File
resolveFrontendPath
(File projectRoot, String path) Looks up the frontend resource at the given path.static File
resolveFrontendPath
(File projectRoot, String path, File frontendDirectory) Looks up the fronted resource at the given path.static String
streamToString
(InputStream inputStream) Read a stream and copy the content into a String using system line separators for all 'carriage return' characters.
-
Field Details
-
PROJECT_BASEDIR
- See Also:
-
DEFAULT_NODE_DIR
Default folder for the node related content. It's the base directory forConstants.PACKAGE_JSON
andNODE_MODULES
. By default it's the project root folder.- See Also:
-
NODE_MODULES
Location for the installed node packages. This folder is always considered by node, even though we define extra folders with theNODE_PATH
.- See Also:
-
FRONTEND
Default folder used for source and generated folders.- See Also:
-
GENERATED
Default folder for client-side generated files inside the project root frontend folder.- See Also:
-
DEFAULT_FRONTEND_DIR
Path of the folder containing application frontend source files, it needs to be relative to theDEFAULT_NODE_DIR
By default it is/frontend
in the project folder.- See Also:
-
VITE_CONFIG
The name of the vite configuration file.- See Also:
-
VITE_GENERATED_CONFIG
The name of the generated vite configuration file.- See Also:
-
SERVICE_WORKER_SRC
The name of the service worker source file for InjectManifest method of the workbox plugin.- See Also:
-
SERVICE_WORKER_SRC_JS
The JavaScript version of the service worker file, for checking if a user has a JavaScript version of a custom service worker file already.- See Also:
-
JAR_RESOURCES_FOLDER
The folder inside the 'generated' folder where frontend resources from jars are copied.- See Also:
-
JAR_RESOURCES_IMPORT
The location where javascript files present in jar resources are copied and can be imported from.- See Also:
-
JAR_RESOURCES_IMPORT_FRONTEND_RELATIVE
The location where javascript files present in jar resources are copied and can be imported from, relative to the frontend folder. -
IMPORTS_NAME
Name of the file that contains application imports, javascript, theme and style annotations.- See Also:
-
IMPORTS_D_TS_NAME
The TypeScript definitions for theIMPORTS_NAME
file.- See Also:
-
THEME_IMPORTS_D_TS_NAME
- See Also:
-
THEME_IMPORTS_NAME
- See Also:
-
BOOTSTRAP_FILE_NAME
File name of the bootstrap file that is generated in frontendGENERATED
folder. The bootstrap file is always executed in a Vaadin app.- See Also:
-
WEB_COMPONENT_BOOTSTRAP_FILE_NAME
File name of the web component bootstrap file that is generated in frontendGENERATED
folder. The bootstrap file is always executed in an exported web component.- See Also:
-
FEATURE_FLAGS_FILE_NAME
File name of the feature flags file that is generated in frontendGENERATED
folder. The feature flags file contains code to define feature flags as globals that might be used by Vaadin web components or application code.- See Also:
-
INDEX_HTML
File name of the index.html in client side.- See Also:
-
WEB_COMPONENT_HTML
File name of the web-component.html in client side.- See Also:
-
INDEX_TS
File name of the index.ts in client side.- See Also:
-
INDEX_JS
File name of the index.js in client side.- See Also:
-
INDEX_TSX
File name of the index.tsx in client side.- See Also:
-
VITE_DEVMODE_TS
File name of Vite helper used in development mode.- See Also:
-
DEFAULT_PROJECT_FRONTEND_GENERATED_DIR
Default generated path for generated frontend files.- See Also:
-
PARAM_FRONTEND_DIR
A parameter for overriding theDEFAULT_FRONTEND_DIR
folder.- See Also:
-
PARAM_FLOW_FRONTEND_DIR
- See Also:
-
PARAM_THEME_VALUE
- See Also:
-
PARAM_THEME_VARIANT
- See Also:
-
PARAM_THEME_CLASS
- See Also:
-
PARAM_STUDIO_DIR
- See Also:
-
VIEW_DESIGNER_FOLDER
- See Also:
-
FRONTEND_FOLDER
- See Also:
-
BUILD_FOLDER
- See Also:
-
FLOW_FRONTEND_FOLDER
- See Also:
-
GENERATED_FRONTEND_FOLDER
- See Also:
-
PARAM_IGNORE_VERSION_CHECKS
Set totrue
to ignore node/npm tool version checks.- See Also:
-
FRONTEND_FOLDER_ALIAS
A special prefix used to map imports placed in theDEFAULT_FRONTEND_DIR
. e.g.import 'Frontend/foo.js';
references the filefrontend/foo.js
.- See Also:
-
FRONTEND_GENERATED_FLOW_IMPORT_PATH
The prefix used to import files generated by Flow.- See Also:
-
TOKEN_FILE
File used to enable npm mode.- See Also:
-
CHUNKS
A key in a Json object for chunks list.- See Also:
-
EXPORT_CHUNK
The entry-point key used for the exported bundle.- See Also:
-
CSS_IMPORTS
A key in a Json object for css imports data.- See Also:
-
JS_MODULES
A key in a Json object for js modules data.- See Also:
-
PARAM_TOKEN_FILE
A parameter informing about the location of theTOKEN_FILE
.- See Also:
-
DISABLE_CHECK
- See Also:
-
YELLOW
- See Also:
-
RED
- See Also:
-
GREEN
- See Also:
-
BRIGHT_BLUE
- See Also:
-
-
Method Details
-
getOsName
Get the Operating System name from theos.name
system property.- Returns:
- operating system name
-
isWindows
public static boolean isWindows()Check if the current os is Windows.- Returns:
- true if windows
-
streamToString
Read a stream and copy the content into a String using system line separators for all 'carriage return' characters.- Parameters:
inputStream
- the input stream- Returns:
- the string
-
createProcessBuilder
Creates a process builder for the given list of program and arguments. If the program is defined as an absolute path, then the directory that contains the program is also appended to PATH so that the it can locate related tools.- Parameters:
command
- a list with the program and arguments- Returns:
- a configured process builder
-
getIndexHtmlContent
public static String getIndexHtmlContent(com.vaadin.flow.server.VaadinService service) throws IOException Gets the content of thefrontend/index.html
file which is served by vite in dev-mode and read from classpath in production mode.NOTE: In dev mode, the file content is fetched using an http request so that we don't need to have a separate index.html's content watcher. Auto-reloading will work automatically, like other files in the `frontend/` folder.
- Parameters:
service
- the vaadin service- Returns:
- the content of the index html file as a string, null if not found.
- Throws:
IOException
- on error when reading file
-
getWebComponentHtmlContent
public static String getWebComponentHtmlContent(com.vaadin.flow.server.VaadinService service) throws IOException Gets the content of thefrontend/web-component.html
file which is served by vite in dev-mode and read from classpath in production mode.NOTE: In dev mode, the file content is fetched using an http request so that we don't need to have a separate web-component.html's content watcher. Auto-reloading will work automatically, like other files in the `frontend/` folder.
- Parameters:
service
- the vaadin service- Returns:
- the content of the web-component.html file as a string, null if not found.
- Throws:
IOException
- on error when reading file
-
getFrontendFileFromDevModeHandler
public static InputStream getFrontendFileFromDevModeHandler(com.vaadin.flow.server.VaadinService service, String path) Get the contents of a frontend file from the running dev server.- Parameters:
service
- the Vaadin service.path
- the file path.- Returns:
- an input stream for reading the file contents; null if there is no such file or the dev server is not running.
-
resolveFrontendPath
Looks up the frontend resource at the given path. If the path starts with./
, first look infrontend
, then in "jar-resources". If the path does not start with./
, look innode_modules
instead.- Parameters:
projectRoot
- the project root folder.path
- the file path.- Returns:
- an existing
File
, or null if the file doesn't exist.
-
resolveFrontendPath
Looks up the fronted resource at the given path. If the path starts with./
, first look infrontend
, then in "jar-resources". If the path does not start with./
, look innode_modules
instead.- Parameters:
projectRoot
- the project root folder.path
- the file path.frontendDirectory
- the frontend directory.- Returns:
- an existing
File
, or null if the file doesn't exist.
-
getJarResourceString
public static String getJarResourceString(String jarImport, com.vaadin.flow.server.frontend.scanner.ClassFinder finder) Get resource from JAR package.- Parameters:
jarImport
- jar file to get (no resource folder should be added)- Returns:
- resource as String or
null
if not found
-
getJarResourcesFolder
Get the front-end resources folder. This is where the contents of JAR dependencies are copied to.- Parameters:
frontendDirectory
- project's frontend directory- Returns:
- a
File
representing a folder with copied resources
-
getFrontendGeneratedFolder
-
getProjectFrontendDir
public static File getProjectFrontendDir(com.vaadin.flow.server.AbstractConfiguration configuration) Get directory where project's frontend files are located.- Parameters:
configuration
- the current deployment configuration- Returns:
DEFAULT_FRONTEND_DIR
or value ofPARAM_FRONTEND_DIR
if it is set.
-
getUnixRelativePath
Get relative path from a source path to a target path in Unix form. All the Windows' path separator will be replaced.- Parameters:
source
- the source pathtarget
- the target path- Returns:
- unix relative path from source to target
-
getUnixPath
Get path as a String in Unix form.- Parameters:
source
- path to get- Returns:
- path as a String in Unix form.
-
getVersion
protected static com.vaadin.flow.server.frontend.FrontendVersion getVersion(String tool, List<String> versionCommand) throws FrontendUtils.UnknownVersionException -
executeCommand
public static String executeCommand(List<String> command) throws FrontendUtils.CommandExecutionException Executes a given command as a native process.- Parameters:
command
- the command to be executed and it's arguments.- Returns:
- process output string.
- Throws:
FrontendUtils.CommandExecutionException
- if the process completes exceptionally.
-
consumeProcessStreams
public static CompletableFuture<com.vaadin.flow.internal.Pair<String,String>> consumeProcessStreams(Process process) Reads input and error stream from the give process asynchronously. The method returns aCompletableFuture
that is completed when both the streams are consumed. Streams are converted into strings and wrapped into aPair
, mapping input stream intoPair.getFirst()
and error stream intoPair.getSecond()
. This method should be mainly used to avoid thatProcess.waitFor()
hangs indefinitely on some operating systems because process streams are not consumed. See https://github.com/vaadin/flow/issues/15339 for an example case.- Parameters:
process
- the process whose streams should be read- Returns:
- a
CompletableFuture
that return the string contents of the process input and error streams when both are consumed, wrapped into aPair
.
-
parseFrontendVersion
public static com.vaadin.flow.server.frontend.FrontendVersion parseFrontendVersion(String versionString) throws IOException Parse the version number of node/npm from version output string.- Parameters:
versionString
- string containing version output, typically produced bytool --version
- Returns:
- FrontendVersion of versionString
- Throws:
IOException
- if parsing fails
-
getVaadinHomeDirectory
Gets vaadin home directory (".vaadin"
folder in the user home dir).The directory is created if it's doesn't exist.
- Returns:
- a vaadin home directory
-
commandToString
Pretty prints a command line order. It split in lines adapting to 80 columns, and allowing copy and paste in console. It also removes the current directory to avoid security issues in log files.- Parameters:
baseDir
- the current directorycommand
- the command and it's arguments- Returns:
- the string for printing in logs
-
getPackageVersionFromJson
public static com.vaadin.flow.server.frontend.FrontendVersion getPackageVersionFromJson(elemental.json.JsonObject sourceJson, String pkg, String versionOrigin) Tries to parse the given package's frontend version or if it doesn't exist, returnsnull
. In case the value cannot be parsed, logs an error and returnsnull
.- Parameters:
sourceJson
- json object that has the packagepkg
- the package nameversionOrigin
- origin of the version (like a file), used in error message- Returns:
- the frontend version the package or
null
-
console
Intentionally send to console instead to log, useful when executing external processes.- Parameters:
format
- Format of the line to send to console, it must contain a `%s` outlet for the messagemessage
- the string to show
-
console
- See Also:
-
console
-
logInFile
-
logInFile
-
getLogFile
-
deleteNodeModules
Try to remove thenode_modules
directory, if it exists inside the given base directory. Note that pnpm uses symlinks internally, so delete utilities that follow symlinks when deleting and/or modifying permissions may not work as intended.- Parameters:
nodeModules
- thenode_modules
directory- Throws:
IOException
- on failure to delete any one file, or if the directory name is notnode_modules
-
deleteDirectory
Recursively delete given directory and contents.Will not delete contents of symlink or junction directories, only the link file.
- Parameters:
directory
- directory to delete- Throws:
IOException
- on failure to delete or read any one file
-
getFrontendServletPath
Gets the servlet path (excluding the context path) for the servlet used for serving the VAADIN frontend bundle.- Returns:
- the path to the servlet used for the frontend bundle. Empty for a /* mapping, otherwise always starts with a slash but never ends with a slash
-
getFlowGeneratedFolder
Gets the folder where Flow generated frontend files are placed.- Parameters:
frontendFolder
- the project frontend folder- Returns:
- the folder for Flow generated files
-
getFlowGeneratedImports
Gets the location of the generated import file for Flow.- Parameters:
frontendFolder
- the project frontend folder- Returns:
- the location of the generated import JS file
-
getFlowGeneratedWebComponentsFolder
Gets the folder where exported web components are generated.- Parameters:
frontendFolder
- the project frontend folder- Returns:
- the exported web components folder
-
findFreePort
public static int findFreePort(int rangeStart, int rangeEnd) -
getResourceAsStream
-
getResource
-
getProjectBaseDir
public static File getProjectBaseDir(com.vaadin.flow.server.startup.ApplicationConfiguration configuration)
-