TypeScript: Import refactoring results in broken code
Issue Type: Bug
This is likely best reproduced in a larger project with existing references between files.
For me, it always goes like this:
- Move a file within the directory structure of the project.
- VSC will ask if I want to automatically update imports, I agree and my imports throughout the project are updated to the new path. So far, so good.
- I rename the file that I just moved.
- VSC will ask if I want to automatically update imports, I agree and now all the files that were adjusted in step 2 are broken.
I’m assuming this related to me having source.organizeImports enabled on save, but that’s just a guess.
The way the code files break is always with some invalid syntax in the imports.
In this case I moved MikroORM.ts from the root of the project into the container directory. We can see the updated path in the imports.
Then I renamed the file to ProvideMikroORM and everything breaks.
While I can reproduce this almost with 100% success, I’ve had cases where everything went as expected. I felt like it’s relevant which document is currently focused when the refactoring runs. Just a guess so far though.
I also want to note another possibly related issue I’m having, as it also relates to renaming files: https://github.com/microsoft/TypeScript/issues/40616
VS Code version: Code 1.49.1 (58bb7b2331731bf72587010e943852e13e6fd3cf, 2020-09-16T23:27:51.792Z) OS version: Windows_NT x64 10.0.19041 Remote OS version: Linux x64 4.19.128-microsoft-standard Remote OS version: Linux x64 4.19.128-microsoft-standard Remote OS version: Linux x64 4.19.128-microsoft-standard
System Info
| Item | Value |
|---|---|
| CPUs | Intel® Core™ i7-6850K CPU @ 3.60GHz (12 x 3672) |
| GPU Status | 2d_canvas: enabled flash_3d: enabled flash_stage3d: enabled flash_stage3d_baseline: enabled gpu_compositing: enabled multiple_raster_threads: enabled_on oop_rasterization: disabled_off opengl: enabled_on protected_video_decode: unavailable_off rasterization: enabled skia_renderer: disabled_off_ok video_decode: enabled vulkan: disabled_off webgl: enabled webgl2: enabled |
| Load (avg) | undefined |
| Memory (System) | 63.91GB (45.62GB free) |
| Process Argv | –folder-uri=vscode-remote://wsl+Ubuntu/home/oliver/fairmanager/fairmanager/static2 --remote=wsl+Ubuntu --crash-reporter-id f825acfe-92fa-4526-a38a-f8815cf9f7ea |
| Screen Reader | no |
| VM | 0% |
| Item | Value |
|---|---|
| Remote | WSL: Ubuntu |
| OS | Linux x64 4.19.128-microsoft-standard |
| CPUs | Intel® Core™ i7-6850K CPU @ 3.60GHz (12 x 3672) |
| Memory (System) | 50.14GB (43.72GB free) |
| VM | 0% |
| Item | Value |
|---|---|
| Remote | WSL: Ubuntu |
| OS | Linux x64 4.19.128-microsoft-standard |
| CPUs | Intel® Core™ i7-6850K CPU @ 3.60GHz (12 x 3672) |
| Memory (System) | 50.14GB (43.72GB free) |
| VM | 0% |
| Item | Value |
|---|---|
| Remote | WSL: Ubuntu |
| OS | Linux x64 4.19.128-microsoft-standard |
| CPUs | Intel® Core™ i7-6850K CPU @ 3.60GHz (12 x 3672) |
| Memory (System) | 50.14GB (43.72GB free) |
| VM | 0% |
Extensions (28)
| Extension | Author (truncated) | Version |
|---|---|---|
| javascript-ejs-support | Dig | 1.3.1 |
| eslint-disable-snippets | drK | 1.2.0 |
| output-colorizer | IBM | 0.1.2 |
| vscode-docker | ms- | 1.6.0 |
| remote-containers | ms- | 0.140.1 |
| remote-ssh | ms- | 0.55.0 |
| remote-ssh-edit | ms- | 0.55.0 |
| remote-wsl | ms- | 0.44.5 |
| vscode-remote-extensionpack | ms- | 0.20.0 |
| vscode-icons | vsc | 11.0.0 |
| better-toml | bun | 0.3.2 |
| vscode-eslint | dba | 2.1.8 |
| eslint-disable-snippets | drK | 1.2.0 |
| gitlens | eam | 10.2.2 |
| EditorConfig | Edi | 0.15.1 |
| prettier-vscode | esb | 5.6.0 |
| vs-code-xml-format | fab | 0.1.5 |
| generateuuid | Fir | 0.0.5 |
| shell-format | fox | 7.0.1 |
| terraform | has | 2.2.3 |
| vscode-esformatter | how | 1.6.0 |
| code-beautifier | mic | 2.3.3 |
| vscode-docker | ms- | 1.6.0 |
| js-debug-nightly | ms- | 2020.9.2117 |
| vscode-paste-image | mus | 1.0.4 |
| vscode-xml | red | 0.13.0 |
| vscode-yaml | red | 0.11.0 |
| lit-plugin | run | 1.2.1 |
(2 theme extensions excluded)
About this issue
- Original URL
- State: closed
- Created 4 years ago
- Comments: 19 (11 by maintainers)
I’ve disabled running code actions on auto save in VS Code: https://github.com/microsoft/vscode/issues/121155
It was already disabled by default for auto saves after a delay, but not on focus changes. I believe this should fix the root trigger of this issue
@mjbvz - the issue is that the editor is sending
updateOpencalls out of order. The first file move in the repro steps executes correctly; its only purpose is to open a bunch of files with unsaved changes. So we’re in a consistent state prior to the rename (step 4), and there are a bunch of files open with unsaved changes. The sequence of events for the rename happens like this:getEditsForFileRenamefrom TS Server; server responds with an edit for each of those other open filesorganizeImportsedits from TS Server; server responds with editsupdateOpeninfo to server@oliversalzburg ack, my bad, I opened the wrong log file, didn’t realize I already had a file named
tsserver.login my downloads 🤦 The one you sent is good 👍Yep, it repros on Windows with the save on focus change 😮
When I rename the file, and the “Update imports for ‘MyEntityManager.ts’” dialog appears, that’s when the files are saved. I would assume the focus being switched over to the dialog is what causes the focus change and thus the save operation.
At that point in time, before confirming the dialog, I see some problems being indicated. I assume these are the imports that were broken by my renaming.
After confirming the dialog, the files will have the syntax errors.
I removed all of my user settings and only put the
autoSaveinto the project settings and recorded my reproduction. Maybe I’m skipping some important detail in my description: https://www.youtube.com/watch?v=AskpAN6hK9Y I also enabled ESLint in this reproduction for no particular reason, which causes unrelated problems to be shown in the problems panel. Sorry for the noise.@oliversalzburg could you record a log file while reproducing the issue?