Fix flaky initialize handler tests (#1883)

* Wait on state creation for discover events * Use correct capabilities for workspace folders in tests * Add changelog
hashicorp · Dec 2, 2024 · e4971fd · e4971fd
1 parent c1f90c8
commit e4971fd
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/.changes/unreleased/INTERNAL-20241202-134258.yaml b/.changes/unreleased/INTERNAL-20241202-134258.yaml
@@ -0,0 +1,6 @@
+kind: INTERNAL
+body: Fix flaky initialize handler tests
+time: 2024-12-02T13:42:58.677986+01:00
+custom:
+    Issue: "1883"
+    Repository: terraform-ls
diff --git a/internal/features/modules/modules_feature.go b/internal/features/modules/modules_feature.go
@@ -73,7 +73,8 @@ func (f *ModulesFeature) Start(ctx context.Context) {
 	ctx, cancelFunc := context.WithCancel(ctx)
 	f.stopFunc = cancelFunc
 
-	discover := f.eventbus.OnDiscover("feature.modules", nil)
+	discoverDone := make(chan job.IDs, 10)
+	discover := f.eventbus.OnDiscover("feature.modules", discoverDone)
 
 	didOpenDone := make(chan job.IDs, 10)
 	didOpen := f.eventbus.OnDidOpen("feature.modules", didOpenDone)
@@ -90,6 +91,7 @@ func (f *ModulesFeature) Start(ctx context.Context) {
 			case discover := <-discover:
 				// TODO? collect errors
 				f.discover(discover.Path, discover.Files)
+				discoverDone <- job.IDs{}
 			case didOpen := <-didOpen:
 				// TODO? collect errors
 				spawnedIds, _ := f.didOpen(didOpen.Context, didOpen.Dir, didOpen.LanguageID)

diff --git a/internal/features/rootmodules/root_modules_feature.go b/internal/features/rootmodules/root_modules_feature.go
@@ -69,7 +69,8 @@ func (f *RootModulesFeature) Start(ctx context.Context) {
 	ctx, cancelFunc := context.WithCancel(ctx)
 	f.stopFunc = cancelFunc
 
-	discover := f.eventbus.OnDiscover("feature.rootmodules", nil)
+	discoverDone := make(chan job.IDs, 10)
+	discover := f.eventbus.OnDiscover("feature.rootmodules", discoverDone)
 
 	didOpenDone := make(chan job.IDs, 10)
 	didOpen := f.eventbus.OnDidOpen("feature.rootmodules", didOpenDone)
@@ -86,6 +87,7 @@ func (f *RootModulesFeature) Start(ctx context.Context) {
 			case discover := <-discover:
 				// TODO? collect errors
 				f.discover(discover.Path, discover.Files)
+				discoverDone <- job.IDs{}
 			case didOpen := <-didOpen:
 				// TODO? collect errors
 				spawnedIds, _ := f.didOpen(didOpen.Context, didOpen.Dir)

diff --git a/internal/langserver/handlers/initialize_test.go b/internal/langserver/handlers/initialize_test.go
@@ -545,7 +545,11 @@ func TestInitialize_differentWorkspaceLayouts(t *testing.T) {
 			ls.Call(t, &langserver.CallRequest{
 				Method: "initialize",
 				ReqParams: fmt.Sprintf(`{
-				"capabilities": {},
+				"capabilities": {
+					"workspace": {
+						"workspaceFolders": true
+					}
+				},
 				"rootUri": %q,
 				"processId": 12345,
 				"workspaceFolders": [