Progress report capabilities

Hi there,

I am trying to setup a progress report from the LS to Visual Code.

I implemented the following functions :

@diplomat_server.command(DiplomatLanguageServer.CMD_TST_PROGRESS_STRT)
def on_start_progress(ls : DiplomatLanguageServer, *args):
	initiate_progress(ls)
	print("Start progress on uuid",ls.progress_uuid)
	ls.send_notification("$/progress",WorkDoneProgressParams(token=ls.progress_uuid,value=WorkDoneProgressBegin(title = "Working hard")))


@diplomat_server.command(DiplomatLanguageServer.CMD_TST_PROGRESS_STOP)
def on_stop_progress(ls : DiplomatLanguageServer, *args):
	print("Stop progress")

	ls.send_notification("$/progress",WorkDoneProgressParams(token=ls.progress_uuid, value=WorkDoneProgressEnd(message = "Stuff done.")))

@diplomat_server.command(WINDOW_WORK_DONE_PROGRESS_CREATE)
def initiate_progress(ls : DiplomatLanguageServer, *args) -> ProgressToken:
	ls.progress_uuid = uuid.uuid4().int
	return ls.progress_uuid

When I execute on_start_progress and on_stop_progress from a client command, I do get the appropriates prints on the python side, however, I have no reaction at all even though I expect to have an indefinite progress bar.

I haven’t found any resource about this in the documentation so is there a limitation that I’m not aware of or an obvious mistake ? I suspect my initiate_progress command or its call are the problem, but I have no clue about how to do otherwise…

If there is a place to ask for help which is more appropriate than GH issues, please let me know.

Best regards, Julien Faucher

[danixeee]

@suzizecat Progress reporting is now added to the server.

[danixeee]

We will add some helper methods to the server class, like get_configuration and get_configuration_async.

You can see differences between thread, async, and callback approaches in the json example.

In your case:

@server.thread()
@server.command("SHOW_PROGRESS")
def on_progress_show(ls: DiplomatLanguageServer, *args):
   progress_token = uuid.uuid4().int

    # Tell the client to create a progress bar
    ls.lsp.send_request(
        WINDOW_WORK_DONE_PROGRESS_CREATE,
        WorkDoneProgressCreateParams(
            token=progress_token
        )
    ).result(1) # waits for 1 second before raise the exception

    ...