Skip to content

Avoid unnecessary Gradle re-synch on restart #1485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2020
Merged

Avoid unnecessary Gradle re-synch on restart #1485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 45 additions & 38 deletions ...ipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/managers/GradleProjectImporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
import java.io.FilenameFilter;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Properties;

import org.apache.commons.lang3.StringUtils;
import org.eclipse.buildship.core.BuildConfiguration;
import org.eclipse.buildship.core.GradleCore;
import org.eclipse.buildship.core.GradleDistribution;
Expand All @@ -44,6 +44,7 @@
import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
import org.eclipse.jdt.ls.core.internal.ProjectUtils;
import org.eclipse.jdt.ls.core.internal.preferences.PreferenceManager;
import org.eclipse.jdt.ls.core.internal.preferences.Preferences;
import org.eclipse.jdt.ls.internal.gradle.checksums.ValidationResult;
import org.eclipse.jdt.ls.internal.gradle.checksums.WrapperValidator;
import org.eclipse.lsp4j.ExecuteCommandParams;
Expand All @@ -54,6 +55,7 @@
* @author Fred Bricon
*
*/
@SuppressWarnings("restriction")
public class GradleProjectImporter extends AbstractProjectImporter {

public static final String GRADLE_HOME = "GRADLE_HOME";
Expand Down Expand Up @@ -87,14 +89,15 @@ public boolean applies(IProgressMonitor monitor) throws CoreException {
if (rootFolder == null) {
return false;
}
PreferenceManager preferencesManager = JavaLanguageServerPlugin.getPreferencesManager();
if (preferencesManager != null && !preferencesManager.getPreferences().isImportGradleEnabled()) {
Preferences preferences = getPreferences();
if (!preferences.isImportGradleEnabled()) {
return false;
}
if (directories == null) {
BasicFileDetector gradleDetector = new BasicFileDetector(rootFolder.toPath(), BUILD_GRADLE_DESCRIPTOR)
.includeNested(false)
.addExclusions("**/build");//default gradle build dir
.addExclusions("**/build")//default gradle build dir
.addExclusions("**/bin");
directories = gradleDetector.scan(monitor);
}
return !directories.isEmpty();
Expand All @@ -117,16 +120,18 @@ public void importToWorkspace(IProgressMonitor monitor) throws CoreException {
subMonitor.done();
}

private void importDir(Path rootFolder, IProgressMonitor monitor) {
private void importDir(Path projectFolder, IProgressMonitor monitor) {
if (monitor.isCanceled()) {
return;
}
startSynchronization(rootFolder, monitor);
startSynchronization(projectFolder, monitor);
}


public static GradleDistribution getGradleDistribution(Path rootFolder) {
PreferenceManager preferencesManager = JavaLanguageServerPlugin.getPreferencesManager();
if (preferencesManager != null && preferencesManager.getPreferences().isGradleWrapperEnabled() && Files.exists(rootFolder.resolve("gradlew"))) {
Preferences preferences = getPreferences();
if (preferencesManager != null && preferences.isGradleWrapperEnabled() && Files.exists(rootFolder.resolve("gradlew"))) {
WrapperValidator validator = new WrapperValidator();
try {
ValidationResult result = validator.checkWrapper(rootFolder.toFile().getAbsolutePath());
Expand All @@ -143,7 +148,8 @@ public static GradleDistribution getGradleDistribution(Path rootFolder) {
pm.getConnection().sendNotification(params);
} else {
//@formatter:off
String message = GRADLE_WRAPPER_CHEKSUM_WARNING_TEMPLATE.replaceAll("@wrapper@", result.getWrapperJar()).replaceAll("@checksum@", result.getChecksum());
String message = GRADLE_WRAPPER_CHEKSUM_WARNING_TEMPLATE.replaceAll("@wrapper@", result.getWrapperJar())
.replaceAll("@checksum@", result.getChecksum());
//@formatter:on
pm.getConnection().showMessage(new MessageParams(MessageType.Error, message));
}
Expand All @@ -154,10 +160,10 @@ public static GradleDistribution getGradleDistribution(Path rootFolder) {
JavaLanguageServerPlugin.logException(e.getMessage(), e);
}
}
if (preferencesManager != null && preferencesManager.getPreferences().getGradleVersion() != null) {
if (StringUtils.isNotBlank(preferences.getGradleVersion())) {
List<GradleVersion> versions = CorePlugin.publishedGradleVersions().getVersions();
GradleVersion gradleVersion = null;
String versionString = preferencesManager.getPreferences().getGradleVersion();
String versionString = preferences.getGradleVersion();
GradleVersion requiredVersion = GradleVersion.version(versionString);
for (GradleVersion version : versions) {
if (version.compareTo(requiredVersion) == 0) {
Expand All @@ -184,8 +190,9 @@ public static File getGradleHomeFile() {
}

public static File getGradleHomeFile(Map<String, String> env, Properties sysprops) {
if (JavaLanguageServerPlugin.getPreferencesManager() != null && JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getGradleHome() != null) {
return new File(JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getGradleHome());
Preferences preferences = getPreferences();
if (StringUtils.isNotBlank(preferences.getGradleHome())) {
return new File(preferences.getGradleHome());
}
String gradleHome = env.get(GRADLE_HOME);
if (gradleHome == null || !new File(gradleHome).isDirectory()) {
Expand All @@ -201,9 +208,9 @@ public static File getGradleHomeFile(Map<String, String> env, Properties sysprop
}

public static File getGradleUserHomeFile() {
if (JavaLanguageServerPlugin.getPreferencesManager() != null && JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getGradleUserHome() != null
&& !JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getGradleUserHome().isEmpty()) {
return new File(JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getGradleUserHome());
Preferences preferences = getPreferences();
if (StringUtils.isNotBlank(preferences.getGradleUserHome())) {
return new File(preferences.getGradleUserHome());
}
String gradleUserHome = System.getenv().get(GRADLE_USER_HOME);
if (gradleUserHome == null) {
Expand All @@ -212,19 +219,11 @@ public static File getGradleUserHomeFile() {
return (gradleUserHome == null || gradleUserHome.isEmpty()) ? null : new File(gradleUserHome);
}

protected void startSynchronization(Path rootFolder, IProgressMonitor monitor) {
File location = rootFolder.toFile();
protected void startSynchronization(Path projectFolder, IProgressMonitor monitor) {
File location = projectFolder.toFile();
boolean shouldSynchronize = shouldSynchronize(location);
List<IProject> projects = ProjectUtils.getGradleProjects();
for (IProject project : projects) {
File projectDir = project.getLocation() == null ? null : project.getLocation().toFile();
if (location.equals(projectDir)) {
shouldSynchronize = checkGradlePersistence(shouldSynchronize, project, projectDir);
break;
}
}
if (shouldSynchronize) {
BuildConfiguration build = getBuildConfiguration(rootFolder);
BuildConfiguration build = getBuildConfiguration(projectFolder);
SynchronizationResult result = GradleCore.getWorkspace().createBuild(build).synchronize(monitor);
if (!result.getStatus().isOK()) {
JavaLanguageServerPlugin.log(result.getStatus());
Expand All @@ -236,16 +235,17 @@ public static BuildConfiguration getBuildConfiguration(Path rootFolder) {
GradleDistribution distribution = getGradleDistribution(rootFolder);
IVMInstall javaDefaultRuntime = JavaRuntime.getDefaultVMInstall();
File javaHome;
Preferences preferences = getPreferences();
if (javaDefaultRuntime != null && javaDefaultRuntime.getVMRunner(ILaunchManager.RUN_MODE) != null) {
javaHome = javaDefaultRuntime.getInstallLocation();
} else {
String javaHomeStr = JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getJavaHome();
String javaHomeStr = preferences.getJavaHome();
javaHome = javaHomeStr == null ? null : new File(javaHomeStr);
}
File gradleUserHome = getGradleUserHomeFile();
List<String> gradleArguments = JavaLanguageServerPlugin.getPreferencesManager() != null ? JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getGradleArguments() : new ArrayList<>();
List<String> gradleJvmArguments = JavaLanguageServerPlugin.getPreferencesManager() != null ? JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getGradleJvmArguments() : new ArrayList<>();
boolean offlineMode = JavaLanguageServerPlugin.getPreferencesManager() != null ? JavaLanguageServerPlugin.getPreferencesManager().getPreferences().isImportGradleOfflineEnabled() : false;
List<String> gradleArguments = preferences.getGradleArguments();
List<String> gradleJvmArguments = preferences.getGradleJvmArguments();
boolean offlineMode = preferences.isImportGradleOfflineEnabled();
boolean overrideWorkspaceConfiguration = !(distribution instanceof WrapperGradleDistribution) || offlineMode || (gradleArguments != null && !gradleArguments.isEmpty()) || (gradleJvmArguments != null && !gradleJvmArguments.isEmpty())
|| gradleUserHome != null || javaHome != null;
// @formatter:off
Expand All @@ -263,22 +263,25 @@ public static BuildConfiguration getBuildConfiguration(Path rootFolder) {
}

public static boolean shouldSynchronize(File location) {
boolean shouldSynchronize = true;
List<IProject> projects = ProjectUtils.getGradleProjects();
for (IProject project : projects) {
for (IProject project : ProjectUtils.getGradleProjects()) {
File projectDir = project.getLocation() == null ? null : project.getLocation().toFile();
if (location.equals(projectDir)) {
shouldSynchronize = checkGradlePersistence(shouldSynchronize, project, projectDir);
break;
boolean shouldSynchronize = checkGradlePersistence(project, projectDir);
if (shouldSynchronize) {
JavaLanguageServerPlugin.logInfo(project.getName() + " was modified since last time the workspace was opened, must be synchronized");
}
return shouldSynchronize;
}
}
return shouldSynchronize;
JavaLanguageServerPlugin.logInfo("No previous Gradle project at " + location + ", it must be synchronized");
return true;
}

private static boolean checkGradlePersistence(boolean shouldSynchronize, IProject project, File projectDir) {
if (!ProjectUtils.isJavaProject(project) || !project.getFile(IJavaProject.CLASSPATH_FILE_NAME).exists()) {
private static boolean checkGradlePersistence(IProject project, File projectDir) {
if (ProjectUtils.isJavaProject(project) && !project.getFile(IJavaProject.CLASSPATH_FILE_NAME).exists()) {
return true;
}
boolean shouldSynchronize = true;
PersistentModel model = CorePlugin.modelPersistence().loadModel(project);
if (model.isPresent()) {
File persistentFile = CorePlugin.getInstance().getStateLocation().append("project-preferences").append(project.getName()).toFile();
Expand Down Expand Up @@ -306,4 +309,8 @@ public boolean accept(File dir, String name) {
public void reset() {
}

private static Preferences getPreferences() {
return (JavaLanguageServerPlugin.getPreferencesManager() == null || JavaLanguageServerPlugin.getPreferencesManager().getPreferences() == null) ? new Preferences() : JavaLanguageServerPlugin.getPreferencesManager().getPreferences();
}

}
8 changes: 8 additions & 0 deletions org.eclipse.jdt.ls.tests/projects/gradle/nested/gradle3/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/*
* This build file was auto generated by running the Gradle 'init' task
* by 'fbricon' at '24/10/16 11:28' with Gradle 3.0
*
* This generated file contains a sample Java project to get you started.
* For more details take a look at the Java Quickstart chapter in the Gradle
* user guide available at https://docs.gradle.org/3.0/userguide/tutorial_java_projects.html
*/
183 changes: 183 additions & 0 deletions org.eclipse.jdt.ls.tests/projects/gradle/nested/gradle3/gradlew
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
#!/usr/bin/env sh

#
# Copyright 2015 the original author or authors.
#
# 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
#
# https://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.
#

##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################

# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null

APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"

warn () {
echo "$*"
}

die () {
echo
echo "$*"
echo
exit 1
}

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar

# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME

Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.

Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi

# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi

# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`

# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option

if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=`expr $i + 1`
done
case $i in
0) set -- ;;
1) set -- "$args0" ;;
2) set -- "$args0" "$args1" ;;
3) set -- "$args0" "$args1" "$args2" ;;
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi

# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=`save "$@"`

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"

exec "$JAVACMD" "$@"
Loading