address performance improvement feedback from GuardRails team

Author: wahyudibo

internal/archiver/archiver.go

@@ -76,44 +76,58 @@ func compress(projectPath string, filepaths []string, output io.Writer) (err err
 	}()
 
 	for _, path := range filepaths {
-		// path variables only contains relative path of the project root, so we need to append project path to get absolute path.
-		// path/filepath packages works cross platform which will use appropriate file separator based on OS.
-		fullpath := filepath.Join(projectPath, path)
-
-		file, err := os.Open(fullpath)
+		isDir, err := compressFile(projectPath, path, tarWriter)
 		if err != nil {
 			return err
 		}
-		defer func() {
-			closeErr := file.Close()
-			if err == nil {
-				err = closeErr
-			}
-		}()
-
-		fileInfo, err := file.Stat()
-		if err != nil {
-			return err
-		}
-		if fileInfo.IsDir() {
+		if isDir {
 			continue
 		}
+	}
 
-		header, err := tar.FileInfoHeader(fileInfo, fileInfo.Name())
-		if err != nil {
-			return err
-		}
-		header.Name = strings.Replace(strings.TrimPrefix(path, string(filepath.Separator)), "\\", "/", -1)
-		err = tarWriter.WriteHeader(header)
-		if err != nil {
-			return err
-		}
+	return nil
+}
 
-		_, err = io.Copy(tarWriter, file)
-		if err != nil {
-			return err
+func compressFile(projectPath, path string, writer *tar.Writer) (bool, error) {
+	// path variables only contains relative path of the project root, so we need to append project path to get absolute path.
+	// path/filepath packages works cross platform which will use appropriate file separator based on OS.
+	fullpath := filepath.Join(projectPath, path)
+
+	file, err := os.Open(fullpath)
+	if err != nil {
+		return false, err
+	}
+
+	defer func() {
+		closeErr := file.Close()
+		if err == nil {
+			err = closeErr
 		}
+	}()
+
+	fileInfo, err := file.Stat()
+	if err != nil {
+		return false, err
+	}
+	if fileInfo.IsDir() {
+		return true, nil
 	}
 
-	return nil
+	header, err := tar.FileInfoHeader(fileInfo, fileInfo.Name())
+	if err != nil {
+		return false, err
+	}
+
+	header.Name = strings.Replace(strings.TrimPrefix(path, string(filepath.Separator)), "\\", "/", -1)
+	err = writer.WriteHeader(header)
+	if err != nil {
+		return false, err
+	}
+
+	_, err = io.Copy(writer, file)
+	if err != nil {
+		return false, err
+	}
+
+	return false, nil
 }

internal/client/guardrails/message.go

@@ -95,7 +95,7 @@ type GetScanDataRuleResp struct {
 		Name   string `json:"name"`
 		Docs   string `json:"docs"`
 	} `json:"rule"`
-	Languages       []string                         `json:"languages"`
+	Languages       []string                         `json:"language"`
 	Count           *GetScanDataCountResp            `json:"count"`
 	Vulnerabilities []GetScanDataVulnerabilitiesResp `json:"vulnerabilities"`
 }

internal/command/scan/args.go

@@ -17,7 +17,8 @@ const (
 )
 
 var (
-	ErrMissingToken = errors.New("missing token, please provide your Guardrails CLI token via -—token option or GUARDRAILS_CLI_TOKEN environment variable")
+	ErrMissingToken       = errors.New("missing token, please provide your Guardrails CLI token via -—token option or GUARDRAILS_CLI_TOKEN environment variable")
+	ErrInvalidFormatParam = errors.New("failed to parse format value")
 )
 
 // Args provides arguments for scan command handler.
@@ -49,7 +50,7 @@ func (args *Args) SetDefault() error {
 func isFormatAllowed(value interface{}) error {
 	input, ok := value.(string)
 	if !ok {
-		return errors.New("failed to parse format value")
+		return ErrInvalidFormatParam
 	}
 
 	allowedFormat := []string{FormatJSON, FormatCSV, FormatSARIF, FormatPretty}

internal/repository/repository.go

@@ -17,6 +17,7 @@ var (
 	ErrNotAValidGitRepo = func(path string) error {
 		return fmt.Errorf("%s is not a valid git repository", path)
 	}
+	ErrGitRemoteURLNotFound = errors.New("repository doesn't have remote URLs")
 )
 
 //go:generate mockgen -destination=mock/repository.go -package=mockrepository . Repository
@@ -71,7 +72,7 @@ func (r *repository) GetMetadataFromRemoteURL() (*Metadata, error) {
 	// TODO: currently we only take first remote URL from origin. It could be expanded later since git can have multiple remote urls.
 	remoteURLs := cfg.Remotes["origin"].URLs
 	if len(remoteURLs) == 0 {
-		return nil, errors.New("repository doesn't have remote URLs")
+		return nil, ErrGitRemoteURLNotFound
 	}
 
 	remoteURL := remoteURLs[0]