Add GET /v1/extensionData?server={name/uuid} endpoint

Utilizes the same code used earlier for the /v1/player extension data,
the data just needs to be displayed slightly differently on the frontend
This commit is contained in:
Aurora Lahtela 2022-08-21 10:35:29 +03:00
parent a43a2ae581
commit 26409a7b59
3 changed files with 125 additions and 1 deletions

View File

@ -50,6 +50,7 @@ public enum DataID {
PERFORMANCE_OVERVIEW,
EXTENSION_NAV,
EXTENSION_TABS,
EXTENSION_JSON,
LIST_SERVERS;
public String of(ServerUUID serverUUID) {

View File

@ -0,0 +1,121 @@
/*
* This file is part of Player Analytics (Plan).
*
* Plan is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License v3 as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Plan is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Plan. If not, see <https://www.gnu.org/licenses/>.
*/
package com.djrapitops.plan.delivery.webserver.resolver.json;
import com.djrapitops.plan.delivery.domain.datatransfer.extension.ExtensionDataDto;
import com.djrapitops.plan.delivery.web.resolver.MimeType;
import com.djrapitops.plan.delivery.web.resolver.Resolver;
import com.djrapitops.plan.delivery.web.resolver.Response;
import com.djrapitops.plan.delivery.web.resolver.exception.BadRequestException;
import com.djrapitops.plan.delivery.web.resolver.exception.NotFoundException;
import com.djrapitops.plan.delivery.web.resolver.request.Request;
import com.djrapitops.plan.delivery.webserver.cache.AsyncJSONResolverService;
import com.djrapitops.plan.delivery.webserver.cache.DataID;
import com.djrapitops.plan.delivery.webserver.cache.JSONStorage;
import com.djrapitops.plan.extension.implementation.results.ExtensionData;
import com.djrapitops.plan.extension.implementation.storage.queries.ExtensionServerDataQuery;
import com.djrapitops.plan.identification.Identifiers;
import com.djrapitops.plan.identification.ServerUUID;
import com.djrapitops.plan.storage.database.DBSystem;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.ExampleObject;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import jakarta.ws.rs.GET;
import javax.inject.Inject;
import javax.inject.Singleton;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
/**
* @author AuroraLS3
*/
@Singleton
public class ExtensionJSONResolver implements Resolver {
private final DBSystem dbSystem;
private final Identifiers identifiers;
private final AsyncJSONResolverService jsonResolverService;
@Inject
public ExtensionJSONResolver(DBSystem dbSystem, Identifiers identifiers, AsyncJSONResolverService jsonResolverService) {
this.dbSystem = dbSystem;
this.identifiers = identifiers;
this.jsonResolverService = jsonResolverService;
}
@Override
public boolean canAccess(Request request) {
return false;
}
@GET
@Operation(
description = "Get extension data of a specific server.",
responses = {
@ApiResponse(responseCode = "200", content = @Content(mediaType = MimeType.JSON)),
@ApiResponse(responseCode = "400", description = "If 'server' parameter is not given"),
@ApiResponse(responseCode = "404", description = "If 'server' parameter is not an existing server")
},
parameters = @Parameter(in = ParameterIn.QUERY, required = true, name = "server", description = "Server identifier to get data for", examples = {
@ExampleObject("Server 1"),
@ExampleObject("1"),
@ExampleObject("1fb39d2a-eb82-4868-b245-1fad17d823b3"),
}),
requestBody = @RequestBody(content = @Content(examples = @ExampleObject()))
)
@Override
public Optional<Response> resolve(Request request) {
String identifier = request.getQuery().get("server")
.orElseThrow(() -> new BadRequestException("'server' parameter was not given"));
ServerUUID serverUUID = identifiers.getServerUUID(identifier)
.orElseThrow(() -> new NotFoundException("Server with identifier '" + identifier + "' was not found in database"));
return Optional.of(getResponse(request, serverUUID));
}
private JSONStorage.StoredJSON getJSON(Request request, ServerUUID serverUUID) {
Optional<Long> timestamp = Identifiers.getTimestamp(request);
return jsonResolverService.resolve(
timestamp, DataID.EXTENSION_JSON, serverUUID,
this::getExtensionData
);
}
private Response getResponse(Request request, ServerUUID serverUUID) {
JSONStorage.StoredJSON json = getJSON(request, serverUUID);
return Response.builder()
.setJSONContent(json.json)
.build();
}
private Map<String, List<ExtensionDataDto>> getExtensionData(ServerUUID serverUUID) {
List<ExtensionData> extensionData = dbSystem.getDatabase().query(new ExtensionServerDataQuery(serverUUID));
return Map.of(
"extensions", extensionData.stream()
.map(ExtensionDataDto::new)
.collect(Collectors.toList())
);
}
}

View File

@ -63,7 +63,8 @@ public class RootJSONResolver {
VersionJSONResolver versionJSONResolver,
MetadataJSONResolver metadataJSONResolver,
WhoAmIJSONResolver whoAmIJSONResolver,
ServerIdentityJSONResolver serverIdentityJSONResolver
ServerIdentityJSONResolver serverIdentityJSONResolver,
ExtensionJSONResolver extensionJSONResolver
) {
this.identifiers = identifiers;
this.asyncJSONResolverService = asyncJSONResolverService;
@ -90,6 +91,7 @@ public class RootJSONResolver {
.add("metadata", metadataJSONResolver)
.add("serverIdentity", serverIdentityJSONResolver)
.add("whoami", whoAmIJSONResolver)
.add("extensionData", extensionJSONResolver)
.build();
}