fix: refactor shared types and constants to sast_contract

Author: acke

domain/ide/command/sast_enabled.go

@@ -18,7 +18,7 @@ package command
 
 import (
 	"context"
-	"github.com/snyk/go-application-framework/pkg/configuration"
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow"
 	"github.com/snyk/snyk-ls/application/config"
 
 	"github.com/rs/zerolog"
@@ -47,7 +47,7 @@ func (cmd *sastEnabled) Execute(_ context.Context) (any, error) {
 	}
 
 	gafConfig := cmd.c.Engine().GetConfiguration()
-	sastResponse := gafConfig.Get(configuration.SAST_SETTINGS)
+	sastResponse := gafConfig.Get(code_workflow.ConfigurationSastSettings)
 
 	return sastResponse, nil
 }

domain/ide/command/sast_enabled_test.go

@@ -18,6 +18,7 @@ package command
 
 import (
 	"context"
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -28,8 +29,6 @@ import (
 	"github.com/snyk/snyk-ls/internal/notification"
 	"github.com/snyk/snyk-ls/internal/observability/error_reporting"
 	"github.com/snyk/snyk-ls/internal/testutil"
-
-	"github.com/snyk/go-application-framework/pkg/common"
 )
 
 func Test_ApiClient_isCalledAndResultReturned(t *testing.T) {
@@ -42,7 +41,7 @@ func Test_ApiClient_isCalledAndResultReturned(t *testing.T) {
 
 	result, _ := sastEnabledCmd.Execute(context.Background())
 
-	assert.True(t, result.(common.SastResponse).SastEnabled)
+	assert.True(t, result.(code_workflow.SastResponse).SastEnabled)
 }
 
 func setupSastEnabledCommand(t *testing.T, c *config.Config, fakeApiClient *snyk_api.FakeApiClient) sastEnabled {

infrastructure/code/code.go

@@ -19,6 +19,7 @@ package code
 import (
 	"bytes"
 	"context"
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow/sast_contract"
 	"os"
 	"sync"
 	"time"
@@ -47,8 +48,7 @@ import (
 	"github.com/snyk/snyk-ls/internal/progress"
 	"github.com/snyk/snyk-ls/internal/uri"
 
-	"github.com/snyk/go-application-framework/pkg/common"
-	"github.com/snyk/go-application-framework/pkg/configuration"
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow"
 )
 
 type ScanStatus struct {
@@ -151,13 +151,13 @@ func (sc *Scanner) Scan(ctx context.Context, path types.FilePath, folderPath typ
 		return issues, err
 	}
 	gafConfig := sc.C.Engine().GetConfiguration()
-	sastResponse := gafConfig.Get(configuration.SAST_SETTINGS)
+	sastResponse := gafConfig.Get(code_workflow.ConfigurationSastSettings)
 
-	sastSettings, ok := sastResponse.(common.SastResponse)
+	sastSettingsPtr, ok := sastResponse.(*sast_contract.SastResponse)
 	if !ok {
 		return issues, errors.New("Failed to convert SAST settings to the correct type")
 	}
-
+	sastSettings := *sastSettingsPtr
 	if !sc.isSastEnabled(sastSettings) {
 		return issues, errors.New("SAST is not enabled")
 	}
@@ -166,7 +166,7 @@ func (sc *Scanner) Scan(ctx context.Context, path types.FilePath, folderPath typ
 		sc.updateCodeApiLocalEngine(sastSettings)
 	}
 
-	sc.C.SetDeepCodeAIFixEnabled(sastResponse.AutofixEnabled)
+	sc.C.SetDeepCodeAIFixEnabled(sastSettings.AutofixEnabled)
 
 	sc.changedFilesMutex.Lock()
 	if sc.changedPaths[folderPath] == nil {

infrastructure/code/sast_enabled.go

@@ -17,7 +17,7 @@
 package code
 
 import (
-	"github.com/snyk/go-application-framework/pkg/common"
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow/sast_contract"
 	"github.com/snyk/snyk-ls/internal/data_structure"
 	"github.com/snyk/snyk-ls/internal/types"
 )
@@ -29,7 +29,7 @@ const codeDisabledInOrganisationMessageText = "It looks like your organization h
 const enableSnykCodeMessageActionItemTitle types.MessageAction = "Enable Snyk Code"
 const closeMessageActionItemTitle types.MessageAction = "Close"
 
-func (sc *Scanner) isSastEnabled(sastResponse common.SastResponse) bool {
+func (sc *Scanner) isSastEnabled(sastResponse sast_contract.SastResponse) bool {
 	if !sastResponse.SastEnabled {
 		// this is processed in the listener registered to translate into the right client protocol
 		actionCommandMap := data_structure.NewOrderedMap[types.MessageAction, types.CommandData]()

infrastructure/code/sast_enabled_test.go

@@ -17,6 +17,7 @@
 package code
 
 import (
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow/sast_contract"
 	"strconv"
 	"testing"
 
@@ -27,8 +28,6 @@ import (
 	"github.com/snyk/snyk-ls/internal/data_structure"
 	"github.com/snyk/snyk-ls/internal/notification"
 	"github.com/snyk/snyk-ls/internal/types"
-
-	"github.com/snyk/go-application-framework/pkg/common"
 )
 
 func TestIsSastEnabled(t *testing.T) {
@@ -37,9 +36,9 @@ func TestIsSastEnabled(t *testing.T) {
 		ApiError:    nil,
 	}
 
-	mockedSastResponse := common.SastResponse{
+	mockedSastResponse := sast_contract.SastResponse{
 		SastEnabled: true,
-		LocalCodeEngine: common.LocalCodeEngine{
+		LocalCodeEngine: sast_contract.LocalCodeEngine{
 			AllowCloudUpload: false,
 			Url:              "http://local.engine",
 			Enabled:          true,

infrastructure/code/sast_local_engine.go

@@ -17,16 +17,16 @@
 package code
 
 import (
-	"github.com/snyk/go-application-framework/pkg/common"
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow/sast_contract"
 	"github.com/snyk/snyk-ls/application/config"
 )
 
-func (sc *Scanner) isLocalEngineEnabled(sastResponse common.SastResponse) bool {
+func (sc *Scanner) isLocalEngineEnabled(sastResponse sast_contract.SastResponse) bool {
 	sc.C.Logger().Debug().Any("sastResponse", sastResponse).Msg("sast response")
 	return sastResponse.SastEnabled && sastResponse.LocalCodeEngine.Enabled
 }
 
-func (sc *Scanner) updateCodeApiLocalEngine(sastResponse common.SastResponse) {
+func (sc *Scanner) updateCodeApiLocalEngine(sastResponse sast_contract.SastResponse) {
 	config.CurrentConfig().SetSnykCodeApi(sastResponse.LocalCodeEngine.Url)
 	api := config.CurrentConfig().SnykCodeApi()
 	sc.C.Logger().Debug().Str("snykCodeApi", api).Msg("updated Snyk Code API Local Engine")

infrastructure/code/sast_local_engine_test.go

@@ -17,7 +17,7 @@
 package code
 
 import (
-	"github.com/snyk/go-application-framework/pkg/configuration"
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow/sast_contract"
 	"slices"
 	"testing"
 
@@ -27,7 +27,7 @@ import (
 	"github.com/snyk/snyk-ls/infrastructure/snyk_api"
 	"github.com/snyk/snyk-ls/internal/notification"
 
-	"github.com/snyk/go-application-framework/pkg/common"
+	"github.com/snyk/go-application-framework/pkg/configuration"
 )
 
 func TestIsLocalEngine(t *testing.T) {
@@ -37,9 +37,9 @@ func TestIsLocalEngine(t *testing.T) {
 		ApiError:    nil,
 	}
 
-	mockedSastResponse := common.SastResponse{
+	mockedSastResponse := sast_contract.SastResponse{
 		SastEnabled: true,
-		LocalCodeEngine: common.LocalCodeEngine{
+		LocalCodeEngine: sast_contract.LocalCodeEngine{
 			AllowCloudUpload: false,
 			Url:              "http://local.engine",
 			Enabled:          true,

infrastructure/snyk_api/snyk_api_pact_test.go

@@ -18,8 +18,7 @@ package snyk_api
 
 import (
 	"fmt"
-	"github.com/snyk/go-application-framework/pkg/common"
-	"github.com/snyk/go-application-framework/pkg/configuration"
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow"
 	"net/http"
 	"testing"
 
@@ -56,9 +55,9 @@ func TestSnykApiPact(t *testing.T) {
 	}()
 
 	t.Run("Get SAST enablement", func(t *testing.T) {
-		expectedResponse := common.SastResponse{
+		expectedResponse := code_workflow.SastResponse{
 			SastEnabled:                 true,
-			LocalCodeEngine:             common.LocalCodeEngine{Enabled: false},
+			LocalCodeEngine:             code_workflow.LocalCodeEngine{Enabled: false},
 			ReportFalsePositivesEnabled: false,
 			AutofixEnabled:              false,
 		}
@@ -114,9 +113,9 @@ func TestSnykApiPact(t *testing.T) {
 		organization := orgUUID
 		c.SetOrganization(organization)
 
-		expectedResponse := common.SastResponse{
+		expectedResponse := code_workflow.SastResponse{
 			SastEnabled:                 true,
-			LocalCodeEngine:             common.LocalCodeEngine{Enabled: false},
+			LocalCodeEngine:             code_workflow.LocalCodeEngine{Enabled: false},
 			ReportFalsePositivesEnabled: false,
 			AutofixEnabled:              false,
 		}