The Unified and Autonomous Development Platform
fix #3: Json entity should be used in Response body when handling errors in GitHub-style restful API
robin shen1bf60f2874d7
diff --git a/core/src/main/java/io/onedev/server/rest/github/CommitStatusResource.java b/core/src/main/java/io/onedev/server/rest/github/CommitStatusResource.javaindex a9bdb02f25..48ca275ad2 100644--- a/core/src/main/java/io/onedev/server/rest/github/CommitStatusResource.java+++ b/core/src/main/java/io/onedev/server/rest/github/CommitStatusResource.java@@ -15,16 +15,15 @@ import javax.ws.rs.core.Context;import javax.ws.rs.core.MediaType;import javax.ws.rs.core.MultivaluedMap;import javax.ws.rs.core.Response;+import javax.ws.rs.core.Response.Status;import javax.ws.rs.core.UriBuilder;import javax.ws.rs.core.UriInfo;import org.apache.commons.lang3.math.NumberUtils;-import org.apache.shiro.authz.UnauthorizedException;import org.eclipse.jgit.lib.ObjectId;import com.fasterxml.jackson.databind.ObjectMapper;-import io.onedev.server.exception.OneException;import io.onedev.server.manager.BuildManager;import io.onedev.server.manager.ConfigurationManager;import io.onedev.server.manager.ProjectManager;@@ -58,22 +57,18 @@ public class CommitStatusResource {this.configurationManager = configurationManager;}- private Project getProject(String projectName) {- Project project = projectManager.find(projectName);- if (project == null)- throw new OneException("Unable to find project: " + projectName);- return project;- }-@Consumes(MediaType.APPLICATION_JSON)@Path("/{projectName}/statuses/{commit}")@POSTpublic Response save(@PathParam("projectName") String projectName, @PathParam("commit") String commitHash,Map<String, String> commitStatus, @Context UriInfo uriInfo) {- Project project = getProject(projectName);+ Project project = projectManager.find(projectName);+ if (project == null)+ return GithubUtils.buildErrorResponse(Status.NOT_FOUND, "Unable to find project: " + projectName);+if (!SecurityUtils.canWriteCode(project.getFacade()))- throw new UnauthorizedException();+ return GithubUtils.buildErrorResponse(Status.FORBIDDEN, "Code write permission is desired to update commit status");String context = commitStatus.get("context");if (context == null)@@ -82,7 +77,7 @@ public class CommitStatusResource {Configuration configuration = configurationManager.find(project, context);if (configuration == null) {String message = String.format("Unable to find configuration (project: %s, name: %s)", project.getName(), context);- throw new OneException(message);+ return GithubUtils.buildErrorResponse(Status.NOT_FOUND, message);}ObjectId commit = ObjectId.fromString(commitHash);diff --git a/core/src/main/java/io/onedev/server/rest/github/GithubUtils.java b/core/src/main/java/io/onedev/server/rest/github/GithubUtils.javanew file mode 100644index 0000000000..0ecc4c3fa1--- /dev/null+++ b/core/src/main/java/io/onedev/server/rest/github/GithubUtils.java@@ -0,0 +1,20 @@+package io.onedev.server.rest.github;++import java.util.HashMap;+import java.util.Map;++import javax.ws.rs.core.Response;+import javax.ws.rs.core.Response.Status;++import io.onedev.server.rest.RestConstants;++public class GithubUtils {++ public static Response buildErrorResponse(Status status, String message) {+ Map<String, String> entity = new HashMap<>();+ entity.put("error", message);+ entity.put("message", message);+ return Response.status(status).entity(entity).type(RestConstants.JSON_UTF8).build();+ }++}diff --git a/core/src/main/java/io/onedev/server/rest/github/PullRequestResource.java b/core/src/main/java/io/onedev/server/rest/github/PullRequestResource.javaindex 556d3d6967..1e4f986fc8 100644--- a/core/src/main/java/io/onedev/server/rest/github/PullRequestResource.java+++ b/core/src/main/java/io/onedev/server/rest/github/PullRequestResource.java@@ -18,9 +18,9 @@ import javax.ws.rs.QueryParam;import javax.ws.rs.core.Context;import javax.ws.rs.core.MediaType;import javax.ws.rs.core.Response;+import javax.ws.rs.core.Response.Status;import javax.ws.rs.core.UriInfo;-import org.apache.shiro.authz.UnauthorizedException;import org.eclipse.jgit.revwalk.RevCommit;import org.hibernate.criterion.Restrictions;@@ -52,18 +52,16 @@ public class PullRequestResource {this.pullRequestManager = pullRequestManager;}- private Project getProject(String projectName) {- return Preconditions.checkNotNull(projectManager.find(projectName));- }-@Path("/{name}/pulls/{pullRequestNumber}")@GETpublic Response getPullRequest(@PathParam("name") String projectName,@PathParam("pullRequestNumber") Long pullRequestNumber, @Context UriInfo uriInfo) {- Project project = getProject(projectName);+ Project project = projectManager.find(projectName);+ if (project == null)+ return GithubUtils.buildErrorResponse(Status.NOT_FOUND, "Unable to find project '" + projectName + "'");if (!SecurityUtils.canReadCode(project.getFacade()))- throw new UnauthorizedException("Unauthorized access to project '" + projectName + "'");+ return GithubUtils.buildErrorResponse(Status.FORBIDDEN, "Unauthorized access to project '" + projectName + "'");PullRequest request = Preconditions.checkNotNull(pullRequestManager.find(project, pullRequestNumber));@@ -75,10 +73,12 @@ public class PullRequestResource {@GETpublic Response getCommits(@PathParam("name") String projectName,@PathParam("pullRequestNumber") Long pullRequestNumber) {- Project project = getProject(projectName);-+ Project project = projectManager.find(projectName);+ if (project == null)+ return GithubUtils.buildErrorResponse(Status.NOT_FOUND, "Unable to find project '" + projectName + "'");+if (!SecurityUtils.canReadCode(project.getFacade()))- throw new UnauthorizedException("Unauthorized access to project '" + projectName + "'");+ return GithubUtils.buildErrorResponse(Status.FORBIDDEN, "Unauthorized access to project '" + projectName + "'");PullRequest request = pullRequestManager.find(project, pullRequestNumber);List<Map<String, Object>> entity = new ArrayList<>();@@ -187,10 +187,12 @@ public class PullRequestResource {@PathParam("name") String projectName, @QueryParam("base") String branch,@QueryParam("state") String state, @QueryParam("per_page") Integer perPage,@QueryParam("page") Integer page, @Context UriInfo uriInfo) {- Project project = getProject(projectName);-+ Project project = projectManager.find(projectName);+ if (project == null)+ return GithubUtils.buildErrorResponse(Status.NOT_FOUND, "Unable to find project '" + projectName + "'");+if (!SecurityUtils.canReadCode(project.getFacade()))- throw new UnauthorizedException("Unauthorized access to project '" + projectName + "'");+ return GithubUtils.buildErrorResponse(Status.FORBIDDEN, "Unauthorized access to project '" + projectName + "'");EntityCriteria<PullRequest> criteria = EntityCriteria.of(PullRequest.class);criteria.add(PullRequest.CriterionHelper.ofTargetProject(project));diff --git a/core/src/main/java/io/onedev/server/rest/github/RepositoryResource.java b/core/src/main/java/io/onedev/server/rest/github/RepositoryResource.javaindex 73976df0fa..fe2c21e2de 100644--- a/core/src/main/java/io/onedev/server/rest/github/RepositoryResource.java+++ b/core/src/main/java/io/onedev/server/rest/github/RepositoryResource.java@@ -12,8 +12,7 @@ import javax.ws.rs.PathParam;import javax.ws.rs.Produces;import javax.ws.rs.core.MediaType;import javax.ws.rs.core.Response;--import org.apache.shiro.authz.UnauthorizedException;+import javax.ws.rs.core.Response.Status;import io.onedev.server.manager.ProjectManager;import io.onedev.server.model.Project;@@ -37,26 +36,27 @@ public class RepositoryResource {@GETpublic Response get(@PathParam("name") String name) {Project project = projectManager.find(name);+ if (project == null)+ return GithubUtils.buildErrorResponse(Status.NOT_FOUND, "Unable to find project '" + name + "'");++ if (!SecurityUtils.canReadCode(project.getFacade()))+ return GithubUtils.buildErrorResponse(Status.FORBIDDEN, "Unauthorized access to project '" + name + "'");- if (!SecurityUtils.canReadCode(project.getFacade())) {- throw new UnauthorizedException("Unauthorized access to project " + project.getName());- } else {- Map<String, Object> entity = new HashMap<>();- Map<String, String> permissionsMap = new HashMap<>();- entity.put("name", project.getName());- permissionsMap.put("admin", String.valueOf(SecurityUtils.canAdministrate(project.getFacade())));- permissionsMap.put("push", String.valueOf(SecurityUtils.canWriteCode(project.getFacade())));- permissionsMap.put("pull", "true");- entity.put("permissions", permissionsMap);-- Map<String, String> ownerMap = new HashMap<>();- ownerMap.put("login", "projects");- ownerMap.put("id", "1000000");-- entity.put("owner", ownerMap);-- return Response.ok(entity, RestConstants.JSON_UTF8).build();- }+ Map<String, Object> entity = new HashMap<>();+ Map<String, String> permissionsMap = new HashMap<>();+ entity.put("name", project.getName());+ permissionsMap.put("admin", String.valueOf(SecurityUtils.canAdministrate(project.getFacade())));+ permissionsMap.put("push", String.valueOf(SecurityUtils.canWriteCode(project.getFacade())));+ permissionsMap.put("pull", "true");+ entity.put("permissions", permissionsMap);++ Map<String, String> ownerMap = new HashMap<>();+ ownerMap.put("login", "projects");+ ownerMap.put("id", "1000000");++ entity.put("owner", ownerMap);++ return Response.ok(entity, RestConstants.JSON_UTF8).build();}}