BRP Add schedule.list endpoint

[Zeophlite]

Objective

• List schedules in BRP

Solution

• Add the endpoint
• Add to Schedules some tracking of temporarily_removed (schedule removed to execute) and empty_labels (no Schedule for that label)

Related:

• BRP Add schedule.graph endpoint #23452
• Add BRP to render app #23446

Testing

• in terminal 1 run cargo run --example server --features="bevy_remote"
• in terminal 2 run curl -d'{"jsonrpc":"2.0","method":"schedule.list","id":1,"params":{}}' -X POST -H "Accept: applcation/json" -H "Content-Type: application/json" http://127.0.0.1:15702

Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "empty_schedule_labels": [
            "FixedPreUpdate",
            "FixedUpdate"
        ],
        "schedule_labels": [
            "Startup",
            "First",
            "RunFixedMainLoop",
            "PostStartup",
            "FixedFirst",
            "StateTransition",
            "PreUpdate",
            "PostUpdate",
            "Update",
            "PreStartup",
            "SpawnScene",
            "Last",
            "FixedLast",
            "FixedPostUpdate",
            "FixedMain"
        ],
        "unavailable_schedule_labels": [
            "Main",
            "RemoteLast"
        ]
    }
}

[Zeophlite]

@kfc35 Apologies I had a larger WIP branch that I split out this from, could you please have another look?

[kfc35]

This looks good for an initial endpoint, and I appreciate the vision heh. I checked out the branch and it works as expected for the remote example, sample response: {"jsonrpc":"2.0","id":1,"result":["StateTransition","FixedFirst","Update","FixedMain","PreUpdate","PreStartup","Startup","Last","SpawnScene","FixedLast","First","RunFixedMainLoop","FixedPostUpdate","PostStartup","PostUpdate”]}

I wonder if people will be curious to see the schedules for the render subapp too, but that could be extended later as a request parameter or something. Don’t mind my tendency to over-engineer edit: i see your other PR has to do with render app stuff and bevy_remote, so I will just have to look at that I suppose

[Zeophlite]

I wonder if people will be curious to see the schedules for the render subapp too, but that could be extended later as a request parameter or something. Don’t mind my tendency to over-engineer edit: i see your other PR has to do with render app stuff and bevy_remote, so I will just have to look at that I suppose

Indeed, and it gives this response for the render subapp

{"jsonrpc":"2.0","id":1,"result":["Core3d","RenderGraph","ExtractSchedule","Core2d","RenderStartup"]}

Ref: #23446

[ChristopherBiscardi]

It feels strange that this is basically a special-cased endpoint for the Schedules Resource that skips around the world.get_resources handler. That also means this doesn't return ScheduleLabels like Main, which also can't be used in the followup #23452 .

We should at least document the caveats for what data is going to be returned here so users know what to expect.

[Zeophlite]

As mentioned in #23452 (comment) , bevy_ecs temporarily removes a schedule from the resource in order to execute it. New version tracks these "unavailable" schedules, so the user knows they exist but can't be queried. Also tracks "empty" schedule labels. Output is now as follows:

{"jsonrpc":"2.0","id":1,"result":{"empty_schedule_labels":["FixedPreUpdate","FixedUpdate"],"schedule_labels":["Startup","First","RunFixedMainLoop","PostStartup","FixedFirst","StateTransition","PreUpdate","PostUpdate","Update","PreStartup","SpawnScene","Last","FixedLast","FixedPostUpdate","FixedMain"],"unavailable_schedule_labels":["Main","RemoteLast"]}}

[alice-i-cecile]

Needs a test :)