x/tools/cmd/gopls: Formatting/CodeAction fail on single line file #31797
Labels
FrozenDueToAge
gopls
Issues related to the Go language server, gopls.
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
Comments
myitcv
added
NeedsInvestigation
|
Actually @ianthehat I'm minded to think it's invalid for a |
|
It is invalid for a go file presented to the compiler to not have a \n, but formatting a file without one should cause one to be added, so this issue is relevant. |
|
Understood. Purely FYI, this bug only surfaced because of a bug in |
|
Change https://golang.org/cl/174943 mentions this issue: |
|
This change breaks the |
|
@nezorflame - I'd open a new issue; comments on closed issues tend to get missed. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
What version of Go are you using (
go version)?Does this issue reproduce with the latest release?
Yes
What operating system and processor architecture are you using (
go env)?go envOutputWhat did you do?
Distilled from #31150 (comment)
I've managed to track down this particular instance of the
ToUTF16Column: point is missing offseterror to the case where a file contains a single line that is the package clause, with no trailing\n. Here is the sequence of events fromgovim's perspective:Sequence of events
gopls server start ======================= gopls.Initialize() call; params: &protocol.InitializeParams{ ProcessID: 0, RootPath: "", RootURI: "file:///home/myitcv/gostuff/src/github.com/myitcv/playground", Capabilities: protocol.ClientCapabilities{ Workspace: struct { ApplyEdit bool "json:\"applyEdit,omitempty\""; WorkspaceEdit struct { DocumentChanges bool "json:\"documentChanges,omitempty\""; ResourceOperations []protocol.ResourceOperationKind "json:\"resourceOperations,omitempty\""; FailureHandling protocol.FailureHandlingKind "json:\"failureHandling,omitempty\"" } "json:\"workspaceEdit,omitempty\""; DidChangeConfiguration struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"didChangeConfiguration,omitempty\""; DidChangeWatchedFiles struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"didChangeWatchedFiles,omitempty\""; Symbol struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; SymbolKind struct { ValueSet []protocol.SymbolKind "json:\"valueSet,omitempty\"" } "json:\"symbolKind,omitempty\"" } "json:\"symbol,omitempty\""; ExecuteCommand struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"executeCommand,omitempty\""; WorkspaceFolders bool "json:\"workspaceFolders,omitempty\""; Configuration bool "json:\"configuration,omitempty\"" }{}, TextDocument: struct { Synchronization struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; WillSave bool "json:\"willSave,omitempty\""; WillSaveWaitUntil bool "json:\"willSaveWaitUntil,omitempty\""; DidSave bool "json:\"didSave,omitempty\"" } "json:\"synchronization,omitempty\""; Completion struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; CompletionItem struct { SnippetSupport bool "json:\"snippetSupport,omitempty\""; CommitCharactersSupport bool "json:\"commitCharactersSupport,omitempty\""; DocumentationFormat []protocol.MarkupKind "json:\"documentationFormat,omitempty\""; DeprecatedSupport bool "json:\"deprecatedSupport,omitempty\""; PreselectSupport bool "json:\"preselectSupport,omitempty\"" } "json:\"completionItem,omitempty\""; CompletionItemKind struct { ValueSet []protocol.CompletionItemKind "json:\"valueSet,omitempty\"" } "json:\"completionItemKind,omitempty\""; ContextSupport bool "json:\"contextSupport,omitempty\"" } "json:\"completion,omitempty\""; Hover struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; ContentFormat []protocol.MarkupKind "json:\"contentFormat,omitempty\"" } "json:\"hover,omitempty\""; SignatureHelp struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; SignatureInformation struct { DocumentationFormat []protocol.MarkupKind "json:\"documentationFormat,omitempty\""; ParameterInformation struct { LabelOffsetSupport bool "json:\"labelOffsetSupport,omitempty\"" } "json:\"parameterInformation,omitempty\"" } "json:\"signatureInformation,omitempty\"" } "json:\"signatureHelp,omitempty\""; References struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"references,omitempty\""; DocumentHighlight struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"documentHighlight,omitempty\""; DocumentSymbol struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; SymbolKind struct { ValueSet []protocol.SymbolKind "json:\"valueSet,omitempty\"" } "json:\"symbolKind,omitempty\""; HierarchicalDocumentSymbolSupport bool "json:\"hierarchicalDocumentSymbolSupport,omitempty\"" } "json:\"documentSymbol,omitempty\""; Formatting struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"formatting,omitempty\""; RangeFormatting struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"rangeFormatting,omitempty\""; OnTypeFormatting struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"onTypeFormatting,omitempty\""; Definition struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; LinkSupport bool "json:\"linkSupport,omitempty\"" } "json:\"definition,omitempty\""; CodeAction struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; CodeActionLiteralSupport struct { CodeActionKind struct { ValueSet []protocol.CodeActionKind "json:\"valueSet\"" } "json:\"codeActionKind\"" } "json:\"codeActionLiteralSupport,omitempty\"" } "json:\"codeAction,omitempty\""; CodeLens struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"codeLens,omitempty\""; DocumentLink struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"documentLink,omitempty\""; Rename struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; PrepareSupport bool "json:\"prepareSupport,omitempty\"" } "json:\"rename,omitempty\""; PublishDiagnostics struct { RelatedInformation bool "json:\"relatedInformation,omitempty\""; TagSupport bool "json:\"tagSupport,omitempty\"" } "json:\"publishDiagnostics,omitempty\""; Implementation struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; LinkSupport bool "json:\"linkSupport,omitempty\"" } "json:\"implementation,omitempty\""; TypeDefinition struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; LinkSupport bool "json:\"linkSupport,omitempty\"" } "json:\"typeDefinition,omitempty\""; ColorProvider struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"colorProvider,omitempty\""; FoldingRange struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; RangeLimit float64 "json:\"rangeLimit,omitempty\""; LineFoldingOnly bool "json:\"lineFoldingOnly,omitempty\"" } "json:\"foldingRange,omitempty\""; Declaration struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; LinkSupport bool "json:\"linkSupport,omitempty\"" } "json:\"declaration,omitempty\""; SelectionRange struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" } "json:\"selectionRange,omitempty\"" }{ Synchronization: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; WillSave bool "json:\"willSave,omitempty\""; WillSaveWaitUntil bool "json:\"willSaveWaitUntil,omitempty\""; DidSave bool "json:\"didSave,omitempty\"" }{}, Completion: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; CompletionItem struct { SnippetSupport bool "json:\"snippetSupport,omitempty\""; CommitCharactersSupport bool "json:\"commitCharactersSupport,omitempty\""; DocumentationFormat []protocol.MarkupKind "json:\"documentationFormat,omitempty\""; DeprecatedSupport bool "json:\"deprecatedSupport,omitempty\""; PreselectSupport bool "json:\"preselectSupport,omitempty\"" } "json:\"completionItem,omitempty\""; CompletionItemKind struct { ValueSet []protocol.CompletionItemKind "json:\"valueSet,omitempty\"" } "json:\"completionItemKind,omitempty\""; ContextSupport bool "json:\"contextSupport,omitempty\"" }{}, Hover: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; ContentFormat []protocol.MarkupKind "json:\"contentFormat,omitempty\"" }{ DynamicRegistration: false, ContentFormat: {"plaintext"}, }, SignatureHelp: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; SignatureInformation struct { DocumentationFormat []protocol.MarkupKind "json:\"documentationFormat,omitempty\""; ParameterInformation struct { LabelOffsetSupport bool "json:\"labelOffsetSupport,omitempty\"" } "json:\"parameterInformation,omitempty\"" } "json:\"signatureInformation,omitempty\"" }{}, References: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" }{}, DocumentHighlight: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" }{}, DocumentSymbol: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; SymbolKind struct { ValueSet []protocol.SymbolKind "json:\"valueSet,omitempty\"" } "json:\"symbolKind,omitempty\""; HierarchicalDocumentSymbolSupport bool "json:\"hierarchicalDocumentSymbolSupport,omitempty\"" }{}, Formatting: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" }{}, RangeFormatting: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" }{}, OnTypeFormatting: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" }{}, Definition: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; LinkSupport bool "json:\"linkSupport,omitempty\"" }{}, CodeAction: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; CodeActionLiteralSupport struct { CodeActionKind struct { ValueSet []protocol.CodeActionKind "json:\"valueSet\"" } "json:\"codeActionKind\"" } "json:\"codeActionLiteralSupport,omitempty\"" }{}, CodeLens: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" }{}, DocumentLink: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" }{}, Rename: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; PrepareSupport bool "json:\"prepareSupport,omitempty\"" }{}, PublishDiagnostics: struct { RelatedInformation bool "json:\"relatedInformation,omitempty\""; TagSupport bool "json:\"tagSupport,omitempty\"" }{}, Implementation: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; LinkSupport bool "json:\"linkSupport,omitempty\"" }{}, TypeDefinition: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; LinkSupport bool "json:\"linkSupport,omitempty\"" }{}, ColorProvider: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" }{}, FoldingRange: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; RangeLimit float64 "json:\"rangeLimit,omitempty\""; LineFoldingOnly bool "json:\"lineFoldingOnly,omitempty\"" }{}, Declaration: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\""; LinkSupport bool "json:\"linkSupport,omitempty\"" }{}, SelectionRange: struct { DynamicRegistration bool "json:\"dynamicRegistration,omitempty\"" }{}, }, Experimental: nil, }, InitializationOptions: nil, Trace: "", WorkspaceFolders: nil, } gopls server end ======================= gopls server start ======================= gopls.Initialize() return; err: ; res: &protocol.InitializeResult{ Capabilities: protocol.ServerCapabilities{ TextDocumentSync: map[string]interface {}{ "openClose": bool(true), "change": float64(1), }, HoverProvider: true, CompletionProvider: &protocol.CompletionOptions{ TriggerCharacters: {"."}, AllCommitCharacters: nil, ResolveProvider: false, }, SignatureHelpProvider: &protocol.SignatureHelpOptions{ TriggerCharacters: {"(", ","}, }, DefinitionProvider: true, ReferencesProvider: false, DocumentHighlightProvider: true, DocumentSymbolProvider: true, WorkspaceSymbolProvider: false, CodeActionProvider: true, CodeLensProvider: (*protocol.CodeLensOptions)(nil), DocumentFormattingProvider: true, DocumentRangeFormattingProvider: true, DocumentOnTypeFormattingProvider: (*struct { FirstTriggerCharacter string "json:\"firstTriggerCharacter\""; MoreTriggerCharacter []string "json:\"moreTriggerCharacter,omitempty\"" })(nil), RenameProvider: (*protocol.RenameOptions)(nil), DocumentLinkProvider: (*protocol.DocumentLinkOptions)(nil), ExecuteCommandProvider: (*protocol.ExecuteCommandOptions)(nil), Experimental: nil, ImplementationProvider: false, TypeDefinitionProvider: true, Workspace: (*struct { WorkspaceFolders *struct { Supported bool "json:\"supported,omitempty\""; ChangeNotifications string "json:\"changeNotifications,omitempty\"" } "json:\"workspaceFolders,omitempty\"" })(nil), ColorProvider: false, FoldingRangeProvider: false, DeclarationProvider: false, SelectionRangeProvider: false, }, Custom: {}, } gopls server end ======================= gopls server start ======================= gopls.DidOpen() call; params: &protocol.DidOpenTextDocumentParams{ TextDocument: protocol.TextDocumentItem{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/main.go", LanguageID:"", Version:0, Text:"package main\n"}, } gopls server end ======================= gopls server start ======================= gopls.DidOpen() return; err: gopls server end ======================= gopls server start ======================= gopls.DidOpen() call; params: &protocol.DidOpenTextDocumentParams{ TextDocument: protocol.TextDocumentItem{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go", LanguageID:"", Version:0, Text:""}, } gopls server end ======================= gopls server start ======================= gopls.DidOpen() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 1, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "p", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 2, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "pa", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 3, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "pac", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 4, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "pack", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 5, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "packa", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 6, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "packag", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 7, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "package", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 8, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "package ", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 9, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "package m", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 10, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "package ma", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 11, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "package mai", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.DidChange() call; params: &protocol.DidChangeTextDocumentParams{ TextDocument: protocol.VersionedTextDocumentIdentifier{ Version: 12, TextDocumentIdentifier: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, }, ContentChanges: { { Range: (*protocol.Range)(nil), RangeLength: 0, Text: "package main", }, }, } gopls server end ======================= gopls server start ======================= gopls.DidChange() return; err: gopls server end ======================= gopls server start ======================= gopls.CodeAction() call; params: &protocol.CodeActionParams{ TextDocument: protocol.TextDocumentIdentifier{URI:"file:///home/myitcv/gostuff/src/github.com/myitcv/playground/blah.go"}, Range: protocol.Range{}, Context: protocol.CodeActionContext{}, } gopls server end =======================which gives rise to the following exception:
If instead of simply writing
package maintoblah.goI writepackage main\n(i.e. there is a trailing newline), then I don't see any issues.This fails for both
FormattingandCodeActionWhat did you expect to see?
No error when calling either
FormattingorCodeAction.What did you see instead?
An error similar to the above (which I hacked to panic for the stack trace)
cc @ianthehat
The text was updated successfully, but these errors were encountered: