feat: send delta scan information to analytics [IDE-528] (#621)

Author: bastiandoetsch

domain/ide/workspace/folder.go

@@ -405,6 +405,7 @@ func sendAnalytics(data *snyk.ScanData) {
 	ic.SetTargetId(targetId)
 
 	ic.AddExtension("device_id", c.DeviceID())
+	ic.AddExtension("is_delta_scan", data.IsDeltaScan)
 
 	//Populate the runtime attribute of the analytics event
 	ua := util.GetUserAgent(gafConfig, config.Version)

domain/ide/workspace/folder_test.go

@@ -19,12 +19,13 @@ package workspace
 import (
 	"context"
 	"errors"
-	"github.com/snyk/snyk-ls/domain/snyk/persistence"
 	"path/filepath"
 	"sync"
 	"testing"
 	"time"
 
+	"github.com/snyk/snyk-ls/domain/snyk/persistence"
+
 	"github.com/golang/mock/gomock"
 	"github.com/google/uuid"
 	"github.com/puzpuzpuz/xsync/v3"

domain/snyk/scan_result_processor.go

@@ -29,6 +29,7 @@ type ScanData struct {
 	DurationMs        time.Duration
 	TimestampFinished time.Time
 	Path              string
+	IsDeltaScan       bool
 }
 
 type ScanResultProcessor = func(scanData ScanData)

domain/snyk/scanner.go

@@ -272,6 +272,12 @@ func (sc *DelegatingConcurrentScanner) Scan(
 					TimestampFinished: time.Now().UTC(),
 					Path:              folderPath,
 				}
+
+				// in case of delta scans, we add additional fields
+				if deltaScanner, ok := s.(types.DeltaScanner); ok {
+					data.IsDeltaScan = deltaScanner.DeltaScanningEnabled()
+				}
+
 				processResults(data)
 				logger.Info().Msgf("Scanning %s with %T: COMPLETE found %v issues", path, s, len(foundIssues))
 			}(scanner)

infrastructure/code/code.go

@@ -48,6 +48,8 @@ import (
 	"github.com/snyk/snyk-ls/internal/uri"
 )
 
+var _ types.DeltaScanner = (*Scanner)(nil)
+
 type ScanStatus struct {
 	// finished channel is closed once the scan has finished
 	finished chan bool
@@ -92,6 +94,10 @@ type Scanner struct {
 	scanPersister       persistence.ScanSnapshotPersister
 }
 
+func (sc *Scanner) DeltaScanningEnabled() bool {
+	return sc.c.IsDeltaFindingsEnabled()
+}
+
 func New(bundleUploader *BundleUploader, apiClient snyk_api.SnykApiClient, reporter codeClientObservability.ErrorReporter, learnService learn.Service, notifier notification.Notifier, codeScanner codeClient.CodeScanner, scanPersister persistence.ScanSnapshotPersister) *Scanner {
 	sc := &Scanner{
 		BundleUploader: bundleUploader,

internal/types/delta.go

@@ -0,0 +1,21 @@
+/*
+ * © 2024 Snyk Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package types
+
+type DeltaScanner interface {
+	DeltaScanningEnabled() bool
+}