Document that deploy_component waits for restart: true and reports restart_completed - #638
Document that deploy_component waits for restart: true and reports restart_completed#638kriszyp wants to merge 6 commits into
Conversation
…rue and reports restart_completed
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-638 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-638 This preview will update automatically when you push new commits. |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-638 This preview will update automatically when you push new commits. |
…oved response field
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-638 This preview will update automatically when you push new commits. |
…se take install + restart time
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-638 This preview will update automatically when you push new commits. |
1 participant
Documents the
deploy_componentrestart behavior that HarperFast/harper#2341 changes:"restart": truenow waits for the worker restart before responding, so a successful response means every worker thread is serving the new code.drop_componentwaits the same way.The old behavior was undocumented and load-bearing for callers: the operation reported success while the rolling restart was still running, so a client acting on that success could be served by a worker that had never loaded the component (harper#2335).
For the human reviewer
v5.3.0, per Kris's call — the change ships in the next minor rather than a 5.2 patch. PerAGENTS.mdthis still gets re-checked at merge time.#### Restarting (restart)subsection underdeploy_component, next to the existing credentials subsection, rather than expanding the one-line mention in the intro paragraph. The alternative is a shorter note inline; the subsection wins if therestart_completedsemantics are worth spelling out for CI callers, which is the audiencelearn/developers/deploying-from-ci.mdxtargets.Verification
npm run format:writethennpm run format:check— clean. Claims checked against the implementation: the awaited restart and its give-up conditions incomponents/operations.jsandcomponents/awaitRestart.ts, and the"rolling"path's replicatedrestart_servicejob (it does restart peers — an earlier draft of this text said it did not). An earlier revision of this PR documented arestart_completedresponse field; that field was dropped from #2341, and so from here.