Correct issue where new projects were orphaned. Refactor code, add comments.

pjewald · pjewald · commit 696988ce450d · 2019-02-06T08:52:50.000-08:00
diff --git a/src/main/java/com/parallax/server/blocklyprop/db/dao/impl/ProjectDaoImpl.java b/src/main/java/com/parallax/server/blocklyprop/db/dao/impl/ProjectDaoImpl.java
@@ -643,16 +643,21 @@ public ProjectRecord updateProjectCode(Long idProject, String code) {
     @Override
     public ProjectRecord saveProjectCodeAs(Long idProject, String code, String newName, String newBoard) {
         
-        LOG.info("Saving project code as '{}'", newName);
+        LOG.info("Saving project code from project {} as '{}'", idProject,  newName);
 
         // Retreive the source project
         ProjectRecord original = getProject(idProject);
+
         if (original == null) {
             LOG.error("Original project {} is missing. Unable to save code as...", idProject);
             throw new NullPointerException("Project doesn't exist");
-        } else if (newBoard == null) {
+        }
+
+        // Use the board type from the parent project if it was not provided
+        if (newBoard == null) {
             newBoard = original.getBoard();
         }
+
         
         // Obtain the current bp user record. 
         Long idUser = BlocklyPropSecurityUtils.getCurrentUserId();
@@ -663,6 +668,7 @@ public ProjectRecord saveProjectCodeAs(Long idProject, String code, String newNa
             // shared or community project
             // --------------------------------------------------------------------
             if (original.getIdUser().equals(idUser) || original.getShared()) {
+
                 ProjectRecord cloned = createProject(
                         newName, 
                         original.getDescription(),
@@ -674,7 +680,13 @@ public ProjectRecord saveProjectCodeAs(Long idProject, String code, String newNa
                         false,                  // Set project unshared
                         original.getId());
 
+                if (cloned == null) {
+                    LOG.warn("Unable to create a copy og the project.");
+                }
                 return cloned;
+            } else {
+                LOG.warn("Unable to copy the project. UID: {}, PUID: {}, Shared: {}",
+                        idUser, original.getIdUser(), original.getShared());
             }
         } else {
             LOG.info("Unable to retreive BP user id");
diff --git a/src/main/java/com/parallax/server/blocklyprop/rest/RestSharedProject.java b/src/main/java/com/parallax/server/blocklyprop/rest/RestSharedProject.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Parallax Inc.
+ * Copyright (c) 2019 Parallax Inc.
  *
  * 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
@@ -16,7 +16,7 @@
  * 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.
+ * SOFTWARE.
  */
 
 package com.parallax.server.blocklyprop.rest;
@@ -42,35 +42,67 @@
 import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.Response;
 
+import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 
 /**
+ * Manage requests for public projects
  *
  * @author Michel
+ *
+ * NOTE:
+ * The concept of 'shared' projects has changed over time. A project
+ * can be private or public. A project can also be associated with a
+ * specific project sharing URL, regardless of its public/private status.
  */
 @Path("/shared/project")
 @Group(name = "/shared/project", title = "Project management")
 @HttpCode("500>Internal Server Error,200>Success Response")
 public class RestSharedProject {
 
+    /**
+     * Get a connection to the logging system
+     */
     private static final Logger LOG = LoggerFactory.getLogger(RestSharedProject.class);
 
+
+    /**
+     * Get a handle to project services
+     */
     private ProjectService projectService;
 
+
+    /**
+     * Get a handle to a project converter
+     */
     private ProjectConverter projectConverter;
 
+
+    /**
+     * Inject project services
+     *
+     * @param projectService
+     * An instance of the ProjectService object
+     */
     @Inject
     public void setProjectService(ProjectService projectService) {
         this.projectService = projectService;
     }
 
+
+    /**
+     * Inject project conversion services
+     * @param projectConverter
+     * An instance of the ProjectConverter object
+     */
     @Inject
     public void setProjectConverter(ProjectConverter projectConverter) {
         this.projectConverter = projectConverter;
     }
 
+
     /**
      * Return a list of community projects.
      * 
@@ -101,33 +133,33 @@ public Response get(
             @QueryParam("limit") Integer limit, 
             @QueryParam("offset") Integer offset) {
 
-        LOG.info("REST:/shared/project/list/ endpoint activated");
-        LOG.debug("REST:/shared/project/list/ Sort parameter is '{}'", sort);
-        LOG.debug("REST:/shared/project/list/ Sort parameter is '{}'", sort);
+        String endPoint = "REST:/shared/project/list/";
+
+        LOG.info("{} endpoint activated", endPoint);
 
         boolean parametersValid = false;
         
         // Sort flag evaluation
         if (sort != null) {
             for (TableSort t : TableSort.values()) {
-                LOG.debug("REST:/shared/project/list/ Sort test for '{}'", t);
+                LOG.debug("{} Sort test for '{}'",endPoint, t);
             
                 if (sort == t) {
                     parametersValid = true;
                     break;
                 }
             }
         
-            if (parametersValid == false) {
-                LOG.warn("REST:/shared/project/list/ Sort parameter failed");
+            if (!parametersValid) {
+                LOG.warn("{} Sort parameter failed", endPoint);
                 return Response.status(Response.Status.NOT_ACCEPTABLE).build();
             }
         }
 
         // Sort order evaluation
         if (order != null) {
             parametersValid = false;
-            LOG.debug("REST:/shared/project/list/ Checking order");
+            LOG.debug("{} Checking order", endPoint);
         
             for (TableOrder t : TableOrder.values()) {
                 if (order == t) {
@@ -136,41 +168,52 @@ public Response get(
                 }
             }
         
-            if (parametersValid == false) {
+            if (!parametersValid) {
                 return Response.status(Response.Status.NOT_ACCEPTABLE).build();
             }
         }
         
         // Limit result set value
         if ( (limit == null) || (limit > 50)) {
-            LOG.info("REST:/shared/project/list/ Limit throttle to 50 entries");
+            LOG.info("{} Limit throttle to 50 entries", endPoint);
             limit = 50;
         }
         
         // Check ofset from the beginning of the record set
         if ((offset == null) || (offset < 0)) {
             offset = 0;
         }
-        
+
+        // Get a block of projects
         List<ProjectRecord> projects
                 = projectService.getSharedProjects(sort, order, limit, offset);
         
         // Obtain a count of the total number of community projects available
         int projectCount = projectService.countSharedProjects();
 
-        JsonObject result = new JsonObject();
-        JsonArray jsonProjects = new JsonArray();
-        
-        for (ProjectRecord project : projects) {
-            jsonProjects.add(projectConverter.toListJson(project));
-        }
-
-        result.add("rows", jsonProjects);
-        result.addProperty("total", projectCount);
-
-        return Response.ok(result.toString()).build();
+        return Response.ok(returnProjectsJson(projects, projectCount)).build();
     }
 
+
+    /**
+     * Get a list of projects owned by a specific user
+     *
+     * @param sort
+     * The project field used to evaluate the sort
+     *
+     * @param order
+     * Specify the sort order - ascending or descending
+     *
+     * @param limit
+     * Specify the maximum number of rows to return
+     *
+     * @param offset
+     * Specify the beginning row to return
+     *
+     * @return
+     * Return a response object that contains either the data requested
+     * or a JSON string containing the error details
+     */
     @GET
     @Path("/list/user/{id}")
     @Detail("Get shared projects by user")
@@ -183,25 +226,44 @@ public Response get(
             @QueryParam("offset") Integer offset, 
             @PathParam("id") Long idUser) {
 
-        LOG.info("REST:/shared/project/list/user/ Get request received for user '{}'", idUser);
+        String endPoint = "REST:/shared/project/list/user/";
 
-        List<ProjectRecord> projects = projectService.getSharedProjectsByUser(sort, order, limit, offset, idUser);
-        int projectCount = projectService.countSharedProjectsByUser(idUser);
+        LOG.info("{} Get request received for user '{}'", endPoint, idUser);
 
-        JsonObject result = new JsonObject();
-        JsonArray jsonProjects = new JsonArray();
-        
-        for (ProjectRecord project : projects) {
-            jsonProjects.add(projectConverter.toListJson(project));
+        // Limit result set value
+        if ( (limit == null) || (limit > 50)) {
+            LOG.info("{} Limit throttle to 50 entries", endPoint);
+            limit = 50;
+        }
+
+        // Check ofset from the beginning of the record set
+        if ((offset == null) || (offset < 0)) {
+            offset = 0;
         }
 
-        result.add("rows", jsonProjects);
-        result.addProperty("total", projectCount);
 
-        return Response.ok(result.toString()).build();
+        List<ProjectRecord> projects = projectService.getSharedProjectsByUser(sort, order, limit, offset, idUser);
+        int projectCount = projectService.countSharedProjectsByUser(idUser);
+
+        return Response.ok(returnProjectsJson(projects, projectCount)).build();
+
     }
 
 
+    /**
+     *
+     * @param authorization
+     * Authorization header token
+     *
+     * @param timestamp
+     * A timestamp
+     *
+     * @param idProject
+     * The project key ID
+     *
+     * @return
+     * Returns a Json string containing the project details
+     */
     @GET
     @Path("/get/{id}")
     @Detail("Get project by id")
@@ -212,20 +274,21 @@ public Response get(
             @HeaderParam("X-Timestamp") Long timestamp, 
             @PathParam("id") Long idProject) {
 
-        LOG.info("REST:/rest/shared/project/get/ Get request received for projecet '{}'", idProject);
+        String endPoint = "REST:/rest/shared/project/get/";
+
+        LOG.info("{} Get request received for project '{}'", endPoint, idProject);
         
         try {
-            LOG.info("Getting project record.");
             ProjectRecord project = projectService.getProject(idProject);
             
             if (project == null) {
                 LOG.info("project record was not found");
                 return Response.status(Response.Status.NOT_FOUND).build();
             }
 
-            LOG.info("Converting project to JSON string");
+            LOG.info("Converting project {} to JSON string", idProject);
             JsonObject result = projectConverter.toJson(project, false);
-            LOG.info("REST: /get/" + idProject.toString() + "/ returning project {}.", project.getId());
+            LOG.info("{}" + idProject.toString() + "/ returning project {}.", endPoint, project.getId());
 
             return Response.ok(result.toString()).build();
         }
@@ -235,6 +298,22 @@ public Response get(
         }
     }
 
+
+    /**
+     * Get project details, including the project code payload
+     *
+     * @param authorization
+     * Request authorization header
+     *
+     * @param timestamp
+     * A timestamp
+     *
+     * @param idProject
+     * The project key ID
+     *
+     * @return
+     * A string containing a Json object representing the requested project
+     */
     @GET
     @Path("/editor/{id}")
     @Detail("Get project by id for editor")
@@ -267,4 +346,32 @@ public Response getEditor(
         }
     }
 
+
+    /**
+     * Iterate a list of projects into an array of Json objects
+     *
+     * @param projects
+     * A List of ProjectRecord objects
+     *
+     * @param projectCount
+     * The number of projects available. This may not be the same value as
+     * the number of records contained in the passed list of ProjectRecords.
+     *
+     * @return
+     * A String containing the array of the converted Json objects
+     */
+    private String returnProjectsJson(@NotNull List<ProjectRecord> projects, int projectCount) {
+        JsonObject result = new JsonObject();
+        JsonArray jsonProjects = new JsonArray();
+
+        for (ProjectRecord project : projects) {
+            jsonProjects.add(projectConverter.toListJson(project));
+        }
+
+        result.add("rows", jsonProjects);
+        result.addProperty("total", projectCount);
+
+        return result.toString();
+    }
+
 }
