feat(cms): Add upload document endpoint (#262)

* Add publish document endpoint

* Add upload document endpoint

Author: angary

backend/endpoints/models/volume_models.go

@@ -16,6 +16,12 @@ type (
 		Image       multipart.File
 	}
 
+	// ValidImageUploadRequest is the request model for an handler that uploads an IMAGE to a docker volume
+	ValidDocumentUploadRequest struct {
+		DocumentID uuid.UUID `schema:"DocumentID,required"`
+		Content    string    `schema:"Content,required"` // TODO: Add check that content is valid JSON
+	}
+
 	// ValidPublishDocumentRequest is the request model for any handler that publishes a document
 	ValidPublishDocumentRequest struct {
 		DocumentID uuid.UUID `schema:"DocumentID,required"`

backend/endpoints/registration.go

@@ -10,6 +10,7 @@ func RegisterFilesystemEndpoints(mux *http.ServeMux) {
 	mux.Handle("/api/filesystem/rename", newHandler("POST", RenameFilesystemEntity, false)) // auth
 	mux.Handle("/api/filesystem/children", newHandler("GET", GetChildren, false))
 	mux.Handle("/api/filesystem/upload-image", newHandler("POST", UploadImage, true))           // auth
+	mux.Handle("/api/filesystem/upload-document", newHandler("POST", UploadDocument, false))    // auth
 	mux.Handle("/api/filesystem/publish-document", newHandler("POST", PublishDocument, false))  // auth
 	mux.Handle("/api/filesystem/get/published", newHandler("GET", GetPublishedDocument, false)) // auth
 }

backend/endpoints/volume_endpoints.go

@@ -13,7 +13,7 @@ import (
 
 // UploadImage takes an image from a request and uploads it to the published docker volume
 func UploadImage(form ValidImageUploadRequest, df DependencyFactory) handlerResponse[NewEntityResponse] {
-	dockerRepository := df.GetUnpublishedVolumeRepo()
+	unpublishedVol := df.GetUnpublishedVolumeRepo()
 	repository := df.GetFilesystemRepo()
 	log := df.GetLogger()
 
@@ -28,22 +28,22 @@ func UploadImage(form ValidImageUploadRequest, df DependencyFactory) handlerResp
 	// Push the new entry into the repository
 	e, err := repository.CreateEntry(entityToCreate)
 	if err != nil {
+		log.Write("failed to create a repository entry")
+		log.Write(err.Error())
 		return handlerResponse[NewEntityResponse]{
 			Status: http.StatusNotAcceptable,
 		}
 	}
 
 	// Create and get a new entry in docker file system
-	dockerRepository.AddToVolume(e.EntityID.String())
-	if dockerFile, err := dockerRepository.GetFromVolume(e.EntityID.String()); err != nil {
+	unpublishedVol.AddToVolume(e.EntityID.String())
+	if dockerFile, err := unpublishedVol.GetFromVolume(e.EntityID.String()); err != nil {
 		return handlerResponse[NewEntityResponse]{Status: http.StatusInternalServerError}
-	} else {
-		_, err := io.Copy(dockerFile, form.Image)
-		if err != nil {
-			log.Write("failed to write image to docker container")
-			return handlerResponse[NewEntityResponse]{
-				Status: http.StatusInternalServerError,
-			}
+	} else if _, err := io.Copy(dockerFile, form.Image); err != nil {
+		log.Write("failed to write image to docker container")
+		log.Write(err.Error())
+		return handlerResponse[NewEntityResponse]{
+			Status: http.StatusInternalServerError,
 		}
 	}
 
@@ -54,27 +54,63 @@ func UploadImage(form ValidImageUploadRequest, df DependencyFactory) handlerResp
 	}
 }
 
+// UploadImage takes an image from a request and uploads it to the published docker volume
+func UploadDocument(form ValidDocumentUploadRequest, df DependencyFactory) handlerResponse[NewEntityResponse] {
+	unpublishedVol := df.GetUnpublishedVolumeRepo()
+	log := df.GetLogger()
+
+	// fetch the target file form the unpublished volume
+	filename := form.DocumentID.String()
+	file, err := unpublishedVol.GetFromVolume(filename)
+	if err != nil {
+		log.Write(fmt.Sprintf("failed to get file: %s from volume", filename))
+		log.Write(err.Error())
+		return handlerResponse[NewEntityResponse]{
+			Status: http.StatusNotFound,
+		}
+	}
+
+	bytes, err := file.WriteString(form.Content)
+	if (bytes == 0 && len(form.Content) != 0) || err != nil {
+		log.Write("was an error writing to file")
+		log.Write(err.Error())
+		return handlerResponse[NewEntityResponse]{
+			Status: http.StatusInternalServerError,
+		}
+	}
+
+	return handlerResponse[NewEntityResponse]{
+		Response: NewEntityResponse{NewID: form.DocumentID},
+		Status:   http.StatusOK,
+	}
+}
+
 // PublishDocument takes in DocumentID and transfers the document from unpublished to published volume if it exists
 func PublishDocument(form ValidPublishDocumentRequest, df DependencyFactory) handlerResponse[empty] {
 	unpublishedVol := df.GetUnpublishedVolumeRepo()
 	publishedVol := df.GetPublishedVolumeRepo()
+	log := df.GetLogger()
 
 	// fetch the target file form the unpublished volume
 	filename := form.DocumentID.String()
 	file, err := unpublishedVol.GetFromVolume(filename)
 	if err != nil {
+		log.Write(fmt.Sprintf("failed to get file: %s from volume", filename))
+		log.Write(err.Error())
 		return handlerResponse[empty]{
 			Status: http.StatusNotFound,
 		}
 	}
 
 	// Copy over to the target volume
-	if publishedVol.CopyToVolume(file, filename) != nil {
+	err = publishedVol.CopyToVolume(file, filename)
+	if err != nil {
+		log.Write("failed to copy file to published volume")
+		log.Write(err.Error())
 		return handlerResponse[empty]{
 			Status: http.StatusInternalServerError,
 		}
 	}
-
 	return handlerResponse[empty]{}
 }
 
@@ -86,8 +122,11 @@ func GetPublishedDocument(form ValidGetPublishedDocumentRequest, df DependencyFa
 	log := df.GetLogger()
 
 	// Get file from published volume
-	file, err := publishedVol.GetFromVolume(form.DocumentID.String())
+	filename := form.DocumentID.String()
+	file, err := publishedVol.GetFromVolume(filename)
 	if err != nil {
+		log.Write(fmt.Sprintf("failed to get file: %s from volume", filename))
+		log.Write(err.Error())
 		return handlerResponse[[]byte]{
 			Status: http.StatusNotFound,
 		}
@@ -99,6 +138,7 @@ func GetPublishedDocument(form ValidGetPublishedDocumentRequest, df DependencyFa
 	bytes, err := buf.ReadFrom(file)
 	if err != nil || bytes == 0 {
 		log.Write("failed to read from the requested file")
+		log.Write(err.Error())
 		buf.WriteString(emptyFile)
 	}