fix: use pointer for sastResponse and returning nil instead of empty [IDE-724] (#333)

Author: acke

internal/api/api.go

@@ -23,7 +23,7 @@ type ApiClient interface {
 	GetFeatureFlag(flagname string, origId string) (bool, error)
 	GetUserMe() (string, error)
 	GetSelf() (contract.SelfResponse, error)
-	GetSastSettings(orgId string) (sast_contract.SastResponse, error)
+	GetSastSettings(orgId string) (*sast_contract.SastResponse, error)
 }
 
 var _ ApiClient = (*snykApiClient)(nil)
@@ -198,28 +198,26 @@ func (a *snykApiClient) GetSelf() (contract.SelfResponse, error) {
 	return selfData, nil
 }
 
-func (a *snykApiClient) GetSastSettings(orgId string) (sast_contract.SastResponse, error) {
-	var response sast_contract.SastResponse
-	var defaultResult sast_contract.SastResponse
-
+func (a *snykApiClient) GetSastSettings(orgId string) (*sast_contract.SastResponse, error) {
 	endpoint := a.url + "/v1/cli-config/settings/sast?org=" + url.QueryEscape(orgId)
 	res, err := a.client.Get(endpoint)
 	if err != nil {
-		return defaultResult, fmt.Errorf("unable to retrieve settings: %w", err)
+		return nil, fmt.Errorf("unable to retrieve settings: %w", err)
 	}
 	//goland:noinspection GoUnhandledErrorResult
 	defer res.Body.Close()
 
 	body, err := io.ReadAll(res.Body)
 	if err != nil {
-		return defaultResult, fmt.Errorf("unable to retrieve settings: %w", err)
+		return nil, fmt.Errorf("unable to retrieve settings: %w", err)
 	}
 
+	var response sast_contract.SastResponse
 	if err = json.Unmarshal(body, &response); err != nil {
-		return defaultResult, fmt.Errorf("unable to retrieve settings (status: %d): %w", res.StatusCode, err)
+		return nil, fmt.Errorf("unable to retrieve settings (status: %d): %w", res.StatusCode, err)
 	}
 
-	return response, err
+	return &response, err
 }
 
 // clientGet performs an HTTP GET request to the Snyk API, handling query parameters,

internal/mocks/api.go

@@ -54,11 +54,11 @@ func getSastSettings(engine workflow.Engine) (*sast_contract.SastResponse, error
 	tmp, err := apiClient.GetSastSettings(org)
 	if err != nil {
 		engine.GetLogger().Err(err).Msg("Failed to access settings.")
-		return &tmp, err
+		return nil, err
 	}
 
-	engine.GetConfiguration().Set(code_workflow.ConfigurationSastSettings, &tmp)
-	return &tmp, nil
+	engine.GetConfiguration().Set(code_workflow.ConfigurationSastSettings, tmp)
+	return tmp, nil
 }
 
 func getSastSettingsConfig(engine workflow.Engine) configuration.DefaultValueFunction {
@@ -70,7 +70,7 @@ func getSastSettingsConfig(engine workflow.Engine) configuration.DefaultValueFun
 		response, err := getSastSettings(engine)
 		if err != nil {
 			engine.GetLogger().Err(err).Msg("Failed to access settings.")
-			return false, err
+			return nil, err
 		}
 
 		return response, nil