refactor(misc): code quality checks with Qodana

.run/api.run.xml → api/.run/api.run.xml

@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="api" type="GoApplicationRunConfiguration" factoryName="Go Application">
-    <module name="voltaserve" />
-    <working_directory value="$PROJECT_DIR$/api" />
+    <module name="api" />
+    <working_directory value="$PROJECT_DIR$" />
     <kind value="PACKAGE" />
     <package value="github.com/kouprlabs/voltaserve/api" />
     <directory value="$PROJECT_DIR$" />
-    <filePath value="$PROJECT_DIR$/api/main.go" />
+    <filePath value="$PROJECT_DIR$" />
     <method v="2" />
   </configuration>
 </component>

api/client/conversion_client/pipeline_client.go

@@ -30,10 +30,6 @@ func NewPipelineClient() *PipelineClient {
 }
 
 const (
-	PipelinePDF      = "pdf"
-	PipelineOffice   = "office"
-	PipelineImage    = "image"
-	PipelineVideo    = "video"
 	PipelineInsights = "insights"
 	PipelineMosaic   = "mosaic"
 )

api/infra/file_identifier.go

@@ -13,10 +13,12 @@ package infra
 import (
 	"archive/zip"
 	"encoding/json"
+	"io"
 	"path/filepath"
 	"strings"
 
 	"github.com/kouprlabs/voltaserve/api/config"
+	"github.com/kouprlabs/voltaserve/api/log"
 )
 
 type FileIdentifier struct {
@@ -207,13 +209,17 @@ type GLTF struct {
 	} `json:"buffers"`
 }
 
-/* Inspects a ZIP archive to see if it contains a glTF 2.0 structure. */
+// IsGLTF inspects a ZIP archive to see if it contains a glTF 2.0 structure.
 func (fi *FileIdentifier) IsGLTF(path string) (bool, error) {
 	zipFile, err := zip.OpenReader(path)
 	if err != nil {
 		return false, err
 	}
-	defer zipFile.Close()
+	defer func(zipFile *zip.ReadCloser) {
+		if err := zipFile.Close(); err != nil {
+			log.GetLogger().Error(err)
+		}
+	}(zipFile)
 	var hasGLTF, hasBin bool
 	var gltfFile *zip.File
 	for _, file := range zipFile.File {
@@ -231,7 +237,11 @@ func (fi *FileIdentifier) IsGLTF(path string) (bool, error) {
 			if err != nil {
 				return false, err
 			}
-			defer rc.Close()
+			defer func(rc io.ReadCloser) {
+				if err := rc.Close(); err != nil {
+					log.GetLogger().Error(err)
+				}
+			}(rc)
 			var gltf GLTF
 			if err := json.NewDecoder(rc).Decode(&gltf); err != nil {
 				return false, err
@@ -244,7 +254,7 @@ func (fi *FileIdentifier) IsGLTF(path string) (bool, error) {
 			}
 		}
 	}
-	return hasGLTF && (!hasBin || (hasBin && gltfFile != nil)), nil
+	return hasGLTF && (!hasBin || gltfFile != nil), nil
 }
 
 func (fi *FileIdentifier) GetProcessingLimitMB(path string) int {

api/model/snapshot_model.go

@@ -14,7 +14,6 @@ const (
 	SnapshotStatusWaiting    = "waiting"
 	SnapshotStatusProcessing = "processing"
 	SnapshotStatusReady      = "ready"
-	SnapshotStatusError      = "error"
 )
 
 type Snapshot interface {

api/model/task_model.go

@@ -13,8 +13,6 @@ package model
 const (
 	TaskStatusWaiting = "waiting"
 	TaskStatusRunning = "running"
-	TaskStatusSuccess = "success"
-	TaskStatusError   = "error"
 )
 
 type Task interface {

api/qodana.yaml

@@ -0,0 +1,29 @@
+#-------------------------------------------------------------------------------#
+#               Qodana analysis is configured by qodana.yaml file               #
+#             https://www.jetbrains.com/help/qodana/qodana-yaml.html            #
+#-------------------------------------------------------------------------------#
+version: "1.0"
+
+#Specify inspection profile for code analysis
+profile:
+  name: qodana.starter
+
+#Enable inspections
+#include:
+#  - name: <SomeEnabledInspectionId>
+
+#Disable inspections
+#exclude:
+#  - name: <SomeDisabledInspectionId>
+#    paths:
+#      - <path/where/not/run/inspection>
+
+#Execute shell command before Qodana execution (Applied in CI/CD pipeline)
+#bootstrap: sh ./prepare-qodana.sh
+
+#Install IDE plugins before Qodana execution (Applied in CI/CD pipeline)
+#plugins:
+#  - id: <plugin.id> #(plugin id can be found at https://plugins.jetbrains.com)
+
+#Specify Qodana linter for analysis (Applied in CI/CD pipeline)
+linter: jetbrains/qodana-go:latest

api/router/user_router.go

@@ -214,7 +214,7 @@ func (r *UserRouter) DownloadPicture(c *fiber.Ctx) error {
 		return errorpkg.NewUserPictureNotFoundError(nil)
 	}
 	c.Set("Content-Type", *mime)
-	c.Set("Content-Disposition", fmt.Sprintf("filename=\"picture%s\"", ext))
+	c.Set("Content-Disposition", fmt.Sprintf("filename=\"picture%s\"", *ext))
 	return c.Send(b)
 }
 

api/search/user_search.go

@@ -35,7 +35,7 @@ func (s *UserSearch) Query(query string, opts infra.QueryOptions) ([]model.User,
 	if err != nil {
 		return nil, err
 	}
-	res := []model.User{}
+	res := make([]model.User, 0)
 	for _, v := range hits {
 		b, err := json.Marshal(v)
 		if err != nil {

api/service/file_service.go

@@ -1372,7 +1372,7 @@ func (svc *FileService) DeleteOne(id string, userID string) error {
 		for _, treeID := range treeIDs {
 			if err := svc.fileCache.Delete(treeID); err != nil {
 				// Here we intentionally don't return an error or panic, we just print the error
-				fmt.Println(err)
+				log.GetLogger().Error(err)
 			}
 		}
 	}(treeIDs)
@@ -1381,7 +1381,7 @@ func (svc *FileService) DeleteOne(id string, userID string) error {
 	go func(ids []string) {
 		if err := svc.fileSearch.Delete(treeIDs); err != nil {
 			// Here we intentionally don't return an error or panic, we just print the error
-			fmt.Println(err)
+			log.GetLogger().Error(err)
 		}
 	}(treeIDs)
 

console/qodana.yaml

@@ -0,0 +1,29 @@
+#-------------------------------------------------------------------------------#
+#               Qodana analysis is configured by qodana.yaml file               #
+#             https://www.jetbrains.com/help/qodana/qodana-yaml.html            #
+#-------------------------------------------------------------------------------#
+version: "1.0"
+
+#Specify inspection profile for code analysis
+profile:
+  name: qodana.starter
+
+#Enable inspections
+#include:
+#  - name: <SomeEnabledInspectionId>
+
+#Disable inspections
+#exclude:
+#  - name: <SomeDisabledInspectionId>
+#    paths:
+#      - <path/where/not/run/inspection>
+
+#Execute shell command before Qodana execution (Applied in CI/CD pipeline)
+#bootstrap: sh ./prepare-qodana.sh
+
+#Install IDE plugins before Qodana execution (Applied in CI/CD pipeline)
+#plugins:
+#  - id: <plugin.id> #(plugin id can be found at https://plugins.jetbrains.com)
+
+#Specify Qodana linter for analysis (Applied in CI/CD pipeline)
+linter: jetbrains/qodana-python:latest

.run/conversion.run.xml → conversion/.run/conversion.run.xml

@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="conversion" type="GoApplicationRunConfiguration" factoryName="Go Application">
-    <module name="voltaserve" />
-    <working_directory value="$PROJECT_DIR$/conversion" />
+    <module name="conversion" />
+    <working_directory value="$PROJECT_DIR$" />
     <kind value="PACKAGE" />
     <package value="github.com/kouprlabs/voltaserve/conversion" />
     <directory value="$PROJECT_DIR$" />
-    <filePath value="$PROJECT_DIR$/conversion/main.go" />
+    <filePath value="$PROJECT_DIR$" />
     <method v="2" />
   </configuration>
 </component>

conversion/client/api_client/snapshot_client.go

@@ -46,7 +46,6 @@ type SnapshotPatchOptions struct {
 }
 
 const (
-	SnapshotStatusWaiting    = "waiting"
 	SnapshotStatusProcessing = "processing"
 	SnapshotStatusReady      = "ready"
 	SnapshotStatusError      = "error"
@@ -61,7 +60,6 @@ const (
 	SnapshotFieldMosaic    = "mosaic"
 	SnapshotFieldThumbnail = "thumbnail"
 	SnapshotFieldStatus    = "status"
-	SnapshotFieldLanguage  = "language"
 	SnapshotFieldTaskID    = "taskId"
 )
 

conversion/client/api_client/task_client.go

@@ -42,7 +42,6 @@ type TaskCreateOptions struct {
 }
 
 const (
-	TaskStatusWaiting = "waiting"
 	TaskStatusRunning = "running"
 	TaskStatusSuccess = "success"
 	TaskStatusError   = "error"
@@ -83,13 +82,9 @@ type TaskPatchOptions struct {
 }
 
 const (
-	TaskFieldName            = "name"
-	TaskFieldError           = "error"
-	TaskFieldPercentage      = "percentage"
-	TaskFieldIsIndeterminate = "isIndeterminate"
-	TaskFieldUserID          = "userId"
-	TaskFieldStatus          = "status"
-	TaskFieldPayload         = "payload"
+	TaskFieldName   = "name"
+	TaskFieldError  = "error"
+	TaskFieldStatus = "status"
 )
 
 func (cl *TaskClient) Patch(id string, opts TaskPatchOptions) error {