Spring/spring-tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Boot version validation progress and error reporting

Browse Source
This commit is contained in:
aboyko
2023-10-10 16:14:23 -04:00
parent 1dfba38500
commit 8ef70e9e01
10 changed files with 168 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
headless-services/commons/commons-language-server/src/main/java/org/springframework/ide/vscode/commons/languageserver/MessageService.java Normal file
View File

@@ -0,0 +1,23 @@
/*******************************************************************************
* Copyright (c) 2023 VMware, Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* VMware, Inc. - initial API and implementation
*******************************************************************************/
package org.springframework.ide.vscode.commons.languageserver;
public interface MessageService {
void error(String message);
void warning(String message);
void info(String message);
void log(String message);
}

8
headless-services/commons/commons-language-server/src/main/java/org/springframework/ide/vscode/commons/languageserver/Sts4LanguageServer.java
View File

@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2017 Pivotal, Inc.
* Copyright (c) 2017, 2023 Pivotal, Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -39,5 +39,11 @@ public interface Sts4LanguageServer extends LanguageServer {
* @return
*/
DiagnosticService getDiagnosticService();
/**
* Message Service to show various string messages in the IDE client UI
* @return message service instance
*/
MessageService getMessageService();
}

33
headless-services/commons/commons-language-server/src/main/java/org/springframework/ide/vscode/commons/languageserver/util/SimpleLanguageServer.java
View File

@@ -79,6 +79,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.ide.vscode.commons.languageserver.DiagnosticService;
import org.springframework.ide.vscode.commons.languageserver.MessageService;
import org.springframework.ide.vscode.commons.languageserver.ProgressService;
import org.springframework.ide.vscode.commons.languageserver.Sts4LanguageServer;
import org.springframework.ide.vscode.commons.languageserver.completion.ICompletionEngine;
@@ -201,6 +202,33 @@ public final class SimpleLanguageServer implements Sts4LanguageServer, SpringInd
}
}
};
private MessageService messageService = new MessageService() {
@Override
public void warning(String message) {
message(MessageType.Warning, message);
}
@Override
public void log(String message) {
message(MessageType.Log, message);
}
@Override
public void info(String message) {
message(MessageType.Info, message);
}
@Override
public void error(String message) {
message(MessageType.Error, message);
}
private void message(MessageType messageType, String message) {
getClient().showMessage(new MessageParams(messageType, message));
}
};
private DiagnosticService diagnosticService = message -> onError(null, message);
@@ -858,6 +886,11 @@ public final class SimpleLanguageServer implements Sts4LanguageServer, SpringInd
public ProgressService getProgressService() {
return progressService;
}
@Override
public MessageService getMessageService() {
return messageService;
}
public void setTestListener(LanguageServerTestListener languageServerTestListener) {
Assert.isLegal(this.testListener==null);

4
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/app/BootVersionValidationConfig.java
View File

@@ -50,8 +50,8 @@ public class BootVersionValidationConfig {
return new GenerationsValidator(server.getDiagnosticSeverityProvider(), projectsProvider);
}
@Bean ProjectVersionDiagnosticProvider projectVersionDiagnosticProvider(List<VersionValidator> validators) {
return new ProjectVersionDiagnosticProvider(validators);
@Bean ProjectVersionDiagnosticProvider projectVersionDiagnosticProvider(SimpleLanguageServer server, List<VersionValidator> validators) {
return new ProjectVersionDiagnosticProvider(server.getProgressService(), server.getMessageService(), validators);
}
@ConditionalOnMissingClass("org.springframework.ide.vscode.languageserver.testharness.LanguageServerHarness")

11
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/validation/generations/AbstractDiagnosticValidator.java
View File

@@ -19,6 +19,7 @@ import org.eclipse.lsp4j.Position;
import org.eclipse.lsp4j.Range;
import org.springframework.ide.vscode.boot.validation.generations.preferences.VersionValidationProblemType;
import org.springframework.ide.vscode.commons.languageserver.reconcile.DiagnosticSeverityProvider;
import org.springframework.ide.vscode.commons.languageserver.reconcile.ProblemType;
abstract public class AbstractDiagnosticValidator implements VersionValidator {
@@ -69,4 +70,14 @@ abstract public class AbstractDiagnosticValidator implements VersionValidator {
protected Diagnostic createDiagnostic(VersionValidationProblemType problemType, String diagnosticMessage) {
return createDiagnostic(null, problemType, diagnosticMessage);
}
protected boolean isEnabled(ProblemType... problemTypes) {
for (ProblemType problemType : problemTypes) {
DiagnosticSeverity severity = diagnosticSeverityProvider.getDiagnosticSeverity(problemType);
if (severity != null) {
return true;
}
}
return false;
}
}

34
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/validation/generations/GenerationsValidator.java
View File

@@ -21,7 +21,6 @@ import org.springframework.ide.vscode.commons.Version;
import org.springframework.ide.vscode.commons.java.IJavaProject;
import org.springframework.ide.vscode.commons.java.SpringProjectUtil;
import org.springframework.ide.vscode.commons.languageserver.reconcile.DiagnosticSeverityProvider;
import org.springframework.ide.vscode.commons.util.Assert;
import com.google.common.collect.ImmutableList;
@@ -54,7 +53,6 @@ public class GenerationsValidator extends AbstractDiagnosticValidator {
public Collection<Diagnostic> validate(IJavaProject javaProject, Version javaProjectVersion) throws Exception {
ResolvedSpringProject springProject = provider.getProject(SpringProjectUtil.SPRING_BOOT);
Generation javaProjectGen = getGenerationForJavaProject(javaProject, springProject);
Assert.isLegal(javaProjectGen != null, "Unable to find Spring Project Generation for project: " + javaProjectVersion.toString());
ImmutableList.Builder<Diagnostic> b = ImmutableList.builder();
if (VersionValidationUtils.isOssValid(javaProjectGen)) {
@@ -70,9 +68,14 @@ public class GenerationsValidator extends AbstractDiagnosticValidator {
} else {
StringBuilder message = new StringBuilder();
message.append("OSS support for Spring Boot ");
message.append(javaProjectGen.getName());
message.append(" no longer available, ended on: ");
message.append(javaProjectGen.getOssSupportEndDate());
if (javaProjectGen == null) {
message.append(javaProjectVersion);
message.append(" not available!");
} else {
message.append(javaProjectGen.getName());
message.append(" no longer available, ended on: ");
message.append(javaProjectGen.getOssSupportEndDate());
}
Diagnostic d = createDiagnostic(VersionValidationProblemType.UNSUPPORTED_OSS_VERSION, message.toString());
if (d != null) {
b.add(d);
@@ -92,9 +95,14 @@ public class GenerationsValidator extends AbstractDiagnosticValidator {
} else {
StringBuilder message = new StringBuilder();
message.append("Commercial support for Spring Boot ");
message.append(javaProjectGen.getName());
message.append(" no longer available, ended on: ");
message.append(javaProjectGen.getCommercialSupportEndDate());
if (javaProjectGen == null) {
message.append(javaProjectVersion);
message.append(" not available!");
} else {
message.append(javaProjectGen.getName());
message.append(" no longer available, ended on: ");
message.append(javaProjectGen.getCommercialSupportEndDate());
}
Diagnostic d = createDiagnostic(VersionValidationProblemType.UNSUPPORTED_COMMERCIAL_VERSION, message.toString());
if (d != null) {
b.add(d);
@@ -104,4 +112,14 @@ public class GenerationsValidator extends AbstractDiagnosticValidator {
return b.build();
}
@Override
public boolean isEnabled() {
return isEnabled(
VersionValidationProblemType.SUPPORTED_OSS_VERSION,
VersionValidationProblemType.UNSUPPORTED_OSS_VERSION,
VersionValidationProblemType.SUPPORTED_COMMERCIAL_VERSION,
VersionValidationProblemType.UNSUPPORTED_COMMERCIAL_VERSION
);
}
}

55
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/validation/generations/ProjectVersionDiagnosticProvider.java
View File

@@ -16,6 +16,7 @@ import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import org.eclipse.lsp4j.Diagnostic;
import org.slf4j.Logger;
@@ -23,6 +24,9 @@ import org.slf4j.LoggerFactory;
import org.springframework.ide.vscode.commons.Version;
import org.springframework.ide.vscode.commons.java.IJavaProject;
import org.springframework.ide.vscode.commons.java.SpringProjectUtil;
import org.springframework.ide.vscode.commons.languageserver.MessageService;
import org.springframework.ide.vscode.commons.languageserver.PercentageProgressTask;
import org.springframework.ide.vscode.commons.languageserver.ProgressService;
public class ProjectVersionDiagnosticProvider {
@@ -30,7 +34,13 @@ public class ProjectVersionDiagnosticProvider {
private final List<VersionValidator> validators;
public ProjectVersionDiagnosticProvider(List<VersionValidator> validators) {
private ProgressService progressService;
private MessageService messageService;
public ProjectVersionDiagnosticProvider(ProgressService progressService, MessageService messageService, List<VersionValidator> validators) {
this.progressService = progressService;
this.messageService = messageService;
this.validators = validators;
}
@@ -42,26 +52,41 @@ public class ProjectVersionDiagnosticProvider {
throw new Exception("Unable to find build file in project while computing version validation for: " + javaProject.getElementName());
}
Version javaProjectVersion = SpringProjectUtil.getSpringBootVersion(javaProject);
if (javaProjectVersion == null) {
log.warn("Unable to resolve version for project: " + javaProject.getLocationUri().toASCIIString());
return new DiagnosticResult(buildFileUri, Collections.emptyList());
}
List<VersionValidator> applicableValidators = validators.stream().filter(v -> v.isEnabled()).collect(Collectors.toList());
List<Diagnostic> diagnostics = new ArrayList<Diagnostic>();
for (VersionValidator validator : validators) {
if (!applicableValidators.isEmpty()) {
PercentageProgressTask progress = progressService.createPercentageProgressTask(
"validate-" + javaProject.getElementName(),
applicableValidators.size(),
"Validating Spring Boot Version of project '%s'".formatted(javaProject.getElementName()));
try {
Collection<Diagnostic> batch = validator.validate(javaProject, javaProjectVersion);
if (batch != null) {
diagnostics.addAll(batch);
Version javaProjectVersion = SpringProjectUtil.getSpringBootVersion(javaProject);
if (javaProjectVersion == null) {
log.warn("Unable to resolve version for project: " + javaProject.getLocationUri().toASCIIString());
return new DiagnosticResult(buildFileUri, Collections.emptyList());
}
} catch (Exception e) {
log.error("", e);
for (VersionValidator validator : applicableValidators) {
try {
Collection<Diagnostic> batch = validator.validate(javaProject, javaProjectVersion);
if (batch != null) {
diagnostics.addAll(batch);
}
} catch (Exception e) {
messageService.error("Failed Spring Boot version validation for project '%s': %s".formatted(javaProject.getElementName(), e.getMessage()));
log.error("", e);
}
progress.increment();
}
} finally {
progress.done();
}
}
return new DiagnosticResult(buildFileUri, diagnostics);
}

10
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/validation/generations/UpdateBootVersion.java
View File

@@ -161,4 +161,14 @@ public class UpdateBootVersion extends AbstractDiagnosticValidator {
ImmutableList.of(showDocumentParams)));
return releaseNoteLink;
}
@Override
public boolean isEnabled() {
return isEnabled(
VersionValidationProblemType.UPDATE_LATEST_PATCH_VERSION,
VersionValidationProblemType.UPDATE_LATEST_MINOR_VERSION,
VersionValidationProblemType.UPDATE_LATEST_MAJOR_VERSION
);
}
}

20
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/validation/generations/VersionValidationUtils.java
View File

@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2022 VMware, Inc.
* Copyright (c) 2022, 2023 VMware, Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -20,15 +20,21 @@ import org.springframework.ide.vscode.commons.Version;
public class VersionValidationUtils {
public static boolean isOssValid(Generation gen) {
Date currentDate = new Date(System.currentTimeMillis());
Date ossEndDate = Date.valueOf(gen.getOssSupportEndDate());
return currentDate.before(ossEndDate);
if (gen != null) {
Date currentDate = new Date(System.currentTimeMillis());
Date ossEndDate = Date.valueOf(gen.getOssSupportEndDate());
return currentDate.before(ossEndDate);
}
return false;
}
public static boolean isCommercialValid(Generation gen) {
Date currentDate = new Date(System.currentTimeMillis());
Date commercialEndDate = Date.valueOf(gen.getCommercialSupportEndDate());
return currentDate.before(commercialEndDate);
if (gen != null) {
Date currentDate = new Date(System.currentTimeMillis());
Date commercialEndDate = Date.valueOf(gen.getCommercialSupportEndDate());
return currentDate.before(commercialEndDate);
}
return false;
}
public static Version getLatestSupportedRelease(ResolvedSpringProject springProject)

4
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/validation/generations/VersionValidator.java
View File

@@ -19,5 +19,7 @@ import org.springframework.ide.vscode.commons.java.IJavaProject;
public interface VersionValidator {
Collection<Diagnostic> validate(IJavaProject javaProject, Version javaProjectVersion) throws Exception;
boolean isEnabled();
}