v0.10.1

Fix:

- Fix the instrumentation tool ignoring vendored packages and leading to missing
  hook points in the agent.

Author: Julio Guerra

CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.10.1
+
+## Fix
+
+- (#116) Fix the instrumentation tool ignoring vendored packages, leading to
+  missing hook points in the agent.
+
 # v0.10.0
 
 ## New Features

internal/app/runtime.go

@@ -153,11 +153,15 @@ func executable(logger *plog.Logger) string {
 
 func VendorPrefix() string {
 	type t struct{}
-	pkg := reflect.TypeOf(t{}).PkgPath()
-	vendor := "vendor/"
-	i := strings.Index(pkg, vendor)
+	pkgPath := reflect.TypeOf(t{}).PkgPath()
+	return vendorPrefix(pkgPath)
+}
+
+func vendorPrefix(pkgPath string) (prefix string) {
+	vendor := "/vendor/"
+	i := strings.Index(pkgPath, vendor)
 	if i == -1 {
 		return ""
 	}
-	return pkg[:i+len(vendor)]
+	return pkgPath[:i+len(vendor)]
 }

internal/app/runtime_test.go

@@ -0,0 +1,39 @@
+// Copyright (c) 2016 - 2020 Sqreen. All Rights Reserved.
+// Please refer to our terms for more information:
+// https://www.sqreen.io/terms.html
+
+package app
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestVendorPrefix(t *testing.T) {
+	for _, tc := range []struct {
+		PkgPath  string
+		Expected string
+	}{
+		{
+			PkgPath:  "github.com/sqreen/go-agent/internal/protection/http",
+			Expected: "",
+		},
+
+		{
+			PkgPath:  "github.com/my-org/my-app/vendor/github.com/sqreen/go-agent/internal/protection/http",
+			Expected: "github.com/my-org/my-app/vendor/",
+		},
+
+		{
+			PkgPath:  "my-app/vendor/github.com/sqreen/go-agent/internal/protection/http",
+			Expected: "my-app/vendor/",
+		},
+	} {
+		tc := tc
+		t.Run("", func(t *testing.T) {
+			got := vendorPrefix(tc.PkgPath)
+			require.Equal(t, tc.Expected, got)
+		})
+	}
+}

internal/rule/rule.go

@@ -59,11 +59,17 @@ func NewEngine(logger Logger, instrumentationEngine InstrumentationFace, metrics
 	if instrumentationEngine == nil {
 		instrumentationEngine = defaultInstrumentationEngine
 	}
+
+	vendorPrefix := app.VendorPrefix()
+	if vendorPrefix != "" {
+		logger.Debugf("vendor folder detected at `%s`", vendorPrefix)
+	}
+
 	return &Engine{
 		logger:                logger,
 		metricsEngine:         metricsEngine,
 		publicKey:             publicKey,
-		vendorPrefix:          app.VendorPrefix(),
+		vendorPrefix:          vendorPrefix,
 		instrumentationEngine: instrumentationEngine,
 		errorMetricsStore:     errorMetricsStore,
 	}

internal/version/version.go

@@ -4,7 +4,7 @@
 
 package version
 
-const version = "0.10.0"
+const version = "0.10.1"
 
 func Version() string {
 	return version

sdk/sqreen-instrumentation-tool/ast.go

@@ -449,7 +449,21 @@ var limitedInstrumentationPkgPrefixes = []string{
 	"database/sql",
 }
 
+// Given the Go vendoring conventions, return the package prefix of the vendored
+// package. For example, given `my-app/vendor/github.com/sqreen/go-agent`,
+// the function should return `my-app/vendor/`
+func unvendorPackagePath(pkg string) (unvendored string) {
+	vendorDir := "/vendor/"
+	i := strings.Index(pkg, vendorDir)
+	if i == -1 {
+		return pkg
+	}
+	return pkg[i+len(vendorDir):]
+}
+
 func isPackageNameIgnored(pkg string, fullInstrumentation bool) bool {
+	pkg = unvendorPackagePath(pkg)
+
 	for _, prefix := range ignoredPkgPrefixes {
 		if strings.HasPrefix(pkg, prefix) {
 			return true

sdk/sqreen-instrumentation-tool/main_test.go

@@ -46,3 +46,31 @@ func TestParseCommandID(t *testing.T) {
 		})
 	}
 }
+
+func TestUnvendorPackagePath(t *testing.T) {
+	for _, tc := range []struct {
+		PkgPath  string
+		Expected string
+	}{
+		{
+			PkgPath:  "github.com/sqreen/go-agent/internal/protection/http",
+			Expected: "github.com/sqreen/go-agent/internal/protection/http",
+		},
+
+		{
+			PkgPath:  "github.com/my-org/my-app/vendor/github.com/sqreen/go-agent/internal/protection/http",
+			Expected: "github.com/sqreen/go-agent/internal/protection/http",
+		},
+
+		{
+			PkgPath:  "my-app/vendor/github.com/sqreen/go-agent/internal/protection/http",
+			Expected: "github.com/sqreen/go-agent/internal/protection/http",
+		},
+	} {
+		tc := tc
+		t.Run("", func(t *testing.T) {
+			got := unvendorPackagePath(tc.PkgPath)
+			require.Equal(t, tc.Expected, got)
+		})
+	}
+}