Conversation
Migrate delete, delete-org, and delete-space from aggregated PollJob to a streaming job poll (PollJobToEventStream -> WaitForResult), so warnings print live instead of dumped at the end. Dedupe distinct warnings to at most once per operation.
|
Backport for v8: #3860 |
|
@johha I noticed the integration tests are currently failing. Could you take a look at fixing those while I review the rest of the PR? |
|
|
||
| if waitForCompletion { | ||
| fmt.Fprint(ui.Writer(), "Waiting for the operation to complete") | ||
| fmt.Fprintln(ui.Writer(), "Waiting for the operation to complete") |
There was a problem hiding this comment.
This newline moves the progress dots onto their own line, and WaitForResult is shared by 14 commands — the 3 delete commands added here plus 11 pre-existing service commands (bind-service, unbind-service, bind-route-service, unbind-route-service, create-service, update-service, upgrade-service, delete-service, create-service-key, delete-service-key, cleanup-outdated-service-bindings).
The unit tests were correctly updated for all of them:
-Say(`Waiting for the operation to complete\.\.\.\n`),
+Say(`Waiting for the operation to complete\n\.\.\.`),But the identical assertions in integration/v7/isolated/ were not and this PR touches no files under integration/. These 11 assertions expect dots immediately after complete, which no longer holds:
Worth calling out in the PR description as well: the change alters output for 11 service commands, not only the three delete commands the title describes. Anyone parsing cf bind-service --wait output is affected.
There was a problem hiding this comment.
Fixed. Updated all affected files under integration/v7/isolated/ with the same regex adjustment already applied to the unit tests.
Update integration/v7/isolated/ banner regex to match new newline-before-dots output. Restore two-phase DeleteRoute: issue all calls first, then poll, so CC can process them concurrently as before.
Thanks for the review @prkalle. The integration tests are skipped now. The CVE job seems to fail for almost all jobs. Also addressed all findings. Also adjust the v8 PR #3860 |
prkalle
left a comment
There was a problem hiding this comment.
Thanks for making these changes, @johha!
I re-ran the integration tests in CI and noticed a few failures. I've also left a couple of comments on the code for you to review.
(Note: You can ignore the CVE-related CI failures, I will handle fixing those in a separate PR.)
| Say(`Updating service instance %s in org %s / space %s as %s\.\.\.\n`, serviceInstanceName, orgName, spaceName, username), | ||
| Say(`\n`), | ||
| Say(`Update of service instance %s complete\.\n`, serviceInstanceName), | ||
| Say(`Update of service instance %s complete\n\.\n`, serviceInstanceName), |
There was a problem hiding this comment.
All 11 banner assertions look right now. But the replace also caught Update of service instance X complete. — that's the command's final success line (update_service_command.go:74), not the banner, and this PR doesn't change it. It should stay complete\.\n.
Three sites here: L186, L210, L336. L186 and L210 don't even pass --wait, so the banner never appears in them.
| Say(`Update of service instance %s complete\n\.\n`, serviceInstanceName), | |
| Say(`Update of service instance %s complete\.\n`, serviceInstanceName), |
Same slip in upgrade_service_command_test.go — commented there. Integration tests need a live foundation, so unit CI won't catch either.
| Say(`Waiting for the operation to complete\n\.+`), | ||
| Say(`\n`), | ||
| Say(`Upgrade of service instance %s complete\.\n`, serviceInstanceName), | ||
| Say(`Upgrade of service instance %s complete\n\.\n`, serviceInstanceName), |
There was a problem hiding this comment.
Same collateral edit as in update_service_command_test.go (see the comment there for the full explanation).
Upgrade of service instance X complete. is the terminal success message, emitted at command/v7/upgrade_service_command.go:65, and is unaffected by this PR. The banner assertion two lines above is correct; this one should go back to the original:
| Say(`Upgrade of service instance %s complete\n\.\n`, serviceInstanceName), | |
| Say(`Upgrade of service instance %s complete\.\n`, serviceInstanceName), |
| if deleteRoutes { | ||
| type routeJob struct { | ||
| jobURL ccv3.JobURL | ||
| warnings Warnings |
There was a problem hiding this comment.
Suggestion: routeJob.warnings is set but never read, since those warnings are already streamed on the previous line. routeJob can collapse to just the job URL:
Description of the Change
cf delete,cf delete-org, andcf delete-spacekick off an asynchronous Cloud Controller job and then poll it to completion. Previously the CLI aggregated every warning returned across all poll ticks and dumped them at the very end, after the job reached a terminal state. Because Cloud Controller re-sends the same warnings on every poll, a single warning could be printed dozens of times.This PR migrates those three commands from the aggregated
CloudControllerClient.PollJobpath to a streaming poll: the actor returns achan PollJobEvent(viaPollJobToEventStream) thatcommand/v7/shared.WaitForResultdrains, printing warnings as they arrive instead of at the end.Key changes:
DeleteApplicationByNameAndSpace,DeleteOrganization, andDeleteSpacenow return(chan PollJobEvent, Warnings, error). Forcf delete -r, the app-delete job and each route-delete job are merged into a single stream in the actor, so the whole operation streams through one channel.WaitForResultprints each distinct warning at most once per operation, collapsing the tick-by-tick repeats (including warnings that interleave across ticks).Example:
cf delete-orgagainst a job that returns warnings on every pollBefore (warnings aggregated and repeated per poll tick):
After (each distinct warning shown once, streamed live with progress dots):
cf delete APP -r(delete app + mapped routes) andcf delete-spacebehave the same way - warnings from the app job and each route/space job stream through as the jobs progress.Why Is This PR Valuable?
Users deleting orgs, spaces, or apps get feedback while the operation runs rather than a wall of duplicated text at the end. Warnings that Cloud Controller emits mid-operation (progress hints, content warnings) now surface promptly and legibly - each distinct message once - instead of being buffered until the job finishes or the poll window times out.
This is part of the ongoing effort to make recursive/async delete operations more intuitive (cloudfoundry/cloud_controller_ng#3589). The corresponding Cloud Controller work that emits these async-delete warnings is landing on the server side; this PR is the CLI half that surfaces them well.
Applicable Issues
How Urgent Is The Change?
Not urgent
Other Relevant Parties
None.
This PR was drafted with the help of Claude (Opus).