Renaming a module adds additional new lines

[karthiknadig]

Before:

After:

Looks like the refactor code adds new lines, to each change.

[pappasam]

@karthiknadig I'm unable to reproduce in Neovim with coc.nvim. See gif with latest release under coc.nvim:

[karthiknadig]

This is what i get as a response message:

[Trace - 12:24:36 PM] Received response 'textDocument/rename - (40)' in 15ms.
Result: {
    "documentChanges": [
        {
            "textDocument": {
                "uri": "file:///c:/GIT/repro/renaming/myscript.py",
                "version": 0
            },
            "edits": [
                {
                    "range": {
                        "start": {
                            "line": 0,
                            "character": 24
                        },
                        "end": {
                            "line": 1,
                            "character": 0
                        }
                    },
                    "newText": "new_somemodule\r\n\r"
                },
                {
                    "range": {
                        "start": {
                            "line": 2,
                            "character": 10
                        },
                        "end": {
                            "line": 13,
                            "character": 0
                        }
                    },
                    "newText": "\r\n    new_somemodule.bar()\r\n    new_somemodule.bar()\r\n    new_somemodule.bar()\r\n    new_somemodule.bar()\r\n    new_somemodule.bar()\r\n\r\n\r\n\r\n\r\n\r\n\r"
                },
                {
                    "range": {
                        "start": {
                            "line": 14,
                            "character": 26
                        },
                        "end": {
                            "line": 15,
                            "character": 9
                        }
                    },
                    "newText": "\r\n    run()"
                }
            ]
        },
        {
            "kind": "rename",
            "oldUri": "file:///c:/GIT/repro/renaming/somepackage/somemodule.py",
            "newUri": "file:///c:/GIT/repro/renaming/somepackage/new_somemodule.py",
            "options": {
                "overwrite": true,
                "ignoreIfExists": true
            }
        }
    ]
}

As you can see in the response there is additional \r\n

[karthiknadig]

@pappasam I am seeing more reports of this. microsoft/vscode-python#17024
https://www.reddit.com/r/vscode/comments/nc12yo/rename_symbol_bug/

[pappasam]

@karthiknadig I'll try adding the test case in a bit to see if I can narrow it down.

[pappasam]

tl;dr I cannot reproduce this issue with the example provided.

@karthiknadig I've added some automated tests with your example. They pass on both Ubuntu and Windows containers with Github actions. Here's the relevant commit: f2c7a5e

If this is indeed an issue with the latest version of jedi-language-server and vscode, it's possible that this has to do with the existence of carriage returns within a file. If that's the case, this is probably a lower-level pygls issue. Either way, given the fact that I'm on a POSIX-like system, any further testing will be somewhat challenging on my end.

[alexandrelarouche]

I just found a fix (for me anyway) for this issue. Perhaps it could also shed light on what could be happening behind the scenes. I usually use Linux, but I sometimes develop on Windows and this issue seemed to only happen on Windows in my case. The issue seems to be with the carriage return character.

If you switch the line ends in your file for LF (\n) instead of CRLF (\r), the issue stops happening. To change default character used when pressing enter in VSCode, you can follow this guide.

Hope this helps, cause this definitely plagued me.

[pappasam]

@karthiknadig is this issue still present with the latest release? I've tried testing this out in several ways on my machine by running files through unix2dos, which adds carriage returns locally, and I've so-far been unable to reproduce on my end.

[karthiknadig]

I will investigate this one. If there is anything, i will make a PR. But it might take some time for me to get to this.