[SR-16104] SourceKit-LSP: Add support for RenameRequest

[adam-fowler]

Previous ID	SR-16104
Radar	None
Original Reporter	@adam-fowler
Type	Improvement

Additional Detail from JIRA

Votes	0
Component/s	SourceKit-LSP
Labels	Improvement
Assignee	None
Priority	Medium

md5: 8028e8b5f474f8ce22efadde5bd6c30a

Issue Description:

Add support for RenameRequest message.

[MozarellaMan]

I'd like to try working on this. Would I be correct in saying it would be very similar to references in SourceKitServer?

[ahoppen]

references only reports references to the symbol within the same file but I would expect RenameRequest to rename all occurrences of the symbol across files, which sourcekitd doesn’t currently support. We would need to query the index database (SourceKitLSP.Workspace.index) for all references to the renamed symbol across all files but I think this should definitely be possible.

[resolritter]

references only reports references to the symbol within the same file but I would expect RenameRequest to rename all occurrences of the symbol across files

@ahoppen does that mean symbol.usr is not used across modules? At the moment I'm a bit confused by this statement of "references only reports references to the symbol within the same file" because I don't see any filtering being done in https://github.com/apple/sourcekit-lsp/blob/0329b49735083c374a56a479c990888d924806a9/Sources/SourceKitLSP/SourceKitServer.swift#L1315-L1325 for the locations of req.params.textDocument. I'm also trying to grok addRelation and nameAndUSRCache from https://github.com/apple/swift/blob/0b20f2117c6d6115a5e055782105711d654dd6c2/lib/Index/Index.cpp#L529 but haven't quite found where the per-file scoping happens.

[ahoppen]

The SourceKit-LSP textDocument/references request is backed by the sourcekitd source.request.cursorinfo request, which walks the AST of the the current file and reports any usages of the variable that’s currently highlighted within it. It does not do an index lookup and thus can’t find usages of the variable in other files.

[ahoppen]

rdar://95587948

[adam-fowler]

@ahoppen I was just looking at the textDocument/references request and it seems to be returning all references of a symbol across all packages.

[ahoppen]

Oh, you’re right. I didn’t realize we were doing an index lookup for textDocument/references.

[MartinLau7]

Hi all, is there any new progress on this function request?