Avoid flood of warnings when trying to edit "untitled..." URL

Author: michaliskambi

server/udocumentsymbolsupport.pas

@@ -57,6 +57,8 @@ implementation
 
 uses ulogvscode, CodeToolManager, CodeCache, CodeTree, PascalParserTool;
 
+{ Get filename from "textDocument/documentSymbol" request.
+  Returns empty string if not possible (invalid, unrecognized URI). }
 function ParseDocumentSymbolRequest(Reader: TJsonReader): String;
 var
   Key, Uri: String;
@@ -78,22 +80,6 @@ function ParseDocumentSymbolRequest(Reader: TJsonReader): String;
   Result := URIToFileNameEasy(Uri);
 end;
 
-{ Return null response, that signals "no error, but also no result". }
-procedure SendNullResponse(const Rpc: TRpcPeer; const Request: TRpcRequest);
-var
-  Response: TRpcResponse;
-  Writer:   TJsonWriter;
-begin
-  Response := TRpcResponse.Create(Request.Id);
-  try
-    Writer := Response.Writer;
-    Writer.Null;
-    Rpc.Send(Response);
-  finally
-    FreeAndNil(Response);
-  end;
-end;
-
 { Responses for textDocument/documentSymbol method
   Docs: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentSymbol }
 procedure TextDocument_DocumentSymbol(const Rpc: TRpcPeer; const Request: TRpcRequest);
@@ -113,14 +99,25 @@ procedure TextDocument_DocumentSymbol(const Rpc: TRpcPeer; const Request: TRpcRe
   ProcedureName: String;
 begin
   Filename := ParseDocumentSymbolRequest(Request.Reader);
+  if Filename = '' then
+  begin
+    { This happens when opening new file that is not yet saved,
+      with "untitled:" URI that has no real filename.
+      Return null (not any error) in response, to avoid flooding
+      notifications to user that tried to edit such file. }
+    SendNullResponse(Rpc, Request);
+    Exit;
+  end;
+
   LogInfo(Rpc, 'File name:' + Filename);
   Code := CodeToolBoss.FindFile(Filename);
-
   if Code = nil then
+  begin
     raise ERpcError.CreateFmt(
       jsrpcInvalidRequest,
       'File not found: %s', [Filename]
     );
+  end;
 
  { Based on lazarus TProcedureListForm.GetCodeTreeNode() }
 

server/ujsonrpc.pas

@@ -102,9 +102,12 @@   ERpcError = class(Exception)
   jsrpcMethodNotFound       = -32601;
   jsrpcRequestFailed        = -32803;
 
+{ Return null response, that signals "no error, but also no result". }
+procedure SendNullResponse(const Rpc: TRpcPeer; const Request: TRpcRequest);
+
 implementation
 
-uses 
+uses
   CastleLsp, udebug;
 
 procedure WriteRpcId(Writer: TJsonWriter; const Id: TRPcId);
@@ -165,7 +168,7 @@ constructor TRpcResponse.CreateError(
   Writer.Dict;
     Writer.Key('code');
     Writer.Number(Code);
-  
+
     Writer.Key('message');
     Writer.Str(Msg);
   Writer.DictEnd;
@@ -255,7 +258,7 @@ function TRpcPeer.Receive: TRpcRequest;
       raise EParserError.Create('Invalid request body.');
 
     Buffer := TBytesStream.Create();
-    Buffer.SetSize(Len);  
+    Buffer.SetSize(Len);
     FInput.BlockRead(PByte(Buffer.Memory)^, Len);
 
     // 1st pass: Extract meta data
@@ -285,13 +288,13 @@ function TRpcPeer.Receive: TRpcRequest;
 
     if (Version <> '2.0') then
       raise ERpcError.Create(
-        jsrpcInvalidRequest, 
+        jsrpcInvalidRequest,
         'No or invalid jsonrpc version specified. Must be 2.0.'
       );
 
     if (Method = '') then
       raise ERpcError.Create(
-        jsrpcInvalidRequest, 
+        jsrpcInvalidRequest,
         'No method specified.'
       );
 
@@ -319,7 +322,7 @@ function TRpcPeer.Receive: TRpcRequest;
     Result.Id      := Id;
     Result.Reader  := Reader;
     Result.FBuffer := Buffer;
-    
+
     LogFullJson := UserConfig.ReadBool('log', 'full_json', false);
     if LogFullJson then
       CutLength := MaxInt
@@ -355,7 +358,7 @@ procedure TRpcPeer.Send(Response: TRpcResponse);
     [ContentType, Response.FBuffer.Size]
   ));
   FOutput.WriteBuffer(
-    PByte(Response.FBuffer.Memory)^, 
+    PByte(Response.FBuffer.Memory)^,
     Response.FBuffer.Size
   );
 
@@ -388,5 +391,20 @@ constructor ERpcError.CreateFmt(
   Code := ACode;
 end;
 
+procedure SendNullResponse(const Rpc: TRpcPeer; const Request: TRpcRequest);
+var
+  Response: TRpcResponse;
+  Writer:   TJsonWriter;
+begin
+  Response := TRpcResponse.Create(Request.Id);
+  try
+    Writer := Response.Writer;
+    Writer.Null;
+    Rpc.Send(Response);
+  finally
+    FreeAndNil(Response);
+  end;
+end;
+
 end.
 

server/utextdocument.pas

@@ -100,8 +100,17 @@ procedure TextDocument_DidOpen(Rpc: TRpcPeer; Request: TRpcRequest);
   if ParseChangeOrOpen(Request.Reader, UriStr, Content, false) then
   begin
     FileName := URIToFileNameEasy(UriStr);
+    if FileName = '' then
+    begin
+      raise ERpcError.CreateFmt(
+        jsrpcInvalidRequest,
+        'URI does not describe a regular file: %s', [UriStr]
+      );
+    end;
+
+    // Initialize Code from FileName
     Code := CodeToolBoss.LoadFile(FileName, false, false);
-    { When we can't found file try to create it, workaround for creating
+    { When we can't find file try to create it, workaround for creating
       new source files in vscode }
     if Code = nil then
       Code := CodeToolBoss.CreateFile(FileName);
@@ -123,6 +132,11 @@ procedure TextDocument_DidChange(Rpc: TRpcPeer; Request: TRpcRequest);
   if ParseChangeOrOpen(Request.Reader, UriStr, Content, true) then
   begin
     FileName := URIToFileNameEasy(UriStr);
+    if FileName = '' then
+      raise ERpcError.CreateFmt(
+        jsrpcInvalidRequest,
+        'URI does not describe a regular file: %s', [UriStr]
+      );
     Code     := CodeToolBoss.FindFile(FileName);
     if Code = nil then
       raise ERpcError.CreateFmt(
@@ -348,6 +362,7 @@ procedure GetCompletionRecords(
 type
   TCompletionRequest = record
     X, Y:        Integer;
+    Uri:         String;
     FileName:    String;
     TriggerKind: Integer;
     TriggerChar: string;
@@ -357,9 +372,8 @@   TCompletionRequest = record
 function ParseCompletionRequest(Reader: TJsonReader): TCompletionRequest;
 var
   Key:    string;
-  UriStr: string;
 begin
-  UriStr             := '';
+  Result.Uri         := '';
   Result.TriggerKind := -1;
   Result.Y           := -1;
   Result.X           := -1;
@@ -371,7 +385,7 @@ function ParseCompletionRequest(Reader: TJsonReader): TCompletionRequest;
         while (Reader.Advance <> jsDictEnd) and Reader.Key(Key) do
         begin
           if Key = 'uri' then
-            Reader.Str(UriStr);
+            Reader.Str(Result.Uri);
         end
       else if (Key = 'position') and Reader.Dict then
         while (Reader.Advance <> jsDictEnd) and Reader.Key(Key) do
@@ -395,7 +409,7 @@ function ParseCompletionRequest(Reader: TJsonReader): TCompletionRequest;
         end;
     end;
 
-  Result.FileName := URIToFileNameEasy(UriStr);
+  Result.FileName := URIToFileNameEasy(Result.Uri);
 end;
 
 // Identifier completion
@@ -657,6 +671,12 @@ procedure TextDocument_Completion(Rpc: TRpcPeer; Request: TRpcRequest);
   try
     try
       Req  := ParseCompletionRequest(Request.Reader);
+      if Req.Filename = '' then
+      begin
+        SendNullResponse(Rpc, Request);
+        Exit;
+      end;
+
       Code := CodeToolBoss.FindFile(Req.FileName);
 
       if Code = nil then
@@ -817,6 +837,12 @@ procedure TextDocument_SignatureHelp(Rpc: TRpcPeer; Request: TRpcRequest);
   try
     try
       Req  := ParseCompletionRequest(Request.Reader);
+      if Req.Filename = '' then
+      begin
+        SendNullResponse(Rpc, Request);
+        Exit;
+      end;
+
       Code := CodeToolBoss.FindFile(Req.FileName);
 
       if Code = nil then
@@ -918,6 +944,11 @@ procedure TextDocument_JumpTo(
 
   try
     Req := ParseCompletionRequest(Request.Reader);
+    if Req.Filename = '' then
+    begin
+      SendNullResponse(Rpc, Request);
+      Exit;
+    end;
 
     Code := CodeToolBoss.FindFile(Req.FileName);
 

server/uutils.pas

@@ -27,6 +27,11 @@ interface
 
 function MergePaths(Paths: array of string): string;
 function GetConfigDirForApp(AppName, Vendor: string; Global: Boolean): string;
+
+{ Convert URI (with file:// protocol) to a filename.
+  Accepts also empty string, returning empty string in return.
+  URIs with other protocols (like "untitled://") or invalid URIs
+  result in a warning and also return empty string. }
 function URIToFileNameEasy(const UriStr: String): String;
 
 { Return prefix for error message describing filename, line, column
@@ -91,18 +96,16 @@ function GetConfigDirForApp(AppName, Vendor: string; Global: Boolean): string;
   end;
 end;
 
-{ Convert URI (with file:// protocol) to a filename.
-  Accepts also empty string, returning empty string in return.
-  Other / invalid URIs result in an exception. }
 function URIToFileNameEasy(const UriStr: String): String;
 begin
   if UriStr = '' then
     Exit('');
   if not URIToFilename(UriStr, Result) then
-    raise ERpcError.CreateFmt(
+    Exit('');
+    {raise ERpcError.CreateFmt(
       jsrpcInvalidRequest,
       'Unable to convert URI to filename: %s', [UriStr]
-    );
+    );}
 end;
 
 const