Repository navigation
Commit bcb21e8
authored
[flutter_tools] Fix DTD "Stream already subscribed" error and wait for analysis over DTD in widget preview (flutter#192930)
## Description
During widget preview startup or file updates:
1. Concurrent calls to retrieve previews or wait for analysis (e.g.,
initial command startup racing with file watcher events) could
concurrently invoke `_waitForLspService()`, causing duplicate
`streamListen` calls to the Dart Tooling Daemon. DTD throws JSON-RPC
error 103 (`Stream already subscribed`) when a client attempts to
subscribe to a stream it is already listening to.
2. `WidgetPreviewDtdServices` previously considered the `Lsp` service
ready as soon as *any* `Lsp` method was registered on DTD (or upon
receiving the first `ServiceRegistered` event for `Lsp`). Because the
analysis server registers its LSP methods sequentially before posting an
`initialized` event on the `Lsp` stream, calls to
`Lsp.dart/workspace/analysis/complete` or
`Lsp.dart/workspace/getFlutterWidgetPreviews` could race ahead of their
registration and fail with `-32601 (method not found)`.
3. When connecting to a pre-existing analysis server over DTD
(`--dtd-url`), `LspPreviewDetector.analysisServer` is `null`, causing
`analysisServer?.waitForAnalysis()` calls during startup and file
updates to be no-ops.
This change:
- Deduplicates in-flight calls to `_waitForLspService()` using a shared
future (`_waitForLspServiceFuture`) so concurrent callers await the same
LSP registration check instead of issuing duplicate DTD requests.
- Separates `lspServiceAvailable` (whether an analysis server has begun
registering `Lsp` services on DTD) from `_allLspServicesRegistered`
(whether all required widget preview LSP methods in
`kRequiredLspServices` are registered), and updates
`_waitForLspServiceHelper()` to listen for the `initialized` event on
the `Lsp` stream before checking `getRegisteredServices()`.
- Consolidates LSP DTD calls into `_callLspService()` and removes the
`kMethodNotFound` polling loop now that `_waitForLspService()` ensures
all required LSP methods are registered.
- Safely catches and ignores `RpcErrorCodes.kStreamAlreadySubscribed` on
`streamListen` calls in `WidgetPreviewDtdServices` (`safeStreamListen`).
- Adds `WidgetPreviewDtdServices.waitForAnalysis()` (invoking
`Lsp.dart/workspace/analysis/complete` over DTD), unifies
`LspPreviewDetector.waitForAnalysis()` so widget preview waits for
analysis completion on both tool-managed and pre-existing analysis
servers, and moves the startup `waitForAnalysis()` call inside the DTD
error-handling `try / catch` block in `WidgetPreviewStartCommand`.
- Adds hermetic regression tests covering concurrent/pre-subscribed DTD
streams, partial vs. full LSP service registration (`Lsp.initialized`),
and waiting for analysis over DTD.
Fixes flutter#192424
## Pre-launch Checklist
- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant in-code documentation (doc comments with
`///`).
- [x] If this PR introduces a new feature or capability, I created and
linked a website documentation issue or PR in [flutter/website] (or
verified none is needed).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[AI contribution guidelines]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[flutter/website]: https://github.com/flutter/website
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md1 parent 63768f5 commit bcb21e8
7 files changed
Lines changed: 521 additions & 98 deletions
File tree
- packages/flutter_tools
- lib/src
- commands
- widget_preview
- test
- commands.shard
- hermetic/widget_preview
- permeable/widget_preview
- integration.shard
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
394 | 394 | | |
395 | 395 | | |
396 | 396 | | |
397 | | - | |
398 | | - | |
399 | | - | |
400 | | - | |
401 | | - | |
402 | | - | |
403 | | - | |
404 | | - | |
405 | | - | |
406 | | - | |
407 | | - | |
408 | 397 | | |
409 | 398 | | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
| 409 | + | |
410 | 410 | | |
411 | 411 | | |
412 | 412 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
36 | | - | |
| 36 | + | |
| 37 | + | |
37 | 38 | | |
38 | 39 | | |
39 | | - | |
40 | | - | |
41 | 40 | | |
| 41 | + | |
42 | 42 | | |
43 | | - | |
| 43 | + | |
| 44 | + | |
44 | 45 | | |
45 | 46 | | |
46 | 47 | | |
| |||
75 | 76 | | |
76 | 77 | | |
77 | 78 | | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
78 | 101 | | |
79 | 102 | | |
80 | 103 | | |
| |||
138 | 161 | | |
139 | 162 | | |
140 | 163 | | |
141 | | - | |
142 | | - | |
143 | | - | |
| 164 | + | |
144 | 165 | | |
145 | 166 | | |
146 | 167 | | |
| |||
158 | 179 | | |
159 | 180 | | |
160 | 181 | | |
161 | | - | |
| 182 | + | |
162 | 183 | | |
163 | | - | |
164 | | - | |
165 | | - | |
| 184 | + | |
166 | 185 | | |
167 | 186 | | |
168 | 187 | | |
169 | 188 | | |
170 | 189 | | |
171 | 190 | | |
172 | | - | |
173 | | - | |
174 | | - | |
175 | | - | |
176 | | - | |
177 | | - | |
178 | | - | |
179 | | - | |
180 | | - | |
181 | | - | |
182 | | - | |
183 | | - | |
184 | | - | |
185 | | - | |
186 | | - | |
187 | | - | |
188 | | - | |
189 | | - | |
190 | | - | |
| 191 | + | |
| 192 | + | |
191 | 193 | | |
192 | 194 | | |
193 | 195 | | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
194 | 209 | | |
195 | | - | |
196 | | - | |
197 | | - | |
198 | | - | |
199 | | - | |
200 | | - | |
201 | | - | |
202 | | - | |
203 | | - | |
204 | | - | |
205 | | - | |
206 | | - | |
207 | | - | |
208 | | - | |
209 | | - | |
210 | | - | |
211 | | - | |
212 | | - | |
213 | | - | |
| 210 | + | |
| 211 | + | |
214 | 212 | | |
215 | 213 | | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
216 | 221 | | |
217 | | - | |
| 222 | + | |
218 | 223 | | |
219 | 224 | | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
220 | 243 | | |
221 | | - | |
| 244 | + | |
| 245 | + | |
222 | 246 | | |
223 | | - | |
224 | | - | |
225 | | - | |
| 247 | + | |
226 | 248 | | |
227 | 249 | | |
228 | | - | |
| 250 | + | |
229 | 251 | | |
230 | 252 | | |
231 | | - | |
232 | | - | |
233 | | - | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
234 | 256 | | |
235 | 257 | | |
236 | | - | |
237 | 258 | | |
| 259 | + | |
238 | 260 | | |
239 | | - | |
240 | | - | |
241 | | - | |
242 | | - | |
243 | | - | |
244 | | - | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
245 | 266 | | |
246 | 267 | | |
247 | | - | |
| 268 | + | |
248 | 269 | | |
249 | 270 | | |
250 | 271 | | |
251 | 272 | | |
252 | 273 | | |
253 | | - | |
| 274 | + | |
254 | 275 | | |
255 | 276 | | |
256 | 277 | | |
| |||
287 | 308 | | |
288 | 309 | | |
289 | 310 | | |
290 | | - | |
| 311 | + | |
291 | 312 | | |
292 | 313 | | |
293 | 314 | | |
| |||
379 | 400 | | |
380 | 401 | | |
381 | 402 | | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
| 409 | + | |
| 410 | + | |
| 411 | + | |
| 412 | + | |
| 413 | + | |
| 414 | + | |
| 415 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
117 | 117 | | |
118 | 118 | | |
119 | 119 | | |
120 | | - | |
| 120 | + | |
121 | 121 | | |
122 | 122 | | |
123 | 123 | | |
124 | 124 | | |
125 | 125 | | |
126 | 126 | | |
127 | | - | |
128 | | - | |
129 | | - | |
130 | | - | |
131 | | - | |
132 | | - | |
133 | | - | |
| 127 | + | |
| 128 | + | |
134 | 129 | | |
135 | 130 | | |
136 | 131 | | |
| |||
185 | 180 | | |
186 | 181 | | |
187 | 182 | | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
188 | 193 | | |
189 | 194 | | |
190 | 195 | | |
| |||
196 | 201 | | |
197 | 202 | | |
198 | 203 | | |
199 | | - | |
| 204 | + | |
200 | 205 | | |
201 | 206 | | |
202 | 207 | | |
| |||
0 commit comments