fix(internal/ensure): Do not fail hard when the submodule does not exist (#736)

Signed-off-by: Kemal Akkoyun <[email protected]>

Fixes #732

Signed-off-by: Kemal Akkoyun <[email protected]>

Author: kakkoyun

internal/ensure/requiredintegrations.go

@@ -196,23 +196,41 @@ var (
 
 func fetchShippedVersions() map[string]string {
 	initOnce.Do(func() {
-		versions := make(map[string]string)
 		_, thisFile, _, _ := runtime.Caller(0)
-		// The version of dd-trace-go that shipped with the current version of orchestrion.
-		// We use this to determine if we need to upgrade dd-trace-go when pinning.
 		orchestrionRoot := filepath.Join(thisFile, "..", "..", "..")
-		ver, err := resolveDependencyVersion(orchestrionRoot, integrations.DatadogTracerV2)
-		if err != nil {
-			panic(fmt.Errorf("resolving %s version in %q: %w", integrations.DatadogTracerV2, orchestrionRoot, err))
-		}
-		versions[integrations.DatadogTracerV2] = ver
-		instrumentationRoot := filepath.Join(orchestrionRoot, "instrument")
-		ver, err = resolveDependencyVersion(instrumentationRoot, integrations.DatadogTracerV2All)
-		if err != nil {
-			panic(fmt.Errorf("resolving %s version in %q: %w", integrations.DatadogTracerV2All, instrumentationRoot, err))
-		}
-		versions[integrations.DatadogTracerV2All] = ver
+		versions := loadShippedVersions(orchestrionRoot)
 		orchestrionShippedVersions.Store(&versions)
 	})
 	return *orchestrionShippedVersions.Load()
 }
+
+func loadShippedVersions(orchestrionRoot string) map[string]string {
+	versions := make(map[string]string)
+
+	// The version of dd-trace-go that shipped with the current version of orchestrion.
+	// We use this to determine if we need to upgrade dd-trace-go when pinning.
+	ver, err := resolveDependencyVersion(orchestrionRoot, integrations.DatadogTracerV2)
+	if err != nil {
+		panic(fmt.Errorf("resolving %s version in %q: %w", integrations.DatadogTracerV2, orchestrionRoot, err))
+	}
+	versions[integrations.DatadogTracerV2] = ver
+
+	// Default to using the same version as DatadogTracerV2 for DatadogTracerV2All.
+	// This serves as a fallback when the instrument directory (which is a separate submodule)
+	// is not accessible, such as when orchestrion is used as a module dependency from the
+	// Go module cache where nested submodules may not be present.
+	versions[integrations.DatadogTracerV2All] = versions[integrations.DatadogTracerV2]
+
+	// If the instrument directory exists, override with the actual version from its go.mod
+	instrumentationRoot := filepath.Join(orchestrionRoot, "instrument")
+	if _, err := os.Stat(instrumentationRoot); err != nil {
+		return versions
+	}
+	ver, err = resolveDependencyVersion(instrumentationRoot, integrations.DatadogTracerV2All)
+	if err != nil {
+		panic(fmt.Errorf("resolving %s version in %q: %w", integrations.DatadogTracerV2All, instrumentationRoot, err))
+	}
+	versions[integrations.DatadogTracerV2All] = ver
+
+	return versions
+}

internal/ensure/requiredintegrations_test.go

@@ -10,6 +10,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"path/filepath"
 	"testing"
 
 	"github.com/DataDog/orchestrion/internal/gomod"
@@ -411,6 +412,24 @@ func TestFetchShippedVersions(t *testing.T) {
 			}
 		}
 	})
+
+	t.Run("fallback-when-instrument-missing", func(t *testing.T) {
+		// Create temp directory without instrument/ subdirectory
+		tempDir := t.TempDir()
+		testGoMod := filepath.Join(tempDir, "go.mod")
+		require.NoError(t, os.WriteFile(testGoMod, []byte(`module test
+require github.com/DataDog/dd-trace-go/v2 v2.3.0
+`), 0644))
+
+		versions := loadShippedVersions(tempDir)
+
+		v2Version := versions["github.com/DataDog/dd-trace-go/v2"]
+		allVersion := versions["github.com/DataDog/dd-trace-go/orchestrion/all/v2"]
+
+		require.NotEmpty(t, v2Version)
+		require.NotEmpty(t, allVersion)
+		assert.Equal(t, v2Version, allVersion, "both should use same version when instrument/ is missing")
+	})
 }
 
 func TestRequiredIntegrationsEdgeCases(t *testing.T) {