Reference codeLens action not working

[razzeee]

I'm trying to use the build in command for editor.action.showReferences and have it bound to a codeLens. But I can't figure out, what I'm doing wrong.

[Trace - 12:51:43 AM] Received response 'codeLens/resolve - (25)' in 6ms.
Result: {
    "range": {
        "start": {
            "line": 380,
            "character": 8
        },
        "end": {
            "line": 381,
            "character": 50
        }
    },
    "data": {
        "codeLensType": "referenceCounter",
        "references": [
            {
                "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "range": {
                    "start": {
                        "line": 380,
                        "character": 8
                    },
                    "end": {
                        "line": 380,
                        "character": 16
                    }
                }
            },
            {
                "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "range": {
                    "start": {
                        "line": 117,
                        "character": 30
                    },
                    "end": {
                        "line": 117,
                        "character": 38
                    }
                }
            },
            {
                "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "range": {
                    "start": {
                        "line": 152,
                        "character": 35
                    },
                    "end": {
                        "line": 152,
                        "character": 43
                    }
                }
            },
            {
                "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "range": {
                    "start": {
                        "line": 157,
                        "character": 35
                    },
                    "end": {
                        "line": 157,
                        "character": 43
                    }
                }
            },
            {
                "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "range": {
                    "start": {
                        "line": 350,
                        "character": 35
                    },
                    "end": {
                        "line": 350,
                        "character": 43
                    }
                }
            },
            {
                "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "range": {
                    "start": {
                        "line": 363,
                        "character": 33
                    },
                    "end": {
                        "line": 363,
                        "character": 41
                    }
                }
            },
            {
                "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "range": {
                    "start": {
                        "line": 385,
                        "character": 25
                    },
                    "end": {
                        "line": 385,
                        "character": 33
                    }
                }
            },
            {
                "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "range": {
                    "start": {
                        "line": 388,
                        "character": 23
                    },
                    "end": {
                        "line": 388,
                        "character": 31
                    }
                }
            },
            {
                "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "range": {
                    "start": {
                        "line": 479,
                        "character": 16
                    },
                    "end": {
                        "line": 479,
                        "character": 24
                    }
                }
            }
        ],
        "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm"
    },
    "command": {
        "title": "9 references",
        "command": "editor.action.showReferences",
        "arguments": [
            {
                "$mid": 1,
                "path": "/home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "scheme": "file"
            },
            {
                "line": 380,
                "character": 8
            },
            [
                {
                    "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                    "range": {
                        "start": {
                            "line": 380,
                            "character": 8
                        },
                        "end": {
                            "line": 380,
                            "character": 16
                        }
                    }
                },
                {
                    "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                    "range": {
                        "start": {
                            "line": 117,
                            "character": 30
                        },
                        "end": {
                            "line": 117,
                            "character": 38
                        }
                    }
                },
                {
                    "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                    "range": {
                        "start": {
                            "line": 152,
                            "character": 35
                        },
                        "end": {
                            "line": 152,
                            "character": 43
                        }
                    }
                },
                {
                    "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                    "range": {
                        "start": {
                            "line": 157,
                            "character": 35
                        },
                        "end": {
                            "line": 157,
                            "character": 43
                        }
                    }
                },
                {
                    "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                    "range": {
                        "start": {
                            "line": 350,
                            "character": 35
                        },
                        "end": {
                            "line": 350,
                            "character": 43
                        }
                    }
                },
                {
                    "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                    "range": {
                        "start": {
                            "line": 363,
                            "character": 33
                        },
                        "end": {
                            "line": 363,
                            "character": 41
                        }
                    }
                },
                {
                    "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                    "range": {
                        "start": {
                            "line": 385,
                            "character": 25
                        },
                        "end": {
                            "line": 385,
                            "character": 33
                        }
                    }
                },
                {
                    "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                    "range": {
                        "start": {
                            "line": 388,
                            "character": 23
                        },
                        "end": {
                            "line": 388,
                            "character": 31
                        }
                    }
                },
                {
                    "uri": "file:///home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                    "range": {
                        "start": {
                            "line": 479,
                            "character": 16
                        },
                        "end": {
                            "line": 479,
                            "character": 24
                        }
                    }
                }
            ]
        ]
    }
}

This is the error that happens, when I click the code action.

#210

https://github.com/elm-tooling/elm-language-server/blob/57550c1a0c95b74df3ecb71c98b261785a306c69/src/providers/codeLensProvider.ts#L79

[dbaeumer]

The problem is very likely this:

            {
                "$mid": 1,
                "path": "/home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm",
                "scheme": "file"
            }

since the LSP has no support (on purpose) for decoding VS Code URIs. Since you make this VS Code speicific in the first place (by using the VS Code command editor.action.showReferences) you are better of handling this in the VS Code extension. Options are:

• having you own command that then calls editor.action.showReferences
• implementing a VS Code LSP client middleware and send the URI as a string and then convert it on the client side to a VS Code speicific URI format.

LEt me know how it goes.

[razzeee]

Makes sense never thought of it that way. But as lsp already has reference messages, can't we use them? Or do they need to be called by the client? And that would be a protocol change?

…

On Tue, Jun 11, 2019, 10:47 Dirk Bäumer ***@***.***> wrote: The problem is very likely this: { "$mid": 1, "path": "/home/razze/Development/elm-spa-example/src/Page/Article/Editor.elm", "scheme": "file" } since the LSP has no support (on purpose) for decoding VS Code URIs. Since you make this VS Code speicific in the first place (by using the VS Code command editor.action.showReferences) you are better of handling this in the VS Code extension. Options are: - having you own command that then calls editor.action.showReferences - implementing a VS Code LSP client middleware and send the URI as a string and then convert it on the client side to a VS Code speicific URI format. LEt me know how it goes. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#495?email_source=notifications&email_token=ABNLEZD7K4YD2XACFZVL35LPZ5RBNA5CNFSM4HVLUOV2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODXMM73Y#issuecomment-500748271>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABNLEZA6KQY2SJRP7LBMWATPZ5RBNANCNFSM4HVLUOVQ> .

[dbaeumer]

You can of course call the textDocument/references request in the server yourself. The LSP spec explicitly allows this even for files that are not open in the editor.

[razzeee]

Are there any docs on how to do this with vscode-languageserver-node?

[dbaeumer]

@razzeee

you have your own command and then implement a command handler on the VS Code side which then

• calls the editor command
• or sends a textDocument/references to the server and renders the result in its own view, ...

[Krzysztof-Cieslak]

You can also register middleware in Code’s client side to transform the types - example in PowerShell client - https://github.com/PowerShell/vscode-powershell/blob/master/src/session.ts#L366

[dbaeumer]

@Krzysztof-Cieslak cool idea!

[Krzysztof-Cieslak]

Yes, this is pretty OK workaround... but I kinda believe this behaviour should be fixed here in vscode-languageclient. Number-of-references CodeLenses is a feature supported by whole bunch of popular plugins (C#, F#, Powershell, Go to just name a few) and every single one of them needs to implement some type of workaround

[dbaeumer]

@Krzysztof-Cieslak agree. Would require some spec in the LSP with some property to indicate that a code lens should trigger reference search. I don't want to standardize command id's in LSP. Then the VS Code implementation could trigger the command.

PR welcome.

[angelozerr]

I don't want to standardize command id's in LSP.

Why? It should be really nice to have command IDs standardization, XML CodeLens references is a very good sample. We have this problem with our XML Language Server which which provides references for DTD, XSD. It works pretty well in vscode (call just LSP textDocument/references request but not in Eclipse IDE which doesn't implement this request(see eclipse-wildwebdeveloper/wildwebdeveloper#644).

With standard command IDs, a lot of language server could benefit with standard commands (ex : click on references) without extra code.

[dbaeumer]

If we standardize this it must be more than a string ID to make it an explicit concept. And clients still need to announce which commands it supports.

[angelozerr]

If we standardize this it must be more than a string ID to make it an explicit concept.

Yes sure it will require to specify ID + args command. It will give the capability to use standard structure for args on language server side. I think it can be a good idea.

And clients still need to announce which commands it supports.

Indeed and I think again it's a good idea because for XML Language Server we do that with custom capability. If we have standard capability, it should be cleaner.