Update DAO code for readability

pjewald · pjewald · commit 502b8f985151 · 2017-02-16T14:03:51.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
@@ -43,6 +43,10 @@ public void setDSLContext(DSLContext dsl) {
      *
      * Create a ProjectRecord object from an existing project.
      * 
+     * Note: There are private getProject methods that retrieve
+     *       a project record based on a number of parameters
+     *       passed in.
+     * 
      * TODO: add details.
      * 
      * @param idProject
@@ -58,6 +62,8 @@ public ProjectRecord getProject(Long idProject) {
                 .fetchOne();
 
         // Return the project after checking if for depricated blocks
+        //
+        // Todo: Verify that the record was fetched - it sometimes is not.
         return alterReadRecord(record);
     }
 
@@ -215,8 +221,10 @@ public ProjectRecord createProject(
      */
     @Override
     public ProjectRecord updateProject(
-            Long idProject, String name, String description,
-            String descriptionHtml, boolean privateProject,
+            Long idProject, String name,
+            String description,
+            String descriptionHtml,
+            boolean privateProject,
             boolean sharedProject) {
 
         LOG.info("Update project {}.", idProject);
@@ -259,8 +267,12 @@ public ProjectRecord updateProject(
      */
     @Override
     public ProjectRecord updateProject(
-            Long idProject, String name, String description, 
-            String descriptionHtml, String code, boolean privateProject, 
+            Long idProject, 
+            String name, 
+            String description, 
+            String descriptionHtml, 
+            String code, 
+            boolean privateProject, 
             boolean sharedProject) {
 
         LOG.info("Update project {}.", idProject);
@@ -301,10 +313,14 @@ public ProjectRecord saveCode(Long idProject, String code) {
         ProjectRecord record = getProject(idProject, true);
         if (record != null) {
             record.setCode(code);
-            ProjectRecord returningRecord = create.update(Tables.PROJECT).set(record).returning().fetchOne();
+            ProjectRecord returningRecord = create
+                    .update(Tables.PROJECT)
+                    .set(record)
+                    .returning()
+                    .fetchOne();
             return returningRecord;
         }
-        LOG.warn("Unable to save code for project {}", idProject);
+        LOG.error("Unable to save code for project {}", idProject);
         return null;
     }
 
@@ -550,7 +566,9 @@ public ProjectRecord saveProjectCodeAs(Long idProject, String code, String newNa
         return null;
     }
 
-        
+    // Private over-ride of the public getProject()
+    //
+    // 
     private ProjectRecord getProject(Long idProject, boolean toEdit) {
         LOG.info("Retreiving project {}.", idProject);
         ProjectRecord record = create
@@ -564,6 +582,8 @@ private ProjectRecord getProject(Long idProject, boolean toEdit) {
             // Return a project if the edit flag is off or the edit flag is
             // on and the project owner is the current user
             if (!toEdit || record.getIdUser().equals(idUser)) {
+                
+                // Todo: Verify that the record was fetched - it sometimes is not.
                 return alterReadRecord(record);
             } else {
                 LOG.error("User {} attempted to edit project {} without authorization.",
@@ -573,6 +593,8 @@ private ProjectRecord getProject(Long idProject, boolean toEdit) {
         }
 
         // Return the project after checking if for depricated blocks
+        //
+        // Todo: Verify that the record was fetched - it sometimes is not.
         return alterReadRecord(record);
     }
 
@@ -597,12 +619,17 @@ private ProjectRecord doProjectClone(ProjectRecord original) {
     }
 
 
-        // Swap out old block definitions
+    // Evaluate project code and replace any depricated or updated blocks
+    //
+    // Return a ProjectRecord object. The code field may be altered to correct
+    // any old, depricated or updated blocks. The method will throw an
+    // exception if the ProjectRecord parameter is null or something has gone
+    // horribly wrong with the string conversions.
+    //
     private ProjectRecord alterReadRecord(ProjectRecord record) {
         LOG.info("Verify project block characteristics");
         String currentCode, newCode;
         
-        
         if (record == null) {
             LOG.error("Null project record detected.");
             throw new NullPointerException("Cannot alter a null project record.");
@@ -613,7 +640,7 @@ private ProjectRecord alterReadRecord(ProjectRecord record) {
 
             // Return immediately if there is no code to adjust
             if (currentCode == null) {
-                LOG.warn("Project is empty.");
+                LOG.warn("Project () code block is empty.", record.getId());
                 return record;
             }
             
@@ -633,13 +660,13 @@ private ProjectRecord alterReadRecord(ProjectRecord record) {
 
             // Check for any difference from the original code
             if (! currentCode.equals(newCode)) {
-                LOG.info("Updating converted project.");
+                LOG.info("Updated depricated project code blocks in project {}.", record.getId());
                 record.setCode(newCode);
             }
         }
         
         catch (Exception ex) {
-            LOG.error("Exception trapped. Messate is: {}", ex.getMessage());
+            LOG.error("Exception trapped. Message is: {}", ex.getMessage());
         }
 
         return record;
diff --git a/src/main/java/com/parallax/server/blocklyprop/rest/RestSharedProject.java b/src/main/java/com/parallax/server/blocklyprop/rest/RestSharedProject.java
@@ -25,6 +25,9 @@
 import javax.ws.rs.Produces;
 import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.Response;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 
 /**
  *
@@ -34,6 +37,7 @@
 @Group(name = "/shared/project", title = "Project management")
 @HttpCode("500>Internal Server Error,200>Success Response")
 public class RestSharedProject {
+    private static final Logger LOG = LoggerFactory.getLogger(RestSharedProject.class);
 
     private ProjectService projectService;
 
@@ -55,7 +59,7 @@ public void setProjectConverter(ProjectConverter projectConverter) {
     @Name("Get all shared projects")
     @Produces("application/json")
     public Response get(@QueryParam("sort") TableSort sort, @QueryParam("order") TableOrder order, @QueryParam("limit") Integer limit, @QueryParam("offset") Integer offset) {
-        System.out.println("Sort: " + sort);
+        LOG.info("Sort: {}", sort);
 
         List<ProjectRecord> projects = projectService.getSharedProjects(sort, order, limit, offset);
         int projectCount = projectService.countSharedProjects();
@@ -78,7 +82,7 @@ public Response get(@QueryParam("sort") TableSort sort, @QueryParam("order") Tab
     @Name("Get shared projects by user")
     @Produces("application/json")
     public Response get(@QueryParam("sort") TableSort sort, @QueryParam("order") TableOrder order, @QueryParam("limit") Integer limit, @QueryParam("offset") Integer offset, @PathParam("id") Long idUser) {
-        System.out.println("Sort: " + sort);
+        LOG.info("Sort: {}", sort);
 
         List<ProjectRecord> projects = projectService.getSharedProjectsByUser(sort, order, limit, offset, idUser);
         int projectCount = projectService.countSharedProjectsByUser(idUser);
@@ -102,15 +106,21 @@ public Response get(@QueryParam("sort") TableSort sort, @QueryParam("order") Tab
     @Name("Get project by id")
     @Produces("application/json")
     public Response get(@HeaderParam("X-Authorization") String authorization, @HeaderParam("X-Timestamp") Long timestamp, @PathParam("id") Long idProject) {
-        ProjectRecord project = projectService.getProject(idProject);
-
-        if (project == null) {
+        
+        try {
+            ProjectRecord project = projectService.getProject(idProject);
+            
+            if (project == null) {
+                return Response.status(Response.Status.NOT_FOUND).build();
+            }
+            
+            JsonObject result = projectConverter.toJson(project);
+            return Response.ok(result.toString()).build();
+        }
+        catch (Exception e) {
+            LOG.error("Exception in {} detected. Message is: {}", e.getClass(), e.getLocalizedMessage());
             return Response.status(Response.Status.NOT_FOUND).build();
         }
-
-        JsonObject result = projectConverter.toJson(project);
-
-        return Response.ok(result.toString()).build();
     }
 
     @GET
@@ -119,18 +129,24 @@ public Response get(@HeaderParam("X-Authorization") String authorization, @Heade
     @Name("Get project by id for editor")
     @Produces("application/json")
     public Response getEditor(@HeaderParam("X-Authorization") String authorization, @HeaderParam("X-Timestamp") Long timestamp, @PathParam("id") Long idProject) {
-        System.out.println("Authorization: " + authorization);
+        LOG.info("Authorization: {}", authorization);
 
-        ProjectRecord project = projectService.getProject(idProject);
+        try {
+            ProjectRecord project = projectService.getProject(idProject);
 
-        if (project == null) {
-            return Response.status(Response.Status.NOT_FOUND).build();
-        }
+            if (project == null) {
+                return Response.status(Response.Status.NOT_FOUND).build();
+            }
 
-        JsonObject result = projectConverter.toJson(project);
-        result.addProperty("code", project.getCode());
+            JsonObject result = projectConverter.toJson(project);
+            result.addProperty("code", project.getCode());
 
-        return Response.ok(result.toString()).build();
+            return Response.ok(result.toString()).build();
+        }
+        catch (Exception e) {
+            LOG.error("Exception in {} detected. Message is: {}", e.getClass(), e.getLocalizedMessage());
+            return Response.status(Response.Status.NOT_FOUND).build();
+        }
     }
 
 }
