Rhythm 2.0 Specifications

Appearance

JNY-PFM-OPS-002Rhythm staff recover failed workspace provisioning

Markdown

JNY-PFM-OPS-002

Rhythm staff recover failed workspace provisioning

Markdown
  • DocumentDraft
  • Product intentConfirmed
  • ImplementationPartially observed

Planning

Feature
FEAT-PFM-OPS-01
Actor
ACT-PFM-004
Capabilities
CAP-PFM-OPS-006, CAP-PFM-OPS-001, CAP-PFM-OPS-002, CAP-PFM-OPS-003, CAP-PFM-OPS-004
Rules in play
BR-CAP-PFM-OPS-001-06, BR-CAP-PFM-OPS-002-07, BR-CAP-PFM-OPS-003-03, BR-CAP-PFM-OPS-003-06, BR-CAP-PFM-OPS-004-01, BR-CAP-PFM-OPS-004-02, BR-CAP-PFM-OPS-004-08

KindJourneyProduct areaPlatformModuleOperational RecordsRevision1End-to-endRequired

Read atservices-platform ad3f6a65macroservice-libraries 54536a44react-console baf6dae3

Rhythm staff recover failed workspace provisioning ​

Story ​

A Rhythm administrator submits workspace provisioning and follows the job page. Failure supplies an explanation and the owner’s recovery consequence, with requester notification attempted independently of job success. The administrator can confirm a supported retry that keeps the prior attempt’s history. This journey combines wizard, monitoring, notification and owning-module recovery evidence; it is not one already bound end-to-end proof.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Goal
Follow a provisioning failure, learn its outcome and recover without repeating completed work.
Screens
/hq/tenants/provision/hq/jobs/{jobKind}/{jobId}/hq/jobs

Steps

#SurfaceActionCapabilityExpectedProvenance
1/hq/tenants/provisionFinish the workspace preparation wizard.CAP-PFM-OPS-006Submission opens the created job’s HQ page.test
react-console:e2e/mock/hq-ops.mock.spec.ts#walks every step and lands on the job it started
2/hq/jobs/{jobKind}/{jobId}Follow the active run on its page.CAP-PFM-OPS-006The page presents progress and history while refreshing active work.test
react-console:e2e/mock/hq-ops.mock.spec.ts#shows a running job's step, its timeline and its event log
3jobAllow a permanent task refusal to end execution.CAP-PFM-OPS-001The job retains the safe failure explanation and the owner applies the workspace consequence.test
macroservice-libraries:packages/jobs/src/workflow/job-workflow.spec.ts#fails the job with the refusal’s own words and the execution’s correlation
4jobAttempt the declared requester notification.CAP-PFM-OPS-003Delivery handling uses the job’s requester, environment and matching HQ page link.observed
services-platform:modules/jobs/services/notices/notify-job-requester.ts:notifyJobRequester
5/hq/jobs/{jobKind}/{jobId}Follow the message link to investigate failure.CAP-PFM-OPS-006The detail page explains the failure and offers eligible provisioning recovery.test
react-console:e2e/mock/hq-ops.mock.spec.ts#shows a failed job's reason and retries its provisioning
6retryTenantProvisioningConfirm Retry Provisioning.CAP-PFM-OPS-004The new attempt links to its predecessor and carries completed step keys.test
macroservice-libraries:packages/jobs/src/engine/job-engine.spec.ts#answers the steps the prior job completed, which the start carries into the new execution

Alternate and Failure Paths

PathFrom stepConditionPath takenOutcomeProvenance
alternate3No execution starts or failure handling never completes.Reconciliation later applies the registered failure consequence.The workspace reaches recoverable failure and notification handling can run.test
services-platform:modules/tenants/tests/integration/lifecycle/reconciled-job-failure.integration.spec.js#tells the staff member who asked for the tenant that it failed, though no task of the job ever ran
alternate5The staff caller lacks the retry button’s permission.Inspect the failure without a retry control.A permitted operator is needed to request recovery.observed
react-console:components/console/hq/job/job-retry.tsx:JobRetry
failure6The caller has the button permission but lacks backend provisioning authority.Display the operation’s refusal after confirmation.No retry job is created.observed
services-platform:modules/tenants/aws/api/tenants.routes.ts:retryTenantProvisioning (HQ_TENANTS_PERMISSIONS.Provision)

Assertions

IdStatementProvenance
01A completed failure notice suppresses delivery when its consequence is repeated sequentially.test
services-platform:modules/tenants/tests/integration/lifecycle/reconciled-job-failure.integration.spec.js#sends the requester nothing a second time either
02The provisioning failure consequence restores a recoverable workspace state.test
services-platform:modules/tenants/tests/integration/lifecycle/reconciled-job-failure.integration.spec.js#moves the tenant to provisioning_failed, which is what makes it retryable and deletable again
03Retry preserves predecessor identity and completed step keys.test
macroservice-libraries:packages/jobs/src/engine/job-engine.spec.ts#creates the retry with lineage to the prior job

End-to-end policy: required: The outcome crosses submission, monitoring, messaging and recovery, requiring browser coverage alongside backend failure and delivery proofs.

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software