Map module sources to their installation path

Introduce a new map based on the content of the module manifest. We can
use the map to look up local installation paths based on the module
source.

Author: dbanck

internal/features/rootmodules/root_modules_feature.go

@@ -188,3 +188,22 @@ func (f *RootModulesFeature) Telemetry(path string) map[string]interface{} {
 
 	return properties
 }
+
+// InstalledModulePath checks the installed modules in the given root module
+// for the given normalized source address.
+//
+// If the module is installed, it returns the path to the module installation
+// directory on disk.
+func (f *RootModulesFeature) InstalledModulePath(rootPath string, normalizedSource string) (string, bool) {
+	record, err := f.Store.RootRecordByPath(rootPath)
+	if err != nil {
+		return "", false
+	}
+
+	dir, ok := record.InstalledModules[normalizedSource]
+	if !ok {
+		return "", false
+	}
+
+	return dir, true
+}

internal/features/rootmodules/state/installed_modules.go

@@ -0,0 +1,26 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package state
+
+import "github.com/hashicorp/terraform-ls/internal/terraform/datadir"
+
+// InstalledModules is a map of normalized source addresses from the
+// manifest to the path of the local directory where the module is installed
+type InstalledModules map[string]string
+
+func InstalledModulesFromManifest(manifest *datadir.ModuleManifest) InstalledModules {
+	if manifest == nil {
+		return nil
+	}
+
+	installedModules := make(InstalledModules, len(manifest.Records))
+
+	// TODO: To support multiple versions of the same module, we need to
+	// look into resolving the version constraints to a specific version.
+	for _, v := range manifest.Records {
+		installedModules[v.RawSourceAddr] = v.Dir
+	}
+
+	return installedModules
+}

internal/features/rootmodules/state/root_record.go

@@ -23,6 +23,10 @@ type RootRecord struct {
 	ModManifestErr   error
 	ModManifestState op.OpState
 
+	// InstalledModules is a map of normalized source addresses from the
+	// manifest to the path of the local directory where the module is installed
+	InstalledModules InstalledModules
+
 	TerraformVersion      *version.Version
 	TerraformVersionErr   error
 	TerraformVersionState op.OpState
@@ -56,13 +60,20 @@ func (m *RootRecord) Copy() *RootRecord {
 	}
 
 	if m.InstalledProviders != nil {
-		newRecord.InstalledProviders = make(InstalledProviders, 0)
+		newRecord.InstalledProviders = make(InstalledProviders, len(m.InstalledProviders))
 		for addr, pv := range m.InstalledProviders {
 			// version.Version is practically immutable once parsed
 			newRecord.InstalledProviders[addr] = pv
 		}
 	}
 
+	if m.InstalledModules != nil {
+		newRecord.InstalledModules = make(InstalledModules, len(m.InstalledModules))
+		for source, dir := range m.InstalledModules {
+			newRecord.InstalledModules[source] = dir
+		}
+	}
+
 	return newRecord
 }
 

internal/features/rootmodules/state/root_store.go

@@ -258,6 +258,7 @@ func (s *RootStore) UpdateModManifest(path string, manifest *datadir.ModuleManif
 
 	record.ModManifest = manifest
 	record.ModManifestErr = mErr
+	record.InstalledModules = InstalledModulesFromManifest(manifest)
 
 	err = txn.Insert(s.tableName, record)
 	if err != nil {