Server does not end all progress tokens

[alcarney]

Expected behavior

After a build had failed VSCode was still showing the window/workDoneProgress spinner, even though no build was in progress.

Actual behavior

The server should ensure the progress is marked as complete, even when there's an error

Log output

No response

(Optional) Settings from conf.py

No response

[alcarney]

Not sure if it's necessarily build failures, or if it's many builds triggered in succession?
After actually using the pre-release a bit more recently, I often see the progress spinner when it's not actually building...

[alcarney]

It doesn't appear to be related to build errors at all. The server's progress token tracking needs improvement, it's starting tokens multiple tokens but loses track of some so they never get closed.

$ lsp-devtools record --include-method '$/progress' -f '[{.params.token}][{.params.value.kind}]: {.params.value.message}'
20:02:44 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: writing output...                                    
20:02:44 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: reading sources...                                   
20:02:44 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: pickling environment                                 
20:02:45 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: checking consistency                                 
20:02:45 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: preparing documents                                  
20:02:45 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: copying assets                                       
20:02:45 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: copying static files                                 
20:02:45 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: copying extra files                                  
20:02:45 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: writing output...                                    
20:02:46 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: generating indices                                   
20:02:46 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: writing additional pages                             
20:02:46 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: dumping search index in English (code: en)           
20:02:46 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][report]: dumping object inventory                             
20:02:46 SERVER [e34590b7-6744-4176-a4d7-12927fbb4bbe][end]: Finished                                                
20:02:49 SERVER [acf95633-9c6a-4b2a-86e2-62955dfa389e][report]: writing output...   <-- This token is never closed,                                 
20:02:49 SERVER [acf95633-9c6a-4b2a-86e2-62955dfa389e][report]: reading sources...  <-- leaving a persistent spinner in the client!
20:02:50 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: pickling environment                                 
20:02:50 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: checking consistency                                 
20:02:50 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: preparing documents                                  
20:02:50 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: copying assets                                       
20:02:50 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: copying static files                                 
20:02:50 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: copying extra files                                  
20:02:50 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: writing output...                                    
20:02:51 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: generating indices                                   
20:02:51 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: writing additional pages                             
20:02:51 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: dumping search index in English (code: en)           
20:02:51 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][report]: dumping object inventory                             
20:02:51 SERVER [6128c05d-9289-447c-9281-b90ec4819f31][end]: Finished