Skip to content

Commit 391f8b7

Browse files
radeksimkoradeksimko
authored
Pick core schema only based on required_version constraint (hashicorp#1027)
* Pick schema based on constraints + account for too new/old version * tests: Wait for all jobs from didOpen * handlers: add tests for edge cases (old & new TF version) * deps: bump tfschema to latest main rev
1 parent 4308af8 commit 391f8b7

29 files changed

+693
-85
lines changed

‎go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ require (
1919
github.com/hashicorp/terraform-exec v0.17.2
2020
github.com/hashicorp/terraform-json v0.14.0
2121
github.com/hashicorp/terraform-registry-address v0.0.0-20220623143253-7d51757b572c
22-
github.com/hashicorp/terraform-schema v0.0.0-20220805102629-49cc6ae5bfa3
22+
github.com/hashicorp/terraform-schema v0.0.0-20220809100530-1ef9558a761c
2323
github.com/kylelemons/godebug v1.1.0 // indirect
2424
github.com/mh-cbon/go-fmt-fail v0.0.0-20160815164508-67765b3fbcb5
2525
github.com/mitchellh/cli v1.1.4

‎go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -338,8 +338,8 @@ github.com/hashicorp/terraform-json v0.14.0 h1:sh9iZ1Y8IFJLx+xQiKHGud6/TSUCM0N8e
338338
github.com/hashicorp/terraform-json v0.14.0/go.mod h1:5A9HIWPkk4e5aeeXIBbkcOvaZbIYnAIkEyqP2pNSckM=
339339
github.com/hashicorp/terraform-registry-address v0.0.0-20220623143253-7d51757b572c h1:D8aRO6+mTqHfLsK/BC3j5OAoogv1WLRWzY1AaTo3rBg=
340340
github.com/hashicorp/terraform-registry-address v0.0.0-20220623143253-7d51757b572c/go.mod h1:Wn3Na71knbXc1G8Lh+yu/dQWWJeFQEpDeJMtWMtlmNI=
341-
github.com/hashicorp/terraform-schema v0.0.0-20220805102629-49cc6ae5bfa3 h1:1MdlLPlGxrTKSrkIf8ehb8b9TQuiMwvZSZ0CPlGQRQk=
342-
github.com/hashicorp/terraform-schema v0.0.0-20220805102629-49cc6ae5bfa3/go.mod h1:YfAL2BROQ9jq7ei+c8HqGyx0C1lc3xenQ/2FTr4AtKI=
341+
github.com/hashicorp/terraform-schema v0.0.0-20220809100530-1ef9558a761c h1:NlNpLN/GHk2ycoeGcfGbVFt0nMIC+c0WLvYPu8s8faU=
342+
github.com/hashicorp/terraform-schema v0.0.0-20220809100530-1ef9558a761c/go.mod h1:vZFv3NuAOpCxkP8j4d08ofVXVeCEjIbeKy/fNxYFbhg=
343343
github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 h1:HKLsbzeOsfXmKNpr3GiT18XAblV0BjCbzL8KQAMZGa0=
344344
github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734/go.mod h1:kNDNcF7sN4DocDLBkQYz73HGKwN1ANB1blq4lIYLYvg=
345345
github.com/huandu/xstrings v1.3.1/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=

‎internal/decoder/module_schema.go

+35-18
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,14 @@ import (
99
)
1010

1111
func schemaForModule(mod *state.Module, schemaReader state.SchemaReader, modReader state.ModuleCallReader) (*schema.BodySchema, error) {
12-
var coreSchema *schema.BodySchema
13-
coreRequirements := make(version.Constraints, 0)
14-
if mod.TerraformVersion != nil {
15-
var err error
16-
coreSchema, err = tfschema.CoreModuleSchemaForVersion(mod.TerraformVersion)
17-
if err != nil {
18-
return nil, err
19-
}
20-
coreRequirements, err = version.NewConstraint(mod.TerraformVersion.String())
21-
if err != nil {
22-
return nil, err
23-
}
24-
} else {
25-
coreSchema = tfschema.UniversalCoreModuleSchema()
26-
}
27-
28-
sm := tfschema.NewSchemaMerger(coreSchema)
12+
sm := tfschema.NewSchemaMerger(coreSchema(mod))
2913
sm.SetSchemaReader(schemaReader)
3014
sm.SetTerraformVersion(mod.TerraformVersion)
3115
sm.SetModuleReader(modReader)
3216

3317
meta := &tfmodule.Meta{
3418
Path: mod.Path,
35-
CoreRequirements: coreRequirements,
19+
CoreRequirements: mod.Meta.CoreRequirements,
3620
ProviderRequirements: mod.Meta.ProviderRequirements,
3721
ProviderReferences: mod.Meta.ProviderReferences,
3822
Variables: mod.Meta.Variables,
@@ -42,3 +26,36 @@ func schemaForModule(mod *state.Module, schemaReader state.SchemaReader, modRead
4226

4327
return sm.SchemaForModule(meta)
4428
}
29+
30+
func coreSchema(mod *state.Module) *schema.BodySchema {
31+
if mod.TerraformVersion != nil {
32+
s, err := tfschema.CoreModuleSchemaForVersion(mod.TerraformVersion)
33+
if err == nil {
34+
return s
35+
}
36+
if mod.TerraformVersion.LessThan(tfschema.OldestAvailableVersion) {
37+
return mustCoreSchemaForVersion(tfschema.OldestAvailableVersion)
38+
}
39+
40+
return mustCoreSchemaForVersion(tfschema.LatestAvailableVersion)
41+
}
42+
43+
s, err := tfschema.CoreModuleSchemaForConstraint(mod.Meta.CoreRequirements)
44+
if err == nil {
45+
return s
46+
}
47+
if mod.Meta.CoreRequirements.Check(tfschema.OldestAvailableVersion) {
48+
return mustCoreSchemaForVersion(tfschema.OldestAvailableVersion)
49+
}
50+
51+
return mustCoreSchemaForVersion(tfschema.LatestAvailableVersion)
52+
}
53+
54+
func mustCoreSchemaForVersion(v *version.Version) *schema.BodySchema {
55+
s, err := tfschema.CoreModuleSchemaForVersion(v)
56+
if err != nil {
57+
// this should never happen
58+
panic(err)
59+
}
60+
return s
61+
}

‎internal/indexer/document_open.go

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
package indexer
2+
3+
import (
4+
"context"
5+
6+
"github.com/hashicorp/go-multierror"
7+
"github.com/hashicorp/terraform-ls/internal/document"
8+
"github.com/hashicorp/terraform-ls/internal/job"
9+
"github.com/hashicorp/terraform-ls/internal/terraform/exec"
10+
"github.com/hashicorp/terraform-ls/internal/terraform/module"
11+
op "github.com/hashicorp/terraform-ls/internal/terraform/module/operation"
12+
)
13+
14+
func (idx *Indexer) DocumentOpened(modHandle document.DirHandle) (job.IDs, error) {
15+
mod, err := idx.modStore.ModuleByPath(modHandle.Path())
16+
if err != nil {
17+
return nil, err
18+
}
19+
20+
ids := make(job.IDs, 0)
21+
var errs *multierror.Error
22+
23+
if mod.TerraformVersionState == op.OpStateUnknown {
24+
_, err := idx.jobStore.EnqueueJob(job.Job{
25+
Dir: modHandle,
26+
Func: func(ctx context.Context) error {
27+
ctx = exec.WithExecutorFactory(ctx, idx.tfExecFactory)
28+
return module.GetTerraformVersion(ctx, idx.modStore, modHandle.Path())
29+
},
30+
Type: op.OpTypeGetTerraformVersion.String(),
31+
})
32+
if err != nil {
33+
errs = multierror.Append(errs, err)
34+
}
35+
// Given that getting version may take time and we only use it to
36+
// enhance the UX, we ignore the outcome (job ID) here
37+
// to avoid delays when documents of new modules are open.
38+
}
39+
40+
parseId, err := idx.jobStore.EnqueueJob(job.Job{
41+
Dir: modHandle,
42+
Func: func(ctx context.Context) error {
43+
return module.ParseModuleConfiguration(idx.fs, idx.modStore, modHandle.Path())
44+
},
45+
Type: op.OpTypeParseModuleConfiguration.String(),
46+
})
47+
if err != nil {
48+
return ids, err
49+
}
50+
ids = append(ids, parseId)
51+
52+
modIds, err := idx.decodeModule(modHandle, job.IDs{parseId})
53+
if err != nil {
54+
return ids, err
55+
}
56+
ids = append(ids, modIds...)
57+
58+
parseVarsId, err := idx.jobStore.EnqueueJob(job.Job{
59+
Dir: modHandle,
60+
Func: func(ctx context.Context) error {
61+
return module.ParseVariables(idx.fs, idx.modStore, modHandle.Path())
62+
},
63+
Type: op.OpTypeParseVariables.String(),
64+
})
65+
if err != nil {
66+
return ids, err
67+
}
68+
ids = append(ids, parseVarsId)
69+
70+
varsRefsId, err := idx.jobStore.EnqueueJob(job.Job{
71+
Dir: modHandle,
72+
Func: func(ctx context.Context) error {
73+
return module.DecodeVarsReferences(ctx, idx.modStore, idx.schemaStore, modHandle.Path())
74+
},
75+
Type: op.OpTypeDecodeVarsReferences.String(),
76+
DependsOn: job.IDs{parseVarsId},
77+
})
78+
if err != nil {
79+
return ids, err
80+
}
81+
ids = append(ids, varsRefsId)
82+
83+
return ids, errs.ErrorOrNil()
84+
}

‎internal/indexer/walker.go

-15
Original file line numberDiff line numberDiff line change
@@ -83,21 +83,6 @@ func (idx *Indexer) WalkedModule(ctx context.Context, modHandle document.DirHand
8383
}
8484
}
8585

86-
tfVersionId, err := idx.jobStore.EnqueueJob(job.Job{
87-
Dir: modHandle,
88-
Func: func(ctx context.Context) error {
89-
ctx = exec.WithExecutorFactory(ctx, idx.tfExecFactory)
90-
return module.GetTerraformVersion(ctx, idx.modStore, modHandle.Path())
91-
},
92-
Type: op.OpTypeGetTerraformVersion.String(),
93-
})
94-
if err != nil {
95-
errs = multierror.Append(errs, err)
96-
} else {
97-
ids = append(ids, tfVersionId)
98-
refCollectionDeps = append(refCollectionDeps, tfVersionId)
99-
}
100-
10186
dataDir := datadir.WalkDataDirOfModule(idx.fs, modHandle.Path())
10287
idx.logger.Printf("parsed datadir: %#v", dataDir)
10388

‎internal/indexer/watcher.go

-18
Original file line numberDiff line numberDiff line change
@@ -83,23 +83,5 @@ func (idx *Indexer) PluginLockChanged(ctx context.Context, modHandle document.Di
8383
}
8484
ids = append(ids, id)
8585

86-
id, err = idx.jobStore.EnqueueJob(job.Job{
87-
Dir: modHandle,
88-
Func: func(ctx context.Context) error {
89-
ctx = exec.WithExecutorFactory(ctx, idx.tfExecFactory)
90-
eo, ok := exec.ExecutorOptsFromContext(ctx)
91-
if ok {
92-
ctx = exec.WithExecutorOpts(ctx, eo)
93-
}
94-
95-
return module.GetTerraformVersion(ctx, idx.modStore, modHandle.Path())
96-
},
97-
Type: op.OpTypeGetTerraformVersion.String(),
98-
})
99-
if err != nil {
100-
return ids, err
101-
}
102-
ids = append(ids, id)
103-
10486
return ids, nil
10587
}

‎internal/langserver/handlers/code_action_test.go

+3
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ func TestLangServer_codeAction_basic(t *testing.T) {
104104
"uri": "%s/main.tf"
105105
}
106106
}`, tmpDir.URI)})
107+
waitForAllJobs(t, ss)
108+
107109
ls.CallAndExpectResponse(t, &langserver.CallRequest{
108110
Method: "textDocument/codeAction",
109111
ReqParams: fmt.Sprintf(`{
@@ -351,6 +353,7 @@ func TestLangServer_codeAction_no_code_action_requested(t *testing.T) {
351353
"uri": "%s/main.tf"
352354
}
353355
}`, tmpDir.URI)})
356+
waitForAllJobs(t, ss)
354357

355358
ls.CallAndExpectResponse(t, tt.request, tt.want)
356359
})

‎internal/langserver/handlers/code_lens_test.go

+18-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,16 @@ func TestCodeLens_withoutOptIn(t *testing.T) {
4141
t.Fatal(err)
4242
}
4343

44-
ls := langserver.NewLangServerMock(t, NewMockSession(nil))
44+
ss, err := state.NewStateStore()
45+
if err != nil {
46+
t.Fatal(err)
47+
}
48+
wc := walker.NewWalkerCollector()
49+
50+
ls := langserver.NewLangServerMock(t, NewMockSession(&MockSessionInput{
51+
StateStore: ss,
52+
WalkerCollector: wc,
53+
}))
4554
stop := ls.Start(t)
4655
defer stop()
4756

@@ -52,6 +61,8 @@ func TestCodeLens_withoutOptIn(t *testing.T) {
5261
"rootUri": %q,
5362
"processId": 12345
5463
}`, tmpDir.URI)})
64+
waitForWalkerPath(t, ss, wc, tmpDir)
65+
5566
ls.Notify(t, &langserver.CallRequest{
5667
Method: "initialized",
5768
ReqParams: "{}",
@@ -66,6 +77,8 @@ func TestCodeLens_withoutOptIn(t *testing.T) {
6677
"uri": "%s/main.tf"
6778
}
6879
}`, tmpDir.URI)})
80+
waitForAllJobs(t, ss)
81+
6982
ls.CallAndExpectResponse(t, &langserver.CallRequest{
7083
Method: "textDocument/codeLens",
7184
ReqParams: fmt.Sprintf(`{
@@ -170,6 +183,8 @@ output "test" {
170183
value = var.test
171184
}
172185
`, tmpDir.URI)})
186+
waitForAllJobs(t, ss)
187+
173188
ls.CallAndExpectResponse(t, &langserver.CallRequest{
174189
Method: "textDocument/codeLens",
175190
ReqParams: fmt.Sprintf(`{
@@ -282,6 +297,8 @@ variable "instances" {
282297
type = number
283298
}
284299
`, submodUri.URI)})
300+
waitForAllJobs(t, ss)
301+
285302
ls.CallAndExpectResponse(t, &langserver.CallRequest{
286303
Method: "textDocument/codeLens",
287304
ReqParams: fmt.Sprintf(`{

0 commit comments

Comments
 (0)