feat: add analytics event processing [IDE-736]

.github/workflows/build.yaml

@@ -18,8 +18,28 @@ on:
   pull_request:
 
 jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Prepare git
+        run: git config --global core.autocrlf false
+
+      - uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: "./go.mod"
+          cache: "true"
+
+      - name: Lint source code
+        run: |
+          make tools lint
+
   unit-tests:
     name: unit tests
+    needs: [lint]
     runs-on: ubuntu-latest
     steps:
       - name: Prepare git
@@ -49,10 +69,6 @@ jobs:
         run: |
           make tools
 
-      - name: Lint source code
-        run: |
-          make tools lint
-
       - name: Run tests
         env:
           DEEPROXY_API_URL: ${{secrets.DEEPROXY_API_URL}}
@@ -70,6 +86,7 @@ jobs:
 
   integration-tests:
     name: integration-tests
+    needs: [lint]
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -99,12 +116,13 @@ jobs:
         run: |
           make tools
 
-      - name: Run integration tests with Pact
+      - name: Run integration & smoke tests with Pact
         if: matrix.os == 'ubuntu-latest'
         env:
           DEEPROXY_API_URL: ${{secrets.DEEPROXY_API_URL}}
           SNYK_TOKEN: ${{secrets.SNYK_TOKEN }}
           INTEG_TESTS: "true"
+          SMOKE_TESTS: "true"
         run: |
           export PATH=$PATH:~/pact/bin
 
@@ -121,6 +139,7 @@ jobs:
           DEEPROXY_API_URL: ${{secrets.DEEPROXY_API_URL}}
           SNYK_TOKEN: ${{secrets.SNYK_TOKEN }}
           INTEG_TESTS: "true"
+          SMOKE_TESTS: "true"
         run: |
           export PATH=$PATH:~/pact/bin
 
@@ -136,12 +155,14 @@ jobs:
           DEEPROXY_API_URL: ${{secrets.DEEPROXY_API_URL}}
           SNYK_TOKEN: ${{secrets.SNYK_TOKEN }}
           INTEG_TESTS: "true"
+          SMOKE_TESTS: "true"
         run: |
           make clean test
 
 
   proxy-test:
     name: proxy-test
+    needs: [lint]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -154,6 +175,7 @@ jobs:
 
   race-tests:
     name: race-test
+    needs: [lint]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -216,6 +238,7 @@ jobs:
           push: true
   test-release:
     name: test-release
+    needs: [lint, unit-tests]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.github/workflows/release.yaml

@@ -14,9 +14,6 @@
 name: Release
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - "main"
 
 # Grant an OIDC token which we can exchange for an AWS IAM role
 permissions:

domain/ide/command/report_analytics_test.go

@@ -18,11 +18,13 @@ package command
 
 import (
 	"context"
+	"encoding/json"
 	"testing"
 
 	"github.com/golang/mock/gomock"
-
 	localworkflows "github.com/snyk/go-application-framework/pkg/local_workflows"
+	"github.com/snyk/go-application-framework/pkg/workflow"
+	"github.com/stretchr/testify/mock"
 
 	"github.com/snyk/snyk-ls/application/config"
 	"github.com/snyk/snyk-ls/infrastructure/authentication"
@@ -51,6 +53,52 @@ func Test_ReportAnalyticsCommand_IsCallingExtension(t *testing.T) {
 	require.Emptyf(t, output, "output should be empty")
 }
 
+func Test_ReportAnalyticsCommand_PlugInstalledEvent(t *testing.T) {
+	c := testutil.UnitTest(t)
+
+	testInput := types.AnalyticsEventParam{
+		InteractionType: "plugin installed",
+		Category:        []string{"install"},
+		Status:          "success",
+		TargetId:        "pkg:file/none",
+		TimestampMs:     123,
+		Extension:       map[string]any{"device_id": c.DeviceID()},
+	}
+
+	marshal, err := json.Marshal(testInput)
+	if err != nil {
+		return
+	}
+
+	cmd := setupReportAnalyticsCommand(t, c, string(marshal))
+
+	mockEngine, engineConfig := setUpEngineMock(t, c)
+	mockEngine.EXPECT().GetConfiguration().Return(engineConfig).AnyTimes()
+
+	mockEngine.EXPECT().InvokeWithInputAndConfig(
+		localworkflows.WORKFLOWID_REPORT_ANALYTICS,
+		mock.MatchedBy(func(i interface{}) bool {
+			inputData, ok := i.([]workflow.Data)
+			require.Truef(t, ok, "input should be workflow data")
+			require.Lenf(t, inputData, 1, "should only have one input")
+
+			payload := string(inputData[0].GetPayload().([]byte))
+
+			require.Contains(t, payload, "plugin installed")
+			require.Contains(t, payload, "install")
+			require.Contains(t, payload, "device_id")
+			require.Contains(t, payload, "123")
+
+			return true
+		}),
+		gomock.Any(),
+	).Return(nil, nil)
+
+	output, err := cmd.Execute(context.Background())
+	require.NoError(t, err)
+	require.Emptyf(t, output, "output should be empty")
+}
+
 func setupReportAnalyticsCommand(t *testing.T, c *config.Config, testInput string) *reportAnalyticsCommand {
 	t.Helper()
 	provider := authentication.NewFakeCliAuthenticationProvider(c)

domain/ide/workspace/folder.go

@@ -33,12 +33,10 @@ import (
 
 	"github.com/snyk/snyk-ls/internal/delta"
 
-	"github.com/snyk/snyk-ls/internal/types"
-	"github.com/snyk/snyk-ls/internal/util"
-
-	"github.com/google/uuid"
 	"github.com/puzpuzpuz/xsync/v3"
 
+	"github.com/snyk/snyk-ls/internal/types"
+
 	gafanalytics "github.com/snyk/go-application-framework/pkg/analytics"
 	"github.com/snyk/go-application-framework/pkg/instrumentation"
 	"github.com/snyk/go-application-framework/pkg/local_workflows/json_schemas"
@@ -376,7 +374,6 @@ func (f *Folder) updateGlobalCacheAndSeverityCounts(scanData *snyk.ScanData) {
 
 func sendAnalytics(data *snyk.ScanData) {
 	c := config.CurrentConfig()
-	gafConfig := c.Engine().GetConfiguration()
 
 	logger := c.Logger().With().Str("method", "folder.sendAnalytics").Logger()
 	if data.Product == "" {
@@ -389,38 +386,29 @@ func sendAnalytics(data *snyk.ScanData) {
 		return
 	}
 
-	ic := gafanalytics.NewInstrumentationCollector()
-
-	//Add to the interaction attribute in the analytics event
-	iid := instrumentation.AssembleUrnFromUUID(uuid.NewString())
-	ic.SetInteractionId(iid)
-	ic.SetTimestamp(data.TimestampFinished)
-	ic.SetStage("dev")
-	ic.SetInteractionType("Scan done")
-
+	// this information is not filled automatically, so we need to collect it
 	categories := setupCategories(data, c)
-	ic.SetCategory(categories)
-	ic.SetStatus(gafanalytics.Success)
-
-	summary := createTestSummary(data, c)
-	ic.SetTestSummary(summary)
-
 	targetId, err := instrumentation.GetTargetId(data.Path, instrumentation.AutoDetectedTargetId)
 	if err != nil {
 		logger.Err(err).Msg("Error creating the Target Id")
 	}
-	ic.SetTargetId(targetId)
+	summary := createTestSummary(data, c)
 
-	ic.AddExtension("device_id", c.DeviceID())
-	ic.AddExtension("is_delta_scan", data.IsDeltaScan)
+	param := types.AnalyticsEventParam{
+		InteractionType: "Scan done",
+		Category:        categories,
+		Status:          string(gafanalytics.Success),
+		TargetId:        targetId,
+		TimestampMs:     data.TimestampFinished.UnixMilli(),
+		DurationMs:      int64(data.DurationMs),
+		Extension:       map[string]any{"is_delta_scan": data.IsDeltaScan},
+	}
 
-	//Populate the runtime attribute of the analytics event
-	ua := util.GetUserAgent(gafConfig, config.Version)
-	ic.SetUserAgent(ua)
-	ic.SetDuration(data.DurationMs)
+	ic := analytics.PayloadForAnalyticsEventParam(c, param)
 
-	//Set the final type attribute of the analytics event
-	ic.SetType("analytics")
+	// test specific data is not handled in the PayloadForAnalytics helper
+	// and must be added explicitly
+	ic.SetTestSummary(summary)
 
 	analyticsData, err := gafanalytics.GetV2InstrumentationObject(ic)
 	if err != nil {

infrastructure/analytics/analytics.go

@@ -17,32 +17,62 @@
 package analytics
 
 import (
+	"encoding/json"
 	"sync"
+	"time"
 
+	"github.com/google/uuid"
+	"github.com/snyk/go-application-framework/pkg/analytics"
 	configuration2 "github.com/snyk/go-application-framework/pkg/configuration"
+	"github.com/snyk/go-application-framework/pkg/instrumentation"
 	localworkflows "github.com/snyk/go-application-framework/pkg/local_workflows"
 	"github.com/snyk/go-application-framework/pkg/workflow"
 
 	"github.com/snyk/snyk-ls/application/config"
+	"github.com/snyk/snyk-ls/internal/types"
+	"github.com/snyk/snyk-ls/internal/util"
 )
 
 var analyticsMu = sync.RWMutex{}
 
 func SendAnalyticsToAPI(c *config.Config, payload []byte) error {
 	logger := c.Logger().With().Str("method", "analytics.sendAnalyticsToAPI").Logger()
-	logger.Debug().Str("payload", string(payload)).Msg("Analytics Payload")
 
-	inputData := workflow.NewData(
-		workflow.NewTypeIdentifier(localworkflows.WORKFLOWID_REPORT_ANALYTICS, "reportAnalytics"),
-		"application/json",
-		payload,
-	)
+	var eventsParam types.AnalyticsEventParam
+	err := json.Unmarshal(payload, &eventsParam)
+	var inputData workflow.Data
+	if err == nil {
+		ic := PayloadForAnalyticsEventParam(c, eventsParam)
+		instrumentationObject, icErr := analytics.GetV2InstrumentationObject(ic)
+		if icErr != nil {
+			return err
+		}
+
+		bytes, marshalErr := json.Marshal(instrumentationObject)
+		if marshalErr != nil {
+			return marshalErr
+		}
+
+		logger.Debug().Str("payload", string(bytes)).Msg("Analytics Payload")
+		inputData = workflow.NewData(
+			workflow.NewTypeIdentifier(localworkflows.WORKFLOWID_REPORT_ANALYTICS, "reportAnalytics"),
+			"application/json",
+			bytes,
+		)
+	} else {
+		logger.Debug().Str("payload", string(payload)).Msg("Analytics Payload")
+		inputData = workflow.NewData(
+			workflow.NewTypeIdentifier(localworkflows.WORKFLOWID_REPORT_ANALYTICS, "reportAnalytics"),
+			"application/json",
+			payload,
+		)
+	}
 
 	engine := c.Engine()
 	configuration := engine.GetConfiguration().Clone()
 	configuration.Set(configuration2.FLAG_EXPERIMENTAL, true)
 	analyticsMu.Lock()
-	_, err := engine.InvokeWithInputAndConfig(
+	_, err = engine.InvokeWithInputAndConfig(
 		localworkflows.WORKFLOWID_REPORT_ANALYTICS,
 		[]workflow.Data{inputData},
 		configuration,
@@ -55,3 +85,27 @@ func SendAnalyticsToAPI(c *config.Config, payload []byte) error {
 	}
 	return nil
 }
+
+func PayloadForAnalyticsEventParam(c *config.Config, param types.AnalyticsEventParam) analytics.InstrumentationCollector {
+	ic := analytics.NewInstrumentationCollector()
+	//Add to the interaction attribute in the analytics event
+	iid := instrumentation.AssembleUrnFromUUID(uuid.NewString())
+
+	//Set the final type attribute of the analytics event
+	ic.SetType("analytics")
+	ic.SetInteractionId(iid)
+	ic.SetStage("dev")
+	ic.AddExtension("device_id", c.DeviceID())
+	for s, a := range param.Extension {
+		ic.AddExtension(s, a)
+	}
+	ua := util.GetUserAgent(c.Engine().GetConfiguration(), config.Version)
+	ic.SetUserAgent(ua)
+
+	ic.SetTimestamp(time.UnixMilli(param.TimestampMs))
+	ic.SetInteractionType(param.InteractionType)
+	ic.SetStatus(analytics.Status(param.Status))
+	ic.SetCategory(param.Category)
+	ic.SetTargetId(param.TargetId)
+	return ic
+}

internal/types/command.go

@@ -119,3 +119,15 @@ func (service *CommandServiceMock) ExecutedCommands() []CommandData {
 	service.m.Unlock()
 	return cmds
 }
+
+type AnalyticsEventParam struct {
+	InteractionType string         `json:"interactionType"`
+	Category        []string       `json:"category"`
+	Status          string         `json:"status"`
+	TargetId        string         `json:"targetId"`
+	TimestampMs     int64          `json:"timestampMs"`
+	DurationMs      int64          `json:"durationMs"`
+	Results         map[string]any `json:"results"`
+	Errors          []any          `json:"errors"`
+	Extension       map[string]any `json:"extension"`
+}