mirror of
https://github.com/scm-manager/scm-manager.git
synced 2026-01-22 23:42:11 +01:00
fix review findings
This commit is contained in:
@@ -60,12 +60,6 @@ public final class ReleaseFeedDto {
|
||||
@Setter
|
||||
public static class Channel {
|
||||
|
||||
private String title;
|
||||
private String description;
|
||||
private String link;
|
||||
private String generator;
|
||||
@XmlJavaTypeAdapter(XmlUTCDateAdapter.class)
|
||||
private Date lastBuildDate;
|
||||
@XmlElement(name = "item")
|
||||
private List<Release> releases;
|
||||
}
|
||||
|
||||
@@ -24,9 +24,11 @@
|
||||
|
||||
package sonia.scm.admin;
|
||||
|
||||
import com.google.common.base.Strings;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import sonia.scm.net.ahc.AdvancedHttpClient;
|
||||
import sonia.scm.version.Version;
|
||||
|
||||
import javax.inject.Inject;
|
||||
import java.io.IOException;
|
||||
@@ -44,18 +46,21 @@ public class ReleaseFeedParser {
|
||||
this.client = client;
|
||||
}
|
||||
|
||||
Optional<ReleaseInfo> findLatestRelease(String url) {
|
||||
Optional<UpdateInfo> findLatestRelease(String url) {
|
||||
LOG.info("Search for newer versions of SCM-Manager");
|
||||
Optional<ReleaseFeedDto.Release> latestRelease = parseLatestReleaseFromRssFeed(url);
|
||||
return latestRelease.map(release -> new ReleaseInfo(release.getTitle(), release.getLink()));
|
||||
return latestRelease.map(release -> new UpdateInfo(release.getTitle(), release.getLink()));
|
||||
}
|
||||
|
||||
private Optional<ReleaseFeedDto.Release> parseLatestReleaseFromRssFeed(String url) {
|
||||
try {
|
||||
if (Strings.isNullOrEmpty(url)) {
|
||||
return Optional.empty();
|
||||
}
|
||||
ReleaseFeedDto releaseFeed = client.get(url).request().contentFromXml(ReleaseFeedDto.class);
|
||||
return filterForLatestRelease(releaseFeed);
|
||||
} catch (IOException e) {
|
||||
LOG.error(String.format("Could not parse release feed from %s", url));
|
||||
LOG.error("Could not parse release feed from {}", url, e);
|
||||
return Optional.empty();
|
||||
}
|
||||
}
|
||||
@@ -63,6 +68,6 @@ public class ReleaseFeedParser {
|
||||
private Optional<ReleaseFeedDto.Release> filterForLatestRelease(ReleaseFeedDto releaseFeed) {
|
||||
return releaseFeed.getChannel().getReleases()
|
||||
.stream()
|
||||
.max(Comparator.comparing(ReleaseFeedDto.Release::getPubDate));
|
||||
.min(Comparator.comparing(release -> Version.parse(release.getTitle().trim())));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -39,12 +39,13 @@ import java.util.Optional;
|
||||
public class ReleaseVersionChecker {
|
||||
|
||||
private static final Logger LOG = LoggerFactory.getLogger(ReleaseVersionChecker.class);
|
||||
private static final String CACHE_NAME = "sonia.cache.releaseInfo";
|
||||
private static final String CACHE_NAME = "sonia.cache.updateInfo";
|
||||
private static final String CACHE_KEY = "latestRelease";
|
||||
|
||||
private final ReleaseFeedParser releaseFeedParser;
|
||||
private final ScmConfiguration scmConfiguration;
|
||||
private final SCMContextProvider scmContextProvider;
|
||||
private Cache<String, ReleaseInfo> cache;
|
||||
private Cache<String, Optional<UpdateInfo>> cache;
|
||||
|
||||
@Inject
|
||||
public ReleaseVersionChecker(ReleaseFeedParser releaseFeedParser, ScmConfiguration scmConfiguration, SCMContextProvider scmContextProvider, CacheManager cacheManager) {
|
||||
@@ -55,32 +56,32 @@ public class ReleaseVersionChecker {
|
||||
}
|
||||
|
||||
@VisibleForTesting
|
||||
void setCache(Cache<String, ReleaseInfo> cache) {
|
||||
void setCache(Cache<String, Optional<UpdateInfo>> cache) {
|
||||
this.cache = cache;
|
||||
}
|
||||
|
||||
public Optional<ReleaseInfo> checkForNewerVersion() {
|
||||
ReleaseInfo cachedReleaseInfo = cache.get("latest");
|
||||
if (cachedReleaseInfo != null) {
|
||||
return Optional.of(cachedReleaseInfo);
|
||||
} else {
|
||||
return findLatestRelease();
|
||||
public Optional<UpdateInfo> checkForNewerVersion() {
|
||||
if (cache.size() > 0) {
|
||||
return cache.get(CACHE_KEY);
|
||||
}
|
||||
return findLatestRelease();
|
||||
}
|
||||
|
||||
private Optional<ReleaseInfo> findLatestRelease() {
|
||||
private Optional<UpdateInfo> findLatestRelease() {
|
||||
String releaseFeedUrl = scmConfiguration.getReleaseFeedUrl();
|
||||
Optional<ReleaseInfo> latestRelease = releaseFeedParser.findLatestRelease(releaseFeedUrl);
|
||||
Optional<UpdateInfo> latestRelease = releaseFeedParser.findLatestRelease(releaseFeedUrl);
|
||||
if (latestRelease.isPresent() && isNewerVersion(latestRelease.get())) {
|
||||
cache.put("latest", latestRelease.get());
|
||||
cache.put(CACHE_KEY, latestRelease);
|
||||
return latestRelease;
|
||||
}
|
||||
// we cache that no new version was available to prevent request every time
|
||||
LOG.info("No newer version found for SCM-Manager");
|
||||
cache.put(CACHE_KEY, Optional.empty());
|
||||
return Optional.empty();
|
||||
}
|
||||
|
||||
private boolean isNewerVersion(ReleaseInfo releaseInfo) {
|
||||
Version versionFromReleaseFeed = Version.parse(releaseInfo.getVersion());
|
||||
private boolean isNewerVersion(UpdateInfo updateInfo) {
|
||||
Version versionFromReleaseFeed = Version.parse(updateInfo.getLatestVersion());
|
||||
return versionFromReleaseFeed.isNewer(scmContextProvider.getVersion());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -29,7 +29,7 @@ import lombok.Getter;
|
||||
|
||||
@AllArgsConstructor
|
||||
@Getter
|
||||
public class ReleaseInfo {
|
||||
private final String version;
|
||||
public class UpdateInfo {
|
||||
private final String latestVersion;
|
||||
private final String link;
|
||||
}
|
||||
@@ -30,8 +30,7 @@ import io.swagger.v3.oas.annotations.media.Content;
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import io.swagger.v3.oas.annotations.responses.ApiResponse;
|
||||
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||
import sonia.scm.admin.ReleaseInfo;
|
||||
import sonia.scm.admin.ReleaseInfoMapper;
|
||||
import sonia.scm.admin.UpdateInfo;
|
||||
import sonia.scm.admin.ReleaseVersionChecker;
|
||||
import sonia.scm.web.VndMediaType;
|
||||
|
||||
@@ -44,14 +43,14 @@ import java.util.Optional;
|
||||
@OpenAPIDefinition(tags = {
|
||||
@Tag(name = "AdminInfo", description = "Admin information endpoints")
|
||||
})
|
||||
@Path("")
|
||||
@Path("v2")
|
||||
public class AdminInfoResource {
|
||||
|
||||
private final ReleaseVersionChecker checker;
|
||||
private final ReleaseInfoMapper mapper;
|
||||
private final UpdateInfoMapper mapper;
|
||||
|
||||
@Inject
|
||||
public AdminInfoResource(ReleaseVersionChecker checker, ReleaseInfoMapper mapper) {
|
||||
public AdminInfoResource(ReleaseVersionChecker checker, UpdateInfoMapper mapper) {
|
||||
this.checker = checker;
|
||||
this.mapper = mapper;
|
||||
}
|
||||
@@ -60,12 +59,11 @@ public class AdminInfoResource {
|
||||
* Checks for a newer core version of SCM-Manager.
|
||||
*/
|
||||
@GET
|
||||
@Path("releaseInfo")
|
||||
@Path("updateInfo")
|
||||
@Produces(VndMediaType.ADMIN_INFO)
|
||||
@Operation(summary = "Returns release info.", description = "Returns information about the latest release if a newer version of SCM-Manager is available.", tags = "AdminInfo")
|
||||
@ApiResponse(responseCode = "200", description = "success")
|
||||
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
|
||||
@ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the information")
|
||||
@ApiResponse(
|
||||
responseCode = "500",
|
||||
description = "internal server error",
|
||||
@@ -73,8 +71,8 @@ public class AdminInfoResource {
|
||||
mediaType = VndMediaType.ERROR_TYPE,
|
||||
schema = @Schema(implementation = ErrorDto.class)
|
||||
))
|
||||
public ReleaseInfoDto getReleaseInfo() {
|
||||
Optional<ReleaseInfo> releaseInfo = checker.checkForNewerVersion();
|
||||
return releaseInfo.map(mapper::map).orElse(null);
|
||||
public UpdateInfoDto getUpdateInfo() {
|
||||
Optional<UpdateInfo> updateInfo = checker.checkForNewerVersion();
|
||||
return updateInfo.map(mapper::map).orElse(null);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -102,7 +102,7 @@ public class IndexDtoGenerator extends HalAppenderMapper {
|
||||
}
|
||||
if (ConfigurationPermissions.list().isPermitted()) {
|
||||
builder.single(link("config", resourceLinks.config().self()));
|
||||
builder.single(link("releaseInfo", resourceLinks.adminInfo().releaseInfo()));
|
||||
builder.single(link("updateInfo", resourceLinks.adminInfo().updateInfo()));
|
||||
}
|
||||
builder.single(link("repositories", resourceLinks.repositoryCollection().self()));
|
||||
builder.single(link("namespaces", resourceLinks.namespaceCollection().self()));
|
||||
|
||||
@@ -27,7 +27,6 @@ package sonia.scm.api.v2.resources;
|
||||
import com.google.inject.AbstractModule;
|
||||
import com.google.inject.servlet.ServletScopes;
|
||||
import org.mapstruct.factory.Mappers;
|
||||
import sonia.scm.admin.ReleaseInfoMapper;
|
||||
import sonia.scm.security.gpg.PublicKeyMapper;
|
||||
import sonia.scm.web.api.RepositoryToHalMapper;
|
||||
|
||||
@@ -77,7 +76,7 @@ public class MapperModule extends AbstractModule {
|
||||
bind(RepositoryToHalMapper.class).to(Mappers.getMapperClass(RepositoryToRepositoryDtoMapper.class));
|
||||
|
||||
bind(BlameResultToBlameDtoMapper.class).to(Mappers.getMapperClass(BlameResultToBlameDtoMapper.class));
|
||||
bind(ReleaseInfoMapper.class).to(Mappers.getMapperClass(ReleaseInfoMapper.class));
|
||||
bind(UpdateInfoMapper.class).to(Mappers.getMapperClass(UpdateInfoMapper.class));
|
||||
|
||||
// no mapstruct required
|
||||
bind(MeDtoFactory.class);
|
||||
|
||||
@@ -275,8 +275,8 @@ class ResourceLinks {
|
||||
adminInfoLinkBuilder = new LinkBuilder(pathInfo, AdminInfoResource.class);
|
||||
}
|
||||
|
||||
String releaseInfo() {
|
||||
return adminInfoLinkBuilder.method("getReleaseInfo").parameters().href();
|
||||
String updateInfo() {
|
||||
return adminInfoLinkBuilder.method("getUpdateInfo").parameters().href();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -24,17 +24,25 @@
|
||||
|
||||
package sonia.scm.api.v2.resources;
|
||||
|
||||
import de.otto.edison.hal.Embedded;
|
||||
import de.otto.edison.hal.HalRepresentation;
|
||||
import de.otto.edison.hal.Links;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
@AllArgsConstructor
|
||||
@NoArgsConstructor
|
||||
@Setter
|
||||
@Getter
|
||||
@SuppressWarnings("squid:S2160") // we do not need equals for dto
|
||||
public class ReleaseInfoDto extends HalRepresentation {
|
||||
private String version;
|
||||
public class UpdateInfoDto extends HalRepresentation {
|
||||
private String latestVersion;
|
||||
private String link;
|
||||
|
||||
UpdateInfoDto(Links links, Embedded embedded) {
|
||||
super(links, embedded);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -22,16 +22,33 @@
|
||||
* SOFTWARE.
|
||||
*/
|
||||
|
||||
package sonia.scm.admin;
|
||||
package sonia.scm.api.v2.resources;
|
||||
|
||||
import de.otto.edison.hal.Embedded;
|
||||
import de.otto.edison.hal.Links;
|
||||
import org.mapstruct.Mapper;
|
||||
import org.mapstruct.Mapping;
|
||||
import sonia.scm.api.v2.resources.HalAppenderMapper;
|
||||
import sonia.scm.api.v2.resources.ReleaseInfoDto;
|
||||
import org.mapstruct.ObjectFactory;
|
||||
import sonia.scm.admin.UpdateInfo;
|
||||
|
||||
import javax.inject.Inject;
|
||||
|
||||
import static de.otto.edison.hal.Links.linkingTo;
|
||||
|
||||
@Mapper
|
||||
public abstract class ReleaseInfoMapper extends HalAppenderMapper {
|
||||
public abstract class UpdateInfoMapper extends HalAppenderMapper {
|
||||
|
||||
@Inject
|
||||
private ResourceLinks resourceLinks;
|
||||
|
||||
@Mapping(target = "attributes", ignore = true) // We do not map HAL attributes
|
||||
public abstract ReleaseInfoDto map(ReleaseInfo releaseInfo);
|
||||
public abstract UpdateInfoDto map(UpdateInfo updateInfo);
|
||||
|
||||
@ObjectFactory
|
||||
UpdateInfoDto createDto() {
|
||||
Links.Builder linksBuilder = linkingTo()
|
||||
.self(resourceLinks.adminInfo().updateInfo());
|
||||
|
||||
return new UpdateInfoDto(linksBuilder.build(), Embedded.emptyEmbedded());
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user