Class FrontendUtils

Field Detail

• PROJECT_BASEDIR

  public static final String PROJECT_BASEDIR

  See Also:

  Constant Field Values

• DEFAULT_NODE_DIR

  public static final String DEFAULT_NODE_DIR

  Default folder for the node related content. It's the base directory for Constants.PACKAGE_JSON, WEBPACK_CONFIG, NODE_MODULES. By default it's the project root folder.

  See Also:

  Constant Field Values

• NODE_MODULES

  public static final String NODE_MODULES

  Location for the installed node packages. This folder is always considered by node, even though we define extra folders with the NODE_PATH.

  See Also:

  Constant Field Values

• FRONTEND

  public static final String FRONTEND

  Default folder used for source and generated folders.

  See Also:

  Constant Field Values

• DEFAULT_FRONTEND_DIR

  public static final String DEFAULT_FRONTEND_DIR

  Path of the folder containing application frontend source files, it needs to be relative to the DEFAULT_NODE_DIR By default it is /frontend in the project folder.

  See Also:

  Constant Field Values

• WEBPACK_CONFIG

  public static final String WEBPACK_CONFIG

  The name of the webpack configuration file.

  See Also:

  Constant Field Values

• WEBPACK_GENERATED

  public static final String WEBPACK_GENERATED

  The name of the webpack generated configuration file.

  See Also:

  Constant Field Values

• FLOW_NPM_PACKAGE_NAME

  public static final String FLOW_NPM_PACKAGE_NAME

  The NPM package name that will be used for the javascript files present in jar resources that will to be copied to the npm folder so as they are accessible to webpack.

  See Also:

  Constant Field Values

• TARGET

  public static final String TARGET

  Default target folder for the java project.

  See Also:

  Constant Field Values

• DEFAULT_GENERATED_DIR

  public static final String DEFAULT_GENERATED_DIR

  Default folder name for flow generated stuff relative to the TARGET.

  See Also:

  Constant Field Values

• IMPORTS_NAME

  public static final String IMPORTS_NAME

  Name of the file that contains application imports, javascript, theme and style annotations. It is also the entry-point for webpack. It is always generated in the DEFAULT_GENERATED_DIR folder.

  See Also:

  Constant Field Values

• FALLBACK_IMPORTS_NAME

  public static final String FALLBACK_IMPORTS_NAME

  Name of the file that contains all application imports, javascript, theme and style annotations which are not discovered by the current scanning strategy (but they are in the project classpath). This file is dynamically imported by the IMPORTS_NAME file. It is always generated in the DEFAULT_GENERATED_DIR folder.

  See Also:

  Constant Field Values

• PARAM_GENERATED_DIR

  public static final String PARAM_GENERATED_DIR

  A parameter for overriding the DEFAULT_GENERATED_DIR folder.

  See Also:

  Constant Field Values

• PARAM_FRONTEND_DIR

  public static final String PARAM_FRONTEND_DIR

  A parameter for overriding the DEFAULT_FRONTEND_DIR folder.

  See Also:

  Constant Field Values

• PARAM_IGNORE_VERSION_CHECKS

  public static final String PARAM_IGNORE_VERSION_CHECKS

  Set to true to ignore node/npm tool version checks.

  See Also:

  Constant Field Values

• WEBPACK_PREFIX_ALIAS

  public static final String WEBPACK_PREFIX_ALIAS

  A special prefix used by webpack to map imports placed in the DEFAULT_FRONTEND_DIR. e.g. import 'Frontend/foo.js'; references the filefrontend/foo.js.

  See Also:

  Constant Field Values

• TOKEN_FILE

  public static final String TOKEN_FILE

  File used to enable npm mode.

  See Also:

  Constant Field Values

• CHUNKS

  public static final String CHUNKS

  A key in a Json object for chunks list.

  See Also:

  Constant Field Values

• FALLBACK

  public static final String FALLBACK

  A key in a Json object for fallback chunk.

  See Also:

  Constant Field Values

• CSS_IMPORTS

  public static final String CSS_IMPORTS

  A key in a Json object for css imports data.

  See Also:

  Constant Field Values

• JS_MODULES

  public static final String JS_MODULES

  A key in a Json object for js modules data.

  See Also:

  Constant Field Values

• PARAM_TOKEN_FILE

  public static final String PARAM_TOKEN_FILE

  A parameter informing about the location of the TOKEN_FILE.

  See Also:

  Constant Field Values

• INSTALL_NODE_LOCALLY

  public static final String INSTALL_NODE_LOCALLY

  See Also:

  Constant Field Values

• DISABLE_CHECK

  public static final String DISABLE_CHECK

  See Also:

  Constant Field Values

Method Detail

• getOsName

  public static String getOsName()

  Get the Operating System name from the os.name system property.

  Returns:

  operating system name

• isWindows

  public static boolean isWindows()

  Check if the current os is Windows.

  Returns:

  true if windows

• getNodeExecutable

  public static String getNodeExecutable(String baseDir)

  Locate node executable.

  Parameters:

  baseDir - project root folder.

  Returns:

  the full path to the executable

• getNpmExecutable

  public static List<String> getNpmExecutable(String baseDir)

  Locate npm executable.

  Parameters:

  baseDir - project root folder.

  Returns:

  the list of all commands in sequence that need to be executed to have npm running

• getBowerExecutable

  public static List<String> getBowerExecutable(String baseDir)

  Locate bower executable.

  An empty list is returned if bower is not found

  Parameters:

  baseDir - project root folder.

  Returns:

  the list of all commands in sequence that need to be executed to have bower running, an empty list if bower is not found

• streamToString

  public static String streamToString(InputStream inputStream)

  Read a stream and copy the content in a String.

  Parameters:

  inputStream - the input stream

  Returns:

  the string

• createProcessBuilder

  public static ProcessBuilder createProcessBuilder(List<String> command)

  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

• getStatsContent

  public static String getStatsContent(VaadinService service)
                                throws IOException

  Gets the content of the stats.json file produced by webpack.

  Parameters:

  service - the vaadin service.

  Returns:

  the content of the file as a string, null if not found.

  Throws:

  IOException - on error reading stats file.

• getStatsHash

  public static String getStatsHash(VaadinService service)
                             throws IOException

  Get the latest has for the stats file in development mode. This is requested from the webpack-dev-server.

  In production mode and disabled dev server mode an empty string is returned.

  Parameters:

  service - the Vaadin service.

  Returns:

  hash string for the stats.json file, empty string if none found

  Throws:

  IOException - if an I/O error occurs while creating the input stream.

• getStatsAssetsByChunkName

  public static String getStatsAssetsByChunkName(VaadinService service)
                                          throws IOException

  Load the asset chunks from stats.json. We will only read the file until we have reached the assetsByChunkName json and return that as a json object string.

  Parameters:

  service - the Vaadin service.

  Returns:

  json for assetsByChunkName object in stats.json

  Throws:

  IOException - if an I/O error occurs while creating the input stream.

• validateNodeAndNpmVersion

  public static void validateNodeAndNpmVersion(String baseDir)

  Validate that the found node and npm versions are new enough. Throws an exception with a descriptive message if a version is too old.

  Parameters:

  baseDir - project root folder.

• isWebpackConfigFile

  public static boolean isWebpackConfigFile(File file)
                                     throws IOException

  Checks whether the file is a webpack configuration file with the expected content (includes a configuration generated by Flow).

  Parameters:

  file - a file to check

  Returns:

  true iff the file exists and includes a generated configuration

  Throws:

  IOException - if an I/O error occurs while reading the file

• readFallbackChunk

  public static FallbackChunk readFallbackChunk(elemental.json.JsonObject object)

  Read fallback chunk data from a json object.

  Parameters:

  object - json object to read fallback chunk data

  Returns:

  a fallback chunk data