Skip to content

Commit

Permalink
feat: add argument channel for version-controller
Browse files Browse the repository at this point in the history
  • Loading branch information
Doc94 committed Oct 28, 2023
1 parent 5b2ddbe commit e2c85f6
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import io.papermc.bibliothek.database.repository.BuildCollection;
import io.papermc.bibliothek.database.repository.ProjectCollection;
import io.papermc.bibliothek.database.repository.VersionCollection;
import io.papermc.bibliothek.exception.ChannelNotFound;
import io.papermc.bibliothek.exception.ProjectNotFound;
import io.papermc.bibliothek.exception.VersionNotFound;
import io.papermc.bibliothek.util.HTTP;
Expand All @@ -40,13 +41,15 @@
import jakarta.validation.constraints.Pattern;
import java.time.Duration;
import java.util.List;
import org.apache.commons.lang3.EnumUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.CacheControl;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
Expand Down Expand Up @@ -85,12 +88,18 @@ public ResponseEntity<?> version(
@Parameter(description = "A version of the project.")
@PathVariable("version")
@Pattern(regexp = Version.PATTERN) //
final String versionName
final String versionName,
@Parameter(description = "The channel to filter builds.")
@RequestParam(required = false, defaultValue = "all") String channel
) {
final Project project = this.projects.findByName(projectName).orElseThrow(ProjectNotFound::new);
final Version version = this.versions.findByProjectAndName(project._id(), versionName).orElseThrow(VersionNotFound::new);
final List<Build> builds = this.builds.findAllByProjectAndVersion(project._id(), version._id());
return HTTP.cachedOk(VersionResponse.from(project, version, builds), CACHE);
boolean hasChannel = (channel != null && !channel.equalsIgnoreCase("all"));
if (hasChannel && !EnumUtils.isValidEnumIgnoreCase(Build.Channel.class, channel)) {
throw new ChannelNotFound(channel);
}
final List<Build> builds = (!hasChannel) ? this.builds.findAllByProjectAndVersion(project._id(), version._id()) : this.builds.findAllByProjectAndVersionAndChannel(project._id(), version._id(), channel.toUpperCase());
return HTTP.cachedOk(VersionResponse.from(project, version, channel, builds), CACHE);
}

@Schema
Expand All @@ -100,14 +109,17 @@ private record VersionResponse(
@Schema(name = "project_name", example = "Paper")
String project_name,
@Schema(name = "version", pattern = Version.PATTERN, example = "1.18")
String channel,
@Schema(name = "channel", examples = {"stable", "all"})
String version,
@Schema(name = "builds")
List<Integer> builds
) {
static VersionResponse from(final Project project, final Version version, final List<Build> builds) {
static VersionResponse from(final Project project, final Version version, final String channel, final List<Build> builds) {
return new VersionResponse(
project.name(),
project.friendlyName(),
channel,
version.name(),
builds.stream().map(Build::number).toList()
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
public interface BuildCollection extends MongoRepository<Build, ObjectId> {
List<Build> findAllByProjectAndVersion(final ObjectId project, final ObjectId version);

List<Build> findAllByProjectAndVersionAndChannel(final ObjectId project, final ObjectId version, final String channel);

List<Build> findAllByProjectAndVersionIn(final ObjectId project, final Collection<ObjectId> version);

Optional<Build> findByProjectAndVersionAndNumber(final ObjectId project, final ObjectId version, final int number);
Expand Down
9 changes: 9 additions & 0 deletions src/main/java/io/papermc/bibliothek/exception/Advice.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
package io.papermc.bibliothek.exception;

import com.fasterxml.jackson.databind.ObjectMapper;
import io.papermc.bibliothek.database.model.Build;
import java.util.stream.Collectors;
import org.apache.commons.lang3.EnumUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
Expand Down Expand Up @@ -72,6 +75,12 @@ public ResponseEntity<?> versionNotFound(final VersionNotFound exception) {
return this.error(HttpStatus.NOT_FOUND, "Version not found.");
}

@ExceptionHandler(ChannelNotFound.class)
@ResponseBody
public ResponseEntity<?> channelNotFound(final ChannelNotFound exception) {
return this.error(HttpStatus.NOT_FOUND, "Channel '%s' not found. Only allowed [all,%s]".formatted(exception.getArgumentPassed(), EnumUtils.getEnumList(Build.Channel.class).stream().map(channel -> channel.toString().toLowerCase()).collect(Collectors.joining(","))));
}

@ExceptionHandler(NoHandlerFoundException.class)
@ResponseBody
public ResponseEntity<?> endpointNotFound(final NoHandlerFoundException exception) {
Expand Down
43 changes: 43 additions & 0 deletions src/main/java/io/papermc/bibliothek/exception/ChannelNotFound.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* This file is part of bibliothek, licensed under the MIT License.
*
* Copyright (c) 2019-2023 PaperMC
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package io.papermc.bibliothek.exception;

import java.io.Serial;

public class ChannelNotFound extends RuntimeException {
@Serial
private static final long serialVersionUID = 1716350953824887164L;

private String argumentPassed;

public ChannelNotFound(String argumentPassed) {
super();
this.argumentPassed = argumentPassed;
}


public String getArgumentPassed() {
return argumentPassed;
}
}

0 comments on commit e2c85f6

Please sign in to comment.