Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2000-2020 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.migration;
import java.io.File;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.commons.io.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.vaadin.flow.server.frontend.FrontendTools;
import com.vaadin.flow.server.frontend.FrontendUtils;
import elemental.json.Json;
import elemental.json.JsonObject;
import elemental.json.JsonValue;
/**
* Migrates resource (template and CSS) files from provided directories and Java
* source files from V13 to V14.
*
* @author Vaadin Ltd
* @since 2.0
*/
public class Migration {
private static final String DEPENDENCIES = "dependencies";
private final File tempMigrationFolder;
private final File targetDirectory;
private final File[] resourceDirectories;
private final MigrationConfiguration configuration;
private FrontendTools tools;
/**
* Creates an instance with given {@code configuration} to migrate.
*
* @param configuration
* configuration to do migration
*/
public Migration(MigrationConfiguration configuration) {
this.configuration = configuration;
if (getTempMigrationFolder() == null) {
if (configuration.getTempMigrationFolder() != null) {
tempMigrationFolder = configuration.getTempMigrationFolder();
} else {
try {
tempMigrationFolder = Files.createTempDirectory("migration")
.toFile();
} catch (IOException e) {
throw new RuntimeException("Could not create a new "
+ "temporary folder for migration. You may specify it manually");
}
}
} else {
if (!getTempMigrationFolder().isDirectory()) {
String message = String.format(
"Received temp migration folder value '%s' is not a directory.",
getTempMigrationFolder());
throw new IllegalArgumentException(message);
} else if (getTempMigrationFolder().list().length > 0) {
String message = String.format(
"Received non empty directory '%s' for use as the temporary migration folder.",
getTempMigrationFolder());
throw new IllegalArgumentException(message);
}
tempMigrationFolder = getTempMigrationFolder();
}
if (configuration.getBaseDirectory() == null) {
throw new IllegalArgumentException(
"Configuration does not provide a base directory");
}
if (configuration.getResourceDirectories() != null
&& configuration.getResourceDirectories().length == 0) {
throw new IllegalArgumentException(
"Configuration does not provide any resource directories");
} else if (configuration.getResourceDirectories() == null) {
resourceDirectories = new File[] { new File(
configuration.getBaseDirectory(), "src/main/webapp") };
} else {
resourceDirectories = configuration.getResourceDirectories();
}
if (configuration.getTargetDirectory() == null) {
targetDirectory = new File(configuration.getBaseDirectory(),
"frontend");
} else {
targetDirectory = configuration.getTargetDirectory();
}
if (configuration.getClassFinder() == null) {
throw new IllegalArgumentException(
"Configuration does not provide a class finder");
}
if (configuration.getJavaSourceDirectories() == null
|| configuration.getJavaSourceDirectories().length == 0) {
throw new IllegalArgumentException(
"Configuration does not provide any java source directories");
}
if (configuration.getCompiledClassDirectory() == null) {
throw new IllegalArgumentException(
"Configuration does not provide a compiled class directory");
}
tools = new FrontendTools(configuration.getBaseDirectory().getPath(),
() -> FrontendUtils.getVaadinHomeDirectory().getAbsolutePath());
}
/**
* Performs the migration.
*
* @throws MigrationToolsException
* Thrown when migration tools are missing
* @throws MigrationFailureException
* Thrown for an exception during migration
*/
public void migrate()
throws MigrationToolsException, MigrationFailureException {
prepareMigrationDirectory();
FrontendTools bowerTools = new FrontendTools(
getTempMigrationFolder().getPath(),
() -> FrontendUtils.getVaadinHomeDirectory().getAbsolutePath());
List bowerCommands = bowerTools.getBowerExecutable();
boolean needInstallBower = bowerCommands.isEmpty();
if (!ensureTools(needInstallBower)) {
throw new MigrationToolsException(
"Could not install tools required for migration (bower or modulizer)");
}
if (needInstallBower) {
bowerCommands = bowerTools.getBowerExecutable();
}
if (bowerCommands.isEmpty()) {
throw new MigrationToolsException(
"Could not locate bower. Install it manually on your system and re-run migration goal.");
}
Set externalComponents;
CopyResourcesStep copyStep = new CopyResourcesStep(
getTempMigrationFolder(), getResources());
Map> paths;
try {
paths = copyStep.copyResources();
externalComponents = copyStep.getBowerComponents();
} catch (IOException exception) {
throw new UncheckedIOException(
"Couldn't copy resources from source directories "
+ Arrays.asList(getResources())
+ " to the target directory "
+ getTempMigrationFolder(),
exception);
}
Set migratedTopLevelDirs = Stream
.of(getTempMigrationFolder().listFiles())
.filter(File::isDirectory).map(File::getName)
.collect(Collectors.toSet());
List allPaths = new ArrayList<>();
paths.values().stream().forEach(allPaths::addAll);
try {
new CreateMigrationJsonsStep(getTempMigrationFolder())
.createJsons(allPaths);
} catch (IOException exception) {
throw new UncheckedIOException("Couldn't generate json files",
exception);
}
if (!saveBowerComponents(bowerCommands, externalComponents)) {
throw new MigrationFailureException(
"Could not install bower components");
}
installNpmPackages();
boolean modulizerHasErrors = false;
if (!runModulizer()) {
modulizerHasErrors = true;
if (configuration.isIgnoreModulizerErrors()) {
getLogger().info("Modulizer has exited with error");
} else {
throw new MigrationFailureException(
"Modulizer has exited with error. Unable to proceed.");
}
}
// copy the result JS files into target dir ("frontend")
if (!getTargetDirectory().exists()) {
try {
FileUtils.forceMkdir(getTargetDirectory());
} catch (IOException exception) {
throw new UncheckedIOException(
"Unable to create a target folder for migrated files: '"
+ getTargetDirectory() + "'",
exception);
}
}
CopyMigratedResourcesStep copyMigratedStep = new CopyMigratedResourcesStep(
getTargetDirectory(), getTempMigrationFolder(),
migratedTopLevelDirs);
try {
copyMigratedStep.copyResources();
} catch (IOException exception) {
throw new UncheckedIOException(
"Couldn't copy migrated resources to the target directory "
+ getTargetDirectory(),
exception);
}
try {
FileUtils.forceDelete(getTempMigrationFolder());
} catch (IOException exception) {
getLogger().debug(
"Couldn't remove " + getTempMigrationFolder().getPath(),
exception);
}
if (!modulizerHasErrors && !configuration.isKeepOriginalFiles()) {
removeOriginalResources(paths);
}
switch (configuration.getAnnotationRewriteStrategy()) {
case SKIP:
break;
case ALWAYS:
rewrite();
break;
case SKIP_ON_ERROR:
if (!modulizerHasErrors) {
rewrite();
}
break;
}
}
/**
* Prepare migration by cleaning everything, except if only node_modules
* exists in the target directory.
*/
protected void prepareMigrationDirectory() {
if (getTempMigrationFolder().exists()) {
try {
FileUtils.forceDelete(getTempMigrationFolder());
} catch (IOException exception) {
String message = String.format(
"Unable to delete directory '%s'",
getTempMigrationFolder());
throw new UncheckedIOException(message, exception);
}
}
try {
FileUtils.forceMkdir(getTempMigrationFolder());
} catch (IOException exception) {
String message = String.format(
"Failed in creating migration folder '%s'",
getTempMigrationFolder());
throw new UncheckedIOException(message, exception);
}
}
private void removeOriginalResources(Map> paths) {
for (Entry> entry : paths.entrySet()) {
File resourceFolder = new File(entry.getKey());
entry.getValue()
.forEach(path -> new File(resourceFolder, path).delete());
}
}
private void installNpmPackages() throws MigrationFailureException {
List npmExec = getFrontendInstallToolExec();
List npmInstall = new ArrayList<>(npmExec.size());
npmInstall.addAll(npmExec);
npmInstall.add("i");
if (!executeProcess(npmInstall, "Couldn't install packages using npm",
"Packages successfully installed",
"Error when running `npm install`")) {
throw new MigrationFailureException(
"Error during package installation via npm");
}
}
private List getFrontendInstallToolExec() {
List executable;
if (configuration.isPnpmEnabled()) {
executable = tools.getPnpmExecutable();
} else {
executable = tools.getNpmExecutable();
}
return executable;
}
private boolean runModulizer() {
Collection depMapping = makeDependencyMapping();
List command = new ArrayList<>();
command.add(tools.getNodeExecutable());
command.add("node_modules/polymer-modulizer/bin/modulizer.js");
command.add("--force");
command.add("--out");
command.add(".");
command.add("--import-style=name");
if (!depMapping.isEmpty()) {
command.add("--dependency-mapping");
command.addAll(depMapping);
}
return executeProcess(command, "Migration has finished with errors",
"Modulizer has completed successfully",
"Error when running moulizer");
}
private Collection makeDependencyMapping() {
File bower = new File(getTempMigrationFolder(), "bower.json");
try {
Set result = new HashSet<>();
String content = Files.readAllLines(bower.toPath()).stream()
.collect(Collectors.joining("\n"));
JsonObject object = Json.parse(content);
if (object.hasKey(DEPENDENCIES)) {
JsonObject deps = object.getObject(DEPENDENCIES);
Stream.of(deps.keys()).filter(key -> key.startsWith("vaadin-"))
.forEach(key -> result
.add(makeVaadinDependencyMapping(deps, key)));
}
return result;
} catch (IOException exception) {
throw new UncheckedIOException("Unable to read bower.json",
exception);
}
}
private String makeVaadinDependencyMapping(JsonObject deps, String key) {
JsonValue version = deps.get(key);
StringBuilder builder = new StringBuilder(key);
builder.append(',');
builder.append("@vaadin/");
builder.append(key).append(',');
builder.append(version.asString());
return builder.toString();
}
private boolean saveBowerComponents(List bowerCommands,
Collection components) {
List command = new ArrayList<>();
command.addAll(bowerCommands);
// install
command.add("i");
// -F option means: Force latest version on conflict
command.add("-F");
// disable interactive mode
command.add("--config.interactive=false");
// -S option means: Save installed packages into the project’s
// bower.json dependencies
command.add("-S");
// add all extracted bower components to install them and save
// the latest polymer version which is chosen by bower has only JS
// module file. It won't be resolved from the import properly. So we
// have to force 2.x.x version which is P2 based.
command.add("polymer#2.8.0");
components.stream().filter(component -> !"polymer".equals(component))
.forEach(command::add);
return executeProcess(command,
"Couldn't install and save bower components",
"All components are installed and saved successfully",
"Error when running `bower install`");
}
private boolean ensureTools(boolean needInstallBower) {
List command = new ArrayList<>();
command.addAll(getFrontendInstallToolExec());
command.add("install");
if (needInstallBower) {
command.add("bower");
}
command.add("polymer-modulizer");
return executeProcess(command, "Couldn't install migration tools",
"Bower is installed successfully",
"Error when running `npm install`");
}
protected boolean executeProcess(List command, String errorMsg,
String successMsg, String exceptionMsg) {
ProcessBuilder builder = FrontendUtils.createProcessBuilder(command);
builder.directory(getTempMigrationFolder());
builder.environment().put("NO_UPDATE_NOTIFIER", "1");
Process process = null;
try {
process = builder.inheritIO().start();
int errorCode = process.waitFor();
if (errorCode != 0) {
getLogger().error(errorMsg);
return false;
} else {
getLogger().debug(successMsg);
}
} catch (InterruptedException | IOException e) {
getLogger().error(exceptionMsg, e);
return false;
} finally {
if (process != null) {
process.destroyForcibly();
}
}
return true;
}
private Logger getLogger() {
return LoggerFactory.getLogger(Migration.class);
}
private File[] getResources() {
if (getResourceDirectories() == null) {
File webApp = new File(configuration.getBaseDirectory(),
"src/main/webapp");
return new File[] { webApp };
}
return getResourceDirectories();
}
private void rewrite() {
RewriteLegacyAnnotationsStep step = new RewriteLegacyAnnotationsStep(
configuration.getCompiledClassDirectory(),
configuration.getClassFinder(),
Stream.of(configuration.getJavaSourceDirectories())
.collect(Collectors.toList()));
step.rewrite();
}
private File getTempMigrationFolder() {
return tempMigrationFolder;
}
private File getTargetDirectory() {
return targetDirectory;
}
private File[] getResourceDirectories() {
return resourceDirectories;
}
}
