GetToolTipText gets the same XML signature for several member overloads

nightroman commented 7 years ago

Repro steps

UPDATE: see the adjusted to the newer API in FSCS (still with the bug) is here: https://github.com/fsharp/FSharp.Compiler.Service/issues/800#issuecomment-334652039

#r @"..\packages\FSharp.Compiler.Service\lib\net45\FSharp.Compiler.Service.dll"
open System
open Microsoft.FSharp.Compiler.SourceCodeServices

let checker = FSharpChecker.Create()

let input = """
open System.IO
File.WriteAllText ("", "")
"""
let inputLines = input.Split('\n')
let file = "/Test.fsx"

let projOptions, errors = checker.GetProjectOptionsFromScript(file, input) |> Async.RunSynchronously
let parseFileResults = checker.ParseFileInProject(file, input, projOptions) |> Async.RunSynchronously
let checkFileAnswer = checker.CheckFileInProject(parseFileResults, file, 0, input, projOptions) |> Async.RunSynchronously
let checkFileResults =
    match checkFileAnswer with
    | FSharpCheckFileAnswer.Succeeded(res) -> res
    | res -> failwithf "Parsing did not finish... (%A)" res

let (FSharpToolTipText tips) =
    checkFileResults.GetToolTipText(3, 18, inputLines.[2], ["File"; "WriteAllText"], FSharpTokenTag.Identifier) |> Async.RunSynchronously

tips
|> List.iter (function
    | FSharpToolTipElement.Group items ->
        for item in items do
            printfn "MainDescription: %s" item.MainDescription
            printfn "XmlDoc: %A" item.XmlDoc
    | _ -> ()
)

Expected behavior

For two overloads of WriteAllText, GetToolTipText gets two items with different MainDescription and different XML doc signatures.

Actual behavior

GetToolTipText gets two items with different MainDescription (expected) and the same XML doc signatures (unexpected). See the output below, the second XML doc signature is expected to be different, with System.Text.Encoding.

Output:

    MainDescription: File.WriteAllText(path: string, contents: string) : unit
    XmlDoc: XmlDocFileSignature
      ("C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.6.2\mscorlib.dll",
       "M:System.IO.File.WriteAllText(System.String,System.String)")

    MainDescription: File.WriteAllText(path: string, contents: string, encoding: System.Text.Encoding) : unit
    XmlDoc: XmlDocFileSignature
      ("C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.6.2\mscorlib.dll",
       "M:System.IO.File.WriteAllText(System.String,System.String)")

MainDescription correctly provides different signatures of two overloads. But XmlDoc.Item2 provides the same XML doc signature for both entries.

Related information

FCS 14.0.2
Windows 7, 8.1, 10

vasily-kirichenko commented 7 years ago

I cannot reproduce it in VFT current master:

vasily-kirichenko commented 7 years ago

It works in Ionide, too:

nightroman commented 7 years ago

But are these the same as the case? I am talking about a problem in my app using FCS. It is reduced to the code provided. This code is not working as expected.

vasily-kirichenko commented 7 years ago

Look at VFT or Ionide source code to see if you use the api properly.

vasily-kirichenko commented 7 years ago

For Ionide, it's around here https://github.com/ionide/FsAutoComplete/blob/master/src/FsAutoComplete.Core/Commands.fs#L210 You can build FSAC in debug mode, put it into the Ionide plugin folder, open your scrips in Code, attach to the FSAC Suave process and debug.

/cc @k_cieslak

vasily-kirichenko commented 7 years ago

Ahhhhhhhhhhhhhh. Sorry, I didn't notice that the problem is not in the XML doc comment (which is entirely missing, BTW), but in the 'M:System.IO.File.WriteAllText(System.String,System.String)' part.

vasily-kirichenko commented 7 years ago

However, the "M:..." part is right in VFT:

First overload:

Second overload:

vasily-kirichenko commented 7 years ago

The above screenshots are taken on this line https://github.com/Microsoft/visualfsharp/blob/master/vsintegration/src/FSharp.Editor/QuickInfo/QuickInfoProvider.fs#L111

nightroman commented 7 years ago

I am on holiday now, will check in a week or two. If my code is wrong, could you suggest what wrong is?

nightroman commented 7 years ago

I am back. Thank you for the links. They are useful, especially the second with a different method GetStructuredToolTipText (that means though that it cannot be used as cannot-repro example). I will investigate the new ways that the links provide.

But I am still interested in the original case working correctly. It gets all overloads in one go, exactly what I need (in my app I am not limited in space for displaying "tooltip", I rather show some mini-help).

If I use the API correctly (I used some testing code from FCS for inspiration) then the result is apparently wrong, XML signature should be different for different overloads.

Thus, the issue still looks valid. (Meanwhile, I'll play with the new alternative GetStructuredToolTipText, thank you once again).

nightroman commented 7 years ago

I played with both suggestions.

(1) FSAC - The suggested code calls GetToolTipText in the same way as I do. But this code does not show how the result is processed, so it does not help. In fact, I am not sure that vscode-ionide uses this method. For example if we leave just File.WriteAllText in the sample code then vscode shows

    The member or object constructor 'WriteAllText' does not take 1 argument(s).
    An overload was found taking 2 arguments

though the sample code still gets info for two existing overloads, one with the correct info, another with some incorrect XML signature.

(2) The suggested code uses a different function GetStructuredToolTipText. I tried it. It gets the result as some pretty heavy and not documented data structures presumably designed for other not documented functions. It looks too difficult to go there without documentation or clear samples.

All in all, the only known somehow documented way is here. This is what I use. This gets not quite right result. Hence the issue.

nightroman commented 7 years ago

The original example uses ParseFileInProject which is deprecated in the latest. Here is the updated code without it. The issue is there, too.

#r @"..\packages\FSharp.Compiler.Service\lib\net45\FSharp.Compiler.Service.dll"
open System
open Microsoft.FSharp.Compiler.SourceCodeServices

let checker = FSharpChecker.Create()

let input = """
open System.IO
File.WriteAllText ("", "")
"""
let inputLines = input.Split('\n')
let file = "/Test.fsx"

let projOptions, errors = checker.GetProjectOptionsFromScript(file, input) |> Async.RunSynchronously
let parseResults, checkAnswer = checker.ParseAndCheckFileInProject(file, 0, input, projOptions) |> Async.RunSynchronously
let checkFileResults =
    match checkAnswer with
    | FSharpCheckFileAnswer.Succeeded(res) -> res
    | res -> failwithf "Parsing did not finish... (%A)" res

let (FSharpToolTipText tips) =
    checkFileResults.GetToolTipText(3, 18, inputLines.[2], ["File"; "WriteAllText"], FSharpTokenTag.Identifier) |> Async.RunSynchronously

tips
|> List.iter (function
    | FSharpToolTipElement.Group items ->
        for item in items do
            printfn "MainDescription: %s" item.MainDescription
            printfn "XmlDoc: %A" item.XmlDoc
    | _ -> ()
)